Linux Audio

Check our new training course

Loading...
v4.6
   1#ifndef __NET_CFG80211_H
   2#define __NET_CFG80211_H
   3/*
   4 * 802.11 device and configuration interface
   5 *
   6 * Copyright 2006-2010	Johannes Berg <johannes@sipsolutions.net>
   7 * Copyright 2013-2014 Intel Mobile Communications GmbH
   8 * Copyright 2015	Intel Deutschland GmbH
   9 *
  10 * This program is free software; you can redistribute it and/or modify
  11 * it under the terms of the GNU General Public License version 2 as
  12 * published by the Free Software Foundation.
  13 */
  14
  15#include <linux/netdevice.h>
  16#include <linux/debugfs.h>
  17#include <linux/list.h>
  18#include <linux/bug.h>
  19#include <linux/netlink.h>
  20#include <linux/skbuff.h>
  21#include <linux/nl80211.h>
  22#include <linux/if_ether.h>
  23#include <linux/ieee80211.h>
  24#include <linux/net.h>
  25#include <net/regulatory.h>
  26
  27/**
  28 * DOC: Introduction
  29 *
  30 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
  31 * userspace and drivers, and offers some utility functionality associated
  32 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
  33 * by all modern wireless drivers in Linux, so that they offer a consistent
  34 * API through nl80211. For backward compatibility, cfg80211 also offers
  35 * wireless extensions to userspace, but hides them from drivers completely.
  36 *
  37 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
  38 * use restrictions.
  39 */
  40
  41
  42/**
  43 * DOC: Device registration
  44 *
  45 * In order for a driver to use cfg80211, it must register the hardware device
  46 * with cfg80211. This happens through a number of hardware capability structs
  47 * described below.
  48 *
  49 * The fundamental structure for each device is the 'wiphy', of which each
  50 * instance describes a physical wireless device connected to the system. Each
  51 * such wiphy can have zero, one, or many virtual interfaces associated with
  52 * it, which need to be identified as such by pointing the network interface's
  53 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
  54 * the wireless part of the interface, normally this struct is embedded in the
  55 * network interface's private data area. Drivers can optionally allow creating
  56 * or destroying virtual interfaces on the fly, but without at least one or the
  57 * ability to create some the wireless device isn't useful.
  58 *
  59 * Each wiphy structure contains device capability information, and also has
  60 * a pointer to the various operations the driver offers. The definitions and
  61 * structures here describe these capabilities in detail.
  62 */
  63
  64struct wiphy;
  65
  66/*
  67 * wireless hardware capability structures
  68 */
  69
  70/**
  71 * enum ieee80211_band - supported frequency bands
  72 *
  73 * The bands are assigned this way because the supported
  74 * bitrates differ in these bands.
  75 *
  76 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
  77 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
  78 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
  79 * @IEEE80211_NUM_BANDS: number of defined bands
  80 */
  81enum ieee80211_band {
  82	IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
  83	IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
  84	IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
  85
  86	/* keep last */
  87	IEEE80211_NUM_BANDS
  88};
  89
  90/**
  91 * enum ieee80211_channel_flags - channel flags
  92 *
  93 * Channel flags set by the regulatory control code.
  94 *
  95 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
  96 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
  97 * 	sending probe requests or beaconing.
  98 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
  99 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
 100 * 	is not permitted.
 101 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
 102 * 	is not permitted.
 103 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
 104 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
 105 *	this flag indicates that an 80 MHz channel cannot use this
 106 *	channel as the control or any of the secondary channels.
 107 *	This may be due to the driver or due to regulatory bandwidth
 108 *	restrictions.
 109 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
 110 *	this flag indicates that an 160 MHz channel cannot use this
 111 *	channel as the control or any of the secondary channels.
 112 *	This may be due to the driver or due to regulatory bandwidth
 113 *	restrictions.
 114 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
 115 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
 116 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
 117 *	on this channel.
 118 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
 119 *	on this channel.
 120 *
 121 */
 122enum ieee80211_channel_flags {
 123	IEEE80211_CHAN_DISABLED		= 1<<0,
 124	IEEE80211_CHAN_NO_IR		= 1<<1,
 125	/* hole at 1<<2 */
 126	IEEE80211_CHAN_RADAR		= 1<<3,
 127	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
 128	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
 129	IEEE80211_CHAN_NO_OFDM		= 1<<6,
 130	IEEE80211_CHAN_NO_80MHZ		= 1<<7,
 131	IEEE80211_CHAN_NO_160MHZ	= 1<<8,
 132	IEEE80211_CHAN_INDOOR_ONLY	= 1<<9,
 133	IEEE80211_CHAN_IR_CONCURRENT	= 1<<10,
 134	IEEE80211_CHAN_NO_20MHZ		= 1<<11,
 135	IEEE80211_CHAN_NO_10MHZ		= 1<<12,
 136};
 137
 138#define IEEE80211_CHAN_NO_HT40 \
 139	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
 140
 141#define IEEE80211_DFS_MIN_CAC_TIME_MS		60000
 142#define IEEE80211_DFS_MIN_NOP_TIME_MS		(30 * 60 * 1000)
 143
 144/**
 145 * struct ieee80211_channel - channel definition
 146 *
 147 * This structure describes a single channel for use
 148 * with cfg80211.
 149 *
 150 * @center_freq: center frequency in MHz
 151 * @hw_value: hardware-specific value for the channel
 152 * @flags: channel flags from &enum ieee80211_channel_flags.
 153 * @orig_flags: channel flags at registration time, used by regulatory
 154 *	code to support devices with additional restrictions
 155 * @band: band this channel belongs to.
 156 * @max_antenna_gain: maximum antenna gain in dBi
 157 * @max_power: maximum transmission power (in dBm)
 158 * @max_reg_power: maximum regulatory transmission power (in dBm)
 159 * @beacon_found: helper to regulatory code to indicate when a beacon
 160 *	has been found on this channel. Use regulatory_hint_found_beacon()
 161 *	to enable this, this is useful only on 5 GHz band.
 162 * @orig_mag: internal use
 163 * @orig_mpwr: internal use
 164 * @dfs_state: current state of this channel. Only relevant if radar is required
 165 *	on this channel.
 166 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
 167 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
 168 */
 169struct ieee80211_channel {
 170	enum ieee80211_band band;
 171	u16 center_freq;
 172	u16 hw_value;
 173	u32 flags;
 174	int max_antenna_gain;
 175	int max_power;
 176	int max_reg_power;
 177	bool beacon_found;
 178	u32 orig_flags;
 179	int orig_mag, orig_mpwr;
 180	enum nl80211_dfs_state dfs_state;
 181	unsigned long dfs_state_entered;
 182	unsigned int dfs_cac_ms;
 183};
 184
 185/**
 186 * enum ieee80211_rate_flags - rate flags
 187 *
 188 * Hardware/specification flags for rates. These are structured
 189 * in a way that allows using the same bitrate structure for
 190 * different bands/PHY modes.
 191 *
 192 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
 193 *	preamble on this bitrate; only relevant in 2.4GHz band and
 194 *	with CCK rates.
 195 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
 196 *	when used with 802.11a (on the 5 GHz band); filled by the
 197 *	core code when registering the wiphy.
 198 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
 199 *	when used with 802.11b (on the 2.4 GHz band); filled by the
 200 *	core code when registering the wiphy.
 201 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
 202 *	when used with 802.11g (on the 2.4 GHz band); filled by the
 203 *	core code when registering the wiphy.
 204 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
 205 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
 206 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
 207 */
 208enum ieee80211_rate_flags {
 209	IEEE80211_RATE_SHORT_PREAMBLE	= 1<<0,
 210	IEEE80211_RATE_MANDATORY_A	= 1<<1,
 211	IEEE80211_RATE_MANDATORY_B	= 1<<2,
 212	IEEE80211_RATE_MANDATORY_G	= 1<<3,
 213	IEEE80211_RATE_ERP_G		= 1<<4,
 214	IEEE80211_RATE_SUPPORTS_5MHZ	= 1<<5,
 215	IEEE80211_RATE_SUPPORTS_10MHZ	= 1<<6,
 216};
 217
 218/**
 219 * enum ieee80211_bss_type - BSS type filter
 220 *
 221 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
 222 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
 223 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
 224 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
 225 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
 226 */
 227enum ieee80211_bss_type {
 228	IEEE80211_BSS_TYPE_ESS,
 229	IEEE80211_BSS_TYPE_PBSS,
 230	IEEE80211_BSS_TYPE_IBSS,
 231	IEEE80211_BSS_TYPE_MBSS,
 232	IEEE80211_BSS_TYPE_ANY
 233};
 234
 235/**
 236 * enum ieee80211_privacy - BSS privacy filter
 237 *
 238 * @IEEE80211_PRIVACY_ON: privacy bit set
 239 * @IEEE80211_PRIVACY_OFF: privacy bit clear
 240 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
 241 */
 242enum ieee80211_privacy {
 243	IEEE80211_PRIVACY_ON,
 244	IEEE80211_PRIVACY_OFF,
 245	IEEE80211_PRIVACY_ANY
 246};
 247
 248#define IEEE80211_PRIVACY(x)	\
 249	((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
 250
 251/**
 252 * struct ieee80211_rate - bitrate definition
 253 *
 254 * This structure describes a bitrate that an 802.11 PHY can
 255 * operate with. The two values @hw_value and @hw_value_short
 256 * are only for driver use when pointers to this structure are
 257 * passed around.
 258 *
 259 * @flags: rate-specific flags
 260 * @bitrate: bitrate in units of 100 Kbps
 261 * @hw_value: driver/hardware value for this rate
 262 * @hw_value_short: driver/hardware value for this rate when
 263 *	short preamble is used
 264 */
 265struct ieee80211_rate {
 266	u32 flags;
 267	u16 bitrate;
 268	u16 hw_value, hw_value_short;
 269};
 270
 271/**
 272 * struct ieee80211_sta_ht_cap - STA's HT capabilities
 273 *
 274 * This structure describes most essential parameters needed
 275 * to describe 802.11n HT capabilities for an STA.
 276 *
 277 * @ht_supported: is HT supported by the STA
 278 * @cap: HT capabilities map as described in 802.11n spec
 279 * @ampdu_factor: Maximum A-MPDU length factor
 280 * @ampdu_density: Minimum A-MPDU spacing
 281 * @mcs: Supported MCS rates
 282 */
 283struct ieee80211_sta_ht_cap {
 284	u16 cap; /* use IEEE80211_HT_CAP_ */
 285	bool ht_supported;
 286	u8 ampdu_factor;
 287	u8 ampdu_density;
 288	struct ieee80211_mcs_info mcs;
 289};
 290
 291/**
 292 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
 293 *
 294 * This structure describes most essential parameters needed
 295 * to describe 802.11ac VHT capabilities for an STA.
 296 *
 297 * @vht_supported: is VHT supported by the STA
 298 * @cap: VHT capabilities map as described in 802.11ac spec
 299 * @vht_mcs: Supported VHT MCS rates
 300 */
 301struct ieee80211_sta_vht_cap {
 302	bool vht_supported;
 303	u32 cap; /* use IEEE80211_VHT_CAP_ */
 304	struct ieee80211_vht_mcs_info vht_mcs;
 305};
 306
 307/**
 308 * struct ieee80211_supported_band - frequency band definition
 309 *
 310 * This structure describes a frequency band a wiphy
 311 * is able to operate in.
 312 *
 313 * @channels: Array of channels the hardware can operate in
 314 *	in this band.
 315 * @band: the band this structure represents
 316 * @n_channels: Number of channels in @channels
 317 * @bitrates: Array of bitrates the hardware can operate with
 318 *	in this band. Must be sorted to give a valid "supported
 319 *	rates" IE, i.e. CCK rates first, then OFDM.
 320 * @n_bitrates: Number of bitrates in @bitrates
 321 * @ht_cap: HT capabilities in this band
 322 * @vht_cap: VHT capabilities in this band
 323 */
 324struct ieee80211_supported_band {
 325	struct ieee80211_channel *channels;
 326	struct ieee80211_rate *bitrates;
 327	enum ieee80211_band band;
 328	int n_channels;
 329	int n_bitrates;
 330	struct ieee80211_sta_ht_cap ht_cap;
 331	struct ieee80211_sta_vht_cap vht_cap;
 332};
 333
 334/*
 335 * Wireless hardware/device configuration structures and methods
 336 */
 337
 338/**
 339 * DOC: Actions and configuration
 340 *
 341 * Each wireless device and each virtual interface offer a set of configuration
 342 * operations and other actions that are invoked by userspace. Each of these
 343 * actions is described in the operations structure, and the parameters these
 344 * operations use are described separately.
 345 *
 346 * Additionally, some operations are asynchronous and expect to get status
 347 * information via some functions that drivers need to call.
 348 *
 349 * Scanning and BSS list handling with its associated functionality is described
 350 * in a separate chapter.
 351 */
 352
 
 
 
 353/**
 354 * struct vif_params - describes virtual interface parameters
 355 * @use_4addr: use 4-address frames
 356 * @macaddr: address to use for this virtual interface.
 357 *	If this parameter is set to zero address the driver may
 358 *	determine the address as needed.
 359 *	This feature is only fully supported by drivers that enable the
 360 *	%NL80211_FEATURE_MAC_ON_CREATE flag.  Others may support creating
 361 **	only p2p devices with specified MAC.
 
 
 362 */
 363struct vif_params {
 364       int use_4addr;
 365       u8 macaddr[ETH_ALEN];
 
 366};
 367
 368/**
 369 * struct key_params - key information
 370 *
 371 * Information about a key
 372 *
 373 * @key: key material
 374 * @key_len: length of key material
 375 * @cipher: cipher suite selector
 376 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
 377 *	with the get_key() callback, must be in little endian,
 378 *	length given by @seq_len.
 379 * @seq_len: length of @seq.
 380 */
 381struct key_params {
 382	const u8 *key;
 383	const u8 *seq;
 384	int key_len;
 385	int seq_len;
 386	u32 cipher;
 387};
 388
 389/**
 390 * struct cfg80211_chan_def - channel definition
 391 * @chan: the (control) channel
 392 * @width: channel width
 393 * @center_freq1: center frequency of first segment
 394 * @center_freq2: center frequency of second segment
 395 *	(only with 80+80 MHz)
 396 */
 397struct cfg80211_chan_def {
 398	struct ieee80211_channel *chan;
 399	enum nl80211_chan_width width;
 400	u32 center_freq1;
 401	u32 center_freq2;
 402};
 403
 404/**
 405 * cfg80211_get_chandef_type - return old channel type from chandef
 406 * @chandef: the channel definition
 407 *
 408 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
 409 * chandef, which must have a bandwidth allowing this conversion.
 410 */
 411static inline enum nl80211_channel_type
 412cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
 413{
 414	switch (chandef->width) {
 415	case NL80211_CHAN_WIDTH_20_NOHT:
 416		return NL80211_CHAN_NO_HT;
 417	case NL80211_CHAN_WIDTH_20:
 418		return NL80211_CHAN_HT20;
 419	case NL80211_CHAN_WIDTH_40:
 420		if (chandef->center_freq1 > chandef->chan->center_freq)
 421			return NL80211_CHAN_HT40PLUS;
 422		return NL80211_CHAN_HT40MINUS;
 423	default:
 424		WARN_ON(1);
 425		return NL80211_CHAN_NO_HT;
 426	}
 427}
 428
 429/**
 430 * cfg80211_chandef_create - create channel definition using channel type
 431 * @chandef: the channel definition struct to fill
 432 * @channel: the control channel
 433 * @chantype: the channel type
 434 *
 435 * Given a channel type, create a channel definition.
 436 */
 437void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
 438			     struct ieee80211_channel *channel,
 439			     enum nl80211_channel_type chantype);
 440
 441/**
 442 * cfg80211_chandef_identical - check if two channel definitions are identical
 443 * @chandef1: first channel definition
 444 * @chandef2: second channel definition
 445 *
 446 * Return: %true if the channels defined by the channel definitions are
 447 * identical, %false otherwise.
 448 */
 449static inline bool
 450cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
 451			   const struct cfg80211_chan_def *chandef2)
 452{
 453	return (chandef1->chan == chandef2->chan &&
 454		chandef1->width == chandef2->width &&
 455		chandef1->center_freq1 == chandef2->center_freq1 &&
 456		chandef1->center_freq2 == chandef2->center_freq2);
 457}
 458
 459/**
 460 * cfg80211_chandef_compatible - check if two channel definitions are compatible
 461 * @chandef1: first channel definition
 462 * @chandef2: second channel definition
 463 *
 464 * Return: %NULL if the given channel definitions are incompatible,
 465 * chandef1 or chandef2 otherwise.
 466 */
 467const struct cfg80211_chan_def *
 468cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
 469			    const struct cfg80211_chan_def *chandef2);
 470
 471/**
 472 * cfg80211_chandef_valid - check if a channel definition is valid
 473 * @chandef: the channel definition to check
 474 * Return: %true if the channel definition is valid. %false otherwise.
 475 */
 476bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
 477
 478/**
 479 * cfg80211_chandef_usable - check if secondary channels can be used
 480 * @wiphy: the wiphy to validate against
 481 * @chandef: the channel definition to check
 482 * @prohibited_flags: the regulatory channel flags that must not be set
 483 * Return: %true if secondary channels are usable. %false otherwise.
 484 */
 485bool cfg80211_chandef_usable(struct wiphy *wiphy,
 486			     const struct cfg80211_chan_def *chandef,
 487			     u32 prohibited_flags);
 488
 489/**
 490 * cfg80211_chandef_dfs_required - checks if radar detection is required
 491 * @wiphy: the wiphy to validate against
 492 * @chandef: the channel definition to check
 493 * @iftype: the interface type as specified in &enum nl80211_iftype
 494 * Returns:
 495 *	1 if radar detection is required, 0 if it is not, < 0 on error
 496 */
 497int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
 498				  const struct cfg80211_chan_def *chandef,
 499				  enum nl80211_iftype iftype);
 500
 501/**
 502 * ieee80211_chandef_rate_flags - returns rate flags for a channel
 503 *
 504 * In some channel types, not all rates may be used - for example CCK
 505 * rates may not be used in 5/10 MHz channels.
 506 *
 507 * @chandef: channel definition for the channel
 508 *
 509 * Returns: rate flags which apply for this channel
 510 */
 511static inline enum ieee80211_rate_flags
 512ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
 513{
 514	switch (chandef->width) {
 515	case NL80211_CHAN_WIDTH_5:
 516		return IEEE80211_RATE_SUPPORTS_5MHZ;
 517	case NL80211_CHAN_WIDTH_10:
 518		return IEEE80211_RATE_SUPPORTS_10MHZ;
 519	default:
 520		break;
 521	}
 522	return 0;
 523}
 524
 525/**
 526 * ieee80211_chandef_max_power - maximum transmission power for the chandef
 527 *
 528 * In some regulations, the transmit power may depend on the configured channel
 529 * bandwidth which may be defined as dBm/MHz. This function returns the actual
 530 * max_power for non-standard (20 MHz) channels.
 531 *
 532 * @chandef: channel definition for the channel
 533 *
 534 * Returns: maximum allowed transmission power in dBm for the chandef
 535 */
 536static inline int
 537ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
 538{
 539	switch (chandef->width) {
 540	case NL80211_CHAN_WIDTH_5:
 541		return min(chandef->chan->max_reg_power - 6,
 542			   chandef->chan->max_power);
 543	case NL80211_CHAN_WIDTH_10:
 544		return min(chandef->chan->max_reg_power - 3,
 545			   chandef->chan->max_power);
 546	default:
 547		break;
 548	}
 549	return chandef->chan->max_power;
 550}
 551
 552/**
 553 * enum survey_info_flags - survey information flags
 554 *
 555 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
 556 * @SURVEY_INFO_IN_USE: channel is currently being used
 557 * @SURVEY_INFO_TIME: active time (in ms) was filled in
 558 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
 559 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
 560 * @SURVEY_INFO_TIME_RX: receive time was filled in
 561 * @SURVEY_INFO_TIME_TX: transmit time was filled in
 562 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
 563 *
 564 * Used by the driver to indicate which info in &struct survey_info
 565 * it has filled in during the get_survey().
 566 */
 567enum survey_info_flags {
 568	SURVEY_INFO_NOISE_DBM		= BIT(0),
 569	SURVEY_INFO_IN_USE		= BIT(1),
 570	SURVEY_INFO_TIME		= BIT(2),
 571	SURVEY_INFO_TIME_BUSY		= BIT(3),
 572	SURVEY_INFO_TIME_EXT_BUSY	= BIT(4),
 573	SURVEY_INFO_TIME_RX		= BIT(5),
 574	SURVEY_INFO_TIME_TX		= BIT(6),
 575	SURVEY_INFO_TIME_SCAN		= BIT(7),
 576};
 577
 578/**
 579 * struct survey_info - channel survey response
 580 *
 581 * @channel: the channel this survey record reports, may be %NULL for a single
 582 *	record to report global statistics
 583 * @filled: bitflag of flags from &enum survey_info_flags
 584 * @noise: channel noise in dBm. This and all following fields are
 585 *	optional
 586 * @time: amount of time in ms the radio was turn on (on the channel)
 587 * @time_busy: amount of time the primary channel was sensed busy
 588 * @time_ext_busy: amount of time the extension channel was sensed busy
 589 * @time_rx: amount of time the radio spent receiving data
 590 * @time_tx: amount of time the radio spent transmitting data
 591 * @time_scan: amount of time the radio spent for scanning
 592 *
 593 * Used by dump_survey() to report back per-channel survey information.
 594 *
 595 * This structure can later be expanded with things like
 596 * channel duty cycle etc.
 597 */
 598struct survey_info {
 599	struct ieee80211_channel *channel;
 600	u64 time;
 601	u64 time_busy;
 602	u64 time_ext_busy;
 603	u64 time_rx;
 604	u64 time_tx;
 605	u64 time_scan;
 606	u32 filled;
 607	s8 noise;
 608};
 609
 
 
 610/**
 611 * struct cfg80211_crypto_settings - Crypto settings
 612 * @wpa_versions: indicates which, if any, WPA versions are enabled
 613 *	(from enum nl80211_wpa_versions)
 614 * @cipher_group: group key cipher suite (or 0 if unset)
 615 * @n_ciphers_pairwise: number of AP supported unicast ciphers
 616 * @ciphers_pairwise: unicast key cipher suites
 617 * @n_akm_suites: number of AKM suites
 618 * @akm_suites: AKM suites
 619 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
 620 *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 621 *	required to assume that the port is unauthorized until authorized by
 622 *	user space. Otherwise, port is marked authorized by default.
 623 * @control_port_ethertype: the control port protocol that should be
 624 *	allowed through even on unauthorized ports
 625 * @control_port_no_encrypt: TRUE to prevent encryption of control port
 626 *	protocol frames.
 
 
 
 627 */
 628struct cfg80211_crypto_settings {
 629	u32 wpa_versions;
 630	u32 cipher_group;
 631	int n_ciphers_pairwise;
 632	u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
 633	int n_akm_suites;
 634	u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
 635	bool control_port;
 636	__be16 control_port_ethertype;
 637	bool control_port_no_encrypt;
 
 
 638};
 639
 640/**
 641 * struct cfg80211_beacon_data - beacon data
 642 * @head: head portion of beacon (before TIM IE)
 643 *	or %NULL if not changed
 644 * @tail: tail portion of beacon (after TIM IE)
 645 *	or %NULL if not changed
 646 * @head_len: length of @head
 647 * @tail_len: length of @tail
 648 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
 649 * @beacon_ies_len: length of beacon_ies in octets
 650 * @proberesp_ies: extra information element(s) to add into Probe Response
 651 *	frames or %NULL
 652 * @proberesp_ies_len: length of proberesp_ies in octets
 653 * @assocresp_ies: extra information element(s) to add into (Re)Association
 654 *	Response frames or %NULL
 655 * @assocresp_ies_len: length of assocresp_ies in octets
 656 * @probe_resp_len: length of probe response template (@probe_resp)
 657 * @probe_resp: probe response template (AP mode only)
 658 */
 659struct cfg80211_beacon_data {
 660	const u8 *head, *tail;
 661	const u8 *beacon_ies;
 662	const u8 *proberesp_ies;
 663	const u8 *assocresp_ies;
 664	const u8 *probe_resp;
 665
 666	size_t head_len, tail_len;
 667	size_t beacon_ies_len;
 668	size_t proberesp_ies_len;
 669	size_t assocresp_ies_len;
 670	size_t probe_resp_len;
 671};
 672
 673struct mac_address {
 674	u8 addr[ETH_ALEN];
 675};
 676
 677/**
 678 * struct cfg80211_acl_data - Access control list data
 679 *
 680 * @acl_policy: ACL policy to be applied on the station's
 681 *	entry specified by mac_addr
 682 * @n_acl_entries: Number of MAC address entries passed
 683 * @mac_addrs: List of MAC addresses of stations to be used for ACL
 684 */
 685struct cfg80211_acl_data {
 686	enum nl80211_acl_policy acl_policy;
 687	int n_acl_entries;
 688
 689	/* Keep it last */
 690	struct mac_address mac_addrs[];
 691};
 692
 
 
 
 
 
 
 
 
 
 
 
 
 693/**
 694 * struct cfg80211_ap_settings - AP configuration
 695 *
 696 * Used to configure an AP interface.
 697 *
 698 * @chandef: defines the channel to use
 699 * @beacon: beacon data
 700 * @beacon_interval: beacon interval
 701 * @dtim_period: DTIM period
 702 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
 703 *	user space)
 704 * @ssid_len: length of @ssid
 705 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
 706 * @crypto: crypto settings
 707 * @privacy: the BSS uses privacy
 708 * @auth_type: Authentication type (algorithm)
 709 * @smps_mode: SMPS mode
 710 * @inactivity_timeout: time in seconds to determine station's inactivity.
 711 * @p2p_ctwindow: P2P CT Window
 712 * @p2p_opp_ps: P2P opportunistic PS
 713 * @acl: ACL configuration used by the drivers which has support for
 714 *	MAC address based access control
 715 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
 716 *	networks.
 
 717 */
 718struct cfg80211_ap_settings {
 719	struct cfg80211_chan_def chandef;
 720
 721	struct cfg80211_beacon_data beacon;
 722
 723	int beacon_interval, dtim_period;
 724	const u8 *ssid;
 725	size_t ssid_len;
 726	enum nl80211_hidden_ssid hidden_ssid;
 727	struct cfg80211_crypto_settings crypto;
 728	bool privacy;
 729	enum nl80211_auth_type auth_type;
 730	enum nl80211_smps_mode smps_mode;
 731	int inactivity_timeout;
 732	u8 p2p_ctwindow;
 733	bool p2p_opp_ps;
 734	const struct cfg80211_acl_data *acl;
 735	bool pbss;
 
 736};
 737
 738/**
 739 * struct cfg80211_csa_settings - channel switch settings
 740 *
 741 * Used for channel switch
 742 *
 743 * @chandef: defines the channel to use after the switch
 744 * @beacon_csa: beacon data while performing the switch
 745 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
 746 * @counter_offsets_presp: offsets of the counters within the probe response
 747 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
 748 * @n_counter_offsets_presp: number of csa counters in the probe response
 749 * @beacon_after: beacon data to be used on the new channel
 750 * @radar_required: whether radar detection is required on the new channel
 751 * @block_tx: whether transmissions should be blocked while changing
 752 * @count: number of beacons until switch
 753 */
 754struct cfg80211_csa_settings {
 755	struct cfg80211_chan_def chandef;
 756	struct cfg80211_beacon_data beacon_csa;
 757	const u16 *counter_offsets_beacon;
 758	const u16 *counter_offsets_presp;
 759	unsigned int n_counter_offsets_beacon;
 760	unsigned int n_counter_offsets_presp;
 761	struct cfg80211_beacon_data beacon_after;
 762	bool radar_required;
 763	bool block_tx;
 764	u8 count;
 765};
 766
 767/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 768 * enum station_parameters_apply_mask - station parameter values to apply
 769 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
 770 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
 771 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
 772 *
 773 * Not all station parameters have in-band "no change" signalling,
 774 * for those that don't these flags will are used.
 775 */
 776enum station_parameters_apply_mask {
 777	STATION_PARAM_APPLY_UAPSD = BIT(0),
 778	STATION_PARAM_APPLY_CAPABILITY = BIT(1),
 779	STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
 780};
 781
 782/**
 783 * struct station_parameters - station parameters
 784 *
 785 * Used to change and create a new station.
 786 *
 787 * @vlan: vlan interface station should belong to
 788 * @supported_rates: supported rates in IEEE 802.11 format
 789 *	(or NULL for no change)
 790 * @supported_rates_len: number of supported rates
 791 * @sta_flags_mask: station flags that changed
 792 *	(bitmask of BIT(NL80211_STA_FLAG_...))
 793 * @sta_flags_set: station flags values
 794 *	(bitmask of BIT(NL80211_STA_FLAG_...))
 795 * @listen_interval: listen interval or -1 for no change
 796 * @aid: AID or zero for no change
 
 797 * @plink_action: plink action to take
 798 * @plink_state: set the peer link state for a station
 799 * @ht_capa: HT capabilities of station
 800 * @vht_capa: VHT capabilities of station
 801 * @uapsd_queues: bitmap of queues configured for uapsd. same format
 802 *	as the AC bitmap in the QoS info field
 803 * @max_sp: max Service Period. same format as the MAX_SP in the
 804 *	QoS info field (but already shifted down)
 805 * @sta_modify_mask: bitmap indicating which parameters changed
 806 *	(for those that don't have a natural "no change" value),
 807 *	see &enum station_parameters_apply_mask
 808 * @local_pm: local link-specific mesh power save mode (no change when set
 809 *	to unknown)
 810 * @capability: station capability
 811 * @ext_capab: extended capabilities of the station
 812 * @ext_capab_len: number of extended capabilities
 813 * @supported_channels: supported channels in IEEE 802.11 format
 814 * @supported_channels_len: number of supported channels
 815 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
 816 * @supported_oper_classes_len: number of supported operating classes
 817 * @opmode_notif: operating mode field from Operating Mode Notification
 818 * @opmode_notif_used: information if operating mode field is used
 
 819 */
 820struct station_parameters {
 821	const u8 *supported_rates;
 822	struct net_device *vlan;
 823	u32 sta_flags_mask, sta_flags_set;
 824	u32 sta_modify_mask;
 825	int listen_interval;
 826	u16 aid;
 
 827	u8 supported_rates_len;
 828	u8 plink_action;
 829	u8 plink_state;
 830	const struct ieee80211_ht_cap *ht_capa;
 831	const struct ieee80211_vht_cap *vht_capa;
 832	u8 uapsd_queues;
 833	u8 max_sp;
 834	enum nl80211_mesh_power_mode local_pm;
 835	u16 capability;
 836	const u8 *ext_capab;
 837	u8 ext_capab_len;
 838	const u8 *supported_channels;
 839	u8 supported_channels_len;
 840	const u8 *supported_oper_classes;
 841	u8 supported_oper_classes_len;
 842	u8 opmode_notif;
 843	bool opmode_notif_used;
 
 844};
 845
 846/**
 847 * struct station_del_parameters - station deletion parameters
 848 *
 849 * Used to delete a station entry (or all stations).
 850 *
 851 * @mac: MAC address of the station to remove or NULL to remove all stations
 852 * @subtype: Management frame subtype to use for indicating removal
 853 *	(10 = Disassociation, 12 = Deauthentication)
 854 * @reason_code: Reason code for the Disassociation/Deauthentication frame
 855 */
 856struct station_del_parameters {
 857	const u8 *mac;
 858	u8 subtype;
 859	u16 reason_code;
 860};
 861
 862/**
 863 * enum cfg80211_station_type - the type of station being modified
 864 * @CFG80211_STA_AP_CLIENT: client of an AP interface
 865 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
 866 *	unassociated (update properties for this type of client is permitted)
 867 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
 868 *	the AP MLME in the device
 869 * @CFG80211_STA_AP_STA: AP station on managed interface
 870 * @CFG80211_STA_IBSS: IBSS station
 871 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
 872 *	while TDLS setup is in progress, it moves out of this state when
 873 *	being marked authorized; use this only if TDLS with external setup is
 874 *	supported/used)
 875 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
 876 *	entry that is operating, has been marked authorized by userspace)
 877 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
 878 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
 879 */
 880enum cfg80211_station_type {
 881	CFG80211_STA_AP_CLIENT,
 882	CFG80211_STA_AP_CLIENT_UNASSOC,
 883	CFG80211_STA_AP_MLME_CLIENT,
 884	CFG80211_STA_AP_STA,
 885	CFG80211_STA_IBSS,
 886	CFG80211_STA_TDLS_PEER_SETUP,
 887	CFG80211_STA_TDLS_PEER_ACTIVE,
 888	CFG80211_STA_MESH_PEER_KERNEL,
 889	CFG80211_STA_MESH_PEER_USER,
 890};
 891
 892/**
 893 * cfg80211_check_station_change - validate parameter changes
 894 * @wiphy: the wiphy this operates on
 895 * @params: the new parameters for a station
 896 * @statype: the type of station being modified
 897 *
 898 * Utility function for the @change_station driver method. Call this function
 899 * with the appropriate station type looking up the station (and checking that
 900 * it exists). It will verify whether the station change is acceptable, and if
 901 * not will return an error code. Note that it may modify the parameters for
 902 * backward compatibility reasons, so don't use them before calling this.
 903 */
 904int cfg80211_check_station_change(struct wiphy *wiphy,
 905				  struct station_parameters *params,
 906				  enum cfg80211_station_type statype);
 907
 908/**
 909 * enum station_info_rate_flags - bitrate info flags
 910 *
 911 * Used by the driver to indicate the specific rate transmission
 912 * type for 802.11n transmissions.
 913 *
 914 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
 915 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
 916 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
 917 * @RATE_INFO_FLAGS_60G: 60GHz MCS
 918 */
 919enum rate_info_flags {
 920	RATE_INFO_FLAGS_MCS			= BIT(0),
 921	RATE_INFO_FLAGS_VHT_MCS			= BIT(1),
 922	RATE_INFO_FLAGS_SHORT_GI		= BIT(2),
 923	RATE_INFO_FLAGS_60G			= BIT(3),
 924};
 925
 926/**
 927 * enum rate_info_bw - rate bandwidth information
 928 *
 929 * Used by the driver to indicate the rate bandwidth.
 930 *
 931 * @RATE_INFO_BW_5: 5 MHz bandwidth
 932 * @RATE_INFO_BW_10: 10 MHz bandwidth
 933 * @RATE_INFO_BW_20: 20 MHz bandwidth
 934 * @RATE_INFO_BW_40: 40 MHz bandwidth
 935 * @RATE_INFO_BW_80: 80 MHz bandwidth
 936 * @RATE_INFO_BW_160: 160 MHz bandwidth
 937 */
 938enum rate_info_bw {
 939	RATE_INFO_BW_5,
 940	RATE_INFO_BW_10,
 941	RATE_INFO_BW_20,
 942	RATE_INFO_BW_40,
 943	RATE_INFO_BW_80,
 944	RATE_INFO_BW_160,
 945};
 946
 947/**
 948 * struct rate_info - bitrate information
 949 *
 950 * Information about a receiving or transmitting bitrate
 951 *
 952 * @flags: bitflag of flags from &enum rate_info_flags
 953 * @mcs: mcs index if struct describes a 802.11n bitrate
 954 * @legacy: bitrate in 100kbit/s for 802.11abg
 955 * @nss: number of streams (VHT only)
 956 * @bw: bandwidth (from &enum rate_info_bw)
 957 */
 958struct rate_info {
 959	u8 flags;
 960	u8 mcs;
 961	u16 legacy;
 962	u8 nss;
 963	u8 bw;
 964};
 965
 966/**
 967 * enum station_info_rate_flags - bitrate info flags
 968 *
 969 * Used by the driver to indicate the specific rate transmission
 970 * type for 802.11n transmissions.
 971 *
 972 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
 973 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
 974 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
 975 */
 976enum bss_param_flags {
 977	BSS_PARAM_FLAGS_CTS_PROT	= 1<<0,
 978	BSS_PARAM_FLAGS_SHORT_PREAMBLE	= 1<<1,
 979	BSS_PARAM_FLAGS_SHORT_SLOT_TIME	= 1<<2,
 980};
 981
 982/**
 983 * struct sta_bss_parameters - BSS parameters for the attached station
 984 *
 985 * Information about the currently associated BSS
 986 *
 987 * @flags: bitflag of flags from &enum bss_param_flags
 988 * @dtim_period: DTIM period for the BSS
 989 * @beacon_interval: beacon interval
 990 */
 991struct sta_bss_parameters {
 992	u8 flags;
 993	u8 dtim_period;
 994	u16 beacon_interval;
 995};
 996
 997/**
 998 * struct cfg80211_tid_stats - per-TID statistics
 999 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1000 *	indicate the relevant values in this struct are filled
1001 * @rx_msdu: number of received MSDUs
1002 * @tx_msdu: number of (attempted) transmitted MSDUs
1003 * @tx_msdu_retries: number of retries (not counting the first) for
1004 *	transmitted MSDUs
1005 * @tx_msdu_failed: number of failed transmitted MSDUs
1006 */
1007struct cfg80211_tid_stats {
1008	u32 filled;
1009	u64 rx_msdu;
1010	u64 tx_msdu;
1011	u64 tx_msdu_retries;
1012	u64 tx_msdu_failed;
1013};
1014
1015#define IEEE80211_MAX_CHAINS	4
1016
1017/**
1018 * struct station_info - station information
1019 *
1020 * Station information filled by driver for get_station() and dump_station.
1021 *
1022 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1023 *	indicate the relevant values in this struct for them
1024 * @connected_time: time(in secs) since a station is last connected
1025 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1026 * @rx_bytes: bytes (size of MPDUs) received from this station
1027 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1028 * @llid: mesh local link id
1029 * @plid: mesh peer link id
1030 * @plink_state: mesh peer link state
1031 * @signal: The signal strength, type depends on the wiphy's signal_type.
1032 *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1033 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1034 *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1035 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1036 * @chain_signal: per-chain signal strength of last received packet in dBm
1037 * @chain_signal_avg: per-chain signal strength average in dBm
1038 * @txrate: current unicast bitrate from this station
1039 * @rxrate: current unicast bitrate to this station
1040 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1041 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1042 * @tx_retries: cumulative retry counts (MPDUs)
1043 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1044 * @rx_dropped_misc:  Dropped for un-specified reason.
1045 * @bss_param: current BSS parameters
1046 * @generation: generation number for nl80211 dumps.
1047 *	This number should increase every time the list of stations
1048 *	changes, i.e. when a station is added or removed, so that
1049 *	userspace can tell whether it got a consistent snapshot.
1050 * @assoc_req_ies: IEs from (Re)Association Request.
1051 *	This is used only when in AP mode with drivers that do not use
1052 *	user space MLME/SME implementation. The information is provided for
1053 *	the cfg80211_new_sta() calls to notify user space of the IEs.
1054 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1055 * @sta_flags: station flags mask & values
1056 * @beacon_loss_count: Number of times beacon loss event has triggered.
1057 * @t_offset: Time offset of the station relative to this host.
1058 * @local_pm: local mesh STA power save mode
1059 * @peer_pm: peer mesh STA power save mode
1060 * @nonpeer_pm: non-peer mesh STA power save mode
1061 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1062 *	towards this station.
1063 * @rx_beacon: number of beacons received from this peer
1064 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1065 *	from this peer
 
1066 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1067 *	(IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1068 */
1069struct station_info {
1070	u32 filled;
1071	u32 connected_time;
1072	u32 inactive_time;
1073	u64 rx_bytes;
1074	u64 tx_bytes;
1075	u16 llid;
1076	u16 plid;
1077	u8 plink_state;
1078	s8 signal;
1079	s8 signal_avg;
1080
1081	u8 chains;
1082	s8 chain_signal[IEEE80211_MAX_CHAINS];
1083	s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1084
1085	struct rate_info txrate;
1086	struct rate_info rxrate;
1087	u32 rx_packets;
1088	u32 tx_packets;
1089	u32 tx_retries;
1090	u32 tx_failed;
1091	u32 rx_dropped_misc;
1092	struct sta_bss_parameters bss_param;
1093	struct nl80211_sta_flag_update sta_flags;
1094
1095	int generation;
1096
1097	const u8 *assoc_req_ies;
1098	size_t assoc_req_ies_len;
1099
1100	u32 beacon_loss_count;
1101	s64 t_offset;
1102	enum nl80211_mesh_power_mode local_pm;
1103	enum nl80211_mesh_power_mode peer_pm;
1104	enum nl80211_mesh_power_mode nonpeer_pm;
1105
1106	u32 expected_throughput;
1107
1108	u64 rx_beacon;
 
1109	u8 rx_beacon_signal_avg;
1110	struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1111};
1112
 
1113/**
1114 * cfg80211_get_station - retrieve information about a given station
1115 * @dev: the device where the station is supposed to be connected to
1116 * @mac_addr: the mac address of the station of interest
1117 * @sinfo: pointer to the structure to fill with the information
1118 *
1119 * Returns 0 on success and sinfo is filled with the available information
1120 * otherwise returns a negative error code and the content of sinfo has to be
1121 * considered undefined.
1122 */
1123int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1124			 struct station_info *sinfo);
 
 
 
 
 
 
 
 
1125
1126/**
1127 * enum monitor_flags - monitor flags
1128 *
1129 * Monitor interface configuration flags. Note that these must be the bits
1130 * according to the nl80211 flags.
1131 *
1132 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1133 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1134 * @MONITOR_FLAG_CONTROL: pass control frames
1135 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1136 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1137 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1138 */
1139enum monitor_flags {
1140	MONITOR_FLAG_FCSFAIL		= 1<<NL80211_MNTR_FLAG_FCSFAIL,
1141	MONITOR_FLAG_PLCPFAIL		= 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1142	MONITOR_FLAG_CONTROL		= 1<<NL80211_MNTR_FLAG_CONTROL,
1143	MONITOR_FLAG_OTHER_BSS		= 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1144	MONITOR_FLAG_COOK_FRAMES	= 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1145	MONITOR_FLAG_ACTIVE		= 1<<NL80211_MNTR_FLAG_ACTIVE,
1146};
1147
1148/**
1149 * enum mpath_info_flags -  mesh path information flags
1150 *
1151 * Used by the driver to indicate which info in &struct mpath_info it has filled
1152 * in during get_station() or dump_station().
1153 *
1154 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1155 * @MPATH_INFO_SN: @sn filled
1156 * @MPATH_INFO_METRIC: @metric filled
1157 * @MPATH_INFO_EXPTIME: @exptime filled
1158 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1159 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1160 * @MPATH_INFO_FLAGS: @flags filled
1161 */
1162enum mpath_info_flags {
1163	MPATH_INFO_FRAME_QLEN		= BIT(0),
1164	MPATH_INFO_SN			= BIT(1),
1165	MPATH_INFO_METRIC		= BIT(2),
1166	MPATH_INFO_EXPTIME		= BIT(3),
1167	MPATH_INFO_DISCOVERY_TIMEOUT	= BIT(4),
1168	MPATH_INFO_DISCOVERY_RETRIES	= BIT(5),
1169	MPATH_INFO_FLAGS		= BIT(6),
1170};
1171
1172/**
1173 * struct mpath_info - mesh path information
1174 *
1175 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1176 *
1177 * @filled: bitfield of flags from &enum mpath_info_flags
1178 * @frame_qlen: number of queued frames for this destination
1179 * @sn: target sequence number
1180 * @metric: metric (cost) of this mesh path
1181 * @exptime: expiration time for the mesh path from now, in msecs
1182 * @flags: mesh path flags
1183 * @discovery_timeout: total mesh path discovery timeout, in msecs
1184 * @discovery_retries: mesh path discovery retries
1185 * @generation: generation number for nl80211 dumps.
1186 *	This number should increase every time the list of mesh paths
1187 *	changes, i.e. when a station is added or removed, so that
1188 *	userspace can tell whether it got a consistent snapshot.
1189 */
1190struct mpath_info {
1191	u32 filled;
1192	u32 frame_qlen;
1193	u32 sn;
1194	u32 metric;
1195	u32 exptime;
1196	u32 discovery_timeout;
1197	u8 discovery_retries;
1198	u8 flags;
1199
1200	int generation;
1201};
1202
1203/**
1204 * struct bss_parameters - BSS parameters
1205 *
1206 * Used to change BSS parameters (mainly for AP mode).
1207 *
1208 * @use_cts_prot: Whether to use CTS protection
1209 *	(0 = no, 1 = yes, -1 = do not change)
1210 * @use_short_preamble: Whether the use of short preambles is allowed
1211 *	(0 = no, 1 = yes, -1 = do not change)
1212 * @use_short_slot_time: Whether the use of short slot time is allowed
1213 *	(0 = no, 1 = yes, -1 = do not change)
1214 * @basic_rates: basic rates in IEEE 802.11 format
1215 *	(or NULL for no change)
1216 * @basic_rates_len: number of basic rates
1217 * @ap_isolate: do not forward packets between connected stations
1218 * @ht_opmode: HT Operation mode
1219 * 	(u16 = opmode, -1 = do not change)
1220 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1221 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1222 */
1223struct bss_parameters {
1224	int use_cts_prot;
1225	int use_short_preamble;
1226	int use_short_slot_time;
1227	const u8 *basic_rates;
1228	u8 basic_rates_len;
1229	int ap_isolate;
1230	int ht_opmode;
1231	s8 p2p_ctwindow, p2p_opp_ps;
1232};
1233
1234/**
1235 * struct mesh_config - 802.11s mesh configuration
1236 *
1237 * These parameters can be changed while the mesh is active.
1238 *
1239 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1240 *	by the Mesh Peering Open message
1241 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1242 *	used by the Mesh Peering Open message
1243 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1244 *	the mesh peering management to close a mesh peering
1245 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1246 *	mesh interface
1247 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1248 *	be sent to establish a new peer link instance in a mesh
1249 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1250 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1251 *	elements
1252 * @auto_open_plinks: whether we should automatically open peer links when we
1253 *	detect compatible mesh peers
1254 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1255 *	synchronize to for 11s default synchronization method
1256 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1257 *	that an originator mesh STA can send to a particular path target
1258 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1259 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1260 *	a path discovery in milliseconds
1261 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1262 *	receiving a PREQ shall consider the forwarding information from the
1263 *	root to be valid. (TU = time unit)
1264 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1265 *	which a mesh STA can send only one action frame containing a PREQ
1266 *	element
1267 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1268 *	which a mesh STA can send only one Action frame containing a PERR
1269 *	element
1270 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1271 *	it takes for an HWMP information element to propagate across the mesh
1272 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1273 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1274 *	announcements are transmitted
1275 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1276 *	station has access to a broader network beyond the MBSS. (This is
1277 *	missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1278 *	only means that the station will announce others it's a mesh gate, but
1279 *	not necessarily using the gate announcement protocol. Still keeping the
1280 *	same nomenclature to be in sync with the spec)
1281 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1282 *	entity (default is TRUE - forwarding entity)
1283 * @rssi_threshold: the threshold for average signal strength of candidate
1284 *	station to establish a peer link
1285 * @ht_opmode: mesh HT protection mode
1286 *
1287 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1288 *	receiving a proactive PREQ shall consider the forwarding information to
1289 *	the root mesh STA to be valid.
1290 *
1291 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1292 *	PREQs are transmitted.
1293 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1294 *	during which a mesh STA can send only one Action frame containing
1295 *	a PREQ element for root path confirmation.
1296 * @power_mode: The default mesh power save mode which will be the initial
1297 *	setting for new peer links.
1298 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1299 *	after transmitting its beacon.
1300 * @plink_timeout: If no tx activity is seen from a STA we've established
1301 *	peering with for longer than this time (in seconds), then remove it
1302 *	from the STA's list of peers.  Default is 30 minutes.
1303 */
1304struct mesh_config {
1305	u16 dot11MeshRetryTimeout;
1306	u16 dot11MeshConfirmTimeout;
1307	u16 dot11MeshHoldingTimeout;
1308	u16 dot11MeshMaxPeerLinks;
1309	u8 dot11MeshMaxRetries;
1310	u8 dot11MeshTTL;
1311	u8 element_ttl;
1312	bool auto_open_plinks;
1313	u32 dot11MeshNbrOffsetMaxNeighbor;
1314	u8 dot11MeshHWMPmaxPREQretries;
1315	u32 path_refresh_time;
1316	u16 min_discovery_timeout;
1317	u32 dot11MeshHWMPactivePathTimeout;
1318	u16 dot11MeshHWMPpreqMinInterval;
1319	u16 dot11MeshHWMPperrMinInterval;
1320	u16 dot11MeshHWMPnetDiameterTraversalTime;
1321	u8 dot11MeshHWMPRootMode;
1322	u16 dot11MeshHWMPRannInterval;
1323	bool dot11MeshGateAnnouncementProtocol;
1324	bool dot11MeshForwarding;
1325	s32 rssi_threshold;
1326	u16 ht_opmode;
1327	u32 dot11MeshHWMPactivePathToRootTimeout;
1328	u16 dot11MeshHWMProotInterval;
1329	u16 dot11MeshHWMPconfirmationInterval;
1330	enum nl80211_mesh_power_mode power_mode;
1331	u16 dot11MeshAwakeWindowDuration;
1332	u32 plink_timeout;
1333};
1334
1335/**
1336 * struct mesh_setup - 802.11s mesh setup configuration
1337 * @chandef: defines the channel to use
1338 * @mesh_id: the mesh ID
1339 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1340 * @sync_method: which synchronization method to use
1341 * @path_sel_proto: which path selection protocol to use
1342 * @path_metric: which metric to use
1343 * @auth_id: which authentication method this mesh is using
1344 * @ie: vendor information elements (optional)
1345 * @ie_len: length of vendor information elements
1346 * @is_authenticated: this mesh requires authentication
1347 * @is_secure: this mesh uses security
1348 * @user_mpm: userspace handles all MPM functions
1349 * @dtim_period: DTIM period to use
1350 * @beacon_interval: beacon interval to use
1351 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1352 * @basic_rates: basic rates to use when creating the mesh
 
1353 *
1354 * These parameters are fixed when the mesh is created.
1355 */
1356struct mesh_setup {
1357	struct cfg80211_chan_def chandef;
1358	const u8 *mesh_id;
1359	u8 mesh_id_len;
1360	u8 sync_method;
1361	u8 path_sel_proto;
1362	u8 path_metric;
1363	u8 auth_id;
1364	const u8 *ie;
1365	u8 ie_len;
1366	bool is_authenticated;
1367	bool is_secure;
1368	bool user_mpm;
1369	u8 dtim_period;
1370	u16 beacon_interval;
1371	int mcast_rate[IEEE80211_NUM_BANDS];
1372	u32 basic_rates;
 
1373};
1374
1375/**
1376 * struct ocb_setup - 802.11p OCB mode setup configuration
1377 * @chandef: defines the channel to use
1378 *
1379 * These parameters are fixed when connecting to the network
1380 */
1381struct ocb_setup {
1382	struct cfg80211_chan_def chandef;
1383};
1384
1385/**
1386 * struct ieee80211_txq_params - TX queue parameters
1387 * @ac: AC identifier
1388 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1389 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1390 *	1..32767]
1391 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1392 *	1..32767]
1393 * @aifs: Arbitration interframe space [0..255]
1394 */
1395struct ieee80211_txq_params {
1396	enum nl80211_ac ac;
1397	u16 txop;
1398	u16 cwmin;
1399	u16 cwmax;
1400	u8 aifs;
1401};
1402
1403/**
1404 * DOC: Scanning and BSS list handling
1405 *
1406 * The scanning process itself is fairly simple, but cfg80211 offers quite
1407 * a bit of helper functionality. To start a scan, the scan operation will
1408 * be invoked with a scan definition. This scan definition contains the
1409 * channels to scan, and the SSIDs to send probe requests for (including the
1410 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1411 * probe. Additionally, a scan request may contain extra information elements
1412 * that should be added to the probe request. The IEs are guaranteed to be
1413 * well-formed, and will not exceed the maximum length the driver advertised
1414 * in the wiphy structure.
1415 *
1416 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1417 * it is responsible for maintaining the BSS list; the driver should not
1418 * maintain a list itself. For this notification, various functions exist.
1419 *
1420 * Since drivers do not maintain a BSS list, there are also a number of
1421 * functions to search for a BSS and obtain information about it from the
1422 * BSS structure cfg80211 maintains. The BSS list is also made available
1423 * to userspace.
1424 */
1425
1426/**
1427 * struct cfg80211_ssid - SSID description
1428 * @ssid: the SSID
1429 * @ssid_len: length of the ssid
1430 */
1431struct cfg80211_ssid {
1432	u8 ssid[IEEE80211_MAX_SSID_LEN];
1433	u8 ssid_len;
1434};
1435
1436/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1437 * struct cfg80211_scan_request - scan request description
1438 *
1439 * @ssids: SSIDs to scan for (active scan only)
1440 * @n_ssids: number of SSIDs
1441 * @channels: channels to scan on.
1442 * @n_channels: total number of channels to scan
1443 * @scan_width: channel width for scanning
1444 * @ie: optional information element(s) to add into Probe Request or %NULL
1445 * @ie_len: length of ie in octets
 
 
 
 
 
1446 * @flags: bit field of flags controlling operation
1447 * @rates: bitmap of rates to advertise for each band
1448 * @wiphy: the wiphy this was for
1449 * @scan_start: time (in jiffies) when the scan started
1450 * @wdev: the wireless device to scan for
1451 * @aborted: (internal) scan request was notified as aborted
1452 * @notified: (internal) scan request was notified as done or aborted
1453 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1454 * @mac_addr: MAC address used with randomisation
1455 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1456 *	are 0 in the mask should be randomised, bits that are 1 should
1457 *	be taken from the @mac_addr
 
1458 */
1459struct cfg80211_scan_request {
1460	struct cfg80211_ssid *ssids;
1461	int n_ssids;
1462	u32 n_channels;
1463	enum nl80211_bss_scan_width scan_width;
1464	const u8 *ie;
1465	size_t ie_len;
 
 
1466	u32 flags;
1467
1468	u32 rates[IEEE80211_NUM_BANDS];
1469
1470	struct wireless_dev *wdev;
1471
1472	u8 mac_addr[ETH_ALEN] __aligned(2);
1473	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
 
1474
1475	/* internal */
1476	struct wiphy *wiphy;
1477	unsigned long scan_start;
1478	bool aborted, notified;
 
1479	bool no_cck;
1480
1481	/* keep last */
1482	struct ieee80211_channel *channels[0];
1483};
1484
1485static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1486{
1487	int i;
1488
1489	get_random_bytes(buf, ETH_ALEN);
1490	for (i = 0; i < ETH_ALEN; i++) {
1491		buf[i] &= ~mask[i];
1492		buf[i] |= addr[i] & mask[i];
1493	}
1494}
1495
1496/**
1497 * struct cfg80211_match_set - sets of attributes to match
1498 *
1499 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1500 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1501 */
1502struct cfg80211_match_set {
1503	struct cfg80211_ssid ssid;
1504	s32 rssi_thold;
1505};
1506
1507/**
1508 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1509 *
1510 * @interval: interval between scheduled scan iterations. In seconds.
1511 * @iterations: number of scan iterations in this scan plan. Zero means
1512 *	infinite loop.
1513 *	The last scan plan will always have this parameter set to zero,
1514 *	all other scan plans will have a finite number of iterations.
1515 */
1516struct cfg80211_sched_scan_plan {
1517	u32 interval;
1518	u32 iterations;
1519};
1520
1521/**
1522 * struct cfg80211_sched_scan_request - scheduled scan request description
1523 *
1524 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1525 * @n_ssids: number of SSIDs
1526 * @n_channels: total number of channels to scan
1527 * @scan_width: channel width for scanning
1528 * @ie: optional information element(s) to add into Probe Request or %NULL
1529 * @ie_len: length of ie in octets
1530 * @flags: bit field of flags controlling operation
1531 * @match_sets: sets of parameters to be matched for a scan result
1532 * 	entry to be considered valid and to be passed to the host
1533 * 	(others are filtered out).
1534 *	If ommited, all results are passed.
1535 * @n_match_sets: number of match sets
1536 * @wiphy: the wiphy this was for
1537 * @dev: the interface
1538 * @scan_start: start time of the scheduled scan
1539 * @channels: channels to scan
1540 * @min_rssi_thold: for drivers only supporting a single threshold, this
1541 *	contains the minimum over all matchsets
1542 * @mac_addr: MAC address used with randomisation
1543 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1544 *	are 0 in the mask should be randomised, bits that are 1 should
1545 *	be taken from the @mac_addr
1546 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1547 *	index must be executed first.
1548 * @n_scan_plans: number of scan plans, at least 1.
1549 * @rcu_head: RCU callback used to free the struct
1550 * @owner_nlportid: netlink portid of owner (if this should is a request
1551 *	owned by a particular socket)
1552 * @delay: delay in seconds to use before starting the first scan
1553 *	cycle.  The driver may ignore this parameter and start
1554 *	immediately (or at any other time), if this feature is not
1555 *	supported.
1556 */
1557struct cfg80211_sched_scan_request {
1558	struct cfg80211_ssid *ssids;
1559	int n_ssids;
1560	u32 n_channels;
1561	enum nl80211_bss_scan_width scan_width;
1562	const u8 *ie;
1563	size_t ie_len;
1564	u32 flags;
1565	struct cfg80211_match_set *match_sets;
1566	int n_match_sets;
1567	s32 min_rssi_thold;
1568	u32 delay;
1569	struct cfg80211_sched_scan_plan *scan_plans;
1570	int n_scan_plans;
1571
1572	u8 mac_addr[ETH_ALEN] __aligned(2);
1573	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1574
1575	/* internal */
1576	struct wiphy *wiphy;
1577	struct net_device *dev;
1578	unsigned long scan_start;
1579	struct rcu_head rcu_head;
1580	u32 owner_nlportid;
1581
1582	/* keep last */
1583	struct ieee80211_channel *channels[0];
1584};
1585
1586/**
1587 * enum cfg80211_signal_type - signal type
1588 *
1589 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1590 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1591 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1592 */
1593enum cfg80211_signal_type {
1594	CFG80211_SIGNAL_TYPE_NONE,
1595	CFG80211_SIGNAL_TYPE_MBM,
1596	CFG80211_SIGNAL_TYPE_UNSPEC,
1597};
1598
1599/**
1600 * struct cfg80211_inform_bss - BSS inform data
1601 * @chan: channel the frame was received on
1602 * @scan_width: scan width that was used
1603 * @signal: signal strength value, according to the wiphy's
1604 *	signal type
1605 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1606 *	received; should match the time when the frame was actually
1607 *	received by the device (not just by the host, in case it was
1608 *	buffered on the device) and be accurate to about 10ms.
1609 *	If the frame isn't buffered, just passing the return value of
1610 *	ktime_get_boot_ns() is likely appropriate.
 
 
 
 
 
1611 */
1612struct cfg80211_inform_bss {
1613	struct ieee80211_channel *chan;
1614	enum nl80211_bss_scan_width scan_width;
1615	s32 signal;
1616	u64 boottime_ns;
 
 
1617};
1618
1619/**
1620 * struct cfg80211_bss_ie_data - BSS entry IE data
1621 * @tsf: TSF contained in the frame that carried these IEs
1622 * @rcu_head: internal use, for freeing
1623 * @len: length of the IEs
1624 * @from_beacon: these IEs are known to come from a beacon
1625 * @data: IE data
1626 */
1627struct cfg80211_bss_ies {
1628	u64 tsf;
1629	struct rcu_head rcu_head;
1630	int len;
1631	bool from_beacon;
1632	u8 data[];
1633};
1634
1635/**
1636 * struct cfg80211_bss - BSS description
1637 *
1638 * This structure describes a BSS (which may also be a mesh network)
1639 * for use in scan results and similar.
1640 *
1641 * @channel: channel this BSS is on
1642 * @scan_width: width of the control channel
1643 * @bssid: BSSID of the BSS
1644 * @beacon_interval: the beacon interval as from the frame
1645 * @capability: the capability field in host byte order
1646 * @ies: the information elements (Note that there is no guarantee that these
1647 *	are well-formed!); this is a pointer to either the beacon_ies or
1648 *	proberesp_ies depending on whether Probe Response frame has been
1649 *	received. It is always non-%NULL.
1650 * @beacon_ies: the information elements from the last Beacon frame
1651 *	(implementation note: if @hidden_beacon_bss is set this struct doesn't
1652 *	own the beacon_ies, but they're just pointers to the ones from the
1653 *	@hidden_beacon_bss struct)
1654 * @proberesp_ies: the information elements from the last Probe Response frame
1655 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1656 *	a BSS that hides the SSID in its beacon, this points to the BSS struct
1657 *	that holds the beacon data. @beacon_ies is still valid, of course, and
1658 *	points to the same data as hidden_beacon_bss->beacon_ies in that case.
1659 * @signal: signal strength value (type depends on the wiphy's signal_type)
1660 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1661 */
1662struct cfg80211_bss {
1663	struct ieee80211_channel *channel;
1664	enum nl80211_bss_scan_width scan_width;
1665
1666	const struct cfg80211_bss_ies __rcu *ies;
1667	const struct cfg80211_bss_ies __rcu *beacon_ies;
1668	const struct cfg80211_bss_ies __rcu *proberesp_ies;
1669
1670	struct cfg80211_bss *hidden_beacon_bss;
1671
1672	s32 signal;
1673
1674	u16 beacon_interval;
1675	u16 capability;
1676
1677	u8 bssid[ETH_ALEN];
1678
1679	u8 priv[0] __aligned(sizeof(void *));
1680};
1681
1682/**
1683 * ieee80211_bss_get_ie - find IE with given ID
1684 * @bss: the bss to search
1685 * @ie: the IE ID
1686 *
1687 * Note that the return value is an RCU-protected pointer, so
1688 * rcu_read_lock() must be held when calling this function.
1689 * Return: %NULL if not found.
1690 */
1691const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1692
1693
1694/**
1695 * struct cfg80211_auth_request - Authentication request data
1696 *
1697 * This structure provides information needed to complete IEEE 802.11
1698 * authentication.
1699 *
1700 * @bss: The BSS to authenticate with, the callee must obtain a reference
1701 *	to it if it needs to keep it.
1702 * @auth_type: Authentication type (algorithm)
1703 * @ie: Extra IEs to add to Authentication frame or %NULL
1704 * @ie_len: Length of ie buffer in octets
1705 * @key_len: length of WEP key for shared key authentication
1706 * @key_idx: index of WEP key for shared key authentication
1707 * @key: WEP key for shared key authentication
1708 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1709 *	Authentication transaction sequence number field.
1710 * @sae_data_len: Length of sae_data buffer in octets
 
 
1711 */
1712struct cfg80211_auth_request {
1713	struct cfg80211_bss *bss;
1714	const u8 *ie;
1715	size_t ie_len;
1716	enum nl80211_auth_type auth_type;
1717	const u8 *key;
1718	u8 key_len, key_idx;
1719	const u8 *sae_data;
1720	size_t sae_data_len;
1721};
1722
1723/**
1724 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1725 *
1726 * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
1727 * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
1728 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1729 */
1730enum cfg80211_assoc_req_flags {
1731	ASSOC_REQ_DISABLE_HT		= BIT(0),
1732	ASSOC_REQ_DISABLE_VHT		= BIT(1),
1733	ASSOC_REQ_USE_RRM		= BIT(2),
1734};
1735
1736/**
1737 * struct cfg80211_assoc_request - (Re)Association request data
1738 *
1739 * This structure provides information needed to complete IEEE 802.11
1740 * (re)association.
1741 * @bss: The BSS to associate with. If the call is successful the driver is
1742 *	given a reference that it must give back to cfg80211_send_rx_assoc()
1743 *	or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1744 *	association requests while already associating must be rejected.
1745 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1746 * @ie_len: Length of ie buffer in octets
1747 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1748 * @crypto: crypto settings
1749 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
 
 
 
 
 
1750 * @flags:  See &enum cfg80211_assoc_req_flags
1751 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1752 *	will be used in ht_capa.  Un-supported values will be ignored.
1753 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1754 * @vht_capa: VHT capability override
1755 * @vht_capa_mask: VHT capability mask indicating which fields to use
 
 
 
 
 
 
1756 */
1757struct cfg80211_assoc_request {
1758	struct cfg80211_bss *bss;
1759	const u8 *ie, *prev_bssid;
1760	size_t ie_len;
1761	struct cfg80211_crypto_settings crypto;
1762	bool use_mfp;
1763	u32 flags;
1764	struct ieee80211_ht_cap ht_capa;
1765	struct ieee80211_ht_cap ht_capa_mask;
1766	struct ieee80211_vht_cap vht_capa, vht_capa_mask;
 
 
 
1767};
1768
1769/**
1770 * struct cfg80211_deauth_request - Deauthentication request data
1771 *
1772 * This structure provides information needed to complete IEEE 802.11
1773 * deauthentication.
1774 *
1775 * @bssid: the BSSID of the BSS to deauthenticate from
1776 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1777 * @ie_len: Length of ie buffer in octets
1778 * @reason_code: The reason code for the deauthentication
1779 * @local_state_change: if set, change local state only and
1780 *	do not set a deauth frame
1781 */
1782struct cfg80211_deauth_request {
1783	const u8 *bssid;
1784	const u8 *ie;
1785	size_t ie_len;
1786	u16 reason_code;
1787	bool local_state_change;
1788};
1789
1790/**
1791 * struct cfg80211_disassoc_request - Disassociation request data
1792 *
1793 * This structure provides information needed to complete IEEE 802.11
1794 * disassocation.
1795 *
1796 * @bss: the BSS to disassociate from
1797 * @ie: Extra IEs to add to Disassociation frame or %NULL
1798 * @ie_len: Length of ie buffer in octets
1799 * @reason_code: The reason code for the disassociation
1800 * @local_state_change: This is a request for a local state only, i.e., no
1801 *	Disassociation frame is to be transmitted.
1802 */
1803struct cfg80211_disassoc_request {
1804	struct cfg80211_bss *bss;
1805	const u8 *ie;
1806	size_t ie_len;
1807	u16 reason_code;
1808	bool local_state_change;
1809};
1810
1811/**
1812 * struct cfg80211_ibss_params - IBSS parameters
1813 *
1814 * This structure defines the IBSS parameters for the join_ibss()
1815 * method.
1816 *
1817 * @ssid: The SSID, will always be non-null.
1818 * @ssid_len: The length of the SSID, will always be non-zero.
1819 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1820 *	search for IBSSs with a different BSSID.
1821 * @chandef: defines the channel to use if no other IBSS to join can be found
1822 * @channel_fixed: The channel should be fixed -- do not search for
1823 *	IBSSs to join on other channels.
1824 * @ie: information element(s) to include in the beacon
1825 * @ie_len: length of that
1826 * @beacon_interval: beacon interval to use
1827 * @privacy: this is a protected network, keys will be configured
1828 *	after joining
1829 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1830 *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1831 *	required to assume that the port is unauthorized until authorized by
1832 *	user space. Otherwise, port is marked authorized by default.
1833 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1834 *	changes the channel when a radar is detected. This is required
1835 *	to operate on DFS channels.
1836 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1837 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1838 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1839 *	will be used in ht_capa.  Un-supported values will be ignored.
1840 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1841 */
1842struct cfg80211_ibss_params {
1843	const u8 *ssid;
1844	const u8 *bssid;
1845	struct cfg80211_chan_def chandef;
1846	const u8 *ie;
1847	u8 ssid_len, ie_len;
1848	u16 beacon_interval;
1849	u32 basic_rates;
1850	bool channel_fixed;
1851	bool privacy;
1852	bool control_port;
1853	bool userspace_handles_dfs;
1854	int mcast_rate[IEEE80211_NUM_BANDS];
1855	struct ieee80211_ht_cap ht_capa;
1856	struct ieee80211_ht_cap ht_capa_mask;
1857};
1858
1859/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1860 * struct cfg80211_connect_params - Connection parameters
1861 *
1862 * This structure provides information needed to complete IEEE 802.11
1863 * authentication and association.
1864 *
1865 * @channel: The channel to use or %NULL if not specified (auto-select based
1866 *	on scan results)
1867 * @channel_hint: The channel of the recommended BSS for initial connection or
1868 *	%NULL if not specified
1869 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1870 *	results)
1871 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1872 *	%NULL if not specified. Unlike the @bssid parameter, the driver is
1873 *	allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1874 *	to use.
1875 * @ssid: SSID
1876 * @ssid_len: Length of ssid in octets
1877 * @auth_type: Authentication type (algorithm)
1878 * @ie: IEs for association request
1879 * @ie_len: Length of assoc_ie in octets
1880 * @privacy: indicates whether privacy-enabled APs should be used
1881 * @mfp: indicate whether management frame protection is used
1882 * @crypto: crypto settings
1883 * @key_len: length of WEP key for shared key authentication
1884 * @key_idx: index of WEP key for shared key authentication
1885 * @key: WEP key for shared key authentication
1886 * @flags:  See &enum cfg80211_assoc_req_flags
1887 * @bg_scan_period:  Background scan period in seconds
1888 *	or -1 to indicate that default value is to be used.
1889 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1890 *	will be used in ht_capa.  Un-supported values will be ignored.
1891 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1892 * @vht_capa:  VHT Capability overrides
1893 * @vht_capa_mask: The bits of vht_capa which are to be used.
1894 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
1895 *	networks.
 
 
 
 
 
 
 
1896 */
1897struct cfg80211_connect_params {
1898	struct ieee80211_channel *channel;
1899	struct ieee80211_channel *channel_hint;
1900	const u8 *bssid;
1901	const u8 *bssid_hint;
1902	const u8 *ssid;
1903	size_t ssid_len;
1904	enum nl80211_auth_type auth_type;
1905	const u8 *ie;
1906	size_t ie_len;
1907	bool privacy;
1908	enum nl80211_mfp mfp;
1909	struct cfg80211_crypto_settings crypto;
1910	const u8 *key;
1911	u8 key_len, key_idx;
1912	u32 flags;
1913	int bg_scan_period;
1914	struct ieee80211_ht_cap ht_capa;
1915	struct ieee80211_ht_cap ht_capa_mask;
1916	struct ieee80211_vht_cap vht_capa;
1917	struct ieee80211_vht_cap vht_capa_mask;
1918	bool pbss;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1919};
1920
1921/**
1922 * enum wiphy_params_flags - set_wiphy_params bitfield values
1923 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1924 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1925 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1926 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1927 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1928 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1929 */
1930enum wiphy_params_flags {
1931	WIPHY_PARAM_RETRY_SHORT		= 1 << 0,
1932	WIPHY_PARAM_RETRY_LONG		= 1 << 1,
1933	WIPHY_PARAM_FRAG_THRESHOLD	= 1 << 2,
1934	WIPHY_PARAM_RTS_THRESHOLD	= 1 << 3,
1935	WIPHY_PARAM_COVERAGE_CLASS	= 1 << 4,
1936	WIPHY_PARAM_DYN_ACK		= 1 << 5,
1937};
1938
1939/*
1940 * cfg80211_bitrate_mask - masks for bitrate control
1941 */
1942struct cfg80211_bitrate_mask {
1943	struct {
1944		u32 legacy;
1945		u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1946		u16 vht_mcs[NL80211_VHT_NSS_MAX];
1947		enum nl80211_txrate_gi gi;
1948	} control[IEEE80211_NUM_BANDS];
1949};
1950/**
1951 * struct cfg80211_pmksa - PMK Security Association
1952 *
1953 * This structure is passed to the set/del_pmksa() method for PMKSA
1954 * caching.
1955 *
1956 * @bssid: The AP's BSSID.
1957 * @pmkid: The PMK material itself.
1958 */
1959struct cfg80211_pmksa {
1960	const u8 *bssid;
1961	const u8 *pmkid;
1962};
1963
1964/**
1965 * struct cfg80211_pkt_pattern - packet pattern
1966 * @mask: bitmask where to match pattern and where to ignore bytes,
1967 *	one bit per byte, in same format as nl80211
1968 * @pattern: bytes to match where bitmask is 1
1969 * @pattern_len: length of pattern (in bytes)
1970 * @pkt_offset: packet offset (in bytes)
1971 *
1972 * Internal note: @mask and @pattern are allocated in one chunk of
1973 * memory, free @mask only!
1974 */
1975struct cfg80211_pkt_pattern {
1976	const u8 *mask, *pattern;
1977	int pattern_len;
1978	int pkt_offset;
1979};
1980
1981/**
1982 * struct cfg80211_wowlan_tcp - TCP connection parameters
1983 *
1984 * @sock: (internal) socket for source port allocation
1985 * @src: source IP address
1986 * @dst: destination IP address
1987 * @dst_mac: destination MAC address
1988 * @src_port: source port
1989 * @dst_port: destination port
1990 * @payload_len: data payload length
1991 * @payload: data payload buffer
1992 * @payload_seq: payload sequence stamping configuration
1993 * @data_interval: interval at which to send data packets
1994 * @wake_len: wakeup payload match length
1995 * @wake_data: wakeup payload match data
1996 * @wake_mask: wakeup payload match mask
1997 * @tokens_size: length of the tokens buffer
1998 * @payload_tok: payload token usage configuration
1999 */
2000struct cfg80211_wowlan_tcp {
2001	struct socket *sock;
2002	__be32 src, dst;
2003	u16 src_port, dst_port;
2004	u8 dst_mac[ETH_ALEN];
2005	int payload_len;
2006	const u8 *payload;
2007	struct nl80211_wowlan_tcp_data_seq payload_seq;
2008	u32 data_interval;
2009	u32 wake_len;
2010	const u8 *wake_data, *wake_mask;
2011	u32 tokens_size;
2012	/* must be last, variable member */
2013	struct nl80211_wowlan_tcp_data_token payload_tok;
2014};
2015
2016/**
2017 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2018 *
2019 * This structure defines the enabled WoWLAN triggers for the device.
2020 * @any: wake up on any activity -- special trigger if device continues
2021 *	operating as normal during suspend
2022 * @disconnect: wake up if getting disconnected
2023 * @magic_pkt: wake up on receiving magic packet
2024 * @patterns: wake up on receiving packet matching a pattern
2025 * @n_patterns: number of patterns
2026 * @gtk_rekey_failure: wake up on GTK rekey failure
2027 * @eap_identity_req: wake up on EAP identity request packet
2028 * @four_way_handshake: wake up on 4-way handshake
2029 * @rfkill_release: wake up when rfkill is released
2030 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2031 *	NULL if not configured.
2032 * @nd_config: configuration for the scan to be used for net detect wake.
2033 */
2034struct cfg80211_wowlan {
2035	bool any, disconnect, magic_pkt, gtk_rekey_failure,
2036	     eap_identity_req, four_way_handshake,
2037	     rfkill_release;
2038	struct cfg80211_pkt_pattern *patterns;
2039	struct cfg80211_wowlan_tcp *tcp;
2040	int n_patterns;
2041	struct cfg80211_sched_scan_request *nd_config;
2042};
2043
2044/**
2045 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2046 *
2047 * This structure defines coalesce rule for the device.
2048 * @delay: maximum coalescing delay in msecs.
2049 * @condition: condition for packet coalescence.
2050 *	see &enum nl80211_coalesce_condition.
2051 * @patterns: array of packet patterns
2052 * @n_patterns: number of patterns
2053 */
2054struct cfg80211_coalesce_rules {
2055	int delay;
2056	enum nl80211_coalesce_condition condition;
2057	struct cfg80211_pkt_pattern *patterns;
2058	int n_patterns;
2059};
2060
2061/**
2062 * struct cfg80211_coalesce - Packet coalescing settings
2063 *
2064 * This structure defines coalescing settings.
2065 * @rules: array of coalesce rules
2066 * @n_rules: number of rules
2067 */
2068struct cfg80211_coalesce {
2069	struct cfg80211_coalesce_rules *rules;
2070	int n_rules;
2071};
2072
2073/**
2074 * struct cfg80211_wowlan_nd_match - information about the match
2075 *
2076 * @ssid: SSID of the match that triggered the wake up
2077 * @n_channels: Number of channels where the match occurred.  This
2078 *	value may be zero if the driver can't report the channels.
2079 * @channels: center frequencies of the channels where a match
2080 *	occurred (in MHz)
2081 */
2082struct cfg80211_wowlan_nd_match {
2083	struct cfg80211_ssid ssid;
2084	int n_channels;
2085	u32 channels[];
2086};
2087
2088/**
2089 * struct cfg80211_wowlan_nd_info - net detect wake up information
2090 *
2091 * @n_matches: Number of match information instances provided in
2092 *	@matches.  This value may be zero if the driver can't provide
2093 *	match information.
2094 * @matches: Array of pointers to matches containing information about
2095 *	the matches that triggered the wake up.
2096 */
2097struct cfg80211_wowlan_nd_info {
2098	int n_matches;
2099	struct cfg80211_wowlan_nd_match *matches[];
2100};
2101
2102/**
2103 * struct cfg80211_wowlan_wakeup - wakeup report
2104 * @disconnect: woke up by getting disconnected
2105 * @magic_pkt: woke up by receiving magic packet
2106 * @gtk_rekey_failure: woke up by GTK rekey failure
2107 * @eap_identity_req: woke up by EAP identity request packet
2108 * @four_way_handshake: woke up by 4-way handshake
2109 * @rfkill_release: woke up by rfkill being released
2110 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2111 * @packet_present_len: copied wakeup packet data
2112 * @packet_len: original wakeup packet length
2113 * @packet: The packet causing the wakeup, if any.
2114 * @packet_80211:  For pattern match, magic packet and other data
2115 *	frame triggers an 802.3 frame should be reported, for
2116 *	disconnect due to deauth 802.11 frame. This indicates which
2117 *	it is.
2118 * @tcp_match: TCP wakeup packet received
2119 * @tcp_connlost: TCP connection lost or failed to establish
2120 * @tcp_nomoretokens: TCP data ran out of tokens
2121 * @net_detect: if not %NULL, woke up because of net detect
2122 */
2123struct cfg80211_wowlan_wakeup {
2124	bool disconnect, magic_pkt, gtk_rekey_failure,
2125	     eap_identity_req, four_way_handshake,
2126	     rfkill_release, packet_80211,
2127	     tcp_match, tcp_connlost, tcp_nomoretokens;
2128	s32 pattern_idx;
2129	u32 packet_present_len, packet_len;
2130	const void *packet;
2131	struct cfg80211_wowlan_nd_info *net_detect;
2132};
2133
2134/**
2135 * struct cfg80211_gtk_rekey_data - rekey data
2136 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2137 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2138 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2139 */
2140struct cfg80211_gtk_rekey_data {
2141	const u8 *kek, *kck, *replay_ctr;
2142};
2143
2144/**
2145 * struct cfg80211_update_ft_ies_params - FT IE Information
2146 *
2147 * This structure provides information needed to update the fast transition IE
2148 *
2149 * @md: The Mobility Domain ID, 2 Octet value
2150 * @ie: Fast Transition IEs
2151 * @ie_len: Length of ft_ie in octets
2152 */
2153struct cfg80211_update_ft_ies_params {
2154	u16 md;
2155	const u8 *ie;
2156	size_t ie_len;
2157};
2158
2159/**
2160 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2161 *
2162 * This structure provides information needed to transmit a mgmt frame
2163 *
2164 * @chan: channel to use
2165 * @offchan: indicates wether off channel operation is required
2166 * @wait: duration for ROC
2167 * @buf: buffer to transmit
2168 * @len: buffer length
2169 * @no_cck: don't use cck rates for this frame
2170 * @dont_wait_for_ack: tells the low level not to wait for an ack
2171 * @n_csa_offsets: length of csa_offsets array
2172 * @csa_offsets: array of all the csa offsets in the frame
2173 */
2174struct cfg80211_mgmt_tx_params {
2175	struct ieee80211_channel *chan;
2176	bool offchan;
2177	unsigned int wait;
2178	const u8 *buf;
2179	size_t len;
2180	bool no_cck;
2181	bool dont_wait_for_ack;
2182	int n_csa_offsets;
2183	const u16 *csa_offsets;
2184};
2185
2186/**
2187 * struct cfg80211_dscp_exception - DSCP exception
2188 *
2189 * @dscp: DSCP value that does not adhere to the user priority range definition
2190 * @up: user priority value to which the corresponding DSCP value belongs
2191 */
2192struct cfg80211_dscp_exception {
2193	u8 dscp;
2194	u8 up;
2195};
2196
2197/**
2198 * struct cfg80211_dscp_range - DSCP range definition for user priority
2199 *
2200 * @low: lowest DSCP value of this user priority range, inclusive
2201 * @high: highest DSCP value of this user priority range, inclusive
2202 */
2203struct cfg80211_dscp_range {
2204	u8 low;
2205	u8 high;
2206};
2207
2208/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2209#define IEEE80211_QOS_MAP_MAX_EX	21
2210#define IEEE80211_QOS_MAP_LEN_MIN	16
2211#define IEEE80211_QOS_MAP_LEN_MAX \
2212	(IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2213
2214/**
2215 * struct cfg80211_qos_map - QoS Map Information
2216 *
2217 * This struct defines the Interworking QoS map setting for DSCP values
2218 *
2219 * @num_des: number of DSCP exceptions (0..21)
2220 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2221 *	the user priority DSCP range definition
2222 * @up: DSCP range definition for a particular user priority
2223 */
2224struct cfg80211_qos_map {
2225	u8 num_des;
2226	struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2227	struct cfg80211_dscp_range up[8];
2228};
2229
2230/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2231 * struct cfg80211_ops - backend description for wireless configuration
2232 *
2233 * This struct is registered by fullmac card drivers and/or wireless stacks
2234 * in order to handle configuration requests on their interfaces.
2235 *
2236 * All callbacks except where otherwise noted should return 0
2237 * on success or a negative error code.
2238 *
2239 * All operations are currently invoked under rtnl for consistency with the
2240 * wireless extensions but this is subject to reevaluation as soon as this
2241 * code is used more widely and we have a first user without wext.
2242 *
2243 * @suspend: wiphy device needs to be suspended. The variable @wow will
2244 *	be %NULL or contain the enabled Wake-on-Wireless triggers that are
2245 *	configured for the device.
2246 * @resume: wiphy device needs to be resumed
2247 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2248 *	to call device_set_wakeup_enable() to enable/disable wakeup from
2249 *	the device.
2250 *
2251 * @add_virtual_intf: create a new virtual interface with the given name,
2252 *	must set the struct wireless_dev's iftype. Beware: You must create
2253 *	the new netdev in the wiphy's network namespace! Returns the struct
2254 *	wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2255 *	also set the address member in the wdev.
2256 *
2257 * @del_virtual_intf: remove the virtual interface
2258 *
2259 * @change_virtual_intf: change type/configuration of virtual interface,
2260 *	keep the struct wireless_dev's iftype updated.
2261 *
2262 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2263 *	when adding a group key.
2264 *
2265 * @get_key: get information about the key with the given parameters.
2266 *	@mac_addr will be %NULL when requesting information for a group
2267 *	key. All pointers given to the @callback function need not be valid
2268 *	after it returns. This function should return an error if it is
2269 *	not possible to retrieve the key, -ENOENT if it doesn't exist.
2270 *
2271 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2272 *	and @key_index, return -ENOENT if the key doesn't exist.
2273 *
2274 * @set_default_key: set the default key on an interface
2275 *
2276 * @set_default_mgmt_key: set the default management frame key on an interface
2277 *
2278 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2279 *
2280 * @start_ap: Start acting in AP mode defined by the parameters.
2281 * @change_beacon: Change the beacon parameters for an access point mode
2282 *	interface. This should reject the call when AP mode wasn't started.
2283 * @stop_ap: Stop being an AP, including stopping beaconing.
2284 *
2285 * @add_station: Add a new station.
2286 * @del_station: Remove a station
2287 * @change_station: Modify a given station. Note that flags changes are not much
2288 *	validated in cfg80211, in particular the auth/assoc/authorized flags
2289 *	might come to the driver in invalid combinations -- make sure to check
2290 *	them, also against the existing state! Drivers must call
2291 *	cfg80211_check_station_change() to validate the information.
2292 * @get_station: get station information for the station identified by @mac
2293 * @dump_station: dump station callback -- resume dump at index @idx
2294 *
2295 * @add_mpath: add a fixed mesh path
2296 * @del_mpath: delete a given mesh path
2297 * @change_mpath: change a given mesh path
2298 * @get_mpath: get a mesh path for the given parameters
2299 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2300 * @get_mpp: get a mesh proxy path for the given parameters
2301 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2302 * @join_mesh: join the mesh network with the specified parameters
2303 *	(invoked with the wireless_dev mutex held)
2304 * @leave_mesh: leave the current mesh network
2305 *	(invoked with the wireless_dev mutex held)
2306 *
2307 * @get_mesh_config: Get the current mesh configuration
2308 *
2309 * @update_mesh_config: Update mesh parameters on a running mesh.
2310 *	The mask is a bitfield which tells us which parameters to
2311 *	set, and which to leave alone.
2312 *
2313 * @change_bss: Modify parameters for a given BSS.
2314 *
2315 * @set_txq_params: Set TX queue parameters
2316 *
2317 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2318 *	as it doesn't implement join_mesh and needs to set the channel to
2319 *	join the mesh instead.
2320 *
2321 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2322 *	interfaces are active this callback should reject the configuration.
2323 *	If no interfaces are active or the device is down, the channel should
2324 *	be stored for when a monitor interface becomes active.
2325 *
2326 * @scan: Request to do a scan. If returning zero, the scan request is given
2327 *	the driver, and will be valid until passed to cfg80211_scan_done().
2328 *	For scan results, call cfg80211_inform_bss(); you can call this outside
2329 *	the scan/scan_done bracket too.
2330 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2331 *	indicate the status of the scan through cfg80211_scan_done().
2332 *
2333 * @auth: Request to authenticate with the specified peer
2334 *	(invoked with the wireless_dev mutex held)
2335 * @assoc: Request to (re)associate with the specified peer
2336 *	(invoked with the wireless_dev mutex held)
2337 * @deauth: Request to deauthenticate from the specified peer
2338 *	(invoked with the wireless_dev mutex held)
2339 * @disassoc: Request to disassociate from the specified peer
2340 *	(invoked with the wireless_dev mutex held)
2341 *
2342 * @connect: Connect to the ESS with the specified parameters. When connected,
2343 *	call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2344 *	If the connection fails for some reason, call cfg80211_connect_result()
2345 *	with the status from the AP.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2346 *	(invoked with the wireless_dev mutex held)
2347 * @disconnect: Disconnect from the BSS/ESS.
 
 
 
 
 
 
2348 *	(invoked with the wireless_dev mutex held)
 
 
 
 
2349 *
2350 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2351 *	cfg80211_ibss_joined(), also call that function when changing BSSID due
2352 *	to a merge.
2353 *	(invoked with the wireless_dev mutex held)
2354 * @leave_ibss: Leave the IBSS.
2355 *	(invoked with the wireless_dev mutex held)
2356 *
2357 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2358 *	MESH mode)
2359 *
2360 * @set_wiphy_params: Notify that wiphy parameters have changed;
2361 *	@changed bitfield (see &enum wiphy_params_flags) describes which values
2362 *	have changed. The actual parameter values are available in
2363 *	struct wiphy. If returning an error, no value should be changed.
2364 *
2365 * @set_tx_power: set the transmit power according to the parameters,
2366 *	the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2367 *	wdev may be %NULL if power was set for the wiphy, and will
2368 *	always be %NULL unless the driver supports per-vif TX power
2369 *	(as advertised by the nl80211 feature flag.)
2370 * @get_tx_power: store the current TX power into the dbm variable;
2371 *	return 0 if successful
2372 *
2373 * @set_wds_peer: set the WDS peer for a WDS interface
2374 *
2375 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2376 *	functions to adjust rfkill hw state
2377 *
2378 * @dump_survey: get site survey information.
2379 *
2380 * @remain_on_channel: Request the driver to remain awake on the specified
2381 *	channel for the specified duration to complete an off-channel
2382 *	operation (e.g., public action frame exchange). When the driver is
2383 *	ready on the requested channel, it must indicate this with an event
2384 *	notification by calling cfg80211_ready_on_channel().
2385 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2386 *	This allows the operation to be terminated prior to timeout based on
2387 *	the duration value.
2388 * @mgmt_tx: Transmit a management frame.
2389 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2390 *	frame on another channel
2391 *
2392 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2393 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2394 *	used by the function, but 0 and 1 must not be touched. Additionally,
2395 *	return error codes other than -ENOBUFS and -ENOENT will terminate the
2396 *	dump and return to userspace with an error, so be careful. If any data
2397 *	was passed in from userspace then the data/len arguments will be present
2398 *	and point to the data contained in %NL80211_ATTR_TESTDATA.
2399 *
2400 * @set_bitrate_mask: set the bitrate mask configuration
2401 *
2402 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2403 *	devices running firmwares capable of generating the (re) association
2404 *	RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2405 * @del_pmksa: Delete a cached PMKID.
2406 * @flush_pmksa: Flush all cached PMKIDs.
2407 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2408 *	allows the driver to adjust the dynamic ps timeout value.
2409 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2410 *	After configuration, the driver should (soon) send an event indicating
2411 *	the current level is above/below the configured threshold; this may
2412 *	need some care when the configuration is changed (without first being
2413 *	disabled.)
2414 * @set_cqm_txe_config: Configure connection quality monitor TX error
2415 *	thresholds.
2416 * @sched_scan_start: Tell the driver to start a scheduled scan.
2417 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2418 *	call must stop the scheduled scan and be ready for starting a new one
2419 *	before it returns, i.e. @sched_scan_start may be called immediately
2420 *	after that again and should not fail in that case. The driver should
2421 *	not call cfg80211_sched_scan_stopped() for a requested stop (when this
2422 *	method returns 0.)
2423 *
2424 * @mgmt_frame_register: Notify driver that a management frame type was
2425 *	registered. The callback is allowed to sleep.
2426 *
2427 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2428 *	Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2429 *	reject TX/RX mask combinations they cannot support by returning -EINVAL
2430 *	(also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2431 *
2432 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2433 *
2434 * @tdls_mgmt: Transmit a TDLS management frame.
2435 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2436 *
2437 * @probe_client: probe an associated client, must return a cookie that it
2438 *	later passes to cfg80211_probe_status().
2439 *
2440 * @set_noack_map: Set the NoAck Map for the TIDs.
2441 *
2442 * @get_channel: Get the current operating channel for the virtual interface.
2443 *	For monitor interfaces, it should return %NULL unless there's a single
2444 *	current monitoring channel.
2445 *
2446 * @start_p2p_device: Start the given P2P device.
2447 * @stop_p2p_device: Stop the given P2P device.
2448 *
2449 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2450 *	Parameters include ACL policy, an array of MAC address of stations
2451 *	and the number of MAC addresses. If there is already a list in driver
2452 *	this new list replaces the existing one. Driver has to clear its ACL
2453 *	when number of MAC addresses entries is passed as 0. Drivers which
2454 *	advertise the support for MAC based ACL have to implement this callback.
2455 *
2456 * @start_radar_detection: Start radar detection in the driver.
2457 *
2458 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2459 *	driver. If the SME is in the driver/firmware, this information can be
2460 *	used in building Authentication and Reassociation Request frames.
2461 *
2462 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2463 *	for a given duration (milliseconds). The protocol is provided so the
2464 *	driver can take the most appropriate actions.
2465 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2466 *	reliability. This operation can not fail.
2467 * @set_coalesce: Set coalesce parameters.
2468 *
2469 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2470 *	responsible for veryfing if the switch is possible. Since this is
2471 *	inherently tricky driver may decide to disconnect an interface later
2472 *	with cfg80211_stop_iface(). This doesn't mean driver can accept
2473 *	everything. It should do it's best to verify requests and reject them
2474 *	as soon as possible.
2475 *
2476 * @set_qos_map: Set QoS mapping information to the driver
2477 *
2478 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2479 *	given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2480 *	changes during the lifetime of the BSS.
2481 *
2482 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2483 *	with the given parameters; action frame exchange has been handled by
2484 *	userspace so this just has to modify the TX path to take the TS into
2485 *	account.
2486 *	If the admitted time is 0 just validate the parameters to make sure
2487 *	the session can be created at all; it is valid to just always return
2488 *	success for that but that may result in inefficient behaviour (handshake
2489 *	with the peer followed by immediate teardown when the addition is later
2490 *	rejected)
2491 * @del_tx_ts: remove an existing TX TS
2492 *
2493 * @join_ocb: join the OCB network with the specified parameters
2494 *	(invoked with the wireless_dev mutex held)
2495 * @leave_ocb: leave the current OCB network
2496 *	(invoked with the wireless_dev mutex held)
2497 *
2498 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2499 *	is responsible for continually initiating channel-switching operations
2500 *	and returning to the base channel for communication with the AP.
2501 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2502 *	peers must be on the base channel when the call completes.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2503 */
2504struct cfg80211_ops {
2505	int	(*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2506	int	(*resume)(struct wiphy *wiphy);
2507	void	(*set_wakeup)(struct wiphy *wiphy, bool enabled);
2508
2509	struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2510						  const char *name,
2511						  unsigned char name_assign_type,
2512						  enum nl80211_iftype type,
2513						  u32 *flags,
2514						  struct vif_params *params);
2515	int	(*del_virtual_intf)(struct wiphy *wiphy,
2516				    struct wireless_dev *wdev);
2517	int	(*change_virtual_intf)(struct wiphy *wiphy,
2518				       struct net_device *dev,
2519				       enum nl80211_iftype type, u32 *flags,
2520				       struct vif_params *params);
2521
2522	int	(*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2523			   u8 key_index, bool pairwise, const u8 *mac_addr,
2524			   struct key_params *params);
2525	int	(*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2526			   u8 key_index, bool pairwise, const u8 *mac_addr,
2527			   void *cookie,
2528			   void (*callback)(void *cookie, struct key_params*));
2529	int	(*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2530			   u8 key_index, bool pairwise, const u8 *mac_addr);
2531	int	(*set_default_key)(struct wiphy *wiphy,
2532				   struct net_device *netdev,
2533				   u8 key_index, bool unicast, bool multicast);
2534	int	(*set_default_mgmt_key)(struct wiphy *wiphy,
2535					struct net_device *netdev,
2536					u8 key_index);
2537
2538	int	(*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2539			    struct cfg80211_ap_settings *settings);
2540	int	(*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2541				 struct cfg80211_beacon_data *info);
2542	int	(*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2543
2544
2545	int	(*add_station)(struct wiphy *wiphy, struct net_device *dev,
2546			       const u8 *mac,
2547			       struct station_parameters *params);
2548	int	(*del_station)(struct wiphy *wiphy, struct net_device *dev,
2549			       struct station_del_parameters *params);
2550	int	(*change_station)(struct wiphy *wiphy, struct net_device *dev,
2551				  const u8 *mac,
2552				  struct station_parameters *params);
2553	int	(*get_station)(struct wiphy *wiphy, struct net_device *dev,
2554			       const u8 *mac, struct station_info *sinfo);
2555	int	(*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2556				int idx, u8 *mac, struct station_info *sinfo);
2557
2558	int	(*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2559			       const u8 *dst, const u8 *next_hop);
2560	int	(*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2561			       const u8 *dst);
2562	int	(*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2563				  const u8 *dst, const u8 *next_hop);
2564	int	(*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2565			     u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2566	int	(*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2567			      int idx, u8 *dst, u8 *next_hop,
2568			      struct mpath_info *pinfo);
2569	int	(*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2570			   u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2571	int	(*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2572			    int idx, u8 *dst, u8 *mpp,
2573			    struct mpath_info *pinfo);
2574	int	(*get_mesh_config)(struct wiphy *wiphy,
2575				struct net_device *dev,
2576				struct mesh_config *conf);
2577	int	(*update_mesh_config)(struct wiphy *wiphy,
2578				      struct net_device *dev, u32 mask,
2579				      const struct mesh_config *nconf);
2580	int	(*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2581			     const struct mesh_config *conf,
2582			     const struct mesh_setup *setup);
2583	int	(*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2584
2585	int	(*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2586			    struct ocb_setup *setup);
2587	int	(*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2588
2589	int	(*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2590			      struct bss_parameters *params);
2591
2592	int	(*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2593				  struct ieee80211_txq_params *params);
2594
2595	int	(*libertas_set_mesh_channel)(struct wiphy *wiphy,
2596					     struct net_device *dev,
2597					     struct ieee80211_channel *chan);
2598
2599	int	(*set_monitor_channel)(struct wiphy *wiphy,
2600				       struct cfg80211_chan_def *chandef);
2601
2602	int	(*scan)(struct wiphy *wiphy,
2603			struct cfg80211_scan_request *request);
2604	void	(*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
2605
2606	int	(*auth)(struct wiphy *wiphy, struct net_device *dev,
2607			struct cfg80211_auth_request *req);
2608	int	(*assoc)(struct wiphy *wiphy, struct net_device *dev,
2609			 struct cfg80211_assoc_request *req);
2610	int	(*deauth)(struct wiphy *wiphy, struct net_device *dev,
2611			  struct cfg80211_deauth_request *req);
2612	int	(*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2613			    struct cfg80211_disassoc_request *req);
2614
2615	int	(*connect)(struct wiphy *wiphy, struct net_device *dev,
2616			   struct cfg80211_connect_params *sme);
 
 
 
 
2617	int	(*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2618			      u16 reason_code);
2619
2620	int	(*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2621			     struct cfg80211_ibss_params *params);
2622	int	(*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2623
2624	int	(*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2625				  int rate[IEEE80211_NUM_BANDS]);
2626
2627	int	(*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2628
2629	int	(*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2630				enum nl80211_tx_power_setting type, int mbm);
2631	int	(*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2632				int *dbm);
2633
2634	int	(*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2635				const u8 *addr);
2636
2637	void	(*rfkill_poll)(struct wiphy *wiphy);
2638
2639#ifdef CONFIG_NL80211_TESTMODE
2640	int	(*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2641				void *data, int len);
2642	int	(*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2643				 struct netlink_callback *cb,
2644				 void *data, int len);
2645#endif
2646
2647	int	(*set_bitrate_mask)(struct wiphy *wiphy,
2648				    struct net_device *dev,
2649				    const u8 *peer,
2650				    const struct cfg80211_bitrate_mask *mask);
2651
2652	int	(*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2653			int idx, struct survey_info *info);
2654
2655	int	(*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2656			     struct cfg80211_pmksa *pmksa);
2657	int	(*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2658			     struct cfg80211_pmksa *pmksa);
2659	int	(*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2660
2661	int	(*remain_on_channel)(struct wiphy *wiphy,
2662				     struct wireless_dev *wdev,
2663				     struct ieee80211_channel *chan,
2664				     unsigned int duration,
2665				     u64 *cookie);
2666	int	(*cancel_remain_on_channel)(struct wiphy *wiphy,
2667					    struct wireless_dev *wdev,
2668					    u64 cookie);
2669
2670	int	(*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2671			   struct cfg80211_mgmt_tx_params *params,
2672			   u64 *cookie);
2673	int	(*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2674				       struct wireless_dev *wdev,
2675				       u64 cookie);
2676
2677	int	(*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2678				  bool enabled, int timeout);
2679
2680	int	(*set_cqm_rssi_config)(struct wiphy *wiphy,
2681				       struct net_device *dev,
2682				       s32 rssi_thold, u32 rssi_hyst);
2683
2684	int	(*set_cqm_txe_config)(struct wiphy *wiphy,
2685				      struct net_device *dev,
2686				      u32 rate, u32 pkts, u32 intvl);
2687
2688	void	(*mgmt_frame_register)(struct wiphy *wiphy,
2689				       struct wireless_dev *wdev,
2690				       u16 frame_type, bool reg);
2691
2692	int	(*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2693	int	(*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2694
2695	int	(*sched_scan_start)(struct wiphy *wiphy,
2696				struct net_device *dev,
2697				struct cfg80211_sched_scan_request *request);
2698	int	(*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2699
2700	int	(*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2701				  struct cfg80211_gtk_rekey_data *data);
2702
2703	int	(*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2704			     const u8 *peer, u8 action_code,  u8 dialog_token,
2705			     u16 status_code, u32 peer_capability,
2706			     bool initiator, const u8 *buf, size_t len);
2707	int	(*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2708			     const u8 *peer, enum nl80211_tdls_operation oper);
2709
2710	int	(*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2711				const u8 *peer, u64 *cookie);
2712
2713	int	(*set_noack_map)(struct wiphy *wiphy,
2714				  struct net_device *dev,
2715				  u16 noack_map);
2716
2717	int	(*get_channel)(struct wiphy *wiphy,
2718			       struct wireless_dev *wdev,
2719			       struct cfg80211_chan_def *chandef);
2720
2721	int	(*start_p2p_device)(struct wiphy *wiphy,
2722				    struct wireless_dev *wdev);
2723	void	(*stop_p2p_device)(struct wiphy *wiphy,
2724				   struct wireless_dev *wdev);
2725
2726	int	(*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2727			       const struct cfg80211_acl_data *params);
2728
2729	int	(*start_radar_detection)(struct wiphy *wiphy,
2730					 struct net_device *dev,
2731					 struct cfg80211_chan_def *chandef,
2732					 u32 cac_time_ms);
2733	int	(*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2734				 struct cfg80211_update_ft_ies_params *ftie);
2735	int	(*crit_proto_start)(struct wiphy *wiphy,
2736				    struct wireless_dev *wdev,
2737				    enum nl80211_crit_proto_id protocol,
2738				    u16 duration);
2739	void	(*crit_proto_stop)(struct wiphy *wiphy,
2740				   struct wireless_dev *wdev);
2741	int	(*set_coalesce)(struct wiphy *wiphy,
2742				struct cfg80211_coalesce *coalesce);
2743
2744	int	(*channel_switch)(struct wiphy *wiphy,
2745				  struct net_device *dev,
2746				  struct cfg80211_csa_settings *params);
2747
2748	int     (*set_qos_map)(struct wiphy *wiphy,
2749			       struct net_device *dev,
2750			       struct cfg80211_qos_map *qos_map);
2751
2752	int	(*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2753				    struct cfg80211_chan_def *chandef);
2754
2755	int	(*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2756			     u8 tsid, const u8 *peer, u8 user_prio,
2757			     u16 admitted_time);
2758	int	(*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2759			     u8 tsid, const u8 *peer);
2760
2761	int	(*tdls_channel_switch)(struct wiphy *wiphy,
2762				       struct net_device *dev,
2763				       const u8 *addr, u8 oper_class,
2764				       struct cfg80211_chan_def *chandef);
2765	void	(*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2766					      struct net_device *dev,
2767					      const u8 *addr);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2768};
2769
2770/*
2771 * wireless hardware and networking interfaces structures
2772 * and registration/helper functions
2773 */
2774
2775/**
2776 * enum wiphy_flags - wiphy capability flags
2777 *
2778 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2779 *	wiphy at all
2780 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2781 *	by default -- this flag will be set depending on the kernel's default
2782 *	on wiphy_new(), but can be changed by the driver if it has a good
2783 *	reason to override the default
2784 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2785 *	on a VLAN interface)
2786 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2787 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2788 *	control port protocol ethertype. The device also honours the
2789 *	control_port_no_encrypt flag.
2790 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2791 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2792 *	auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2793 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2794 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2795 *	firmware.
2796 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2797 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2798 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2799 *	link setup/discovery operations internally. Setup, discovery and
2800 *	teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2801 *	command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2802 *	used for asking the driver/firmware to perform a TDLS operation.
2803 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2804 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2805 *	when there are virtual interfaces in AP mode by calling
2806 *	cfg80211_report_obss_beacon().
2807 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2808 *	responds to probe-requests in hardware.
2809 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2810 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2811 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2812 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2813 *	beaconing mode (AP, IBSS, Mesh, ...).
 
 
2814 */
2815enum wiphy_flags {
2816	/* use hole at 0 */
2817	/* use hole at 1 */
2818	/* use hole at 2 */
2819	WIPHY_FLAG_NETNS_OK			= BIT(3),
2820	WIPHY_FLAG_PS_ON_BY_DEFAULT		= BIT(4),
2821	WIPHY_FLAG_4ADDR_AP			= BIT(5),
2822	WIPHY_FLAG_4ADDR_STATION		= BIT(6),
2823	WIPHY_FLAG_CONTROL_PORT_PROTOCOL	= BIT(7),
2824	WIPHY_FLAG_IBSS_RSN			= BIT(8),
2825	WIPHY_FLAG_MESH_AUTH			= BIT(10),
2826	WIPHY_FLAG_SUPPORTS_SCHED_SCAN		= BIT(11),
2827	/* use hole at 12 */
2828	WIPHY_FLAG_SUPPORTS_FW_ROAM		= BIT(13),
2829	WIPHY_FLAG_AP_UAPSD			= BIT(14),
2830	WIPHY_FLAG_SUPPORTS_TDLS		= BIT(15),
2831	WIPHY_FLAG_TDLS_EXTERNAL_SETUP		= BIT(16),
2832	WIPHY_FLAG_HAVE_AP_SME			= BIT(17),
2833	WIPHY_FLAG_REPORTS_OBSS			= BIT(18),
2834	WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD	= BIT(19),
2835	WIPHY_FLAG_OFFCHAN_TX			= BIT(20),
2836	WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL	= BIT(21),
2837	WIPHY_FLAG_SUPPORTS_5_10_MHZ		= BIT(22),
2838	WIPHY_FLAG_HAS_CHANNEL_SWITCH		= BIT(23),
 
2839};
2840
2841/**
2842 * struct ieee80211_iface_limit - limit on certain interface types
2843 * @max: maximum number of interfaces of these types
2844 * @types: interface types (bits)
2845 */
2846struct ieee80211_iface_limit {
2847	u16 max;
2848	u16 types;
2849};
2850
2851/**
2852 * struct ieee80211_iface_combination - possible interface combination
2853 * @limits: limits for the given interface types
2854 * @n_limits: number of limitations
2855 * @num_different_channels: can use up to this many different channels
2856 * @max_interfaces: maximum number of interfaces in total allowed in this
2857 *	group
2858 * @beacon_int_infra_match: In this combination, the beacon intervals
2859 *	between infrastructure and AP types must match. This is required
2860 *	only in special cases.
2861 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2862 * @radar_detect_regions: bitmap of regions supported for radar detection
 
 
 
 
 
 
2863 *
2864 * With this structure the driver can describe which interface
2865 * combinations it supports concurrently.
2866 *
2867 * Examples:
2868 *
2869 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2870 *
2871 *  struct ieee80211_iface_limit limits1[] = {
2872 *	{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2873 *	{ .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2874 *  };
2875 *  struct ieee80211_iface_combination combination1 = {
2876 *	.limits = limits1,
2877 *	.n_limits = ARRAY_SIZE(limits1),
2878 *	.max_interfaces = 2,
2879 *	.beacon_int_infra_match = true,
2880 *  };
 
 
2881 *
2882 *
2883 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2884 *
2885 *  struct ieee80211_iface_limit limits2[] = {
2886 *	{ .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2887 *			     BIT(NL80211_IFTYPE_P2P_GO), },
2888 *  };
2889 *  struct ieee80211_iface_combination combination2 = {
2890 *	.limits = limits2,
2891 *	.n_limits = ARRAY_SIZE(limits2),
2892 *	.max_interfaces = 8,
2893 *	.num_different_channels = 1,
2894 *  };
 
 
2895 *
2896 *
2897 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2898 *
2899 * This allows for an infrastructure connection and three P2P connections.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2900 *
2901 *  struct ieee80211_iface_limit limits3[] = {
2902 *	{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2903 *	{ .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2904 *			     BIT(NL80211_IFTYPE_P2P_CLIENT), },
2905 *  };
2906 *  struct ieee80211_iface_combination combination3 = {
2907 *	.limits = limits3,
2908 *	.n_limits = ARRAY_SIZE(limits3),
2909 *	.max_interfaces = 4,
2910 *	.num_different_channels = 2,
2911 *  };
2912 */
2913struct ieee80211_iface_combination {
2914	const struct ieee80211_iface_limit *limits;
2915	u32 num_different_channels;
2916	u16 max_interfaces;
2917	u8 n_limits;
2918	bool beacon_int_infra_match;
2919	u8 radar_detect_widths;
2920	u8 radar_detect_regions;
 
2921};
2922
2923struct ieee80211_txrx_stypes {
2924	u16 tx, rx;
2925};
2926
2927/**
2928 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2929 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2930 *	trigger that keeps the device operating as-is and
2931 *	wakes up the host on any activity, for example a
2932 *	received packet that passed filtering; note that the
2933 *	packet should be preserved in that case
2934 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2935 *	(see nl80211.h)
2936 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2937 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2938 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2939 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2940 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2941 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2942 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
2943 */
2944enum wiphy_wowlan_support_flags {
2945	WIPHY_WOWLAN_ANY		= BIT(0),
2946	WIPHY_WOWLAN_MAGIC_PKT		= BIT(1),
2947	WIPHY_WOWLAN_DISCONNECT		= BIT(2),
2948	WIPHY_WOWLAN_SUPPORTS_GTK_REKEY	= BIT(3),
2949	WIPHY_WOWLAN_GTK_REKEY_FAILURE	= BIT(4),
2950	WIPHY_WOWLAN_EAP_IDENTITY_REQ	= BIT(5),
2951	WIPHY_WOWLAN_4WAY_HANDSHAKE	= BIT(6),
2952	WIPHY_WOWLAN_RFKILL_RELEASE	= BIT(7),
2953	WIPHY_WOWLAN_NET_DETECT		= BIT(8),
2954};
2955
2956struct wiphy_wowlan_tcp_support {
2957	const struct nl80211_wowlan_tcp_data_token_feature *tok;
2958	u32 data_payload_max;
2959	u32 data_interval_max;
2960	u32 wake_payload_max;
2961	bool seq;
2962};
2963
2964/**
2965 * struct wiphy_wowlan_support - WoWLAN support data
2966 * @flags: see &enum wiphy_wowlan_support_flags
2967 * @n_patterns: number of supported wakeup patterns
2968 *	(see nl80211.h for the pattern definition)
2969 * @pattern_max_len: maximum length of each pattern
2970 * @pattern_min_len: minimum length of each pattern
2971 * @max_pkt_offset: maximum Rx packet offset
2972 * @max_nd_match_sets: maximum number of matchsets for net-detect,
2973 *	similar, but not necessarily identical, to max_match_sets for
2974 *	scheduled scans.
2975 *	See &struct cfg80211_sched_scan_request.@match_sets for more
2976 *	details.
2977 * @tcp: TCP wakeup support information
2978 */
2979struct wiphy_wowlan_support {
2980	u32 flags;
2981	int n_patterns;
2982	int pattern_max_len;
2983	int pattern_min_len;
2984	int max_pkt_offset;
2985	int max_nd_match_sets;
2986	const struct wiphy_wowlan_tcp_support *tcp;
2987};
2988
2989/**
2990 * struct wiphy_coalesce_support - coalesce support data
2991 * @n_rules: maximum number of coalesce rules
2992 * @max_delay: maximum supported coalescing delay in msecs
2993 * @n_patterns: number of supported patterns in a rule
2994 *	(see nl80211.h for the pattern definition)
2995 * @pattern_max_len: maximum length of each pattern
2996 * @pattern_min_len: minimum length of each pattern
2997 * @max_pkt_offset: maximum Rx packet offset
2998 */
2999struct wiphy_coalesce_support {
3000	int n_rules;
3001	int max_delay;
3002	int n_patterns;
3003	int pattern_max_len;
3004	int pattern_min_len;
3005	int max_pkt_offset;
3006};
3007
3008/**
3009 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3010 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3011 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3012 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3013 *	(must be combined with %_WDEV or %_NETDEV)
3014 */
3015enum wiphy_vendor_command_flags {
3016	WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3017	WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3018	WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3019};
3020
3021/**
3022 * struct wiphy_vendor_command - vendor command definition
3023 * @info: vendor command identifying information, as used in nl80211
3024 * @flags: flags, see &enum wiphy_vendor_command_flags
3025 * @doit: callback for the operation, note that wdev is %NULL if the
3026 *	flags didn't ask for a wdev and non-%NULL otherwise; the data
3027 *	pointer may be %NULL if userspace provided no data at all
3028 * @dumpit: dump callback, for transferring bigger/multiple items. The
3029 *	@storage points to cb->args[5], ie. is preserved over the multiple
3030 *	dumpit calls.
3031 * It's recommended to not have the same sub command with both @doit and
3032 * @dumpit, so that userspace can assume certain ones are get and others
3033 * are used with dump requests.
3034 */
3035struct wiphy_vendor_command {
3036	struct nl80211_vendor_cmd_info info;
3037	u32 flags;
3038	int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3039		    const void *data, int data_len);
3040	int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3041		      struct sk_buff *skb, const void *data, int data_len,
3042		      unsigned long *storage);
3043};
3044
3045/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3046 * struct wiphy - wireless hardware description
3047 * @reg_notifier: the driver's regulatory notification callback,
3048 *	note that if your driver uses wiphy_apply_custom_regulatory()
3049 *	the reg_notifier's request can be passed as NULL
3050 * @regd: the driver's regulatory domain, if one was requested via
3051 * 	the regulatory_hint() API. This can be used by the driver
3052 *	on the reg_notifier() if it chooses to ignore future
3053 *	regulatory domain changes caused by other drivers.
3054 * @signal_type: signal type reported in &struct cfg80211_bss.
3055 * @cipher_suites: supported cipher suites
3056 * @n_cipher_suites: number of supported cipher suites
3057 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3058 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3059 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3060 *	-1 = fragmentation disabled, only odd values >= 256 used
3061 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3062 * @_net: the network namespace this wiphy currently lives in
3063 * @perm_addr: permanent MAC address of this device
3064 * @addr_mask: If the device supports multiple MAC addresses by masking,
3065 *	set this to a mask with variable bits set to 1, e.g. if the last
3066 *	four bits are variable then set it to 00-00-00-00-00-0f. The actual
3067 *	variable bits shall be determined by the interfaces added, with
3068 *	interfaces not matching the mask being rejected to be brought up.
3069 * @n_addresses: number of addresses in @addresses.
3070 * @addresses: If the device has more than one address, set this pointer
3071 *	to a list of addresses (6 bytes each). The first one will be used
3072 *	by default for perm_addr. In this case, the mask should be set to
3073 *	all-zeroes. In this case it is assumed that the device can handle
3074 *	the same number of arbitrary MAC addresses.
3075 * @registered: protects ->resume and ->suspend sysfs callbacks against
3076 *	unregister hardware
3077 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3078 *	automatically on wiphy renames
3079 * @dev: (virtual) struct device for this wiphy
3080 * @registered: helps synchronize suspend/resume with wiphy unregister
3081 * @wext: wireless extension handlers
3082 * @priv: driver private data (sized according to wiphy_new() parameter)
3083 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3084 *	must be set by driver
3085 * @iface_combinations: Valid interface combinations array, should not
3086 *	list single interface types.
3087 * @n_iface_combinations: number of entries in @iface_combinations array.
3088 * @software_iftypes: bitmask of software interface types, these are not
3089 *	subject to any restrictions since they are purely managed in SW.
3090 * @flags: wiphy flags, see &enum wiphy_flags
3091 * @regulatory_flags: wiphy regulatory flags, see
3092 *	&enum ieee80211_regulatory_flags
3093 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3094 * @ext_features: extended features advertised to nl80211, see
3095 *	&enum nl80211_ext_feature_index.
3096 * @bss_priv_size: each BSS struct has private data allocated with it,
3097 *	this variable determines its size
3098 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3099 *	any given scan
3100 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3101 *	for in any given scheduled scan
3102 * @max_match_sets: maximum number of match sets the device can handle
3103 *	when performing a scheduled scan, 0 if filtering is not
3104 *	supported.
3105 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3106 *	add to probe request frames transmitted during a scan, must not
3107 *	include fixed IEs like supported rates
3108 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3109 *	scans
3110 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3111 *	of iterations) for scheduled scan supported by the device.
3112 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3113 *	single scan plan supported by the device.
3114 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3115 *	scan plan supported by the device.
3116 * @coverage_class: current coverage class
3117 * @fw_version: firmware version for ethtool reporting
3118 * @hw_version: hardware version for ethtool reporting
3119 * @max_num_pmkids: maximum number of PMKIDs supported by device
3120 * @privid: a pointer that drivers can use to identify if an arbitrary
3121 *	wiphy is theirs, e.g. in global notifiers
3122 * @bands: information about bands/channels supported by this device
3123 *
3124 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3125 *	transmitted through nl80211, points to an array indexed by interface
3126 *	type
3127 *
3128 * @available_antennas_tx: bitmap of antennas which are available to be
3129 *	configured as TX antennas. Antenna configuration commands will be
3130 *	rejected unless this or @available_antennas_rx is set.
3131 *
3132 * @available_antennas_rx: bitmap of antennas which are available to be
3133 *	configured as RX antennas. Antenna configuration commands will be
3134 *	rejected unless this or @available_antennas_tx is set.
3135 *
3136 * @probe_resp_offload:
3137 *	 Bitmap of supported protocols for probe response offloading.
3138 *	 See &enum nl80211_probe_resp_offload_support_attr. Only valid
3139 *	 when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3140 *
3141 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3142 *	may request, if implemented.
3143 *
3144 * @wowlan: WoWLAN support information
3145 * @wowlan_config: current WoWLAN configuration; this should usually not be
3146 *	used since access to it is necessarily racy, use the parameter passed
3147 *	to the suspend() operation instead.
3148 *
3149 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3150 * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
3151 *	If null, then none can be over-ridden.
3152 * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
3153 *	If null, then none can be over-ridden.
3154 *
 
 
 
3155 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3156 *	supports for ACL.
3157 *
3158 * @extended_capabilities: extended capabilities supported by the driver,
3159 *	additional capabilities might be supported by userspace; these are
3160 *	the 802.11 extended capabilities ("Extended Capabilities element")
3161 *	and are in the same format as in the information element. See
3162 *	802.11-2012 8.4.2.29 for the defined fields.
 
 
3163 * @extended_capabilities_mask: mask of the valid values
3164 * @extended_capabilities_len: length of the extended capabilities
 
 
 
3165 * @coalesce: packet coalescing support information
3166 *
3167 * @vendor_commands: array of vendor commands supported by the hardware
3168 * @n_vendor_commands: number of vendor commands
3169 * @vendor_events: array of vendor events supported by the hardware
3170 * @n_vendor_events: number of vendor events
3171 *
3172 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3173 *	(including P2P GO) or 0 to indicate no such limit is advertised. The
3174 *	driver is allowed to advertise a theoretical limit that it can reach in
3175 *	some cases, but may not always reach.
3176 *
3177 * @max_num_csa_counters: Number of supported csa_counters in beacons
3178 *	and probe responses.  This value should be set if the driver
3179 *	wishes to limit the number of csa counters. Default (0) means
3180 *	infinite.
3181 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3182 *	frame was sent and the channel on which the frame was heard for which
3183 *	the reported rssi is still valid. If a driver is able to compensate the
3184 *	low rssi when a frame is heard on different channel, then it should set
3185 *	this variable to the maximal offset for which it can compensate.
3186 *	This value should be set in MHz.
 
 
 
 
 
3187 */
3188struct wiphy {
3189	/* assign these fields before you register the wiphy */
3190
3191	/* permanent MAC address(es) */
3192	u8 perm_addr[ETH_ALEN];
3193	u8 addr_mask[ETH_ALEN];
3194
3195	struct mac_address *addresses;
3196
3197	const struct ieee80211_txrx_stypes *mgmt_stypes;
3198
3199	const struct ieee80211_iface_combination *iface_combinations;
3200	int n_iface_combinations;
3201	u16 software_iftypes;
3202
3203	u16 n_addresses;
3204
3205	/* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3206	u16 interface_modes;
3207
3208	u16 max_acl_mac_addrs;
3209
3210	u32 flags, regulatory_flags, features;
3211	u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3212
3213	u32 ap_sme_capa;
3214
3215	enum cfg80211_signal_type signal_type;
3216
3217	int bss_priv_size;
3218	u8 max_scan_ssids;
3219	u8 max_sched_scan_ssids;
3220	u8 max_match_sets;
3221	u16 max_scan_ie_len;
3222	u16 max_sched_scan_ie_len;
3223	u32 max_sched_scan_plans;
3224	u32 max_sched_scan_plan_interval;
3225	u32 max_sched_scan_plan_iterations;
3226
3227	int n_cipher_suites;
3228	const u32 *cipher_suites;
3229
3230	u8 retry_short;
3231	u8 retry_long;
3232	u32 frag_threshold;
3233	u32 rts_threshold;
3234	u8 coverage_class;
3235
3236	char fw_version[ETHTOOL_FWVERS_LEN];
3237	u32 hw_version;
3238
3239#ifdef CONFIG_PM
3240	const struct wiphy_wowlan_support *wowlan;
3241	struct cfg80211_wowlan *wowlan_config;
3242#endif
3243
3244	u16 max_remain_on_channel_duration;
3245
3246	u8 max_num_pmkids;
3247
3248	u32 available_antennas_tx;
3249	u32 available_antennas_rx;
3250
3251	/*
3252	 * Bitmap of supported protocols for probe response offloading
3253	 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3254	 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3255	 */
3256	u32 probe_resp_offload;
3257
3258	const u8 *extended_capabilities, *extended_capabilities_mask;
3259	u8 extended_capabilities_len;
3260
 
 
 
3261	/* If multiple wiphys are registered and you're handed e.g.
3262	 * a regular netdev with assigned ieee80211_ptr, you won't
3263	 * know whether it points to a wiphy your driver has registered
3264	 * or not. Assign this to something global to your driver to
3265	 * help determine whether you own this wiphy or not. */
3266	const void *privid;
3267
3268	struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
3269
3270	/* Lets us get back the wiphy on the callback */
3271	void (*reg_notifier)(struct wiphy *wiphy,
3272			     struct regulatory_request *request);
3273
3274	/* fields below are read-only, assigned by cfg80211 */
3275
3276	const struct ieee80211_regdomain __rcu *regd;
3277
3278	/* the item in /sys/class/ieee80211/ points to this,
3279	 * you need use set_wiphy_dev() (see below) */
3280	struct device dev;
3281
3282	/* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3283	bool registered;
3284
3285	/* dir in debugfs: ieee80211/<wiphyname> */
3286	struct dentry *debugfsdir;
3287
3288	const struct ieee80211_ht_cap *ht_capa_mod_mask;
3289	const struct ieee80211_vht_cap *vht_capa_mod_mask;
3290
 
 
3291	/* the network namespace this phy lives in currently */
3292	possible_net_t _net;
3293
3294#ifdef CONFIG_CFG80211_WEXT
3295	const struct iw_handler_def *wext;
3296#endif
3297
3298	const struct wiphy_coalesce_support *coalesce;
3299
3300	const struct wiphy_vendor_command *vendor_commands;
3301	const struct nl80211_vendor_cmd_info *vendor_events;
3302	int n_vendor_commands, n_vendor_events;
3303
3304	u16 max_ap_assoc_sta;
3305
3306	u8 max_num_csa_counters;
3307	u8 max_adj_channel_rssi_comp;
3308
 
 
 
 
3309	char priv[0] __aligned(NETDEV_ALIGN);
3310};
3311
3312static inline struct net *wiphy_net(struct wiphy *wiphy)
3313{
3314	return read_pnet(&wiphy->_net);
3315}
3316
3317static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3318{
3319	write_pnet(&wiphy->_net, net);
3320}
3321
3322/**
3323 * wiphy_priv - return priv from wiphy
3324 *
3325 * @wiphy: the wiphy whose priv pointer to return
3326 * Return: The priv of @wiphy.
3327 */
3328static inline void *wiphy_priv(struct wiphy *wiphy)
3329{
3330	BUG_ON(!wiphy);
3331	return &wiphy->priv;
3332}
3333
3334/**
3335 * priv_to_wiphy - return the wiphy containing the priv
3336 *
3337 * @priv: a pointer previously returned by wiphy_priv
3338 * Return: The wiphy of @priv.
3339 */
3340static inline struct wiphy *priv_to_wiphy(void *priv)
3341{
3342	BUG_ON(!priv);
3343	return container_of(priv, struct wiphy, priv);
3344}
3345
3346/**
3347 * set_wiphy_dev - set device pointer for wiphy
3348 *
3349 * @wiphy: The wiphy whose device to bind
3350 * @dev: The device to parent it to
3351 */
3352static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3353{
3354	wiphy->dev.parent = dev;
3355}
3356
3357/**
3358 * wiphy_dev - get wiphy dev pointer
3359 *
3360 * @wiphy: The wiphy whose device struct to look up
3361 * Return: The dev of @wiphy.
3362 */
3363static inline struct device *wiphy_dev(struct wiphy *wiphy)
3364{
3365	return wiphy->dev.parent;
3366}
3367
3368/**
3369 * wiphy_name - get wiphy name
3370 *
3371 * @wiphy: The wiphy whose name to return
3372 * Return: The name of @wiphy.
3373 */
3374static inline const char *wiphy_name(const struct wiphy *wiphy)
3375{
3376	return dev_name(&wiphy->dev);
3377}
3378
3379/**
3380 * wiphy_new_nm - create a new wiphy for use with cfg80211
3381 *
3382 * @ops: The configuration operations for this device
3383 * @sizeof_priv: The size of the private area to allocate
3384 * @requested_name: Request a particular name.
3385 *	NULL is valid value, and means use the default phy%d naming.
3386 *
3387 * Create a new wiphy and associate the given operations with it.
3388 * @sizeof_priv bytes are allocated for private use.
3389 *
3390 * Return: A pointer to the new wiphy. This pointer must be
3391 * assigned to each netdev's ieee80211_ptr for proper operation.
3392 */
3393struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3394			   const char *requested_name);
3395
3396/**
3397 * wiphy_new - create a new wiphy for use with cfg80211
3398 *
3399 * @ops: The configuration operations for this device
3400 * @sizeof_priv: The size of the private area to allocate
3401 *
3402 * Create a new wiphy and associate the given operations with it.
3403 * @sizeof_priv bytes are allocated for private use.
3404 *
3405 * Return: A pointer to the new wiphy. This pointer must be
3406 * assigned to each netdev's ieee80211_ptr for proper operation.
3407 */
3408static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3409				      int sizeof_priv)
3410{
3411	return wiphy_new_nm(ops, sizeof_priv, NULL);
3412}
3413
3414/**
3415 * wiphy_register - register a wiphy with cfg80211
3416 *
3417 * @wiphy: The wiphy to register.
3418 *
3419 * Return: A non-negative wiphy index or a negative error code.
3420 */
3421int wiphy_register(struct wiphy *wiphy);
3422
3423/**
3424 * wiphy_unregister - deregister a wiphy from cfg80211
3425 *
3426 * @wiphy: The wiphy to unregister.
3427 *
3428 * After this call, no more requests can be made with this priv
3429 * pointer, but the call may sleep to wait for an outstanding
3430 * request that is being handled.
3431 */
3432void wiphy_unregister(struct wiphy *wiphy);
3433
3434/**
3435 * wiphy_free - free wiphy
3436 *
3437 * @wiphy: The wiphy to free
3438 */
3439void wiphy_free(struct wiphy *wiphy);
3440
3441/* internal structs */
3442struct cfg80211_conn;
3443struct cfg80211_internal_bss;
3444struct cfg80211_cached_keys;
3445
3446/**
3447 * struct wireless_dev - wireless device state
3448 *
3449 * For netdevs, this structure must be allocated by the driver
3450 * that uses the ieee80211_ptr field in struct net_device (this
3451 * is intentional so it can be allocated along with the netdev.)
3452 * It need not be registered then as netdev registration will
3453 * be intercepted by cfg80211 to see the new wireless device.
3454 *
3455 * For non-netdev uses, it must also be allocated by the driver
3456 * in response to the cfg80211 callbacks that require it, as
3457 * there's no netdev registration in that case it may not be
3458 * allocated outside of callback operations that return it.
3459 *
3460 * @wiphy: pointer to hardware description
3461 * @iftype: interface type
3462 * @list: (private) Used to collect the interfaces
3463 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3464 * @identifier: (private) Identifier used in nl80211 to identify this
3465 *	wireless device if it has no netdev
3466 * @current_bss: (private) Used by the internal configuration code
3467 * @chandef: (private) Used by the internal configuration code to track
3468 *	the user-set channel definition.
3469 * @preset_chandef: (private) Used by the internal configuration code to
3470 *	track the channel to be used for AP later
3471 * @bssid: (private) Used by the internal configuration code
3472 * @ssid: (private) Used by the internal configuration code
3473 * @ssid_len: (private) Used by the internal configuration code
3474 * @mesh_id_len: (private) Used by the internal configuration code
3475 * @mesh_id_up_len: (private) Used by the internal configuration code
3476 * @wext: (private) Used by the internal wireless extensions compat code
3477 * @use_4addr: indicates 4addr mode is used on this interface, must be
3478 *	set by driver (if supported) on add_interface BEFORE registering the
3479 *	netdev and may otherwise be used by driver read-only, will be update
3480 *	by cfg80211 on change_interface
3481 * @mgmt_registrations: list of registrations for management frames
3482 * @mgmt_registrations_lock: lock for the list
3483 * @mtx: mutex used to lock data in this struct, may be used by drivers
3484 *	and some API functions require it held
3485 * @beacon_interval: beacon interval used on this device for transmitting
3486 *	beacons, 0 when not valid
3487 * @address: The address for this device, valid only if @netdev is %NULL
3488 * @p2p_started: true if this is a P2P Device that has been started
 
3489 * @cac_started: true if DFS channel availability check has been started
3490 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3491 * @cac_time_ms: CAC time in ms
3492 * @ps: powersave mode is enabled
3493 * @ps_timeout: dynamic powersave timeout
3494 * @ap_unexpected_nlportid: (private) netlink port ID of application
3495 *	registered for unexpected class 3 frames (AP mode)
3496 * @conn: (private) cfg80211 software SME connection state machine data
3497 * @connect_keys: (private) keys to set after connection is established
3498 * @conn_bss_type: connecting/connected BSS type
3499 * @ibss_fixed: (private) IBSS is using fixed BSSID
3500 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3501 * @event_list: (private) list for internal event processing
3502 * @event_lock: (private) lock for event list
3503 * @owner_nlportid: (private) owner socket port ID
3504 */
3505struct wireless_dev {
3506	struct wiphy *wiphy;
3507	enum nl80211_iftype iftype;
3508
3509	/* the remainder of this struct should be private to cfg80211 */
3510	struct list_head list;
3511	struct net_device *netdev;
3512
3513	u32 identifier;
3514
3515	struct list_head mgmt_registrations;
3516	spinlock_t mgmt_registrations_lock;
3517
3518	struct mutex mtx;
3519
3520	bool use_4addr, p2p_started;
3521
3522	u8 address[ETH_ALEN] __aligned(sizeof(u16));
3523
3524	/* currently used for IBSS and SME - might be rearranged later */
3525	u8 ssid[IEEE80211_MAX_SSID_LEN];
3526	u8 ssid_len, mesh_id_len, mesh_id_up_len;
3527	struct cfg80211_conn *conn;
3528	struct cfg80211_cached_keys *connect_keys;
3529	enum ieee80211_bss_type conn_bss_type;
3530
3531	struct list_head event_list;
3532	spinlock_t event_lock;
3533
3534	struct cfg80211_internal_bss *current_bss; /* associated / joined */
3535	struct cfg80211_chan_def preset_chandef;
3536	struct cfg80211_chan_def chandef;
3537
3538	bool ibss_fixed;
3539	bool ibss_dfs_possible;
3540
3541	bool ps;
3542	int ps_timeout;
3543
3544	int beacon_interval;
3545
3546	u32 ap_unexpected_nlportid;
3547
3548	bool cac_started;
3549	unsigned long cac_start_time;
3550	unsigned int cac_time_ms;
3551
3552	u32 owner_nlportid;
3553
3554#ifdef CONFIG_CFG80211_WEXT
3555	/* wext data */
3556	struct {
3557		struct cfg80211_ibss_params ibss;
3558		struct cfg80211_connect_params connect;
3559		struct cfg80211_cached_keys *keys;
3560		const u8 *ie;
3561		size_t ie_len;
3562		u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3563		u8 ssid[IEEE80211_MAX_SSID_LEN];
3564		s8 default_key, default_mgmt_key;
3565		bool prev_bssid_valid;
3566	} wext;
3567#endif
3568};
3569
3570static inline u8 *wdev_address(struct wireless_dev *wdev)
3571{
3572	if (wdev->netdev)
3573		return wdev->netdev->dev_addr;
3574	return wdev->address;
3575}
3576
 
 
 
 
 
 
 
3577/**
3578 * wdev_priv - return wiphy priv from wireless_dev
3579 *
3580 * @wdev: The wireless device whose wiphy's priv pointer to return
3581 * Return: The wiphy priv of @wdev.
3582 */
3583static inline void *wdev_priv(struct wireless_dev *wdev)
3584{
3585	BUG_ON(!wdev);
3586	return wiphy_priv(wdev->wiphy);
3587}
3588
3589/**
3590 * DOC: Utility functions
3591 *
3592 * cfg80211 offers a number of utility functions that can be useful.
3593 */
3594
3595/**
3596 * ieee80211_channel_to_frequency - convert channel number to frequency
3597 * @chan: channel number
3598 * @band: band, necessary due to channel number overlap
3599 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3600 */
3601int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3602
3603/**
3604 * ieee80211_frequency_to_channel - convert frequency to channel number
3605 * @freq: center frequency
3606 * Return: The corresponding channel, or 0 if the conversion failed.
3607 */
3608int ieee80211_frequency_to_channel(int freq);
3609
3610/*
3611 * Name indirection necessary because the ieee80211 code also has
3612 * a function named "ieee80211_get_channel", so if you include
3613 * cfg80211's header file you get cfg80211's version, if you try
3614 * to include both header files you'll (rightfully!) get a symbol
3615 * clash.
3616 */
3617struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3618						  int freq);
3619/**
3620 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3621 * @wiphy: the struct wiphy to get the channel for
3622 * @freq: the center frequency of the channel
3623 * Return: The channel struct from @wiphy at @freq.
3624 */
3625static inline struct ieee80211_channel *
3626ieee80211_get_channel(struct wiphy *wiphy, int freq)
3627{
3628	return __ieee80211_get_channel(wiphy, freq);
3629}
3630
3631/**
3632 * ieee80211_get_response_rate - get basic rate for a given rate
3633 *
3634 * @sband: the band to look for rates in
3635 * @basic_rates: bitmap of basic rates
3636 * @bitrate: the bitrate for which to find the basic rate
3637 *
3638 * Return: The basic rate corresponding to a given bitrate, that
3639 * is the next lower bitrate contained in the basic rate map,
3640 * which is, for this function, given as a bitmap of indices of
3641 * rates in the band's bitrate table.
3642 */
3643struct ieee80211_rate *
3644ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3645			    u32 basic_rates, int bitrate);
3646
3647/**
3648 * ieee80211_mandatory_rates - get mandatory rates for a given band
3649 * @sband: the band to look for rates in
3650 * @scan_width: width of the control channel
3651 *
3652 * This function returns a bitmap of the mandatory rates for the given
3653 * band, bits are set according to the rate position in the bitrates array.
3654 */
3655u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3656			      enum nl80211_bss_scan_width scan_width);
3657
3658/*
3659 * Radiotap parsing functions -- for controlled injection support
3660 *
3661 * Implemented in net/wireless/radiotap.c
3662 * Documentation in Documentation/networking/radiotap-headers.txt
3663 */
3664
3665struct radiotap_align_size {
3666	uint8_t align:4, size:4;
3667};
3668
3669struct ieee80211_radiotap_namespace {
3670	const struct radiotap_align_size *align_size;
3671	int n_bits;
3672	uint32_t oui;
3673	uint8_t subns;
3674};
3675
3676struct ieee80211_radiotap_vendor_namespaces {
3677	const struct ieee80211_radiotap_namespace *ns;
3678	int n_ns;
3679};
3680
3681/**
3682 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3683 * @this_arg_index: index of current arg, valid after each successful call
3684 *	to ieee80211_radiotap_iterator_next()
3685 * @this_arg: pointer to current radiotap arg; it is valid after each
3686 *	call to ieee80211_radiotap_iterator_next() but also after
3687 *	ieee80211_radiotap_iterator_init() where it will point to
3688 *	the beginning of the actual data portion
3689 * @this_arg_size: length of the current arg, for convenience
3690 * @current_namespace: pointer to the current namespace definition
3691 *	(or internally %NULL if the current namespace is unknown)
3692 * @is_radiotap_ns: indicates whether the current namespace is the default
3693 *	radiotap namespace or not
3694 *
3695 * @_rtheader: pointer to the radiotap header we are walking through
3696 * @_max_length: length of radiotap header in cpu byte ordering
3697 * @_arg_index: next argument index
3698 * @_arg: next argument pointer
3699 * @_next_bitmap: internal pointer to next present u32
3700 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3701 * @_vns: vendor namespace definitions
3702 * @_next_ns_data: beginning of the next namespace's data
3703 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3704 *	next bitmap word
3705 *
3706 * Describes the radiotap parser state. Fields prefixed with an underscore
3707 * must not be used by users of the parser, only by the parser internally.
3708 */
3709
3710struct ieee80211_radiotap_iterator {
3711	struct ieee80211_radiotap_header *_rtheader;
3712	const struct ieee80211_radiotap_vendor_namespaces *_vns;
3713	const struct ieee80211_radiotap_namespace *current_namespace;
3714
3715	unsigned char *_arg, *_next_ns_data;
3716	__le32 *_next_bitmap;
3717
3718	unsigned char *this_arg;
3719	int this_arg_index;
3720	int this_arg_size;
3721
3722	int is_radiotap_ns;
3723
3724	int _max_length;
3725	int _arg_index;
3726	uint32_t _bitmap_shifter;
3727	int _reset_on_ext;
3728};
3729
3730int
3731ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3732				 struct ieee80211_radiotap_header *radiotap_header,
3733				 int max_length,
3734				 const struct ieee80211_radiotap_vendor_namespaces *vns);
3735
3736int
3737ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3738
3739
3740extern const unsigned char rfc1042_header[6];
3741extern const unsigned char bridge_tunnel_header[6];
3742
3743/**
3744 * ieee80211_get_hdrlen_from_skb - get header length from data
3745 *
3746 * @skb: the frame
3747 *
3748 * Given an skb with a raw 802.11 header at the data pointer this function
3749 * returns the 802.11 header length.
3750 *
3751 * Return: The 802.11 header length in bytes (not including encryption
3752 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3753 * 802.11 header.
3754 */
3755unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3756
3757/**
3758 * ieee80211_hdrlen - get header length in bytes from frame control
3759 * @fc: frame control field in little-endian format
3760 * Return: The header length in bytes.
3761 */
3762unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3763
3764/**
3765 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3766 * @meshhdr: the mesh extension header, only the flags field
3767 *	(first byte) will be accessed
3768 * Return: The length of the extension header, which is always at
3769 * least 6 bytes and at most 18 if address 5 and 6 are present.
3770 */
3771unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3772
3773/**
3774 * DOC: Data path helpers
3775 *
3776 * In addition to generic utilities, cfg80211 also offers
3777 * functions that help implement the data path for devices
3778 * that do not do the 802.11/802.3 conversion on the device.
3779 */
3780
3781/**
 
 
 
 
 
 
 
 
 
 
 
 
3782 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3783 * @skb: the 802.11 data frame
3784 * @addr: the device MAC address
3785 * @iftype: the virtual interface type
3786 * Return: 0 on success. Non-zero on error.
3787 */
3788int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3789			   enum nl80211_iftype iftype);
 
 
 
3790
3791/**
3792 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3793 * @skb: the 802.3 frame
3794 * @addr: the device MAC address
3795 * @iftype: the virtual interface type
3796 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3797 * @qos: build 802.11 QoS data frame
3798 * Return: 0 on success, or a negative error code.
3799 */
3800int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3801			     enum nl80211_iftype iftype, const u8 *bssid,
3802			     bool qos);
3803
3804/**
3805 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3806 *
3807 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3808 * 802.3 frames. The @list will be empty if the decode fails. The
3809 * @skb is consumed after the function returns.
3810 *
3811 * @skb: The input IEEE 802.11n A-MSDU frame.
3812 * @list: The output list of 802.3 frames. It must be allocated and
3813 *	initialized by by the caller.
3814 * @addr: The device MAC address.
3815 * @iftype: The device interface type.
3816 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3817 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
 
3818 */
3819void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3820			      const u8 *addr, enum nl80211_iftype iftype,
3821			      const unsigned int extra_headroom,
3822			      bool has_80211_header);
3823
3824/**
3825 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3826 * @skb: the data frame
3827 * @qos_map: Interworking QoS mapping or %NULL if not in use
3828 * Return: The 802.1p/1d tag.
3829 */
3830unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3831				    struct cfg80211_qos_map *qos_map);
3832
3833/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3834 * cfg80211_find_ie - find information element in data
3835 *
3836 * @eid: element ID
3837 * @ies: data consisting of IEs
3838 * @len: length of data
3839 *
3840 * Return: %NULL if the element ID could not be found or if
3841 * the element is invalid (claims to be longer than the given
3842 * data), or a pointer to the first byte of the requested
3843 * element, that is the byte containing the element ID.
3844 *
3845 * Note: There are no checks on the element length other than
3846 * having to fit into the given data.
3847 */
3848const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3849
3850/**
3851 * cfg80211_find_vendor_ie - find vendor specific information element in data
3852 *
3853 * @oui: vendor OUI
3854 * @oui_type: vendor-specific OUI type
3855 * @ies: data consisting of IEs
3856 * @len: length of data
3857 *
3858 * Return: %NULL if the vendor specific element ID could not be found or if the
3859 * element is invalid (claims to be longer than the given data), or a pointer to
3860 * the first byte of the requested element, that is the byte containing the
3861 * element ID.
3862 *
3863 * Note: There are no checks on the element length other than having to fit into
3864 * the given data.
3865 */
3866const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3867				  const u8 *ies, int len);
3868
3869/**
3870 * DOC: Regulatory enforcement infrastructure
3871 *
3872 * TODO
3873 */
3874
3875/**
3876 * regulatory_hint - driver hint to the wireless core a regulatory domain
3877 * @wiphy: the wireless device giving the hint (used only for reporting
3878 *	conflicts)
3879 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3880 * 	should be in. If @rd is set this should be NULL. Note that if you
3881 * 	set this to NULL you should still set rd->alpha2 to some accepted
3882 * 	alpha2.
3883 *
3884 * Wireless drivers can use this function to hint to the wireless core
3885 * what it believes should be the current regulatory domain by
3886 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3887 * domain should be in or by providing a completely build regulatory domain.
3888 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3889 * for a regulatory domain structure for the respective country.
3890 *
3891 * The wiphy must have been registered to cfg80211 prior to this call.
3892 * For cfg80211 drivers this means you must first use wiphy_register(),
3893 * for mac80211 drivers you must first use ieee80211_register_hw().
3894 *
3895 * Drivers should check the return value, its possible you can get
3896 * an -ENOMEM.
3897 *
3898 * Return: 0 on success. -ENOMEM.
3899 */
3900int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3901
3902/**
3903 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
3904 * @wiphy: the wireless device we want to process the regulatory domain on
3905 * @rd: the regulatory domain informatoin to use for this wiphy
3906 *
3907 * Set the regulatory domain information for self-managed wiphys, only they
3908 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
3909 * information.
3910 *
3911 * Return: 0 on success. -EINVAL, -EPERM
3912 */
3913int regulatory_set_wiphy_regd(struct wiphy *wiphy,
3914			      struct ieee80211_regdomain *rd);
3915
3916/**
3917 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
3918 * @wiphy: the wireless device we want to process the regulatory domain on
3919 * @rd: the regulatory domain information to use for this wiphy
3920 *
3921 * This functions requires the RTNL to be held and applies the new regdomain
3922 * synchronously to this wiphy. For more details see
3923 * regulatory_set_wiphy_regd().
3924 *
3925 * Return: 0 on success. -EINVAL, -EPERM
3926 */
3927int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
3928					struct ieee80211_regdomain *rd);
3929
3930/**
3931 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3932 * @wiphy: the wireless device we want to process the regulatory domain on
3933 * @regd: the custom regulatory domain to use for this wiphy
3934 *
3935 * Drivers can sometimes have custom regulatory domains which do not apply
3936 * to a specific country. Drivers can use this to apply such custom regulatory
3937 * domains. This routine must be called prior to wiphy registration. The
3938 * custom regulatory domain will be trusted completely and as such previous
3939 * default channel settings will be disregarded. If no rule is found for a
3940 * channel on the regulatory domain the channel will be disabled.
3941 * Drivers using this for a wiphy should also set the wiphy flag
3942 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
3943 * that called this helper.
3944 */
3945void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3946				   const struct ieee80211_regdomain *regd);
3947
3948/**
3949 * freq_reg_info - get regulatory information for the given frequency
3950 * @wiphy: the wiphy for which we want to process this rule for
3951 * @center_freq: Frequency in KHz for which we want regulatory information for
3952 *
3953 * Use this function to get the regulatory rule for a specific frequency on
3954 * a given wireless device. If the device has a specific regulatory domain
3955 * it wants to follow we respect that unless a country IE has been received
3956 * and processed already.
3957 *
3958 * Return: A valid pointer, or, when an error occurs, for example if no rule
3959 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3960 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3961 * value will be -ERANGE if we determine the given center_freq does not even
3962 * have a regulatory rule for a frequency range in the center_freq's band.
3963 * See freq_in_rule_band() for our current definition of a band -- this is
3964 * purely subjective and right now it's 802.11 specific.
3965 */
3966const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3967					       u32 center_freq);
3968
3969/**
3970 * reg_initiator_name - map regulatory request initiator enum to name
3971 * @initiator: the regulatory request initiator
3972 *
3973 * You can use this to map the regulatory request initiator enum to a
3974 * proper string representation.
3975 */
3976const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3977
3978/*
3979 * callbacks for asynchronous cfg80211 methods, notification
3980 * functions and BSS handling helpers
3981 */
3982
3983/**
3984 * cfg80211_scan_done - notify that scan finished
3985 *
3986 * @request: the corresponding scan request
3987 * @aborted: set to true if the scan was aborted for any reason,
3988 *	userspace will be notified of that
3989 */
3990void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
 
3991
3992/**
3993 * cfg80211_sched_scan_results - notify that new scan results are available
3994 *
3995 * @wiphy: the wiphy which got scheduled scan results
3996 */
3997void cfg80211_sched_scan_results(struct wiphy *wiphy);
3998
3999/**
4000 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4001 *
4002 * @wiphy: the wiphy on which the scheduled scan stopped
4003 *
4004 * The driver can call this function to inform cfg80211 that the
4005 * scheduled scan had to be stopped, for whatever reason.  The driver
4006 * is then called back via the sched_scan_stop operation when done.
4007 */
4008void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
4009
4010/**
4011 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4012 *
4013 * @wiphy: the wiphy on which the scheduled scan stopped
4014 *
4015 * The driver can call this function to inform cfg80211 that the
4016 * scheduled scan had to be stopped, for whatever reason.  The driver
4017 * is then called back via the sched_scan_stop operation when done.
4018 * This function should be called with rtnl locked.
4019 */
4020void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
4021
4022/**
4023 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4024 * @wiphy: the wiphy reporting the BSS
4025 * @data: the BSS metadata
4026 * @mgmt: the management frame (probe response or beacon)
4027 * @len: length of the management frame
4028 * @gfp: context flags
4029 *
4030 * This informs cfg80211 that BSS information was found and
4031 * the BSS should be updated/added.
4032 *
4033 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4034 * Or %NULL on error.
4035 */
4036struct cfg80211_bss * __must_check
4037cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4038			       struct cfg80211_inform_bss *data,
4039			       struct ieee80211_mgmt *mgmt, size_t len,
4040			       gfp_t gfp);
4041
4042static inline struct cfg80211_bss * __must_check
4043cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4044				struct ieee80211_channel *rx_channel,
4045				enum nl80211_bss_scan_width scan_width,
4046				struct ieee80211_mgmt *mgmt, size_t len,
4047				s32 signal, gfp_t gfp)
4048{
4049	struct cfg80211_inform_bss data = {
4050		.chan = rx_channel,
4051		.scan_width = scan_width,
4052		.signal = signal,
4053	};
4054
4055	return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4056}
4057
4058static inline struct cfg80211_bss * __must_check
4059cfg80211_inform_bss_frame(struct wiphy *wiphy,
4060			  struct ieee80211_channel *rx_channel,
4061			  struct ieee80211_mgmt *mgmt, size_t len,
4062			  s32 signal, gfp_t gfp)
4063{
4064	struct cfg80211_inform_bss data = {
4065		.chan = rx_channel,
4066		.scan_width = NL80211_BSS_CHAN_WIDTH_20,
4067		.signal = signal,
4068	};
4069
4070	return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4071}
4072
4073/**
4074 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4075 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4076 *	from a beacon or probe response
4077 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4078 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4079 */
4080enum cfg80211_bss_frame_type {
4081	CFG80211_BSS_FTYPE_UNKNOWN,
4082	CFG80211_BSS_FTYPE_BEACON,
4083	CFG80211_BSS_FTYPE_PRESP,
4084};
4085
4086/**
4087 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4088 *
4089 * @wiphy: the wiphy reporting the BSS
4090 * @data: the BSS metadata
4091 * @ftype: frame type (if known)
4092 * @bssid: the BSSID of the BSS
4093 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4094 * @capability: the capability field sent by the peer
4095 * @beacon_interval: the beacon interval announced by the peer
4096 * @ie: additional IEs sent by the peer
4097 * @ielen: length of the additional IEs
4098 * @gfp: context flags
4099 *
4100 * This informs cfg80211 that BSS information was found and
4101 * the BSS should be updated/added.
4102 *
4103 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4104 * Or %NULL on error.
4105 */
4106struct cfg80211_bss * __must_check
4107cfg80211_inform_bss_data(struct wiphy *wiphy,
4108			 struct cfg80211_inform_bss *data,
4109			 enum cfg80211_bss_frame_type ftype,
4110			 const u8 *bssid, u64 tsf, u16 capability,
4111			 u16 beacon_interval, const u8 *ie, size_t ielen,
4112			 gfp_t gfp);
4113
4114static inline struct cfg80211_bss * __must_check
4115cfg80211_inform_bss_width(struct wiphy *wiphy,
4116			  struct ieee80211_channel *rx_channel,
4117			  enum nl80211_bss_scan_width scan_width,
4118			  enum cfg80211_bss_frame_type ftype,
4119			  const u8 *bssid, u64 tsf, u16 capability,
4120			  u16 beacon_interval, const u8 *ie, size_t ielen,
4121			  s32 signal, gfp_t gfp)
4122{
4123	struct cfg80211_inform_bss data = {
4124		.chan = rx_channel,
4125		.scan_width = scan_width,
4126		.signal = signal,
4127	};
4128
4129	return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4130					capability, beacon_interval, ie, ielen,
4131					gfp);
4132}
4133
4134static inline struct cfg80211_bss * __must_check
4135cfg80211_inform_bss(struct wiphy *wiphy,
4136		    struct ieee80211_channel *rx_channel,
4137		    enum cfg80211_bss_frame_type ftype,
4138		    const u8 *bssid, u64 tsf, u16 capability,
4139		    u16 beacon_interval, const u8 *ie, size_t ielen,
4140		    s32 signal, gfp_t gfp)
4141{
4142	struct cfg80211_inform_bss data = {
4143		.chan = rx_channel,
4144		.scan_width = NL80211_BSS_CHAN_WIDTH_20,
4145		.signal = signal,
4146	};
4147
4148	return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4149					capability, beacon_interval, ie, ielen,
4150					gfp);
4151}
4152
4153struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4154				      struct ieee80211_channel *channel,
4155				      const u8 *bssid,
4156				      const u8 *ssid, size_t ssid_len,
4157				      enum ieee80211_bss_type bss_type,
4158				      enum ieee80211_privacy);
4159static inline struct cfg80211_bss *
4160cfg80211_get_ibss(struct wiphy *wiphy,
4161		  struct ieee80211_channel *channel,
4162		  const u8 *ssid, size_t ssid_len)
4163{
4164	return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4165				IEEE80211_BSS_TYPE_IBSS,
4166				IEEE80211_PRIVACY_ANY);
4167}
4168
4169/**
4170 * cfg80211_ref_bss - reference BSS struct
4171 * @wiphy: the wiphy this BSS struct belongs to
4172 * @bss: the BSS struct to reference
4173 *
4174 * Increments the refcount of the given BSS struct.
4175 */
4176void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4177
4178/**
4179 * cfg80211_put_bss - unref BSS struct
4180 * @wiphy: the wiphy this BSS struct belongs to
4181 * @bss: the BSS struct
4182 *
4183 * Decrements the refcount of the given BSS struct.
4184 */
4185void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4186
4187/**
4188 * cfg80211_unlink_bss - unlink BSS from internal data structures
4189 * @wiphy: the wiphy
4190 * @bss: the bss to remove
4191 *
4192 * This function removes the given BSS from the internal data structures
4193 * thereby making it no longer show up in scan results etc. Use this
4194 * function when you detect a BSS is gone. Normally BSSes will also time
4195 * out, so it is not necessary to use this function at all.
4196 */
4197void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4198
4199static inline enum nl80211_bss_scan_width
4200cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4201{
4202	switch (chandef->width) {
4203	case NL80211_CHAN_WIDTH_5:
4204		return NL80211_BSS_CHAN_WIDTH_5;
4205	case NL80211_CHAN_WIDTH_10:
4206		return NL80211_BSS_CHAN_WIDTH_10;
4207	default:
4208		return NL80211_BSS_CHAN_WIDTH_20;
4209	}
4210}
4211
4212/**
4213 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4214 * @dev: network device
4215 * @buf: authentication frame (header + body)
4216 * @len: length of the frame data
4217 *
4218 * This function is called whenever an authentication, disassociation or
4219 * deauthentication frame has been received and processed in station mode.
4220 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4221 * call either this function or cfg80211_auth_timeout().
4222 * After being asked to associate via cfg80211_ops::assoc() the driver must
4223 * call either this function or cfg80211_auth_timeout().
4224 * While connected, the driver must calls this for received and processed
4225 * disassociation and deauthentication frames. If the frame couldn't be used
4226 * because it was unprotected, the driver must call the function
4227 * cfg80211_rx_unprot_mlme_mgmt() instead.
4228 *
4229 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4230 */
4231void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4232
4233/**
4234 * cfg80211_auth_timeout - notification of timed out authentication
4235 * @dev: network device
4236 * @addr: The MAC address of the device with which the authentication timed out
4237 *
4238 * This function may sleep. The caller must hold the corresponding wdev's
4239 * mutex.
4240 */
4241void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4242
4243/**
4244 * cfg80211_rx_assoc_resp - notification of processed association response
4245 * @dev: network device
4246 * @bss: the BSS that association was requested with, ownership of the pointer
4247 *	moves to cfg80211 in this call
4248 * @buf: authentication frame (header + body)
4249 * @len: length of the frame data
4250 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
 
4251 *
4252 * After being asked to associate via cfg80211_ops::assoc() the driver must
4253 * call either this function or cfg80211_auth_timeout().
4254 *
4255 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4256 */
4257void cfg80211_rx_assoc_resp(struct net_device *dev,
4258			    struct cfg80211_bss *bss,
4259			    const u8 *buf, size_t len,
4260			    int uapsd_queues);
4261
4262/**
4263 * cfg80211_assoc_timeout - notification of timed out association
4264 * @dev: network device
4265 * @bss: The BSS entry with which association timed out.
4266 *
4267 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4268 */
4269void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4270
4271/**
 
 
 
 
 
 
 
 
 
 
 
4272 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4273 * @dev: network device
4274 * @buf: 802.11 frame (header + body)
4275 * @len: length of the frame data
4276 *
4277 * This function is called whenever deauthentication has been processed in
4278 * station mode. This includes both received deauthentication frames and
4279 * locally generated ones. This function may sleep. The caller must hold the
4280 * corresponding wdev's mutex.
4281 */
4282void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4283
4284/**
4285 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4286 * @dev: network device
4287 * @buf: deauthentication frame (header + body)
4288 * @len: length of the frame data
4289 *
4290 * This function is called whenever a received deauthentication or dissassoc
4291 * frame has been dropped in station mode because of MFP being used but the
4292 * frame was not protected. This function may sleep.
4293 */
4294void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4295				  const u8 *buf, size_t len);
4296
4297/**
4298 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4299 * @dev: network device
4300 * @addr: The source MAC address of the frame
4301 * @key_type: The key type that the received frame used
4302 * @key_id: Key identifier (0..3). Can be -1 if missing.
4303 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4304 * @gfp: allocation flags
4305 *
4306 * This function is called whenever the local MAC detects a MIC failure in a
4307 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4308 * primitive.
4309 */
4310void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4311				  enum nl80211_key_type key_type, int key_id,
4312				  const u8 *tsc, gfp_t gfp);
4313
4314/**
4315 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4316 *
4317 * @dev: network device
4318 * @bssid: the BSSID of the IBSS joined
4319 * @channel: the channel of the IBSS joined
4320 * @gfp: allocation flags
4321 *
4322 * This function notifies cfg80211 that the device joined an IBSS or
4323 * switched to a different BSSID. Before this function can be called,
4324 * either a beacon has to have been received from the IBSS, or one of
4325 * the cfg80211_inform_bss{,_frame} functions must have been called
4326 * with the locally generated beacon -- this guarantees that there is
4327 * always a scan result for this IBSS. cfg80211 will handle the rest.
4328 */
4329void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4330			  struct ieee80211_channel *channel, gfp_t gfp);
4331
4332/**
4333 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4334 *
4335 * @dev: network device
4336 * @macaddr: the MAC address of the new candidate
4337 * @ie: information elements advertised by the peer candidate
4338 * @ie_len: lenght of the information elements buffer
4339 * @gfp: allocation flags
4340 *
4341 * This function notifies cfg80211 that the mesh peer candidate has been
4342 * detected, most likely via a beacon or, less likely, via a probe response.
4343 * cfg80211 then sends a notification to userspace.
4344 */
4345void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4346		const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4347
4348/**
4349 * DOC: RFkill integration
4350 *
4351 * RFkill integration in cfg80211 is almost invisible to drivers,
4352 * as cfg80211 automatically registers an rfkill instance for each
4353 * wireless device it knows about. Soft kill is also translated
4354 * into disconnecting and turning all interfaces off, drivers are
4355 * expected to turn off the device when all interfaces are down.
4356 *
4357 * However, devices may have a hard RFkill line, in which case they
4358 * also need to interact with the rfkill subsystem, via cfg80211.
4359 * They can do this with a few helper functions documented here.
4360 */
4361
4362/**
4363 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4364 * @wiphy: the wiphy
4365 * @blocked: block status
4366 */
4367void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4368
4369/**
4370 * wiphy_rfkill_start_polling - start polling rfkill
4371 * @wiphy: the wiphy
4372 */
4373void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4374
4375/**
4376 * wiphy_rfkill_stop_polling - stop polling rfkill
4377 * @wiphy: the wiphy
4378 */
4379void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4380
4381/**
4382 * DOC: Vendor commands
4383 *
4384 * Occasionally, there are special protocol or firmware features that
4385 * can't be implemented very openly. For this and similar cases, the
4386 * vendor command functionality allows implementing the features with
4387 * (typically closed-source) userspace and firmware, using nl80211 as
4388 * the configuration mechanism.
4389 *
4390 * A driver supporting vendor commands must register them as an array
4391 * in struct wiphy, with handlers for each one, each command has an
4392 * OUI and sub command ID to identify it.
4393 *
4394 * Note that this feature should not be (ab)used to implement protocol
4395 * features that could openly be shared across drivers. In particular,
4396 * it must never be required to use vendor commands to implement any
4397 * "normal" functionality that higher-level userspace like connection
4398 * managers etc. need.
4399 */
4400
4401struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4402					   enum nl80211_commands cmd,
4403					   enum nl80211_attrs attr,
4404					   int approxlen);
4405
4406struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4407					   struct wireless_dev *wdev,
4408					   enum nl80211_commands cmd,
4409					   enum nl80211_attrs attr,
4410					   int vendor_event_idx,
4411					   int approxlen, gfp_t gfp);
4412
4413void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4414
4415/**
4416 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4417 * @wiphy: the wiphy
4418 * @approxlen: an upper bound of the length of the data that will
4419 *	be put into the skb
4420 *
4421 * This function allocates and pre-fills an skb for a reply to
4422 * a vendor command. Since it is intended for a reply, calling
4423 * it outside of a vendor command's doit() operation is invalid.
4424 *
4425 * The returned skb is pre-filled with some identifying data in
4426 * a way that any data that is put into the skb (with skb_put(),
4427 * nla_put() or similar) will end up being within the
4428 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4429 * with the skb is adding data for the corresponding userspace tool
4430 * which can then read that data out of the vendor data attribute.
4431 * You must not modify the skb in any other way.
4432 *
4433 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4434 * its error code as the result of the doit() operation.
4435 *
4436 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4437 */
4438static inline struct sk_buff *
4439cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4440{
4441	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4442					  NL80211_ATTR_VENDOR_DATA, approxlen);
4443}
4444
4445/**
4446 * cfg80211_vendor_cmd_reply - send the reply skb
4447 * @skb: The skb, must have been allocated with
4448 *	cfg80211_vendor_cmd_alloc_reply_skb()
4449 *
4450 * Since calling this function will usually be the last thing
4451 * before returning from the vendor command doit() you should
4452 * return the error code.  Note that this function consumes the
4453 * skb regardless of the return value.
4454 *
4455 * Return: An error code or 0 on success.
4456 */
4457int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4458
4459/**
4460 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4461 * @wiphy: the wiphy
4462 * @wdev: the wireless device
4463 * @event_idx: index of the vendor event in the wiphy's vendor_events
4464 * @approxlen: an upper bound of the length of the data that will
4465 *	be put into the skb
4466 * @gfp: allocation flags
4467 *
4468 * This function allocates and pre-fills an skb for an event on the
4469 * vendor-specific multicast group.
4470 *
4471 * If wdev != NULL, both the ifindex and identifier of the specified
4472 * wireless device are added to the event message before the vendor data
4473 * attribute.
4474 *
4475 * When done filling the skb, call cfg80211_vendor_event() with the
4476 * skb to send the event.
4477 *
4478 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4479 */
4480static inline struct sk_buff *
4481cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4482			     int approxlen, int event_idx, gfp_t gfp)
4483{
4484	return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4485					  NL80211_ATTR_VENDOR_DATA,
4486					  event_idx, approxlen, gfp);
4487}
4488
4489/**
4490 * cfg80211_vendor_event - send the event
4491 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4492 * @gfp: allocation flags
4493 *
4494 * This function sends the given @skb, which must have been allocated
4495 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4496 */
4497static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4498{
4499	__cfg80211_send_event_skb(skb, gfp);
4500}
4501
4502#ifdef CONFIG_NL80211_TESTMODE
4503/**
4504 * DOC: Test mode
4505 *
4506 * Test mode is a set of utility functions to allow drivers to
4507 * interact with driver-specific tools to aid, for instance,
4508 * factory programming.
4509 *
4510 * This chapter describes how drivers interact with it, for more
4511 * information see the nl80211 book's chapter on it.
4512 */
4513
4514/**
4515 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4516 * @wiphy: the wiphy
4517 * @approxlen: an upper bound of the length of the data that will
4518 *	be put into the skb
4519 *
4520 * This function allocates and pre-fills an skb for a reply to
4521 * the testmode command. Since it is intended for a reply, calling
4522 * it outside of the @testmode_cmd operation is invalid.
4523 *
4524 * The returned skb is pre-filled with the wiphy index and set up in
4525 * a way that any data that is put into the skb (with skb_put(),
4526 * nla_put() or similar) will end up being within the
4527 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4528 * with the skb is adding data for the corresponding userspace tool
4529 * which can then read that data out of the testdata attribute. You
4530 * must not modify the skb in any other way.
4531 *
4532 * When done, call cfg80211_testmode_reply() with the skb and return
4533 * its error code as the result of the @testmode_cmd operation.
4534 *
4535 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4536 */
4537static inline struct sk_buff *
4538cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4539{
4540	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4541					  NL80211_ATTR_TESTDATA, approxlen);
4542}
4543
4544/**
4545 * cfg80211_testmode_reply - send the reply skb
4546 * @skb: The skb, must have been allocated with
4547 *	cfg80211_testmode_alloc_reply_skb()
4548 *
4549 * Since calling this function will usually be the last thing
4550 * before returning from the @testmode_cmd you should return
4551 * the error code.  Note that this function consumes the skb
4552 * regardless of the return value.
4553 *
4554 * Return: An error code or 0 on success.
4555 */
4556static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4557{
4558	return cfg80211_vendor_cmd_reply(skb);
4559}
4560
4561/**
4562 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4563 * @wiphy: the wiphy
4564 * @approxlen: an upper bound of the length of the data that will
4565 *	be put into the skb
4566 * @gfp: allocation flags
4567 *
4568 * This function allocates and pre-fills an skb for an event on the
4569 * testmode multicast group.
4570 *
4571 * The returned skb is set up in the same way as with
4572 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4573 * there, you should simply add data to it that will then end up in the
4574 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4575 * in any other way.
4576 *
4577 * When done filling the skb, call cfg80211_testmode_event() with the
4578 * skb to send the event.
4579 *
4580 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4581 */
4582static inline struct sk_buff *
4583cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4584{
4585	return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
4586					  NL80211_ATTR_TESTDATA, -1,
4587					  approxlen, gfp);
4588}
4589
4590/**
4591 * cfg80211_testmode_event - send the event
4592 * @skb: The skb, must have been allocated with
4593 *	cfg80211_testmode_alloc_event_skb()
4594 * @gfp: allocation flags
4595 *
4596 * This function sends the given @skb, which must have been allocated
4597 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4598 * consumes it.
4599 */
4600static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4601{
4602	__cfg80211_send_event_skb(skb, gfp);
4603}
4604
4605#define CFG80211_TESTMODE_CMD(cmd)	.testmode_cmd = (cmd),
4606#define CFG80211_TESTMODE_DUMP(cmd)	.testmode_dump = (cmd),
4607#else
4608#define CFG80211_TESTMODE_CMD(cmd)
4609#define CFG80211_TESTMODE_DUMP(cmd)
4610#endif
4611
4612/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4613 * cfg80211_connect_result - notify cfg80211 of connection result
4614 *
4615 * @dev: network device
4616 * @bssid: the BSSID of the AP
4617 * @req_ie: association request IEs (maybe be %NULL)
4618 * @req_ie_len: association request IEs length
4619 * @resp_ie: association response IEs (may be %NULL)
4620 * @resp_ie_len: assoc response IEs length
4621 * @status: status code, 0 for successful connection, use
4622 *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4623 *	the real status code for failures.
4624 * @gfp: allocation flags
4625 *
4626 * It should be called by the underlying driver whenever connect() has
4627 * succeeded.
4628 */
4629void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4630			     const u8 *req_ie, size_t req_ie_len,
4631			     const u8 *resp_ie, size_t resp_ie_len,
4632			     u16 status, gfp_t gfp);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4633
4634/**
4635 * cfg80211_roamed - notify cfg80211 of roaming
4636 *
4637 * @dev: network device
4638 * @channel: the channel of the new AP
4639 * @bssid: the BSSID of the new AP
4640 * @req_ie: association request IEs (maybe be %NULL)
4641 * @req_ie_len: association request IEs length
4642 * @resp_ie: association response IEs (may be %NULL)
4643 * @resp_ie_len: assoc response IEs length
4644 * @gfp: allocation flags
4645 *
4646 * It should be called by the underlying driver whenever it roamed
4647 * from one AP to another while connected.
4648 */
4649void cfg80211_roamed(struct net_device *dev,
4650		     struct ieee80211_channel *channel,
4651		     const u8 *bssid,
4652		     const u8 *req_ie, size_t req_ie_len,
4653		     const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4654
4655/**
4656 * cfg80211_roamed_bss - notify cfg80211 of roaming
4657 *
4658 * @dev: network device
4659 * @bss: entry of bss to which STA got roamed
4660 * @req_ie: association request IEs (maybe be %NULL)
4661 * @req_ie_len: association request IEs length
4662 * @resp_ie: association response IEs (may be %NULL)
4663 * @resp_ie_len: assoc response IEs length
4664 * @gfp: allocation flags
4665 *
4666 * This is just a wrapper to notify cfg80211 of roaming event with driver
4667 * passing bss to avoid a race in timeout of the bss entry. It should be
4668 * called by the underlying driver whenever it roamed from one AP to another
4669 * while connected. Drivers which have roaming implemented in firmware
4670 * may use this function to avoid a race in bss entry timeout where the bss
4671 * entry of the new AP is seen in the driver, but gets timed out by the time
4672 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4673 * rdev->event_work. In case of any failures, the reference is released
4674 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4675 * it will be released while diconneting from the current bss.
4676 */
4677void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4678			 const u8 *req_ie, size_t req_ie_len,
4679			 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4680
4681/**
4682 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4683 *
4684 * @dev: network device
4685 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4686 * @ie_len: length of IEs
4687 * @reason: reason code for the disconnection, set it to 0 if unknown
4688 * @locally_generated: disconnection was requested locally
4689 * @gfp: allocation flags
4690 *
4691 * After it calls this function, the driver should enter an idle state
4692 * and not try to connect to any AP any more.
4693 */
4694void cfg80211_disconnected(struct net_device *dev, u16 reason,
4695			   const u8 *ie, size_t ie_len,
4696			   bool locally_generated, gfp_t gfp);
4697
4698/**
4699 * cfg80211_ready_on_channel - notification of remain_on_channel start
4700 * @wdev: wireless device
4701 * @cookie: the request cookie
4702 * @chan: The current channel (from remain_on_channel request)
4703 * @duration: Duration in milliseconds that the driver intents to remain on the
4704 *	channel
4705 * @gfp: allocation flags
4706 */
4707void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4708			       struct ieee80211_channel *chan,
4709			       unsigned int duration, gfp_t gfp);
4710
4711/**
4712 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4713 * @wdev: wireless device
4714 * @cookie: the request cookie
4715 * @chan: The current channel (from remain_on_channel request)
4716 * @gfp: allocation flags
4717 */
4718void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4719					struct ieee80211_channel *chan,
4720					gfp_t gfp);
4721
4722
4723/**
4724 * cfg80211_new_sta - notify userspace about station
4725 *
4726 * @dev: the netdev
4727 * @mac_addr: the station's address
4728 * @sinfo: the station information
4729 * @gfp: allocation flags
4730 */
4731void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4732		      struct station_info *sinfo, gfp_t gfp);
4733
4734/**
4735 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4736 * @dev: the netdev
4737 * @mac_addr: the station's address
4738 * @sinfo: the station information/statistics
4739 * @gfp: allocation flags
4740 */
4741void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
4742			    struct station_info *sinfo, gfp_t gfp);
4743
4744/**
4745 * cfg80211_del_sta - notify userspace about deletion of a station
4746 *
4747 * @dev: the netdev
4748 * @mac_addr: the station's address
4749 * @gfp: allocation flags
4750 */
4751static inline void cfg80211_del_sta(struct net_device *dev,
4752				    const u8 *mac_addr, gfp_t gfp)
4753{
4754	cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
4755}
4756
4757/**
4758 * cfg80211_conn_failed - connection request failed notification
4759 *
4760 * @dev: the netdev
4761 * @mac_addr: the station's address
4762 * @reason: the reason for connection failure
4763 * @gfp: allocation flags
4764 *
4765 * Whenever a station tries to connect to an AP and if the station
4766 * could not connect to the AP as the AP has rejected the connection
4767 * for some reasons, this function is called.
4768 *
4769 * The reason for connection failure can be any of the value from
4770 * nl80211_connect_failed_reason enum
4771 */
4772void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4773			  enum nl80211_connect_failed_reason reason,
4774			  gfp_t gfp);
4775
4776/**
4777 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4778 * @wdev: wireless device receiving the frame
4779 * @freq: Frequency on which the frame was received in MHz
4780 * @sig_dbm: signal strength in mBm, or 0 if unknown
4781 * @buf: Management frame (header + body)
4782 * @len: length of the frame data
4783 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4784 *
4785 * This function is called whenever an Action frame is received for a station
4786 * mode interface, but is not processed in kernel.
4787 *
4788 * Return: %true if a user space application has registered for this frame.
4789 * For action frames, that makes it responsible for rejecting unrecognized
4790 * action frames; %false otherwise, in which case for action frames the
4791 * driver is responsible for rejecting the frame.
4792 */
4793bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4794		      const u8 *buf, size_t len, u32 flags);
4795
4796/**
4797 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4798 * @wdev: wireless device receiving the frame
4799 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4800 * @buf: Management frame (header + body)
4801 * @len: length of the frame data
4802 * @ack: Whether frame was acknowledged
4803 * @gfp: context flags
4804 *
4805 * This function is called whenever a management frame was requested to be
4806 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4807 * transmission attempt.
4808 */
4809void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4810			     const u8 *buf, size_t len, bool ack, gfp_t gfp);
4811
4812
4813/**
4814 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4815 * @dev: network device
4816 * @rssi_event: the triggered RSSI event
4817 * @gfp: context flags
4818 *
4819 * This function is called when a configured connection quality monitoring
4820 * rssi threshold reached event occurs.
4821 */
4822void cfg80211_cqm_rssi_notify(struct net_device *dev,
4823			      enum nl80211_cqm_rssi_threshold_event rssi_event,
4824			      gfp_t gfp);
4825
4826/**
4827 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4828 * @dev: network device
4829 * @peer: peer's MAC address
4830 * @num_packets: how many packets were lost -- should be a fixed threshold
4831 *	but probably no less than maybe 50, or maybe a throughput dependent
4832 *	threshold (to account for temporary interference)
4833 * @gfp: context flags
4834 */
4835void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4836				 const u8 *peer, u32 num_packets, gfp_t gfp);
4837
4838/**
4839 * cfg80211_cqm_txe_notify - TX error rate event
4840 * @dev: network device
4841 * @peer: peer's MAC address
4842 * @num_packets: how many packets were lost
4843 * @rate: % of packets which failed transmission
4844 * @intvl: interval (in s) over which the TX failure threshold was breached.
4845 * @gfp: context flags
4846 *
4847 * Notify userspace when configured % TX failures over number of packets in a
4848 * given interval is exceeded.
4849 */
4850void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4851			     u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4852
4853/**
4854 * cfg80211_cqm_beacon_loss_notify - beacon loss event
4855 * @dev: network device
4856 * @gfp: context flags
4857 *
4858 * Notify userspace about beacon loss from the connected AP.
4859 */
4860void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
4861
4862/**
4863 * cfg80211_radar_event - radar detection event
4864 * @wiphy: the wiphy
4865 * @chandef: chandef for the current channel
4866 * @gfp: context flags
4867 *
4868 * This function is called when a radar is detected on the current chanenl.
4869 */
4870void cfg80211_radar_event(struct wiphy *wiphy,
4871			  struct cfg80211_chan_def *chandef, gfp_t gfp);
4872
4873/**
4874 * cfg80211_cac_event - Channel availability check (CAC) event
4875 * @netdev: network device
4876 * @chandef: chandef for the current channel
4877 * @event: type of event
4878 * @gfp: context flags
4879 *
4880 * This function is called when a Channel availability check (CAC) is finished
4881 * or aborted. This must be called to notify the completion of a CAC process,
4882 * also by full-MAC drivers.
4883 */
4884void cfg80211_cac_event(struct net_device *netdev,
4885			const struct cfg80211_chan_def *chandef,
4886			enum nl80211_radar_event event, gfp_t gfp);
4887
4888
4889/**
4890 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4891 * @dev: network device
4892 * @bssid: BSSID of AP (to avoid races)
4893 * @replay_ctr: new replay counter
4894 * @gfp: allocation flags
4895 */
4896void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4897			       const u8 *replay_ctr, gfp_t gfp);
4898
4899/**
4900 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4901 * @dev: network device
4902 * @index: candidate index (the smaller the index, the higher the priority)
4903 * @bssid: BSSID of AP
4904 * @preauth: Whether AP advertises support for RSN pre-authentication
4905 * @gfp: allocation flags
4906 */
4907void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4908				     const u8 *bssid, bool preauth, gfp_t gfp);
4909
4910/**
4911 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4912 * @dev: The device the frame matched to
4913 * @addr: the transmitter address
4914 * @gfp: context flags
4915 *
4916 * This function is used in AP mode (only!) to inform userspace that
4917 * a spurious class 3 frame was received, to be able to deauth the
4918 * sender.
4919 * Return: %true if the frame was passed to userspace (or this failed
4920 * for a reason other than not having a subscription.)
4921 */
4922bool cfg80211_rx_spurious_frame(struct net_device *dev,
4923				const u8 *addr, gfp_t gfp);
4924
4925/**
4926 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4927 * @dev: The device the frame matched to
4928 * @addr: the transmitter address
4929 * @gfp: context flags
4930 *
4931 * This function is used in AP mode (only!) to inform userspace that
4932 * an associated station sent a 4addr frame but that wasn't expected.
4933 * It is allowed and desirable to send this event only once for each
4934 * station to avoid event flooding.
4935 * Return: %true if the frame was passed to userspace (or this failed
4936 * for a reason other than not having a subscription.)
4937 */
4938bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4939					const u8 *addr, gfp_t gfp);
4940
4941/**
4942 * cfg80211_probe_status - notify userspace about probe status
4943 * @dev: the device the probe was sent on
4944 * @addr: the address of the peer
4945 * @cookie: the cookie filled in @probe_client previously
4946 * @acked: indicates whether probe was acked or not
4947 * @gfp: allocation flags
4948 */
4949void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4950			   u64 cookie, bool acked, gfp_t gfp);
4951
4952/**
4953 * cfg80211_report_obss_beacon - report beacon from other APs
4954 * @wiphy: The wiphy that received the beacon
4955 * @frame: the frame
4956 * @len: length of the frame
4957 * @freq: frequency the frame was received on
4958 * @sig_dbm: signal strength in mBm, or 0 if unknown
4959 *
4960 * Use this function to report to userspace when a beacon was
4961 * received. It is not useful to call this when there is no
4962 * netdev that is in AP/GO mode.
4963 */
4964void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4965				 const u8 *frame, size_t len,
4966				 int freq, int sig_dbm);
4967
4968/**
4969 * cfg80211_reg_can_beacon - check if beaconing is allowed
4970 * @wiphy: the wiphy
4971 * @chandef: the channel definition
4972 * @iftype: interface type
4973 *
4974 * Return: %true if there is no secondary channel or the secondary channel(s)
4975 * can be used for beaconing (i.e. is not a radar channel etc.)
4976 */
4977bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4978			     struct cfg80211_chan_def *chandef,
4979			     enum nl80211_iftype iftype);
4980
4981/**
4982 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
4983 * @wiphy: the wiphy
4984 * @chandef: the channel definition
4985 * @iftype: interface type
4986 *
4987 * Return: %true if there is no secondary channel or the secondary channel(s)
4988 * can be used for beaconing (i.e. is not a radar channel etc.). This version
4989 * also checks if IR-relaxation conditions apply, to allow beaconing under
4990 * more permissive conditions.
4991 *
4992 * Requires the RTNL to be held.
4993 */
4994bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
4995				   struct cfg80211_chan_def *chandef,
4996				   enum nl80211_iftype iftype);
4997
4998/*
4999 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5000 * @dev: the device which switched channels
5001 * @chandef: the new channel definition
5002 *
5003 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5004 * driver context!
5005 */
5006void cfg80211_ch_switch_notify(struct net_device *dev,
5007			       struct cfg80211_chan_def *chandef);
5008
5009/*
5010 * cfg80211_ch_switch_started_notify - notify channel switch start
5011 * @dev: the device on which the channel switch started
5012 * @chandef: the future channel definition
5013 * @count: the number of TBTTs until the channel switch happens
5014 *
5015 * Inform the userspace about the channel switch that has just
5016 * started, so that it can take appropriate actions (eg. starting
5017 * channel switch on other vifs), if necessary.
5018 */
5019void cfg80211_ch_switch_started_notify(struct net_device *dev,
5020				       struct cfg80211_chan_def *chandef,
5021				       u8 count);
5022
5023/**
5024 * ieee80211_operating_class_to_band - convert operating class to band
5025 *
5026 * @operating_class: the operating class to convert
5027 * @band: band pointer to fill
5028 *
5029 * Returns %true if the conversion was successful, %false otherwise.
5030 */
5031bool ieee80211_operating_class_to_band(u8 operating_class,
5032				       enum ieee80211_band *band);
5033
5034/**
5035 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5036 *
5037 * @chandef: the chandef to convert
5038 * @op_class: a pointer to the resulting operating class
5039 *
5040 * Returns %true if the conversion was successful, %false otherwise.
5041 */
5042bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5043					  u8 *op_class);
5044
5045/*
5046 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5047 * @dev: the device on which the operation is requested
5048 * @peer: the MAC address of the peer device
5049 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5050 *	NL80211_TDLS_TEARDOWN)
5051 * @reason_code: the reason code for teardown request
5052 * @gfp: allocation flags
5053 *
5054 * This function is used to request userspace to perform TDLS operation that
5055 * requires knowledge of keys, i.e., link setup or teardown when the AP
5056 * connection uses encryption. This is optional mechanism for the driver to use
5057 * if it can automatically determine when a TDLS link could be useful (e.g.,
5058 * based on traffic and signal strength for a peer).
5059 */
5060void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5061				enum nl80211_tdls_operation oper,
5062				u16 reason_code, gfp_t gfp);
5063
5064/*
5065 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5066 * @rate: given rate_info to calculate bitrate from
5067 *
5068 * return 0 if MCS index >= 32
5069 */
5070u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5071
5072/**
5073 * cfg80211_unregister_wdev - remove the given wdev
5074 * @wdev: struct wireless_dev to remove
5075 *
5076 * Call this function only for wdevs that have no netdev assigned,
5077 * e.g. P2P Devices. It removes the device from the list so that
5078 * it can no longer be used. It is necessary to call this function
5079 * even when cfg80211 requests the removal of the interface by
5080 * calling the del_virtual_intf() callback. The function must also
5081 * be called when the driver wishes to unregister the wdev, e.g.
5082 * when the device is unbound from the driver.
5083 *
5084 * Requires the RTNL to be held.
5085 */
5086void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5087
5088/**
5089 * struct cfg80211_ft_event - FT Information Elements
5090 * @ies: FT IEs
5091 * @ies_len: length of the FT IE in bytes
5092 * @target_ap: target AP's MAC address
5093 * @ric_ies: RIC IE
5094 * @ric_ies_len: length of the RIC IE in bytes
5095 */
5096struct cfg80211_ft_event_params {
5097	const u8 *ies;
5098	size_t ies_len;
5099	const u8 *target_ap;
5100	const u8 *ric_ies;
5101	size_t ric_ies_len;
5102};
5103
5104/**
5105 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5106 * @netdev: network device
5107 * @ft_event: IE information
5108 */
5109void cfg80211_ft_event(struct net_device *netdev,
5110		       struct cfg80211_ft_event_params *ft_event);
5111
5112/**
5113 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5114 * @ies: the input IE buffer
5115 * @len: the input length
5116 * @attr: the attribute ID to find
5117 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5118 *	if the function is only called to get the needed buffer size
5119 * @bufsize: size of the output buffer
5120 *
5121 * The function finds a given P2P attribute in the (vendor) IEs and
5122 * copies its contents to the given buffer.
5123 *
5124 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5125 * malformed or the attribute can't be found (respectively), or the
5126 * length of the found attribute (which can be zero).
5127 */
5128int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5129			  enum ieee80211_p2p_attr_id attr,
5130			  u8 *buf, unsigned int bufsize);
5131
5132/**
5133 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5134 * @ies: the IE buffer
5135 * @ielen: the length of the IE buffer
5136 * @ids: an array with element IDs that are allowed before
5137 *	the split
5138 * @n_ids: the size of the element ID array
5139 * @after_ric: array IE types that come after the RIC element
5140 * @n_after_ric: size of the @after_ric array
5141 * @offset: offset where to start splitting in the buffer
5142 *
5143 * This function splits an IE buffer by updating the @offset
5144 * variable to point to the location where the buffer should be
5145 * split.
5146 *
5147 * It assumes that the given IE buffer is well-formed, this
5148 * has to be guaranteed by the caller!
5149 *
5150 * It also assumes that the IEs in the buffer are ordered
5151 * correctly, if not the result of using this function will not
5152 * be ordered correctly either, i.e. it does no reordering.
5153 *
5154 * The function returns the offset where the next part of the
5155 * buffer starts, which may be @ielen if the entire (remainder)
5156 * of the buffer should be used.
5157 */
5158size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5159			      const u8 *ids, int n_ids,
5160			      const u8 *after_ric, int n_after_ric,
5161			      size_t offset);
5162
5163/**
5164 * ieee80211_ie_split - split an IE buffer according to ordering
5165 * @ies: the IE buffer
5166 * @ielen: the length of the IE buffer
5167 * @ids: an array with element IDs that are allowed before
5168 *	the split
5169 * @n_ids: the size of the element ID array
5170 * @offset: offset where to start splitting in the buffer
5171 *
5172 * This function splits an IE buffer by updating the @offset
5173 * variable to point to the location where the buffer should be
5174 * split.
5175 *
5176 * It assumes that the given IE buffer is well-formed, this
5177 * has to be guaranteed by the caller!
5178 *
5179 * It also assumes that the IEs in the buffer are ordered
5180 * correctly, if not the result of using this function will not
5181 * be ordered correctly either, i.e. it does no reordering.
5182 *
5183 * The function returns the offset where the next part of the
5184 * buffer starts, which may be @ielen if the entire (remainder)
5185 * of the buffer should be used.
5186 */
5187static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5188					const u8 *ids, int n_ids, size_t offset)
5189{
5190	return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
5191}
5192
5193/**
5194 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5195 * @wdev: the wireless device reporting the wakeup
5196 * @wakeup: the wakeup report
5197 * @gfp: allocation flags
5198 *
5199 * This function reports that the given device woke up. If it
5200 * caused the wakeup, report the reason(s), otherwise you may
5201 * pass %NULL as the @wakeup parameter to advertise that something
5202 * else caused the wakeup.
5203 */
5204void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5205				   struct cfg80211_wowlan_wakeup *wakeup,
5206				   gfp_t gfp);
5207
5208/**
5209 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5210 *
5211 * @wdev: the wireless device for which critical protocol is stopped.
5212 * @gfp: allocation flags
5213 *
5214 * This function can be called by the driver to indicate it has reverted
5215 * operation back to normal. One reason could be that the duration given
5216 * by .crit_proto_start() has expired.
5217 */
5218void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5219
5220/**
5221 * ieee80211_get_num_supported_channels - get number of channels device has
5222 * @wiphy: the wiphy
5223 *
5224 * Return: the number of channels supported by the device.
5225 */
5226unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5227
5228/**
5229 * cfg80211_check_combinations - check interface combinations
5230 *
5231 * @wiphy: the wiphy
5232 * @num_different_channels: the number of different channels we want
5233 *	to use for verification
5234 * @radar_detect: a bitmap where each bit corresponds to a channel
5235 *	width where radar detection is needed, as in the definition of
5236 *	&struct ieee80211_iface_combination.@radar_detect_widths
5237 * @iftype_num: array with the numbers of interfaces of each interface
5238 *	type.  The index is the interface type as specified in &enum
5239 *	nl80211_iftype.
5240 *
5241 * This function can be called by the driver to check whether a
5242 * combination of interfaces and their types are allowed according to
5243 * the interface combinations.
5244 */
5245int cfg80211_check_combinations(struct wiphy *wiphy,
5246				const int num_different_channels,
5247				const u8 radar_detect,
5248				const int iftype_num[NUM_NL80211_IFTYPES]);
5249
5250/**
5251 * cfg80211_iter_combinations - iterate over matching combinations
5252 *
5253 * @wiphy: the wiphy
5254 * @num_different_channels: the number of different channels we want
5255 *	to use for verification
5256 * @radar_detect: a bitmap where each bit corresponds to a channel
5257 *	width where radar detection is needed, as in the definition of
5258 *	&struct ieee80211_iface_combination.@radar_detect_widths
5259 * @iftype_num: array with the numbers of interfaces of each interface
5260 *	type.  The index is the interface type as specified in &enum
5261 *	nl80211_iftype.
5262 * @iter: function to call for each matching combination
5263 * @data: pointer to pass to iter function
5264 *
5265 * This function can be called by the driver to check what possible
5266 * combinations it fits in at a given moment, e.g. for channel switching
5267 * purposes.
5268 */
5269int cfg80211_iter_combinations(struct wiphy *wiphy,
5270			       const int num_different_channels,
5271			       const u8 radar_detect,
5272			       const int iftype_num[NUM_NL80211_IFTYPES],
5273			       void (*iter)(const struct ieee80211_iface_combination *c,
5274					    void *data),
5275			       void *data);
5276
5277/*
5278 * cfg80211_stop_iface - trigger interface disconnection
5279 *
5280 * @wiphy: the wiphy
5281 * @wdev: wireless device
5282 * @gfp: context flags
5283 *
5284 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5285 * disconnected.
5286 *
5287 * Note: This doesn't need any locks and is asynchronous.
5288 */
5289void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5290			 gfp_t gfp);
5291
5292/**
5293 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5294 * @wiphy: the wiphy to shut down
5295 *
5296 * This function shuts down all interfaces belonging to this wiphy by
5297 * calling dev_close() (and treating non-netdev interfaces as needed).
5298 * It shouldn't really be used unless there are some fatal device errors
5299 * that really can't be recovered in any other way.
5300 *
5301 * Callers must hold the RTNL and be able to deal with callbacks into
5302 * the driver while the function is running.
5303 */
5304void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5305
5306/**
5307 * wiphy_ext_feature_set - set the extended feature flag
5308 *
5309 * @wiphy: the wiphy to modify.
5310 * @ftidx: extended feature bit index.
5311 *
5312 * The extended features are flagged in multiple bytes (see
5313 * &struct wiphy.@ext_features)
5314 */
5315static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5316					 enum nl80211_ext_feature_index ftidx)
5317{
5318	u8 *ft_byte;
5319
5320	ft_byte = &wiphy->ext_features[ftidx / 8];
5321	*ft_byte |= BIT(ftidx % 8);
5322}
5323
5324/**
5325 * wiphy_ext_feature_isset - check the extended feature flag
5326 *
5327 * @wiphy: the wiphy to modify.
5328 * @ftidx: extended feature bit index.
5329 *
5330 * The extended features are flagged in multiple bytes (see
5331 * &struct wiphy.@ext_features)
5332 */
5333static inline bool
5334wiphy_ext_feature_isset(struct wiphy *wiphy,
5335			enum nl80211_ext_feature_index ftidx)
5336{
5337	u8 ft_byte;
5338
5339	ft_byte = wiphy->ext_features[ftidx / 8];
5340	return (ft_byte & BIT(ftidx % 8)) != 0;
5341}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5342
5343/* ethtool helper */
5344void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5345
5346/* Logging, debugging and troubleshooting/diagnostic helpers. */
5347
5348/* wiphy_printk helpers, similar to dev_printk */
5349
5350#define wiphy_printk(level, wiphy, format, args...)		\
5351	dev_printk(level, &(wiphy)->dev, format, ##args)
5352#define wiphy_emerg(wiphy, format, args...)			\
5353	dev_emerg(&(wiphy)->dev, format, ##args)
5354#define wiphy_alert(wiphy, format, args...)			\
5355	dev_alert(&(wiphy)->dev, format, ##args)
5356#define wiphy_crit(wiphy, format, args...)			\
5357	dev_crit(&(wiphy)->dev, format, ##args)
5358#define wiphy_err(wiphy, format, args...)			\
5359	dev_err(&(wiphy)->dev, format, ##args)
5360#define wiphy_warn(wiphy, format, args...)			\
5361	dev_warn(&(wiphy)->dev, format, ##args)
5362#define wiphy_notice(wiphy, format, args...)			\
5363	dev_notice(&(wiphy)->dev, format, ##args)
5364#define wiphy_info(wiphy, format, args...)			\
5365	dev_info(&(wiphy)->dev, format, ##args)
5366
5367#define wiphy_debug(wiphy, format, args...)			\
5368	wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5369
5370#define wiphy_dbg(wiphy, format, args...)			\
5371	dev_dbg(&(wiphy)->dev, format, ##args)
5372
5373#if defined(VERBOSE_DEBUG)
5374#define wiphy_vdbg	wiphy_dbg
5375#else
5376#define wiphy_vdbg(wiphy, format, args...)				\
5377({									\
5378	if (0)								\
5379		wiphy_printk(KERN_DEBUG, wiphy, format, ##args);	\
5380	0;								\
5381})
5382#endif
5383
5384/*
5385 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5386 * of using a WARN/WARN_ON to get the message out, including the
5387 * file/line information and a backtrace.
5388 */
5389#define wiphy_WARN(wiphy, format, args...)			\
5390	WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5391
5392#endif /* __NET_CFG80211_H */
v4.10.11
   1#ifndef __NET_CFG80211_H
   2#define __NET_CFG80211_H
   3/*
   4 * 802.11 device and configuration interface
   5 *
   6 * Copyright 2006-2010	Johannes Berg <johannes@sipsolutions.net>
   7 * Copyright 2013-2014 Intel Mobile Communications GmbH
   8 * Copyright 2015-2016	Intel Deutschland GmbH
   9 *
  10 * This program is free software; you can redistribute it and/or modify
  11 * it under the terms of the GNU General Public License version 2 as
  12 * published by the Free Software Foundation.
  13 */
  14
  15#include <linux/netdevice.h>
  16#include <linux/debugfs.h>
  17#include <linux/list.h>
  18#include <linux/bug.h>
  19#include <linux/netlink.h>
  20#include <linux/skbuff.h>
  21#include <linux/nl80211.h>
  22#include <linux/if_ether.h>
  23#include <linux/ieee80211.h>
  24#include <linux/net.h>
  25#include <net/regulatory.h>
  26
  27/**
  28 * DOC: Introduction
  29 *
  30 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
  31 * userspace and drivers, and offers some utility functionality associated
  32 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
  33 * by all modern wireless drivers in Linux, so that they offer a consistent
  34 * API through nl80211. For backward compatibility, cfg80211 also offers
  35 * wireless extensions to userspace, but hides them from drivers completely.
  36 *
  37 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
  38 * use restrictions.
  39 */
  40
  41
  42/**
  43 * DOC: Device registration
  44 *
  45 * In order for a driver to use cfg80211, it must register the hardware device
  46 * with cfg80211. This happens through a number of hardware capability structs
  47 * described below.
  48 *
  49 * The fundamental structure for each device is the 'wiphy', of which each
  50 * instance describes a physical wireless device connected to the system. Each
  51 * such wiphy can have zero, one, or many virtual interfaces associated with
  52 * it, which need to be identified as such by pointing the network interface's
  53 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
  54 * the wireless part of the interface, normally this struct is embedded in the
  55 * network interface's private data area. Drivers can optionally allow creating
  56 * or destroying virtual interfaces on the fly, but without at least one or the
  57 * ability to create some the wireless device isn't useful.
  58 *
  59 * Each wiphy structure contains device capability information, and also has
  60 * a pointer to the various operations the driver offers. The definitions and
  61 * structures here describe these capabilities in detail.
  62 */
  63
  64struct wiphy;
  65
  66/*
  67 * wireless hardware capability structures
  68 */
  69
  70/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  71 * enum ieee80211_channel_flags - channel flags
  72 *
  73 * Channel flags set by the regulatory control code.
  74 *
  75 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
  76 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
  77 * 	sending probe requests or beaconing.
  78 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
  79 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
  80 * 	is not permitted.
  81 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
  82 * 	is not permitted.
  83 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
  84 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
  85 *	this flag indicates that an 80 MHz channel cannot use this
  86 *	channel as the control or any of the secondary channels.
  87 *	This may be due to the driver or due to regulatory bandwidth
  88 *	restrictions.
  89 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
  90 *	this flag indicates that an 160 MHz channel cannot use this
  91 *	channel as the control or any of the secondary channels.
  92 *	This may be due to the driver or due to regulatory bandwidth
  93 *	restrictions.
  94 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
  95 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
  96 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
  97 *	on this channel.
  98 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
  99 *	on this channel.
 100 *
 101 */
 102enum ieee80211_channel_flags {
 103	IEEE80211_CHAN_DISABLED		= 1<<0,
 104	IEEE80211_CHAN_NO_IR		= 1<<1,
 105	/* hole at 1<<2 */
 106	IEEE80211_CHAN_RADAR		= 1<<3,
 107	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
 108	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
 109	IEEE80211_CHAN_NO_OFDM		= 1<<6,
 110	IEEE80211_CHAN_NO_80MHZ		= 1<<7,
 111	IEEE80211_CHAN_NO_160MHZ	= 1<<8,
 112	IEEE80211_CHAN_INDOOR_ONLY	= 1<<9,
 113	IEEE80211_CHAN_IR_CONCURRENT	= 1<<10,
 114	IEEE80211_CHAN_NO_20MHZ		= 1<<11,
 115	IEEE80211_CHAN_NO_10MHZ		= 1<<12,
 116};
 117
 118#define IEEE80211_CHAN_NO_HT40 \
 119	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
 120
 121#define IEEE80211_DFS_MIN_CAC_TIME_MS		60000
 122#define IEEE80211_DFS_MIN_NOP_TIME_MS		(30 * 60 * 1000)
 123
 124/**
 125 * struct ieee80211_channel - channel definition
 126 *
 127 * This structure describes a single channel for use
 128 * with cfg80211.
 129 *
 130 * @center_freq: center frequency in MHz
 131 * @hw_value: hardware-specific value for the channel
 132 * @flags: channel flags from &enum ieee80211_channel_flags.
 133 * @orig_flags: channel flags at registration time, used by regulatory
 134 *	code to support devices with additional restrictions
 135 * @band: band this channel belongs to.
 136 * @max_antenna_gain: maximum antenna gain in dBi
 137 * @max_power: maximum transmission power (in dBm)
 138 * @max_reg_power: maximum regulatory transmission power (in dBm)
 139 * @beacon_found: helper to regulatory code to indicate when a beacon
 140 *	has been found on this channel. Use regulatory_hint_found_beacon()
 141 *	to enable this, this is useful only on 5 GHz band.
 142 * @orig_mag: internal use
 143 * @orig_mpwr: internal use
 144 * @dfs_state: current state of this channel. Only relevant if radar is required
 145 *	on this channel.
 146 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
 147 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
 148 */
 149struct ieee80211_channel {
 150	enum nl80211_band band;
 151	u16 center_freq;
 152	u16 hw_value;
 153	u32 flags;
 154	int max_antenna_gain;
 155	int max_power;
 156	int max_reg_power;
 157	bool beacon_found;
 158	u32 orig_flags;
 159	int orig_mag, orig_mpwr;
 160	enum nl80211_dfs_state dfs_state;
 161	unsigned long dfs_state_entered;
 162	unsigned int dfs_cac_ms;
 163};
 164
 165/**
 166 * enum ieee80211_rate_flags - rate flags
 167 *
 168 * Hardware/specification flags for rates. These are structured
 169 * in a way that allows using the same bitrate structure for
 170 * different bands/PHY modes.
 171 *
 172 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
 173 *	preamble on this bitrate; only relevant in 2.4GHz band and
 174 *	with CCK rates.
 175 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
 176 *	when used with 802.11a (on the 5 GHz band); filled by the
 177 *	core code when registering the wiphy.
 178 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
 179 *	when used with 802.11b (on the 2.4 GHz band); filled by the
 180 *	core code when registering the wiphy.
 181 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
 182 *	when used with 802.11g (on the 2.4 GHz band); filled by the
 183 *	core code when registering the wiphy.
 184 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
 185 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
 186 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
 187 */
 188enum ieee80211_rate_flags {
 189	IEEE80211_RATE_SHORT_PREAMBLE	= 1<<0,
 190	IEEE80211_RATE_MANDATORY_A	= 1<<1,
 191	IEEE80211_RATE_MANDATORY_B	= 1<<2,
 192	IEEE80211_RATE_MANDATORY_G	= 1<<3,
 193	IEEE80211_RATE_ERP_G		= 1<<4,
 194	IEEE80211_RATE_SUPPORTS_5MHZ	= 1<<5,
 195	IEEE80211_RATE_SUPPORTS_10MHZ	= 1<<6,
 196};
 197
 198/**
 199 * enum ieee80211_bss_type - BSS type filter
 200 *
 201 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
 202 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
 203 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
 204 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
 205 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
 206 */
 207enum ieee80211_bss_type {
 208	IEEE80211_BSS_TYPE_ESS,
 209	IEEE80211_BSS_TYPE_PBSS,
 210	IEEE80211_BSS_TYPE_IBSS,
 211	IEEE80211_BSS_TYPE_MBSS,
 212	IEEE80211_BSS_TYPE_ANY
 213};
 214
 215/**
 216 * enum ieee80211_privacy - BSS privacy filter
 217 *
 218 * @IEEE80211_PRIVACY_ON: privacy bit set
 219 * @IEEE80211_PRIVACY_OFF: privacy bit clear
 220 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
 221 */
 222enum ieee80211_privacy {
 223	IEEE80211_PRIVACY_ON,
 224	IEEE80211_PRIVACY_OFF,
 225	IEEE80211_PRIVACY_ANY
 226};
 227
 228#define IEEE80211_PRIVACY(x)	\
 229	((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
 230
 231/**
 232 * struct ieee80211_rate - bitrate definition
 233 *
 234 * This structure describes a bitrate that an 802.11 PHY can
 235 * operate with. The two values @hw_value and @hw_value_short
 236 * are only for driver use when pointers to this structure are
 237 * passed around.
 238 *
 239 * @flags: rate-specific flags
 240 * @bitrate: bitrate in units of 100 Kbps
 241 * @hw_value: driver/hardware value for this rate
 242 * @hw_value_short: driver/hardware value for this rate when
 243 *	short preamble is used
 244 */
 245struct ieee80211_rate {
 246	u32 flags;
 247	u16 bitrate;
 248	u16 hw_value, hw_value_short;
 249};
 250
 251/**
 252 * struct ieee80211_sta_ht_cap - STA's HT capabilities
 253 *
 254 * This structure describes most essential parameters needed
 255 * to describe 802.11n HT capabilities for an STA.
 256 *
 257 * @ht_supported: is HT supported by the STA
 258 * @cap: HT capabilities map as described in 802.11n spec
 259 * @ampdu_factor: Maximum A-MPDU length factor
 260 * @ampdu_density: Minimum A-MPDU spacing
 261 * @mcs: Supported MCS rates
 262 */
 263struct ieee80211_sta_ht_cap {
 264	u16 cap; /* use IEEE80211_HT_CAP_ */
 265	bool ht_supported;
 266	u8 ampdu_factor;
 267	u8 ampdu_density;
 268	struct ieee80211_mcs_info mcs;
 269};
 270
 271/**
 272 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
 273 *
 274 * This structure describes most essential parameters needed
 275 * to describe 802.11ac VHT capabilities for an STA.
 276 *
 277 * @vht_supported: is VHT supported by the STA
 278 * @cap: VHT capabilities map as described in 802.11ac spec
 279 * @vht_mcs: Supported VHT MCS rates
 280 */
 281struct ieee80211_sta_vht_cap {
 282	bool vht_supported;
 283	u32 cap; /* use IEEE80211_VHT_CAP_ */
 284	struct ieee80211_vht_mcs_info vht_mcs;
 285};
 286
 287/**
 288 * struct ieee80211_supported_band - frequency band definition
 289 *
 290 * This structure describes a frequency band a wiphy
 291 * is able to operate in.
 292 *
 293 * @channels: Array of channels the hardware can operate in
 294 *	in this band.
 295 * @band: the band this structure represents
 296 * @n_channels: Number of channels in @channels
 297 * @bitrates: Array of bitrates the hardware can operate with
 298 *	in this band. Must be sorted to give a valid "supported
 299 *	rates" IE, i.e. CCK rates first, then OFDM.
 300 * @n_bitrates: Number of bitrates in @bitrates
 301 * @ht_cap: HT capabilities in this band
 302 * @vht_cap: VHT capabilities in this band
 303 */
 304struct ieee80211_supported_band {
 305	struct ieee80211_channel *channels;
 306	struct ieee80211_rate *bitrates;
 307	enum nl80211_band band;
 308	int n_channels;
 309	int n_bitrates;
 310	struct ieee80211_sta_ht_cap ht_cap;
 311	struct ieee80211_sta_vht_cap vht_cap;
 312};
 313
 314/*
 315 * Wireless hardware/device configuration structures and methods
 316 */
 317
 318/**
 319 * DOC: Actions and configuration
 320 *
 321 * Each wireless device and each virtual interface offer a set of configuration
 322 * operations and other actions that are invoked by userspace. Each of these
 323 * actions is described in the operations structure, and the parameters these
 324 * operations use are described separately.
 325 *
 326 * Additionally, some operations are asynchronous and expect to get status
 327 * information via some functions that drivers need to call.
 328 *
 329 * Scanning and BSS list handling with its associated functionality is described
 330 * in a separate chapter.
 331 */
 332
 333#define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
 334				    WLAN_USER_POSITION_LEN)
 335
 336/**
 337 * struct vif_params - describes virtual interface parameters
 338 * @use_4addr: use 4-address frames
 339 * @macaddr: address to use for this virtual interface.
 340 *	If this parameter is set to zero address the driver may
 341 *	determine the address as needed.
 342 *	This feature is only fully supported by drivers that enable the
 343 *	%NL80211_FEATURE_MAC_ON_CREATE flag.  Others may support creating
 344 **	only p2p devices with specified MAC.
 345 * @vht_mumimo_groups: MU-MIMO groupID. used for monitoring only
 346 *	 packets belonging to that MU-MIMO groupID.
 347 */
 348struct vif_params {
 349	int use_4addr;
 350	u8 macaddr[ETH_ALEN];
 351	u8 vht_mumimo_groups[VHT_MUMIMO_GROUPS_DATA_LEN];
 352};
 353
 354/**
 355 * struct key_params - key information
 356 *
 357 * Information about a key
 358 *
 359 * @key: key material
 360 * @key_len: length of key material
 361 * @cipher: cipher suite selector
 362 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
 363 *	with the get_key() callback, must be in little endian,
 364 *	length given by @seq_len.
 365 * @seq_len: length of @seq.
 366 */
 367struct key_params {
 368	const u8 *key;
 369	const u8 *seq;
 370	int key_len;
 371	int seq_len;
 372	u32 cipher;
 373};
 374
 375/**
 376 * struct cfg80211_chan_def - channel definition
 377 * @chan: the (control) channel
 378 * @width: channel width
 379 * @center_freq1: center frequency of first segment
 380 * @center_freq2: center frequency of second segment
 381 *	(only with 80+80 MHz)
 382 */
 383struct cfg80211_chan_def {
 384	struct ieee80211_channel *chan;
 385	enum nl80211_chan_width width;
 386	u32 center_freq1;
 387	u32 center_freq2;
 388};
 389
 390/**
 391 * cfg80211_get_chandef_type - return old channel type from chandef
 392 * @chandef: the channel definition
 393 *
 394 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
 395 * chandef, which must have a bandwidth allowing this conversion.
 396 */
 397static inline enum nl80211_channel_type
 398cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
 399{
 400	switch (chandef->width) {
 401	case NL80211_CHAN_WIDTH_20_NOHT:
 402		return NL80211_CHAN_NO_HT;
 403	case NL80211_CHAN_WIDTH_20:
 404		return NL80211_CHAN_HT20;
 405	case NL80211_CHAN_WIDTH_40:
 406		if (chandef->center_freq1 > chandef->chan->center_freq)
 407			return NL80211_CHAN_HT40PLUS;
 408		return NL80211_CHAN_HT40MINUS;
 409	default:
 410		WARN_ON(1);
 411		return NL80211_CHAN_NO_HT;
 412	}
 413}
 414
 415/**
 416 * cfg80211_chandef_create - create channel definition using channel type
 417 * @chandef: the channel definition struct to fill
 418 * @channel: the control channel
 419 * @chantype: the channel type
 420 *
 421 * Given a channel type, create a channel definition.
 422 */
 423void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
 424			     struct ieee80211_channel *channel,
 425			     enum nl80211_channel_type chantype);
 426
 427/**
 428 * cfg80211_chandef_identical - check if two channel definitions are identical
 429 * @chandef1: first channel definition
 430 * @chandef2: second channel definition
 431 *
 432 * Return: %true if the channels defined by the channel definitions are
 433 * identical, %false otherwise.
 434 */
 435static inline bool
 436cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
 437			   const struct cfg80211_chan_def *chandef2)
 438{
 439	return (chandef1->chan == chandef2->chan &&
 440		chandef1->width == chandef2->width &&
 441		chandef1->center_freq1 == chandef2->center_freq1 &&
 442		chandef1->center_freq2 == chandef2->center_freq2);
 443}
 444
 445/**
 446 * cfg80211_chandef_compatible - check if two channel definitions are compatible
 447 * @chandef1: first channel definition
 448 * @chandef2: second channel definition
 449 *
 450 * Return: %NULL if the given channel definitions are incompatible,
 451 * chandef1 or chandef2 otherwise.
 452 */
 453const struct cfg80211_chan_def *
 454cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
 455			    const struct cfg80211_chan_def *chandef2);
 456
 457/**
 458 * cfg80211_chandef_valid - check if a channel definition is valid
 459 * @chandef: the channel definition to check
 460 * Return: %true if the channel definition is valid. %false otherwise.
 461 */
 462bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
 463
 464/**
 465 * cfg80211_chandef_usable - check if secondary channels can be used
 466 * @wiphy: the wiphy to validate against
 467 * @chandef: the channel definition to check
 468 * @prohibited_flags: the regulatory channel flags that must not be set
 469 * Return: %true if secondary channels are usable. %false otherwise.
 470 */
 471bool cfg80211_chandef_usable(struct wiphy *wiphy,
 472			     const struct cfg80211_chan_def *chandef,
 473			     u32 prohibited_flags);
 474
 475/**
 476 * cfg80211_chandef_dfs_required - checks if radar detection is required
 477 * @wiphy: the wiphy to validate against
 478 * @chandef: the channel definition to check
 479 * @iftype: the interface type as specified in &enum nl80211_iftype
 480 * Returns:
 481 *	1 if radar detection is required, 0 if it is not, < 0 on error
 482 */
 483int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
 484				  const struct cfg80211_chan_def *chandef,
 485				  enum nl80211_iftype iftype);
 486
 487/**
 488 * ieee80211_chandef_rate_flags - returns rate flags for a channel
 489 *
 490 * In some channel types, not all rates may be used - for example CCK
 491 * rates may not be used in 5/10 MHz channels.
 492 *
 493 * @chandef: channel definition for the channel
 494 *
 495 * Returns: rate flags which apply for this channel
 496 */
 497static inline enum ieee80211_rate_flags
 498ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
 499{
 500	switch (chandef->width) {
 501	case NL80211_CHAN_WIDTH_5:
 502		return IEEE80211_RATE_SUPPORTS_5MHZ;
 503	case NL80211_CHAN_WIDTH_10:
 504		return IEEE80211_RATE_SUPPORTS_10MHZ;
 505	default:
 506		break;
 507	}
 508	return 0;
 509}
 510
 511/**
 512 * ieee80211_chandef_max_power - maximum transmission power for the chandef
 513 *
 514 * In some regulations, the transmit power may depend on the configured channel
 515 * bandwidth which may be defined as dBm/MHz. This function returns the actual
 516 * max_power for non-standard (20 MHz) channels.
 517 *
 518 * @chandef: channel definition for the channel
 519 *
 520 * Returns: maximum allowed transmission power in dBm for the chandef
 521 */
 522static inline int
 523ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
 524{
 525	switch (chandef->width) {
 526	case NL80211_CHAN_WIDTH_5:
 527		return min(chandef->chan->max_reg_power - 6,
 528			   chandef->chan->max_power);
 529	case NL80211_CHAN_WIDTH_10:
 530		return min(chandef->chan->max_reg_power - 3,
 531			   chandef->chan->max_power);
 532	default:
 533		break;
 534	}
 535	return chandef->chan->max_power;
 536}
 537
 538/**
 539 * enum survey_info_flags - survey information flags
 540 *
 541 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
 542 * @SURVEY_INFO_IN_USE: channel is currently being used
 543 * @SURVEY_INFO_TIME: active time (in ms) was filled in
 544 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
 545 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
 546 * @SURVEY_INFO_TIME_RX: receive time was filled in
 547 * @SURVEY_INFO_TIME_TX: transmit time was filled in
 548 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
 549 *
 550 * Used by the driver to indicate which info in &struct survey_info
 551 * it has filled in during the get_survey().
 552 */
 553enum survey_info_flags {
 554	SURVEY_INFO_NOISE_DBM		= BIT(0),
 555	SURVEY_INFO_IN_USE		= BIT(1),
 556	SURVEY_INFO_TIME		= BIT(2),
 557	SURVEY_INFO_TIME_BUSY		= BIT(3),
 558	SURVEY_INFO_TIME_EXT_BUSY	= BIT(4),
 559	SURVEY_INFO_TIME_RX		= BIT(5),
 560	SURVEY_INFO_TIME_TX		= BIT(6),
 561	SURVEY_INFO_TIME_SCAN		= BIT(7),
 562};
 563
 564/**
 565 * struct survey_info - channel survey response
 566 *
 567 * @channel: the channel this survey record reports, may be %NULL for a single
 568 *	record to report global statistics
 569 * @filled: bitflag of flags from &enum survey_info_flags
 570 * @noise: channel noise in dBm. This and all following fields are
 571 *	optional
 572 * @time: amount of time in ms the radio was turn on (on the channel)
 573 * @time_busy: amount of time the primary channel was sensed busy
 574 * @time_ext_busy: amount of time the extension channel was sensed busy
 575 * @time_rx: amount of time the radio spent receiving data
 576 * @time_tx: amount of time the radio spent transmitting data
 577 * @time_scan: amount of time the radio spent for scanning
 578 *
 579 * Used by dump_survey() to report back per-channel survey information.
 580 *
 581 * This structure can later be expanded with things like
 582 * channel duty cycle etc.
 583 */
 584struct survey_info {
 585	struct ieee80211_channel *channel;
 586	u64 time;
 587	u64 time_busy;
 588	u64 time_ext_busy;
 589	u64 time_rx;
 590	u64 time_tx;
 591	u64 time_scan;
 592	u32 filled;
 593	s8 noise;
 594};
 595
 596#define CFG80211_MAX_WEP_KEYS	4
 597
 598/**
 599 * struct cfg80211_crypto_settings - Crypto settings
 600 * @wpa_versions: indicates which, if any, WPA versions are enabled
 601 *	(from enum nl80211_wpa_versions)
 602 * @cipher_group: group key cipher suite (or 0 if unset)
 603 * @n_ciphers_pairwise: number of AP supported unicast ciphers
 604 * @ciphers_pairwise: unicast key cipher suites
 605 * @n_akm_suites: number of AKM suites
 606 * @akm_suites: AKM suites
 607 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
 608 *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 609 *	required to assume that the port is unauthorized until authorized by
 610 *	user space. Otherwise, port is marked authorized by default.
 611 * @control_port_ethertype: the control port protocol that should be
 612 *	allowed through even on unauthorized ports
 613 * @control_port_no_encrypt: TRUE to prevent encryption of control port
 614 *	protocol frames.
 615 * @wep_keys: static WEP keys, if not NULL points to an array of
 616 *	CFG80211_MAX_WEP_KEYS WEP keys
 617 * @wep_tx_key: key index (0..3) of the default TX static WEP key
 618 */
 619struct cfg80211_crypto_settings {
 620	u32 wpa_versions;
 621	u32 cipher_group;
 622	int n_ciphers_pairwise;
 623	u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
 624	int n_akm_suites;
 625	u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
 626	bool control_port;
 627	__be16 control_port_ethertype;
 628	bool control_port_no_encrypt;
 629	struct key_params *wep_keys;
 630	int wep_tx_key;
 631};
 632
 633/**
 634 * struct cfg80211_beacon_data - beacon data
 635 * @head: head portion of beacon (before TIM IE)
 636 *	or %NULL if not changed
 637 * @tail: tail portion of beacon (after TIM IE)
 638 *	or %NULL if not changed
 639 * @head_len: length of @head
 640 * @tail_len: length of @tail
 641 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
 642 * @beacon_ies_len: length of beacon_ies in octets
 643 * @proberesp_ies: extra information element(s) to add into Probe Response
 644 *	frames or %NULL
 645 * @proberesp_ies_len: length of proberesp_ies in octets
 646 * @assocresp_ies: extra information element(s) to add into (Re)Association
 647 *	Response frames or %NULL
 648 * @assocresp_ies_len: length of assocresp_ies in octets
 649 * @probe_resp_len: length of probe response template (@probe_resp)
 650 * @probe_resp: probe response template (AP mode only)
 651 */
 652struct cfg80211_beacon_data {
 653	const u8 *head, *tail;
 654	const u8 *beacon_ies;
 655	const u8 *proberesp_ies;
 656	const u8 *assocresp_ies;
 657	const u8 *probe_resp;
 658
 659	size_t head_len, tail_len;
 660	size_t beacon_ies_len;
 661	size_t proberesp_ies_len;
 662	size_t assocresp_ies_len;
 663	size_t probe_resp_len;
 664};
 665
 666struct mac_address {
 667	u8 addr[ETH_ALEN];
 668};
 669
 670/**
 671 * struct cfg80211_acl_data - Access control list data
 672 *
 673 * @acl_policy: ACL policy to be applied on the station's
 674 *	entry specified by mac_addr
 675 * @n_acl_entries: Number of MAC address entries passed
 676 * @mac_addrs: List of MAC addresses of stations to be used for ACL
 677 */
 678struct cfg80211_acl_data {
 679	enum nl80211_acl_policy acl_policy;
 680	int n_acl_entries;
 681
 682	/* Keep it last */
 683	struct mac_address mac_addrs[];
 684};
 685
 686/*
 687 * cfg80211_bitrate_mask - masks for bitrate control
 688 */
 689struct cfg80211_bitrate_mask {
 690	struct {
 691		u32 legacy;
 692		u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
 693		u16 vht_mcs[NL80211_VHT_NSS_MAX];
 694		enum nl80211_txrate_gi gi;
 695	} control[NUM_NL80211_BANDS];
 696};
 697
 698/**
 699 * struct cfg80211_ap_settings - AP configuration
 700 *
 701 * Used to configure an AP interface.
 702 *
 703 * @chandef: defines the channel to use
 704 * @beacon: beacon data
 705 * @beacon_interval: beacon interval
 706 * @dtim_period: DTIM period
 707 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
 708 *	user space)
 709 * @ssid_len: length of @ssid
 710 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
 711 * @crypto: crypto settings
 712 * @privacy: the BSS uses privacy
 713 * @auth_type: Authentication type (algorithm)
 714 * @smps_mode: SMPS mode
 715 * @inactivity_timeout: time in seconds to determine station's inactivity.
 716 * @p2p_ctwindow: P2P CT Window
 717 * @p2p_opp_ps: P2P opportunistic PS
 718 * @acl: ACL configuration used by the drivers which has support for
 719 *	MAC address based access control
 720 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
 721 *	networks.
 722 * @beacon_rate: bitrate to be used for beacons
 723 */
 724struct cfg80211_ap_settings {
 725	struct cfg80211_chan_def chandef;
 726
 727	struct cfg80211_beacon_data beacon;
 728
 729	int beacon_interval, dtim_period;
 730	const u8 *ssid;
 731	size_t ssid_len;
 732	enum nl80211_hidden_ssid hidden_ssid;
 733	struct cfg80211_crypto_settings crypto;
 734	bool privacy;
 735	enum nl80211_auth_type auth_type;
 736	enum nl80211_smps_mode smps_mode;
 737	int inactivity_timeout;
 738	u8 p2p_ctwindow;
 739	bool p2p_opp_ps;
 740	const struct cfg80211_acl_data *acl;
 741	bool pbss;
 742	struct cfg80211_bitrate_mask beacon_rate;
 743};
 744
 745/**
 746 * struct cfg80211_csa_settings - channel switch settings
 747 *
 748 * Used for channel switch
 749 *
 750 * @chandef: defines the channel to use after the switch
 751 * @beacon_csa: beacon data while performing the switch
 752 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
 753 * @counter_offsets_presp: offsets of the counters within the probe response
 754 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
 755 * @n_counter_offsets_presp: number of csa counters in the probe response
 756 * @beacon_after: beacon data to be used on the new channel
 757 * @radar_required: whether radar detection is required on the new channel
 758 * @block_tx: whether transmissions should be blocked while changing
 759 * @count: number of beacons until switch
 760 */
 761struct cfg80211_csa_settings {
 762	struct cfg80211_chan_def chandef;
 763	struct cfg80211_beacon_data beacon_csa;
 764	const u16 *counter_offsets_beacon;
 765	const u16 *counter_offsets_presp;
 766	unsigned int n_counter_offsets_beacon;
 767	unsigned int n_counter_offsets_presp;
 768	struct cfg80211_beacon_data beacon_after;
 769	bool radar_required;
 770	bool block_tx;
 771	u8 count;
 772};
 773
 774/**
 775 * struct iface_combination_params - input parameters for interface combinations
 776 *
 777 * Used to pass interface combination parameters
 778 *
 779 * @num_different_channels: the number of different channels we want
 780 *	to use for verification
 781 * @radar_detect: a bitmap where each bit corresponds to a channel
 782 *	width where radar detection is needed, as in the definition of
 783 *	&struct ieee80211_iface_combination.@radar_detect_widths
 784 * @iftype_num: array with the number of interfaces of each interface
 785 *	type.  The index is the interface type as specified in &enum
 786 *	nl80211_iftype.
 787 * @new_beacon_int: set this to the beacon interval of a new interface
 788 *	that's not operating yet, if such is to be checked as part of
 789 *	the verification
 790 */
 791struct iface_combination_params {
 792	int num_different_channels;
 793	u8 radar_detect;
 794	int iftype_num[NUM_NL80211_IFTYPES];
 795	u32 new_beacon_int;
 796};
 797
 798/**
 799 * enum station_parameters_apply_mask - station parameter values to apply
 800 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
 801 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
 802 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
 803 *
 804 * Not all station parameters have in-band "no change" signalling,
 805 * for those that don't these flags will are used.
 806 */
 807enum station_parameters_apply_mask {
 808	STATION_PARAM_APPLY_UAPSD = BIT(0),
 809	STATION_PARAM_APPLY_CAPABILITY = BIT(1),
 810	STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
 811};
 812
 813/**
 814 * struct station_parameters - station parameters
 815 *
 816 * Used to change and create a new station.
 817 *
 818 * @vlan: vlan interface station should belong to
 819 * @supported_rates: supported rates in IEEE 802.11 format
 820 *	(or NULL for no change)
 821 * @supported_rates_len: number of supported rates
 822 * @sta_flags_mask: station flags that changed
 823 *	(bitmask of BIT(%NL80211_STA_FLAG_...))
 824 * @sta_flags_set: station flags values
 825 *	(bitmask of BIT(%NL80211_STA_FLAG_...))
 826 * @listen_interval: listen interval or -1 for no change
 827 * @aid: AID or zero for no change
 828 * @peer_aid: mesh peer AID or zero for no change
 829 * @plink_action: plink action to take
 830 * @plink_state: set the peer link state for a station
 831 * @ht_capa: HT capabilities of station
 832 * @vht_capa: VHT capabilities of station
 833 * @uapsd_queues: bitmap of queues configured for uapsd. same format
 834 *	as the AC bitmap in the QoS info field
 835 * @max_sp: max Service Period. same format as the MAX_SP in the
 836 *	QoS info field (but already shifted down)
 837 * @sta_modify_mask: bitmap indicating which parameters changed
 838 *	(for those that don't have a natural "no change" value),
 839 *	see &enum station_parameters_apply_mask
 840 * @local_pm: local link-specific mesh power save mode (no change when set
 841 *	to unknown)
 842 * @capability: station capability
 843 * @ext_capab: extended capabilities of the station
 844 * @ext_capab_len: number of extended capabilities
 845 * @supported_channels: supported channels in IEEE 802.11 format
 846 * @supported_channels_len: number of supported channels
 847 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
 848 * @supported_oper_classes_len: number of supported operating classes
 849 * @opmode_notif: operating mode field from Operating Mode Notification
 850 * @opmode_notif_used: information if operating mode field is used
 851 * @support_p2p_ps: information if station supports P2P PS mechanism
 852 */
 853struct station_parameters {
 854	const u8 *supported_rates;
 855	struct net_device *vlan;
 856	u32 sta_flags_mask, sta_flags_set;
 857	u32 sta_modify_mask;
 858	int listen_interval;
 859	u16 aid;
 860	u16 peer_aid;
 861	u8 supported_rates_len;
 862	u8 plink_action;
 863	u8 plink_state;
 864	const struct ieee80211_ht_cap *ht_capa;
 865	const struct ieee80211_vht_cap *vht_capa;
 866	u8 uapsd_queues;
 867	u8 max_sp;
 868	enum nl80211_mesh_power_mode local_pm;
 869	u16 capability;
 870	const u8 *ext_capab;
 871	u8 ext_capab_len;
 872	const u8 *supported_channels;
 873	u8 supported_channels_len;
 874	const u8 *supported_oper_classes;
 875	u8 supported_oper_classes_len;
 876	u8 opmode_notif;
 877	bool opmode_notif_used;
 878	int support_p2p_ps;
 879};
 880
 881/**
 882 * struct station_del_parameters - station deletion parameters
 883 *
 884 * Used to delete a station entry (or all stations).
 885 *
 886 * @mac: MAC address of the station to remove or NULL to remove all stations
 887 * @subtype: Management frame subtype to use for indicating removal
 888 *	(10 = Disassociation, 12 = Deauthentication)
 889 * @reason_code: Reason code for the Disassociation/Deauthentication frame
 890 */
 891struct station_del_parameters {
 892	const u8 *mac;
 893	u8 subtype;
 894	u16 reason_code;
 895};
 896
 897/**
 898 * enum cfg80211_station_type - the type of station being modified
 899 * @CFG80211_STA_AP_CLIENT: client of an AP interface
 900 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
 901 *	unassociated (update properties for this type of client is permitted)
 902 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
 903 *	the AP MLME in the device
 904 * @CFG80211_STA_AP_STA: AP station on managed interface
 905 * @CFG80211_STA_IBSS: IBSS station
 906 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
 907 *	while TDLS setup is in progress, it moves out of this state when
 908 *	being marked authorized; use this only if TDLS with external setup is
 909 *	supported/used)
 910 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
 911 *	entry that is operating, has been marked authorized by userspace)
 912 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
 913 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
 914 */
 915enum cfg80211_station_type {
 916	CFG80211_STA_AP_CLIENT,
 917	CFG80211_STA_AP_CLIENT_UNASSOC,
 918	CFG80211_STA_AP_MLME_CLIENT,
 919	CFG80211_STA_AP_STA,
 920	CFG80211_STA_IBSS,
 921	CFG80211_STA_TDLS_PEER_SETUP,
 922	CFG80211_STA_TDLS_PEER_ACTIVE,
 923	CFG80211_STA_MESH_PEER_KERNEL,
 924	CFG80211_STA_MESH_PEER_USER,
 925};
 926
 927/**
 928 * cfg80211_check_station_change - validate parameter changes
 929 * @wiphy: the wiphy this operates on
 930 * @params: the new parameters for a station
 931 * @statype: the type of station being modified
 932 *
 933 * Utility function for the @change_station driver method. Call this function
 934 * with the appropriate station type looking up the station (and checking that
 935 * it exists). It will verify whether the station change is acceptable, and if
 936 * not will return an error code. Note that it may modify the parameters for
 937 * backward compatibility reasons, so don't use them before calling this.
 938 */
 939int cfg80211_check_station_change(struct wiphy *wiphy,
 940				  struct station_parameters *params,
 941				  enum cfg80211_station_type statype);
 942
 943/**
 944 * enum station_info_rate_flags - bitrate info flags
 945 *
 946 * Used by the driver to indicate the specific rate transmission
 947 * type for 802.11n transmissions.
 948 *
 949 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
 950 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
 951 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
 952 * @RATE_INFO_FLAGS_60G: 60GHz MCS
 953 */
 954enum rate_info_flags {
 955	RATE_INFO_FLAGS_MCS			= BIT(0),
 956	RATE_INFO_FLAGS_VHT_MCS			= BIT(1),
 957	RATE_INFO_FLAGS_SHORT_GI		= BIT(2),
 958	RATE_INFO_FLAGS_60G			= BIT(3),
 959};
 960
 961/**
 962 * enum rate_info_bw - rate bandwidth information
 963 *
 964 * Used by the driver to indicate the rate bandwidth.
 965 *
 966 * @RATE_INFO_BW_5: 5 MHz bandwidth
 967 * @RATE_INFO_BW_10: 10 MHz bandwidth
 968 * @RATE_INFO_BW_20: 20 MHz bandwidth
 969 * @RATE_INFO_BW_40: 40 MHz bandwidth
 970 * @RATE_INFO_BW_80: 80 MHz bandwidth
 971 * @RATE_INFO_BW_160: 160 MHz bandwidth
 972 */
 973enum rate_info_bw {
 974	RATE_INFO_BW_5,
 975	RATE_INFO_BW_10,
 976	RATE_INFO_BW_20,
 977	RATE_INFO_BW_40,
 978	RATE_INFO_BW_80,
 979	RATE_INFO_BW_160,
 980};
 981
 982/**
 983 * struct rate_info - bitrate information
 984 *
 985 * Information about a receiving or transmitting bitrate
 986 *
 987 * @flags: bitflag of flags from &enum rate_info_flags
 988 * @mcs: mcs index if struct describes a 802.11n bitrate
 989 * @legacy: bitrate in 100kbit/s for 802.11abg
 990 * @nss: number of streams (VHT only)
 991 * @bw: bandwidth (from &enum rate_info_bw)
 992 */
 993struct rate_info {
 994	u8 flags;
 995	u8 mcs;
 996	u16 legacy;
 997	u8 nss;
 998	u8 bw;
 999};
1000
1001/**
1002 * enum station_info_rate_flags - bitrate info flags
1003 *
1004 * Used by the driver to indicate the specific rate transmission
1005 * type for 802.11n transmissions.
1006 *
1007 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1008 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1009 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1010 */
1011enum bss_param_flags {
1012	BSS_PARAM_FLAGS_CTS_PROT	= 1<<0,
1013	BSS_PARAM_FLAGS_SHORT_PREAMBLE	= 1<<1,
1014	BSS_PARAM_FLAGS_SHORT_SLOT_TIME	= 1<<2,
1015};
1016
1017/**
1018 * struct sta_bss_parameters - BSS parameters for the attached station
1019 *
1020 * Information about the currently associated BSS
1021 *
1022 * @flags: bitflag of flags from &enum bss_param_flags
1023 * @dtim_period: DTIM period for the BSS
1024 * @beacon_interval: beacon interval
1025 */
1026struct sta_bss_parameters {
1027	u8 flags;
1028	u8 dtim_period;
1029	u16 beacon_interval;
1030};
1031
1032/**
1033 * struct cfg80211_tid_stats - per-TID statistics
1034 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1035 *	indicate the relevant values in this struct are filled
1036 * @rx_msdu: number of received MSDUs
1037 * @tx_msdu: number of (attempted) transmitted MSDUs
1038 * @tx_msdu_retries: number of retries (not counting the first) for
1039 *	transmitted MSDUs
1040 * @tx_msdu_failed: number of failed transmitted MSDUs
1041 */
1042struct cfg80211_tid_stats {
1043	u32 filled;
1044	u64 rx_msdu;
1045	u64 tx_msdu;
1046	u64 tx_msdu_retries;
1047	u64 tx_msdu_failed;
1048};
1049
1050#define IEEE80211_MAX_CHAINS	4
1051
1052/**
1053 * struct station_info - station information
1054 *
1055 * Station information filled by driver for get_station() and dump_station.
1056 *
1057 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1058 *	indicate the relevant values in this struct for them
1059 * @connected_time: time(in secs) since a station is last connected
1060 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1061 * @rx_bytes: bytes (size of MPDUs) received from this station
1062 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1063 * @llid: mesh local link id
1064 * @plid: mesh peer link id
1065 * @plink_state: mesh peer link state
1066 * @signal: The signal strength, type depends on the wiphy's signal_type.
1067 *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1068 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1069 *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1070 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1071 * @chain_signal: per-chain signal strength of last received packet in dBm
1072 * @chain_signal_avg: per-chain signal strength average in dBm
1073 * @txrate: current unicast bitrate from this station
1074 * @rxrate: current unicast bitrate to this station
1075 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1076 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1077 * @tx_retries: cumulative retry counts (MPDUs)
1078 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1079 * @rx_dropped_misc:  Dropped for un-specified reason.
1080 * @bss_param: current BSS parameters
1081 * @generation: generation number for nl80211 dumps.
1082 *	This number should increase every time the list of stations
1083 *	changes, i.e. when a station is added or removed, so that
1084 *	userspace can tell whether it got a consistent snapshot.
1085 * @assoc_req_ies: IEs from (Re)Association Request.
1086 *	This is used only when in AP mode with drivers that do not use
1087 *	user space MLME/SME implementation. The information is provided for
1088 *	the cfg80211_new_sta() calls to notify user space of the IEs.
1089 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1090 * @sta_flags: station flags mask & values
1091 * @beacon_loss_count: Number of times beacon loss event has triggered.
1092 * @t_offset: Time offset of the station relative to this host.
1093 * @local_pm: local mesh STA power save mode
1094 * @peer_pm: peer mesh STA power save mode
1095 * @nonpeer_pm: non-peer mesh STA power save mode
1096 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1097 *	towards this station.
1098 * @rx_beacon: number of beacons received from this peer
1099 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1100 *	from this peer
1101 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1102 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1103 *	(IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1104 */
1105struct station_info {
1106	u64 filled;
1107	u32 connected_time;
1108	u32 inactive_time;
1109	u64 rx_bytes;
1110	u64 tx_bytes;
1111	u16 llid;
1112	u16 plid;
1113	u8 plink_state;
1114	s8 signal;
1115	s8 signal_avg;
1116
1117	u8 chains;
1118	s8 chain_signal[IEEE80211_MAX_CHAINS];
1119	s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1120
1121	struct rate_info txrate;
1122	struct rate_info rxrate;
1123	u32 rx_packets;
1124	u32 tx_packets;
1125	u32 tx_retries;
1126	u32 tx_failed;
1127	u32 rx_dropped_misc;
1128	struct sta_bss_parameters bss_param;
1129	struct nl80211_sta_flag_update sta_flags;
1130
1131	int generation;
1132
1133	const u8 *assoc_req_ies;
1134	size_t assoc_req_ies_len;
1135
1136	u32 beacon_loss_count;
1137	s64 t_offset;
1138	enum nl80211_mesh_power_mode local_pm;
1139	enum nl80211_mesh_power_mode peer_pm;
1140	enum nl80211_mesh_power_mode nonpeer_pm;
1141
1142	u32 expected_throughput;
1143
1144	u64 rx_beacon;
1145	u64 rx_duration;
1146	u8 rx_beacon_signal_avg;
1147	struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1148};
1149
1150#if IS_ENABLED(CONFIG_CFG80211)
1151/**
1152 * cfg80211_get_station - retrieve information about a given station
1153 * @dev: the device where the station is supposed to be connected to
1154 * @mac_addr: the mac address of the station of interest
1155 * @sinfo: pointer to the structure to fill with the information
1156 *
1157 * Returns 0 on success and sinfo is filled with the available information
1158 * otherwise returns a negative error code and the content of sinfo has to be
1159 * considered undefined.
1160 */
1161int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1162			 struct station_info *sinfo);
1163#else
1164static inline int cfg80211_get_station(struct net_device *dev,
1165				       const u8 *mac_addr,
1166				       struct station_info *sinfo)
1167{
1168	return -ENOENT;
1169}
1170#endif
1171
1172/**
1173 * enum monitor_flags - monitor flags
1174 *
1175 * Monitor interface configuration flags. Note that these must be the bits
1176 * according to the nl80211 flags.
1177 *
1178 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1179 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1180 * @MONITOR_FLAG_CONTROL: pass control frames
1181 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1182 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1183 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1184 */
1185enum monitor_flags {
1186	MONITOR_FLAG_FCSFAIL		= 1<<NL80211_MNTR_FLAG_FCSFAIL,
1187	MONITOR_FLAG_PLCPFAIL		= 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1188	MONITOR_FLAG_CONTROL		= 1<<NL80211_MNTR_FLAG_CONTROL,
1189	MONITOR_FLAG_OTHER_BSS		= 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1190	MONITOR_FLAG_COOK_FRAMES	= 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1191	MONITOR_FLAG_ACTIVE		= 1<<NL80211_MNTR_FLAG_ACTIVE,
1192};
1193
1194/**
1195 * enum mpath_info_flags -  mesh path information flags
1196 *
1197 * Used by the driver to indicate which info in &struct mpath_info it has filled
1198 * in during get_station() or dump_station().
1199 *
1200 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1201 * @MPATH_INFO_SN: @sn filled
1202 * @MPATH_INFO_METRIC: @metric filled
1203 * @MPATH_INFO_EXPTIME: @exptime filled
1204 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1205 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1206 * @MPATH_INFO_FLAGS: @flags filled
1207 */
1208enum mpath_info_flags {
1209	MPATH_INFO_FRAME_QLEN		= BIT(0),
1210	MPATH_INFO_SN			= BIT(1),
1211	MPATH_INFO_METRIC		= BIT(2),
1212	MPATH_INFO_EXPTIME		= BIT(3),
1213	MPATH_INFO_DISCOVERY_TIMEOUT	= BIT(4),
1214	MPATH_INFO_DISCOVERY_RETRIES	= BIT(5),
1215	MPATH_INFO_FLAGS		= BIT(6),
1216};
1217
1218/**
1219 * struct mpath_info - mesh path information
1220 *
1221 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1222 *
1223 * @filled: bitfield of flags from &enum mpath_info_flags
1224 * @frame_qlen: number of queued frames for this destination
1225 * @sn: target sequence number
1226 * @metric: metric (cost) of this mesh path
1227 * @exptime: expiration time for the mesh path from now, in msecs
1228 * @flags: mesh path flags
1229 * @discovery_timeout: total mesh path discovery timeout, in msecs
1230 * @discovery_retries: mesh path discovery retries
1231 * @generation: generation number for nl80211 dumps.
1232 *	This number should increase every time the list of mesh paths
1233 *	changes, i.e. when a station is added or removed, so that
1234 *	userspace can tell whether it got a consistent snapshot.
1235 */
1236struct mpath_info {
1237	u32 filled;
1238	u32 frame_qlen;
1239	u32 sn;
1240	u32 metric;
1241	u32 exptime;
1242	u32 discovery_timeout;
1243	u8 discovery_retries;
1244	u8 flags;
1245
1246	int generation;
1247};
1248
1249/**
1250 * struct bss_parameters - BSS parameters
1251 *
1252 * Used to change BSS parameters (mainly for AP mode).
1253 *
1254 * @use_cts_prot: Whether to use CTS protection
1255 *	(0 = no, 1 = yes, -1 = do not change)
1256 * @use_short_preamble: Whether the use of short preambles is allowed
1257 *	(0 = no, 1 = yes, -1 = do not change)
1258 * @use_short_slot_time: Whether the use of short slot time is allowed
1259 *	(0 = no, 1 = yes, -1 = do not change)
1260 * @basic_rates: basic rates in IEEE 802.11 format
1261 *	(or NULL for no change)
1262 * @basic_rates_len: number of basic rates
1263 * @ap_isolate: do not forward packets between connected stations
1264 * @ht_opmode: HT Operation mode
1265 * 	(u16 = opmode, -1 = do not change)
1266 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1267 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1268 */
1269struct bss_parameters {
1270	int use_cts_prot;
1271	int use_short_preamble;
1272	int use_short_slot_time;
1273	const u8 *basic_rates;
1274	u8 basic_rates_len;
1275	int ap_isolate;
1276	int ht_opmode;
1277	s8 p2p_ctwindow, p2p_opp_ps;
1278};
1279
1280/**
1281 * struct mesh_config - 802.11s mesh configuration
1282 *
1283 * These parameters can be changed while the mesh is active.
1284 *
1285 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1286 *	by the Mesh Peering Open message
1287 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1288 *	used by the Mesh Peering Open message
1289 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1290 *	the mesh peering management to close a mesh peering
1291 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1292 *	mesh interface
1293 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1294 *	be sent to establish a new peer link instance in a mesh
1295 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1296 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1297 *	elements
1298 * @auto_open_plinks: whether we should automatically open peer links when we
1299 *	detect compatible mesh peers
1300 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1301 *	synchronize to for 11s default synchronization method
1302 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1303 *	that an originator mesh STA can send to a particular path target
1304 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1305 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1306 *	a path discovery in milliseconds
1307 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1308 *	receiving a PREQ shall consider the forwarding information from the
1309 *	root to be valid. (TU = time unit)
1310 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1311 *	which a mesh STA can send only one action frame containing a PREQ
1312 *	element
1313 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1314 *	which a mesh STA can send only one Action frame containing a PERR
1315 *	element
1316 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1317 *	it takes for an HWMP information element to propagate across the mesh
1318 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1319 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1320 *	announcements are transmitted
1321 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1322 *	station has access to a broader network beyond the MBSS. (This is
1323 *	missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1324 *	only means that the station will announce others it's a mesh gate, but
1325 *	not necessarily using the gate announcement protocol. Still keeping the
1326 *	same nomenclature to be in sync with the spec)
1327 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1328 *	entity (default is TRUE - forwarding entity)
1329 * @rssi_threshold: the threshold for average signal strength of candidate
1330 *	station to establish a peer link
1331 * @ht_opmode: mesh HT protection mode
1332 *
1333 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1334 *	receiving a proactive PREQ shall consider the forwarding information to
1335 *	the root mesh STA to be valid.
1336 *
1337 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1338 *	PREQs are transmitted.
1339 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1340 *	during which a mesh STA can send only one Action frame containing
1341 *	a PREQ element for root path confirmation.
1342 * @power_mode: The default mesh power save mode which will be the initial
1343 *	setting for new peer links.
1344 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1345 *	after transmitting its beacon.
1346 * @plink_timeout: If no tx activity is seen from a STA we've established
1347 *	peering with for longer than this time (in seconds), then remove it
1348 *	from the STA's list of peers.  Default is 30 minutes.
1349 */
1350struct mesh_config {
1351	u16 dot11MeshRetryTimeout;
1352	u16 dot11MeshConfirmTimeout;
1353	u16 dot11MeshHoldingTimeout;
1354	u16 dot11MeshMaxPeerLinks;
1355	u8 dot11MeshMaxRetries;
1356	u8 dot11MeshTTL;
1357	u8 element_ttl;
1358	bool auto_open_plinks;
1359	u32 dot11MeshNbrOffsetMaxNeighbor;
1360	u8 dot11MeshHWMPmaxPREQretries;
1361	u32 path_refresh_time;
1362	u16 min_discovery_timeout;
1363	u32 dot11MeshHWMPactivePathTimeout;
1364	u16 dot11MeshHWMPpreqMinInterval;
1365	u16 dot11MeshHWMPperrMinInterval;
1366	u16 dot11MeshHWMPnetDiameterTraversalTime;
1367	u8 dot11MeshHWMPRootMode;
1368	u16 dot11MeshHWMPRannInterval;
1369	bool dot11MeshGateAnnouncementProtocol;
1370	bool dot11MeshForwarding;
1371	s32 rssi_threshold;
1372	u16 ht_opmode;
1373	u32 dot11MeshHWMPactivePathToRootTimeout;
1374	u16 dot11MeshHWMProotInterval;
1375	u16 dot11MeshHWMPconfirmationInterval;
1376	enum nl80211_mesh_power_mode power_mode;
1377	u16 dot11MeshAwakeWindowDuration;
1378	u32 plink_timeout;
1379};
1380
1381/**
1382 * struct mesh_setup - 802.11s mesh setup configuration
1383 * @chandef: defines the channel to use
1384 * @mesh_id: the mesh ID
1385 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1386 * @sync_method: which synchronization method to use
1387 * @path_sel_proto: which path selection protocol to use
1388 * @path_metric: which metric to use
1389 * @auth_id: which authentication method this mesh is using
1390 * @ie: vendor information elements (optional)
1391 * @ie_len: length of vendor information elements
1392 * @is_authenticated: this mesh requires authentication
1393 * @is_secure: this mesh uses security
1394 * @user_mpm: userspace handles all MPM functions
1395 * @dtim_period: DTIM period to use
1396 * @beacon_interval: beacon interval to use
1397 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1398 * @basic_rates: basic rates to use when creating the mesh
1399 * @beacon_rate: bitrate to be used for beacons
1400 *
1401 * These parameters are fixed when the mesh is created.
1402 */
1403struct mesh_setup {
1404	struct cfg80211_chan_def chandef;
1405	const u8 *mesh_id;
1406	u8 mesh_id_len;
1407	u8 sync_method;
1408	u8 path_sel_proto;
1409	u8 path_metric;
1410	u8 auth_id;
1411	const u8 *ie;
1412	u8 ie_len;
1413	bool is_authenticated;
1414	bool is_secure;
1415	bool user_mpm;
1416	u8 dtim_period;
1417	u16 beacon_interval;
1418	int mcast_rate[NUM_NL80211_BANDS];
1419	u32 basic_rates;
1420	struct cfg80211_bitrate_mask beacon_rate;
1421};
1422
1423/**
1424 * struct ocb_setup - 802.11p OCB mode setup configuration
1425 * @chandef: defines the channel to use
1426 *
1427 * These parameters are fixed when connecting to the network
1428 */
1429struct ocb_setup {
1430	struct cfg80211_chan_def chandef;
1431};
1432
1433/**
1434 * struct ieee80211_txq_params - TX queue parameters
1435 * @ac: AC identifier
1436 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1437 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1438 *	1..32767]
1439 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1440 *	1..32767]
1441 * @aifs: Arbitration interframe space [0..255]
1442 */
1443struct ieee80211_txq_params {
1444	enum nl80211_ac ac;
1445	u16 txop;
1446	u16 cwmin;
1447	u16 cwmax;
1448	u8 aifs;
1449};
1450
1451/**
1452 * DOC: Scanning and BSS list handling
1453 *
1454 * The scanning process itself is fairly simple, but cfg80211 offers quite
1455 * a bit of helper functionality. To start a scan, the scan operation will
1456 * be invoked with a scan definition. This scan definition contains the
1457 * channels to scan, and the SSIDs to send probe requests for (including the
1458 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1459 * probe. Additionally, a scan request may contain extra information elements
1460 * that should be added to the probe request. The IEs are guaranteed to be
1461 * well-formed, and will not exceed the maximum length the driver advertised
1462 * in the wiphy structure.
1463 *
1464 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1465 * it is responsible for maintaining the BSS list; the driver should not
1466 * maintain a list itself. For this notification, various functions exist.
1467 *
1468 * Since drivers do not maintain a BSS list, there are also a number of
1469 * functions to search for a BSS and obtain information about it from the
1470 * BSS structure cfg80211 maintains. The BSS list is also made available
1471 * to userspace.
1472 */
1473
1474/**
1475 * struct cfg80211_ssid - SSID description
1476 * @ssid: the SSID
1477 * @ssid_len: length of the ssid
1478 */
1479struct cfg80211_ssid {
1480	u8 ssid[IEEE80211_MAX_SSID_LEN];
1481	u8 ssid_len;
1482};
1483
1484/**
1485 * struct cfg80211_scan_info - information about completed scan
1486 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1487 *	wireless device that requested the scan is connected to. If this
1488 *	information is not available, this field is left zero.
1489 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1490 * @aborted: set to true if the scan was aborted for any reason,
1491 *	userspace will be notified of that
1492 */
1493struct cfg80211_scan_info {
1494	u64 scan_start_tsf;
1495	u8 tsf_bssid[ETH_ALEN] __aligned(2);
1496	bool aborted;
1497};
1498
1499/**
1500 * struct cfg80211_scan_request - scan request description
1501 *
1502 * @ssids: SSIDs to scan for (active scan only)
1503 * @n_ssids: number of SSIDs
1504 * @channels: channels to scan on.
1505 * @n_channels: total number of channels to scan
1506 * @scan_width: channel width for scanning
1507 * @ie: optional information element(s) to add into Probe Request or %NULL
1508 * @ie_len: length of ie in octets
1509 * @duration: how long to listen on each channel, in TUs. If
1510 *	%duration_mandatory is not set, this is the maximum dwell time and
1511 *	the actual dwell time may be shorter.
1512 * @duration_mandatory: if set, the scan duration must be as specified by the
1513 *	%duration field.
1514 * @flags: bit field of flags controlling operation
1515 * @rates: bitmap of rates to advertise for each band
1516 * @wiphy: the wiphy this was for
1517 * @scan_start: time (in jiffies) when the scan started
1518 * @wdev: the wireless device to scan for
1519 * @info: (internal) information about completed scan
1520 * @notified: (internal) scan request was notified as done or aborted
1521 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1522 * @mac_addr: MAC address used with randomisation
1523 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1524 *	are 0 in the mask should be randomised, bits that are 1 should
1525 *	be taken from the @mac_addr
1526 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1527 */
1528struct cfg80211_scan_request {
1529	struct cfg80211_ssid *ssids;
1530	int n_ssids;
1531	u32 n_channels;
1532	enum nl80211_bss_scan_width scan_width;
1533	const u8 *ie;
1534	size_t ie_len;
1535	u16 duration;
1536	bool duration_mandatory;
1537	u32 flags;
1538
1539	u32 rates[NUM_NL80211_BANDS];
1540
1541	struct wireless_dev *wdev;
1542
1543	u8 mac_addr[ETH_ALEN] __aligned(2);
1544	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1545	u8 bssid[ETH_ALEN] __aligned(2);
1546
1547	/* internal */
1548	struct wiphy *wiphy;
1549	unsigned long scan_start;
1550	struct cfg80211_scan_info info;
1551	bool notified;
1552	bool no_cck;
1553
1554	/* keep last */
1555	struct ieee80211_channel *channels[0];
1556};
1557
1558static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1559{
1560	int i;
1561
1562	get_random_bytes(buf, ETH_ALEN);
1563	for (i = 0; i < ETH_ALEN; i++) {
1564		buf[i] &= ~mask[i];
1565		buf[i] |= addr[i] & mask[i];
1566	}
1567}
1568
1569/**
1570 * struct cfg80211_match_set - sets of attributes to match
1571 *
1572 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1573 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1574 */
1575struct cfg80211_match_set {
1576	struct cfg80211_ssid ssid;
1577	s32 rssi_thold;
1578};
1579
1580/**
1581 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1582 *
1583 * @interval: interval between scheduled scan iterations. In seconds.
1584 * @iterations: number of scan iterations in this scan plan. Zero means
1585 *	infinite loop.
1586 *	The last scan plan will always have this parameter set to zero,
1587 *	all other scan plans will have a finite number of iterations.
1588 */
1589struct cfg80211_sched_scan_plan {
1590	u32 interval;
1591	u32 iterations;
1592};
1593
1594/**
1595 * struct cfg80211_sched_scan_request - scheduled scan request description
1596 *
1597 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1598 * @n_ssids: number of SSIDs
1599 * @n_channels: total number of channels to scan
1600 * @scan_width: channel width for scanning
1601 * @ie: optional information element(s) to add into Probe Request or %NULL
1602 * @ie_len: length of ie in octets
1603 * @flags: bit field of flags controlling operation
1604 * @match_sets: sets of parameters to be matched for a scan result
1605 * 	entry to be considered valid and to be passed to the host
1606 * 	(others are filtered out).
1607 *	If ommited, all results are passed.
1608 * @n_match_sets: number of match sets
1609 * @wiphy: the wiphy this was for
1610 * @dev: the interface
1611 * @scan_start: start time of the scheduled scan
1612 * @channels: channels to scan
1613 * @min_rssi_thold: for drivers only supporting a single threshold, this
1614 *	contains the minimum over all matchsets
1615 * @mac_addr: MAC address used with randomisation
1616 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1617 *	are 0 in the mask should be randomised, bits that are 1 should
1618 *	be taken from the @mac_addr
1619 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1620 *	index must be executed first.
1621 * @n_scan_plans: number of scan plans, at least 1.
1622 * @rcu_head: RCU callback used to free the struct
1623 * @owner_nlportid: netlink portid of owner (if this should is a request
1624 *	owned by a particular socket)
1625 * @delay: delay in seconds to use before starting the first scan
1626 *	cycle.  The driver may ignore this parameter and start
1627 *	immediately (or at any other time), if this feature is not
1628 *	supported.
1629 */
1630struct cfg80211_sched_scan_request {
1631	struct cfg80211_ssid *ssids;
1632	int n_ssids;
1633	u32 n_channels;
1634	enum nl80211_bss_scan_width scan_width;
1635	const u8 *ie;
1636	size_t ie_len;
1637	u32 flags;
1638	struct cfg80211_match_set *match_sets;
1639	int n_match_sets;
1640	s32 min_rssi_thold;
1641	u32 delay;
1642	struct cfg80211_sched_scan_plan *scan_plans;
1643	int n_scan_plans;
1644
1645	u8 mac_addr[ETH_ALEN] __aligned(2);
1646	u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1647
1648	/* internal */
1649	struct wiphy *wiphy;
1650	struct net_device *dev;
1651	unsigned long scan_start;
1652	struct rcu_head rcu_head;
1653	u32 owner_nlportid;
1654
1655	/* keep last */
1656	struct ieee80211_channel *channels[0];
1657};
1658
1659/**
1660 * enum cfg80211_signal_type - signal type
1661 *
1662 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1663 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1664 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1665 */
1666enum cfg80211_signal_type {
1667	CFG80211_SIGNAL_TYPE_NONE,
1668	CFG80211_SIGNAL_TYPE_MBM,
1669	CFG80211_SIGNAL_TYPE_UNSPEC,
1670};
1671
1672/**
1673 * struct cfg80211_inform_bss - BSS inform data
1674 * @chan: channel the frame was received on
1675 * @scan_width: scan width that was used
1676 * @signal: signal strength value, according to the wiphy's
1677 *	signal type
1678 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1679 *	received; should match the time when the frame was actually
1680 *	received by the device (not just by the host, in case it was
1681 *	buffered on the device) and be accurate to about 10ms.
1682 *	If the frame isn't buffered, just passing the return value of
1683 *	ktime_get_boot_ns() is likely appropriate.
1684 * @parent_tsf: the time at the start of reception of the first octet of the
1685 *	timestamp field of the frame. The time is the TSF of the BSS specified
1686 *	by %parent_bssid.
1687 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1688 *	the BSS that requested the scan in which the beacon/probe was received.
1689 */
1690struct cfg80211_inform_bss {
1691	struct ieee80211_channel *chan;
1692	enum nl80211_bss_scan_width scan_width;
1693	s32 signal;
1694	u64 boottime_ns;
1695	u64 parent_tsf;
1696	u8 parent_bssid[ETH_ALEN] __aligned(2);
1697};
1698
1699/**
1700 * struct cfg80211_bss_ies - BSS entry IE data
1701 * @tsf: TSF contained in the frame that carried these IEs
1702 * @rcu_head: internal use, for freeing
1703 * @len: length of the IEs
1704 * @from_beacon: these IEs are known to come from a beacon
1705 * @data: IE data
1706 */
1707struct cfg80211_bss_ies {
1708	u64 tsf;
1709	struct rcu_head rcu_head;
1710	int len;
1711	bool from_beacon;
1712	u8 data[];
1713};
1714
1715/**
1716 * struct cfg80211_bss - BSS description
1717 *
1718 * This structure describes a BSS (which may also be a mesh network)
1719 * for use in scan results and similar.
1720 *
1721 * @channel: channel this BSS is on
1722 * @scan_width: width of the control channel
1723 * @bssid: BSSID of the BSS
1724 * @beacon_interval: the beacon interval as from the frame
1725 * @capability: the capability field in host byte order
1726 * @ies: the information elements (Note that there is no guarantee that these
1727 *	are well-formed!); this is a pointer to either the beacon_ies or
1728 *	proberesp_ies depending on whether Probe Response frame has been
1729 *	received. It is always non-%NULL.
1730 * @beacon_ies: the information elements from the last Beacon frame
1731 *	(implementation note: if @hidden_beacon_bss is set this struct doesn't
1732 *	own the beacon_ies, but they're just pointers to the ones from the
1733 *	@hidden_beacon_bss struct)
1734 * @proberesp_ies: the information elements from the last Probe Response frame
1735 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1736 *	a BSS that hides the SSID in its beacon, this points to the BSS struct
1737 *	that holds the beacon data. @beacon_ies is still valid, of course, and
1738 *	points to the same data as hidden_beacon_bss->beacon_ies in that case.
1739 * @signal: signal strength value (type depends on the wiphy's signal_type)
1740 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1741 */
1742struct cfg80211_bss {
1743	struct ieee80211_channel *channel;
1744	enum nl80211_bss_scan_width scan_width;
1745
1746	const struct cfg80211_bss_ies __rcu *ies;
1747	const struct cfg80211_bss_ies __rcu *beacon_ies;
1748	const struct cfg80211_bss_ies __rcu *proberesp_ies;
1749
1750	struct cfg80211_bss *hidden_beacon_bss;
1751
1752	s32 signal;
1753
1754	u16 beacon_interval;
1755	u16 capability;
1756
1757	u8 bssid[ETH_ALEN];
1758
1759	u8 priv[0] __aligned(sizeof(void *));
1760};
1761
1762/**
1763 * ieee80211_bss_get_ie - find IE with given ID
1764 * @bss: the bss to search
1765 * @ie: the IE ID
1766 *
1767 * Note that the return value is an RCU-protected pointer, so
1768 * rcu_read_lock() must be held when calling this function.
1769 * Return: %NULL if not found.
1770 */
1771const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1772
1773
1774/**
1775 * struct cfg80211_auth_request - Authentication request data
1776 *
1777 * This structure provides information needed to complete IEEE 802.11
1778 * authentication.
1779 *
1780 * @bss: The BSS to authenticate with, the callee must obtain a reference
1781 *	to it if it needs to keep it.
1782 * @auth_type: Authentication type (algorithm)
1783 * @ie: Extra IEs to add to Authentication frame or %NULL
1784 * @ie_len: Length of ie buffer in octets
1785 * @key_len: length of WEP key for shared key authentication
1786 * @key_idx: index of WEP key for shared key authentication
1787 * @key: WEP key for shared key authentication
1788 * @auth_data: Fields and elements in Authentication frames. This contains
1789 *	the authentication frame body (non-IE and IE data), excluding the
1790 *	Authentication algorithm number, i.e., starting at the Authentication
1791 *	transaction sequence number field.
1792 * @auth_data_len: Length of auth_data buffer in octets
1793 */
1794struct cfg80211_auth_request {
1795	struct cfg80211_bss *bss;
1796	const u8 *ie;
1797	size_t ie_len;
1798	enum nl80211_auth_type auth_type;
1799	const u8 *key;
1800	u8 key_len, key_idx;
1801	const u8 *auth_data;
1802	size_t auth_data_len;
1803};
1804
1805/**
1806 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1807 *
1808 * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
1809 * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
1810 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1811 */
1812enum cfg80211_assoc_req_flags {
1813	ASSOC_REQ_DISABLE_HT		= BIT(0),
1814	ASSOC_REQ_DISABLE_VHT		= BIT(1),
1815	ASSOC_REQ_USE_RRM		= BIT(2),
1816};
1817
1818/**
1819 * struct cfg80211_assoc_request - (Re)Association request data
1820 *
1821 * This structure provides information needed to complete IEEE 802.11
1822 * (re)association.
1823 * @bss: The BSS to associate with. If the call is successful the driver is
1824 *	given a reference that it must give back to cfg80211_send_rx_assoc()
1825 *	or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1826 *	association requests while already associating must be rejected.
1827 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1828 * @ie_len: Length of ie buffer in octets
1829 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1830 * @crypto: crypto settings
1831 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1832 *	to indicate a request to reassociate within the ESS instead of a request
1833 *	do the initial association with the ESS. When included, this is set to
1834 *	the BSSID of the current association, i.e., to the value that is
1835 *	included in the Current AP address field of the Reassociation Request
1836 *	frame.
1837 * @flags:  See &enum cfg80211_assoc_req_flags
1838 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1839 *	will be used in ht_capa.  Un-supported values will be ignored.
1840 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1841 * @vht_capa: VHT capability override
1842 * @vht_capa_mask: VHT capability mask indicating which fields to use
1843 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
1844 *	%NULL if FILS is not used.
1845 * @fils_kek_len: Length of fils_kek in octets
1846 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
1847 *	Request/Response frame or %NULL if FILS is not used. This field starts
1848 *	with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
1849 */
1850struct cfg80211_assoc_request {
1851	struct cfg80211_bss *bss;
1852	const u8 *ie, *prev_bssid;
1853	size_t ie_len;
1854	struct cfg80211_crypto_settings crypto;
1855	bool use_mfp;
1856	u32 flags;
1857	struct ieee80211_ht_cap ht_capa;
1858	struct ieee80211_ht_cap ht_capa_mask;
1859	struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1860	const u8 *fils_kek;
1861	size_t fils_kek_len;
1862	const u8 *fils_nonces;
1863};
1864
1865/**
1866 * struct cfg80211_deauth_request - Deauthentication request data
1867 *
1868 * This structure provides information needed to complete IEEE 802.11
1869 * deauthentication.
1870 *
1871 * @bssid: the BSSID of the BSS to deauthenticate from
1872 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1873 * @ie_len: Length of ie buffer in octets
1874 * @reason_code: The reason code for the deauthentication
1875 * @local_state_change: if set, change local state only and
1876 *	do not set a deauth frame
1877 */
1878struct cfg80211_deauth_request {
1879	const u8 *bssid;
1880	const u8 *ie;
1881	size_t ie_len;
1882	u16 reason_code;
1883	bool local_state_change;
1884};
1885
1886/**
1887 * struct cfg80211_disassoc_request - Disassociation request data
1888 *
1889 * This structure provides information needed to complete IEEE 802.11
1890 * disassocation.
1891 *
1892 * @bss: the BSS to disassociate from
1893 * @ie: Extra IEs to add to Disassociation frame or %NULL
1894 * @ie_len: Length of ie buffer in octets
1895 * @reason_code: The reason code for the disassociation
1896 * @local_state_change: This is a request for a local state only, i.e., no
1897 *	Disassociation frame is to be transmitted.
1898 */
1899struct cfg80211_disassoc_request {
1900	struct cfg80211_bss *bss;
1901	const u8 *ie;
1902	size_t ie_len;
1903	u16 reason_code;
1904	bool local_state_change;
1905};
1906
1907/**
1908 * struct cfg80211_ibss_params - IBSS parameters
1909 *
1910 * This structure defines the IBSS parameters for the join_ibss()
1911 * method.
1912 *
1913 * @ssid: The SSID, will always be non-null.
1914 * @ssid_len: The length of the SSID, will always be non-zero.
1915 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1916 *	search for IBSSs with a different BSSID.
1917 * @chandef: defines the channel to use if no other IBSS to join can be found
1918 * @channel_fixed: The channel should be fixed -- do not search for
1919 *	IBSSs to join on other channels.
1920 * @ie: information element(s) to include in the beacon
1921 * @ie_len: length of that
1922 * @beacon_interval: beacon interval to use
1923 * @privacy: this is a protected network, keys will be configured
1924 *	after joining
1925 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1926 *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1927 *	required to assume that the port is unauthorized until authorized by
1928 *	user space. Otherwise, port is marked authorized by default.
1929 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1930 *	changes the channel when a radar is detected. This is required
1931 *	to operate on DFS channels.
1932 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1933 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1934 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1935 *	will be used in ht_capa.  Un-supported values will be ignored.
1936 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1937 */
1938struct cfg80211_ibss_params {
1939	const u8 *ssid;
1940	const u8 *bssid;
1941	struct cfg80211_chan_def chandef;
1942	const u8 *ie;
1943	u8 ssid_len, ie_len;
1944	u16 beacon_interval;
1945	u32 basic_rates;
1946	bool channel_fixed;
1947	bool privacy;
1948	bool control_port;
1949	bool userspace_handles_dfs;
1950	int mcast_rate[NUM_NL80211_BANDS];
1951	struct ieee80211_ht_cap ht_capa;
1952	struct ieee80211_ht_cap ht_capa_mask;
1953};
1954
1955/**
1956 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1957 *
1958 * @band: band of BSS which should match for RSSI level adjustment.
1959 * @delta: value of RSSI level adjustment.
1960 */
1961struct cfg80211_bss_select_adjust {
1962	enum nl80211_band band;
1963	s8 delta;
1964};
1965
1966/**
1967 * struct cfg80211_bss_selection - connection parameters for BSS selection.
1968 *
1969 * @behaviour: requested BSS selection behaviour.
1970 * @param: parameters for requestion behaviour.
1971 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
1972 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
1973 */
1974struct cfg80211_bss_selection {
1975	enum nl80211_bss_select_attr behaviour;
1976	union {
1977		enum nl80211_band band_pref;
1978		struct cfg80211_bss_select_adjust adjust;
1979	} param;
1980};
1981
1982/**
1983 * struct cfg80211_connect_params - Connection parameters
1984 *
1985 * This structure provides information needed to complete IEEE 802.11
1986 * authentication and association.
1987 *
1988 * @channel: The channel to use or %NULL if not specified (auto-select based
1989 *	on scan results)
1990 * @channel_hint: The channel of the recommended BSS for initial connection or
1991 *	%NULL if not specified
1992 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1993 *	results)
1994 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1995 *	%NULL if not specified. Unlike the @bssid parameter, the driver is
1996 *	allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1997 *	to use.
1998 * @ssid: SSID
1999 * @ssid_len: Length of ssid in octets
2000 * @auth_type: Authentication type (algorithm)
2001 * @ie: IEs for association request
2002 * @ie_len: Length of assoc_ie in octets
2003 * @privacy: indicates whether privacy-enabled APs should be used
2004 * @mfp: indicate whether management frame protection is used
2005 * @crypto: crypto settings
2006 * @key_len: length of WEP key for shared key authentication
2007 * @key_idx: index of WEP key for shared key authentication
2008 * @key: WEP key for shared key authentication
2009 * @flags:  See &enum cfg80211_assoc_req_flags
2010 * @bg_scan_period:  Background scan period in seconds
2011 *	or -1 to indicate that default value is to be used.
2012 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2013 *	will be used in ht_capa.  Un-supported values will be ignored.
2014 * @ht_capa_mask:  The bits of ht_capa which are to be used.
2015 * @vht_capa:  VHT Capability overrides
2016 * @vht_capa_mask: The bits of vht_capa which are to be used.
2017 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2018 *	networks.
2019 * @bss_select: criteria to be used for BSS selection.
2020 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2021 *	to indicate a request to reassociate within the ESS instead of a request
2022 *	do the initial association with the ESS. When included, this is set to
2023 *	the BSSID of the current association, i.e., to the value that is
2024 *	included in the Current AP address field of the Reassociation Request
2025 *	frame.
2026 */
2027struct cfg80211_connect_params {
2028	struct ieee80211_channel *channel;
2029	struct ieee80211_channel *channel_hint;
2030	const u8 *bssid;
2031	const u8 *bssid_hint;
2032	const u8 *ssid;
2033	size_t ssid_len;
2034	enum nl80211_auth_type auth_type;
2035	const u8 *ie;
2036	size_t ie_len;
2037	bool privacy;
2038	enum nl80211_mfp mfp;
2039	struct cfg80211_crypto_settings crypto;
2040	const u8 *key;
2041	u8 key_len, key_idx;
2042	u32 flags;
2043	int bg_scan_period;
2044	struct ieee80211_ht_cap ht_capa;
2045	struct ieee80211_ht_cap ht_capa_mask;
2046	struct ieee80211_vht_cap vht_capa;
2047	struct ieee80211_vht_cap vht_capa_mask;
2048	bool pbss;
2049	struct cfg80211_bss_selection bss_select;
2050	const u8 *prev_bssid;
2051};
2052
2053/**
2054 * enum cfg80211_connect_params_changed - Connection parameters being updated
2055 *
2056 * This enum provides information of all connect parameters that
2057 * have to be updated as part of update_connect_params() call.
2058 *
2059 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2060 */
2061enum cfg80211_connect_params_changed {
2062	UPDATE_ASSOC_IES		= BIT(0),
2063};
2064
2065/**
2066 * enum wiphy_params_flags - set_wiphy_params bitfield values
2067 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2068 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2069 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2070 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2071 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2072 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2073 */
2074enum wiphy_params_flags {
2075	WIPHY_PARAM_RETRY_SHORT		= 1 << 0,
2076	WIPHY_PARAM_RETRY_LONG		= 1 << 1,
2077	WIPHY_PARAM_FRAG_THRESHOLD	= 1 << 2,
2078	WIPHY_PARAM_RTS_THRESHOLD	= 1 << 3,
2079	WIPHY_PARAM_COVERAGE_CLASS	= 1 << 4,
2080	WIPHY_PARAM_DYN_ACK		= 1 << 5,
2081};
2082
 
 
 
 
 
 
 
 
 
 
 
2083/**
2084 * struct cfg80211_pmksa - PMK Security Association
2085 *
2086 * This structure is passed to the set/del_pmksa() method for PMKSA
2087 * caching.
2088 *
2089 * @bssid: The AP's BSSID.
2090 * @pmkid: The PMK material itself.
2091 */
2092struct cfg80211_pmksa {
2093	const u8 *bssid;
2094	const u8 *pmkid;
2095};
2096
2097/**
2098 * struct cfg80211_pkt_pattern - packet pattern
2099 * @mask: bitmask where to match pattern and where to ignore bytes,
2100 *	one bit per byte, in same format as nl80211
2101 * @pattern: bytes to match where bitmask is 1
2102 * @pattern_len: length of pattern (in bytes)
2103 * @pkt_offset: packet offset (in bytes)
2104 *
2105 * Internal note: @mask and @pattern are allocated in one chunk of
2106 * memory, free @mask only!
2107 */
2108struct cfg80211_pkt_pattern {
2109	const u8 *mask, *pattern;
2110	int pattern_len;
2111	int pkt_offset;
2112};
2113
2114/**
2115 * struct cfg80211_wowlan_tcp - TCP connection parameters
2116 *
2117 * @sock: (internal) socket for source port allocation
2118 * @src: source IP address
2119 * @dst: destination IP address
2120 * @dst_mac: destination MAC address
2121 * @src_port: source port
2122 * @dst_port: destination port
2123 * @payload_len: data payload length
2124 * @payload: data payload buffer
2125 * @payload_seq: payload sequence stamping configuration
2126 * @data_interval: interval at which to send data packets
2127 * @wake_len: wakeup payload match length
2128 * @wake_data: wakeup payload match data
2129 * @wake_mask: wakeup payload match mask
2130 * @tokens_size: length of the tokens buffer
2131 * @payload_tok: payload token usage configuration
2132 */
2133struct cfg80211_wowlan_tcp {
2134	struct socket *sock;
2135	__be32 src, dst;
2136	u16 src_port, dst_port;
2137	u8 dst_mac[ETH_ALEN];
2138	int payload_len;
2139	const u8 *payload;
2140	struct nl80211_wowlan_tcp_data_seq payload_seq;
2141	u32 data_interval;
2142	u32 wake_len;
2143	const u8 *wake_data, *wake_mask;
2144	u32 tokens_size;
2145	/* must be last, variable member */
2146	struct nl80211_wowlan_tcp_data_token payload_tok;
2147};
2148
2149/**
2150 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2151 *
2152 * This structure defines the enabled WoWLAN triggers for the device.
2153 * @any: wake up on any activity -- special trigger if device continues
2154 *	operating as normal during suspend
2155 * @disconnect: wake up if getting disconnected
2156 * @magic_pkt: wake up on receiving magic packet
2157 * @patterns: wake up on receiving packet matching a pattern
2158 * @n_patterns: number of patterns
2159 * @gtk_rekey_failure: wake up on GTK rekey failure
2160 * @eap_identity_req: wake up on EAP identity request packet
2161 * @four_way_handshake: wake up on 4-way handshake
2162 * @rfkill_release: wake up when rfkill is released
2163 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2164 *	NULL if not configured.
2165 * @nd_config: configuration for the scan to be used for net detect wake.
2166 */
2167struct cfg80211_wowlan {
2168	bool any, disconnect, magic_pkt, gtk_rekey_failure,
2169	     eap_identity_req, four_way_handshake,
2170	     rfkill_release;
2171	struct cfg80211_pkt_pattern *patterns;
2172	struct cfg80211_wowlan_tcp *tcp;
2173	int n_patterns;
2174	struct cfg80211_sched_scan_request *nd_config;
2175};
2176
2177/**
2178 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2179 *
2180 * This structure defines coalesce rule for the device.
2181 * @delay: maximum coalescing delay in msecs.
2182 * @condition: condition for packet coalescence.
2183 *	see &enum nl80211_coalesce_condition.
2184 * @patterns: array of packet patterns
2185 * @n_patterns: number of patterns
2186 */
2187struct cfg80211_coalesce_rules {
2188	int delay;
2189	enum nl80211_coalesce_condition condition;
2190	struct cfg80211_pkt_pattern *patterns;
2191	int n_patterns;
2192};
2193
2194/**
2195 * struct cfg80211_coalesce - Packet coalescing settings
2196 *
2197 * This structure defines coalescing settings.
2198 * @rules: array of coalesce rules
2199 * @n_rules: number of rules
2200 */
2201struct cfg80211_coalesce {
2202	struct cfg80211_coalesce_rules *rules;
2203	int n_rules;
2204};
2205
2206/**
2207 * struct cfg80211_wowlan_nd_match - information about the match
2208 *
2209 * @ssid: SSID of the match that triggered the wake up
2210 * @n_channels: Number of channels where the match occurred.  This
2211 *	value may be zero if the driver can't report the channels.
2212 * @channels: center frequencies of the channels where a match
2213 *	occurred (in MHz)
2214 */
2215struct cfg80211_wowlan_nd_match {
2216	struct cfg80211_ssid ssid;
2217	int n_channels;
2218	u32 channels[];
2219};
2220
2221/**
2222 * struct cfg80211_wowlan_nd_info - net detect wake up information
2223 *
2224 * @n_matches: Number of match information instances provided in
2225 *	@matches.  This value may be zero if the driver can't provide
2226 *	match information.
2227 * @matches: Array of pointers to matches containing information about
2228 *	the matches that triggered the wake up.
2229 */
2230struct cfg80211_wowlan_nd_info {
2231	int n_matches;
2232	struct cfg80211_wowlan_nd_match *matches[];
2233};
2234
2235/**
2236 * struct cfg80211_wowlan_wakeup - wakeup report
2237 * @disconnect: woke up by getting disconnected
2238 * @magic_pkt: woke up by receiving magic packet
2239 * @gtk_rekey_failure: woke up by GTK rekey failure
2240 * @eap_identity_req: woke up by EAP identity request packet
2241 * @four_way_handshake: woke up by 4-way handshake
2242 * @rfkill_release: woke up by rfkill being released
2243 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2244 * @packet_present_len: copied wakeup packet data
2245 * @packet_len: original wakeup packet length
2246 * @packet: The packet causing the wakeup, if any.
2247 * @packet_80211:  For pattern match, magic packet and other data
2248 *	frame triggers an 802.3 frame should be reported, for
2249 *	disconnect due to deauth 802.11 frame. This indicates which
2250 *	it is.
2251 * @tcp_match: TCP wakeup packet received
2252 * @tcp_connlost: TCP connection lost or failed to establish
2253 * @tcp_nomoretokens: TCP data ran out of tokens
2254 * @net_detect: if not %NULL, woke up because of net detect
2255 */
2256struct cfg80211_wowlan_wakeup {
2257	bool disconnect, magic_pkt, gtk_rekey_failure,
2258	     eap_identity_req, four_way_handshake,
2259	     rfkill_release, packet_80211,
2260	     tcp_match, tcp_connlost, tcp_nomoretokens;
2261	s32 pattern_idx;
2262	u32 packet_present_len, packet_len;
2263	const void *packet;
2264	struct cfg80211_wowlan_nd_info *net_detect;
2265};
2266
2267/**
2268 * struct cfg80211_gtk_rekey_data - rekey data
2269 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2270 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2271 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2272 */
2273struct cfg80211_gtk_rekey_data {
2274	const u8 *kek, *kck, *replay_ctr;
2275};
2276
2277/**
2278 * struct cfg80211_update_ft_ies_params - FT IE Information
2279 *
2280 * This structure provides information needed to update the fast transition IE
2281 *
2282 * @md: The Mobility Domain ID, 2 Octet value
2283 * @ie: Fast Transition IEs
2284 * @ie_len: Length of ft_ie in octets
2285 */
2286struct cfg80211_update_ft_ies_params {
2287	u16 md;
2288	const u8 *ie;
2289	size_t ie_len;
2290};
2291
2292/**
2293 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2294 *
2295 * This structure provides information needed to transmit a mgmt frame
2296 *
2297 * @chan: channel to use
2298 * @offchan: indicates wether off channel operation is required
2299 * @wait: duration for ROC
2300 * @buf: buffer to transmit
2301 * @len: buffer length
2302 * @no_cck: don't use cck rates for this frame
2303 * @dont_wait_for_ack: tells the low level not to wait for an ack
2304 * @n_csa_offsets: length of csa_offsets array
2305 * @csa_offsets: array of all the csa offsets in the frame
2306 */
2307struct cfg80211_mgmt_tx_params {
2308	struct ieee80211_channel *chan;
2309	bool offchan;
2310	unsigned int wait;
2311	const u8 *buf;
2312	size_t len;
2313	bool no_cck;
2314	bool dont_wait_for_ack;
2315	int n_csa_offsets;
2316	const u16 *csa_offsets;
2317};
2318
2319/**
2320 * struct cfg80211_dscp_exception - DSCP exception
2321 *
2322 * @dscp: DSCP value that does not adhere to the user priority range definition
2323 * @up: user priority value to which the corresponding DSCP value belongs
2324 */
2325struct cfg80211_dscp_exception {
2326	u8 dscp;
2327	u8 up;
2328};
2329
2330/**
2331 * struct cfg80211_dscp_range - DSCP range definition for user priority
2332 *
2333 * @low: lowest DSCP value of this user priority range, inclusive
2334 * @high: highest DSCP value of this user priority range, inclusive
2335 */
2336struct cfg80211_dscp_range {
2337	u8 low;
2338	u8 high;
2339};
2340
2341/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2342#define IEEE80211_QOS_MAP_MAX_EX	21
2343#define IEEE80211_QOS_MAP_LEN_MIN	16
2344#define IEEE80211_QOS_MAP_LEN_MAX \
2345	(IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2346
2347/**
2348 * struct cfg80211_qos_map - QoS Map Information
2349 *
2350 * This struct defines the Interworking QoS map setting for DSCP values
2351 *
2352 * @num_des: number of DSCP exceptions (0..21)
2353 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2354 *	the user priority DSCP range definition
2355 * @up: DSCP range definition for a particular user priority
2356 */
2357struct cfg80211_qos_map {
2358	u8 num_des;
2359	struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2360	struct cfg80211_dscp_range up[8];
2361};
2362
2363/**
2364 * struct cfg80211_nan_conf - NAN configuration
2365 *
2366 * This struct defines NAN configuration parameters
2367 *
2368 * @master_pref: master preference (1 - 255)
2369 * @dual: dual band operation mode, see &enum nl80211_nan_dual_band_conf
2370 */
2371struct cfg80211_nan_conf {
2372	u8 master_pref;
2373	u8 dual;
2374};
2375
2376/**
2377 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2378 * configuration
2379 *
2380 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2381 * @CFG80211_NAN_CONF_CHANGED_DUAL: dual band operation
2382 */
2383enum cfg80211_nan_conf_changes {
2384	CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2385	CFG80211_NAN_CONF_CHANGED_DUAL = BIT(1),
2386};
2387
2388/**
2389 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2390 *
2391 * @filter: the content of the filter
2392 * @len: the length of the filter
2393 */
2394struct cfg80211_nan_func_filter {
2395	const u8 *filter;
2396	u8 len;
2397};
2398
2399/**
2400 * struct cfg80211_nan_func - a NAN function
2401 *
2402 * @type: &enum nl80211_nan_function_type
2403 * @service_id: the service ID of the function
2404 * @publish_type: &nl80211_nan_publish_type
2405 * @close_range: if true, the range should be limited. Threshold is
2406 *	implementation specific.
2407 * @publish_bcast: if true, the solicited publish should be broadcasted
2408 * @subscribe_active: if true, the subscribe is active
2409 * @followup_id: the instance ID for follow up
2410 * @followup_reqid: the requestor instance ID for follow up
2411 * @followup_dest: MAC address of the recipient of the follow up
2412 * @ttl: time to live counter in DW.
2413 * @serv_spec_info: Service Specific Info
2414 * @serv_spec_info_len: Service Specific Info length
2415 * @srf_include: if true, SRF is inclusive
2416 * @srf_bf: Bloom Filter
2417 * @srf_bf_len: Bloom Filter length
2418 * @srf_bf_idx: Bloom Filter index
2419 * @srf_macs: SRF MAC addresses
2420 * @srf_num_macs: number of MAC addresses in SRF
2421 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2422 * @tx_filters: filters that should be transmitted in the SDF.
2423 * @num_rx_filters: length of &rx_filters.
2424 * @num_tx_filters: length of &tx_filters.
2425 * @instance_id: driver allocated id of the function.
2426 * @cookie: unique NAN function identifier.
2427 */
2428struct cfg80211_nan_func {
2429	enum nl80211_nan_function_type type;
2430	u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2431	u8 publish_type;
2432	bool close_range;
2433	bool publish_bcast;
2434	bool subscribe_active;
2435	u8 followup_id;
2436	u8 followup_reqid;
2437	struct mac_address followup_dest;
2438	u32 ttl;
2439	const u8 *serv_spec_info;
2440	u8 serv_spec_info_len;
2441	bool srf_include;
2442	const u8 *srf_bf;
2443	u8 srf_bf_len;
2444	u8 srf_bf_idx;
2445	struct mac_address *srf_macs;
2446	int srf_num_macs;
2447	struct cfg80211_nan_func_filter *rx_filters;
2448	struct cfg80211_nan_func_filter *tx_filters;
2449	u8 num_tx_filters;
2450	u8 num_rx_filters;
2451	u8 instance_id;
2452	u64 cookie;
2453};
2454
2455/**
2456 * struct cfg80211_ops - backend description for wireless configuration
2457 *
2458 * This struct is registered by fullmac card drivers and/or wireless stacks
2459 * in order to handle configuration requests on their interfaces.
2460 *
2461 * All callbacks except where otherwise noted should return 0
2462 * on success or a negative error code.
2463 *
2464 * All operations are currently invoked under rtnl for consistency with the
2465 * wireless extensions but this is subject to reevaluation as soon as this
2466 * code is used more widely and we have a first user without wext.
2467 *
2468 * @suspend: wiphy device needs to be suspended. The variable @wow will
2469 *	be %NULL or contain the enabled Wake-on-Wireless triggers that are
2470 *	configured for the device.
2471 * @resume: wiphy device needs to be resumed
2472 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2473 *	to call device_set_wakeup_enable() to enable/disable wakeup from
2474 *	the device.
2475 *
2476 * @add_virtual_intf: create a new virtual interface with the given name,
2477 *	must set the struct wireless_dev's iftype. Beware: You must create
2478 *	the new netdev in the wiphy's network namespace! Returns the struct
2479 *	wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2480 *	also set the address member in the wdev.
2481 *
2482 * @del_virtual_intf: remove the virtual interface
2483 *
2484 * @change_virtual_intf: change type/configuration of virtual interface,
2485 *	keep the struct wireless_dev's iftype updated.
2486 *
2487 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2488 *	when adding a group key.
2489 *
2490 * @get_key: get information about the key with the given parameters.
2491 *	@mac_addr will be %NULL when requesting information for a group
2492 *	key. All pointers given to the @callback function need not be valid
2493 *	after it returns. This function should return an error if it is
2494 *	not possible to retrieve the key, -ENOENT if it doesn't exist.
2495 *
2496 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2497 *	and @key_index, return -ENOENT if the key doesn't exist.
2498 *
2499 * @set_default_key: set the default key on an interface
2500 *
2501 * @set_default_mgmt_key: set the default management frame key on an interface
2502 *
2503 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2504 *
2505 * @start_ap: Start acting in AP mode defined by the parameters.
2506 * @change_beacon: Change the beacon parameters for an access point mode
2507 *	interface. This should reject the call when AP mode wasn't started.
2508 * @stop_ap: Stop being an AP, including stopping beaconing.
2509 *
2510 * @add_station: Add a new station.
2511 * @del_station: Remove a station
2512 * @change_station: Modify a given station. Note that flags changes are not much
2513 *	validated in cfg80211, in particular the auth/assoc/authorized flags
2514 *	might come to the driver in invalid combinations -- make sure to check
2515 *	them, also against the existing state! Drivers must call
2516 *	cfg80211_check_station_change() to validate the information.
2517 * @get_station: get station information for the station identified by @mac
2518 * @dump_station: dump station callback -- resume dump at index @idx
2519 *
2520 * @add_mpath: add a fixed mesh path
2521 * @del_mpath: delete a given mesh path
2522 * @change_mpath: change a given mesh path
2523 * @get_mpath: get a mesh path for the given parameters
2524 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2525 * @get_mpp: get a mesh proxy path for the given parameters
2526 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2527 * @join_mesh: join the mesh network with the specified parameters
2528 *	(invoked with the wireless_dev mutex held)
2529 * @leave_mesh: leave the current mesh network
2530 *	(invoked with the wireless_dev mutex held)
2531 *
2532 * @get_mesh_config: Get the current mesh configuration
2533 *
2534 * @update_mesh_config: Update mesh parameters on a running mesh.
2535 *	The mask is a bitfield which tells us which parameters to
2536 *	set, and which to leave alone.
2537 *
2538 * @change_bss: Modify parameters for a given BSS.
2539 *
2540 * @set_txq_params: Set TX queue parameters
2541 *
2542 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2543 *	as it doesn't implement join_mesh and needs to set the channel to
2544 *	join the mesh instead.
2545 *
2546 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2547 *	interfaces are active this callback should reject the configuration.
2548 *	If no interfaces are active or the device is down, the channel should
2549 *	be stored for when a monitor interface becomes active.
2550 *
2551 * @scan: Request to do a scan. If returning zero, the scan request is given
2552 *	the driver, and will be valid until passed to cfg80211_scan_done().
2553 *	For scan results, call cfg80211_inform_bss(); you can call this outside
2554 *	the scan/scan_done bracket too.
2555 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2556 *	indicate the status of the scan through cfg80211_scan_done().
2557 *
2558 * @auth: Request to authenticate with the specified peer
2559 *	(invoked with the wireless_dev mutex held)
2560 * @assoc: Request to (re)associate with the specified peer
2561 *	(invoked with the wireless_dev mutex held)
2562 * @deauth: Request to deauthenticate from the specified peer
2563 *	(invoked with the wireless_dev mutex held)
2564 * @disassoc: Request to disassociate from the specified peer
2565 *	(invoked with the wireless_dev mutex held)
2566 *
2567 * @connect: Connect to the ESS with the specified parameters. When connected,
2568 *	call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2569 *	%WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2570 *	cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2571 *	from the AP or cfg80211_connect_timeout() if no frame with status code
2572 *	was received.
2573 *	The driver is allowed to roam to other BSSes within the ESS when the
2574 *	other BSS matches the connect parameters. When such roaming is initiated
2575 *	by the driver, the driver is expected to verify that the target matches
2576 *	the configured security parameters and to use Reassociation Request
2577 *	frame instead of Association Request frame.
2578 *	The connect function can also be used to request the driver to perform a
2579 *	specific roam when connected to an ESS. In that case, the prev_bssid
2580 *	parameter is set to the BSSID of the currently associated BSS as an
2581 *	indication of requesting reassociation.
2582 *	In both the driver-initiated and new connect() call initiated roaming
2583 *	cases, the result of roaming is indicated with a call to
2584 *	cfg80211_roamed() or cfg80211_roamed_bss().
2585 *	(invoked with the wireless_dev mutex held)
2586 * @update_connect_params: Update the connect parameters while connected to a
2587 *	BSS. The updated parameters can be used by driver/firmware for
2588 *	subsequent BSS selection (roaming) decisions and to form the
2589 *	Authentication/(Re)Association Request frames. This call does not
2590 *	request an immediate disassociation or reassociation with the current
2591 *	BSS, i.e., this impacts only subsequent (re)associations. The bits in
2592 *	changed are defined in &enum cfg80211_connect_params_changed.
2593 *	(invoked with the wireless_dev mutex held)
2594 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
2595 *      connection is in progress. Once done, call cfg80211_disconnected() in
2596 *      case connection was already established (invoked with the
2597 *      wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
2598 *
2599 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2600 *	cfg80211_ibss_joined(), also call that function when changing BSSID due
2601 *	to a merge.
2602 *	(invoked with the wireless_dev mutex held)
2603 * @leave_ibss: Leave the IBSS.
2604 *	(invoked with the wireless_dev mutex held)
2605 *
2606 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2607 *	MESH mode)
2608 *
2609 * @set_wiphy_params: Notify that wiphy parameters have changed;
2610 *	@changed bitfield (see &enum wiphy_params_flags) describes which values
2611 *	have changed. The actual parameter values are available in
2612 *	struct wiphy. If returning an error, no value should be changed.
2613 *
2614 * @set_tx_power: set the transmit power according to the parameters,
2615 *	the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2616 *	wdev may be %NULL if power was set for the wiphy, and will
2617 *	always be %NULL unless the driver supports per-vif TX power
2618 *	(as advertised by the nl80211 feature flag.)
2619 * @get_tx_power: store the current TX power into the dbm variable;
2620 *	return 0 if successful
2621 *
2622 * @set_wds_peer: set the WDS peer for a WDS interface
2623 *
2624 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2625 *	functions to adjust rfkill hw state
2626 *
2627 * @dump_survey: get site survey information.
2628 *
2629 * @remain_on_channel: Request the driver to remain awake on the specified
2630 *	channel for the specified duration to complete an off-channel
2631 *	operation (e.g., public action frame exchange). When the driver is
2632 *	ready on the requested channel, it must indicate this with an event
2633 *	notification by calling cfg80211_ready_on_channel().
2634 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2635 *	This allows the operation to be terminated prior to timeout based on
2636 *	the duration value.
2637 * @mgmt_tx: Transmit a management frame.
2638 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2639 *	frame on another channel
2640 *
2641 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2642 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2643 *	used by the function, but 0 and 1 must not be touched. Additionally,
2644 *	return error codes other than -ENOBUFS and -ENOENT will terminate the
2645 *	dump and return to userspace with an error, so be careful. If any data
2646 *	was passed in from userspace then the data/len arguments will be present
2647 *	and point to the data contained in %NL80211_ATTR_TESTDATA.
2648 *
2649 * @set_bitrate_mask: set the bitrate mask configuration
2650 *
2651 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2652 *	devices running firmwares capable of generating the (re) association
2653 *	RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2654 * @del_pmksa: Delete a cached PMKID.
2655 * @flush_pmksa: Flush all cached PMKIDs.
2656 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2657 *	allows the driver to adjust the dynamic ps timeout value.
2658 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2659 *	After configuration, the driver should (soon) send an event indicating
2660 *	the current level is above/below the configured threshold; this may
2661 *	need some care when the configuration is changed (without first being
2662 *	disabled.)
2663 * @set_cqm_txe_config: Configure connection quality monitor TX error
2664 *	thresholds.
2665 * @sched_scan_start: Tell the driver to start a scheduled scan.
2666 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2667 *	call must stop the scheduled scan and be ready for starting a new one
2668 *	before it returns, i.e. @sched_scan_start may be called immediately
2669 *	after that again and should not fail in that case. The driver should
2670 *	not call cfg80211_sched_scan_stopped() for a requested stop (when this
2671 *	method returns 0.)
2672 *
2673 * @mgmt_frame_register: Notify driver that a management frame type was
2674 *	registered. The callback is allowed to sleep.
2675 *
2676 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2677 *	Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2678 *	reject TX/RX mask combinations they cannot support by returning -EINVAL
2679 *	(also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2680 *
2681 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2682 *
2683 * @tdls_mgmt: Transmit a TDLS management frame.
2684 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2685 *
2686 * @probe_client: probe an associated client, must return a cookie that it
2687 *	later passes to cfg80211_probe_status().
2688 *
2689 * @set_noack_map: Set the NoAck Map for the TIDs.
2690 *
2691 * @get_channel: Get the current operating channel for the virtual interface.
2692 *	For monitor interfaces, it should return %NULL unless there's a single
2693 *	current monitoring channel.
2694 *
2695 * @start_p2p_device: Start the given P2P device.
2696 * @stop_p2p_device: Stop the given P2P device.
2697 *
2698 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2699 *	Parameters include ACL policy, an array of MAC address of stations
2700 *	and the number of MAC addresses. If there is already a list in driver
2701 *	this new list replaces the existing one. Driver has to clear its ACL
2702 *	when number of MAC addresses entries is passed as 0. Drivers which
2703 *	advertise the support for MAC based ACL have to implement this callback.
2704 *
2705 * @start_radar_detection: Start radar detection in the driver.
2706 *
2707 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2708 *	driver. If the SME is in the driver/firmware, this information can be
2709 *	used in building Authentication and Reassociation Request frames.
2710 *
2711 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2712 *	for a given duration (milliseconds). The protocol is provided so the
2713 *	driver can take the most appropriate actions.
2714 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2715 *	reliability. This operation can not fail.
2716 * @set_coalesce: Set coalesce parameters.
2717 *
2718 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2719 *	responsible for veryfing if the switch is possible. Since this is
2720 *	inherently tricky driver may decide to disconnect an interface later
2721 *	with cfg80211_stop_iface(). This doesn't mean driver can accept
2722 *	everything. It should do it's best to verify requests and reject them
2723 *	as soon as possible.
2724 *
2725 * @set_qos_map: Set QoS mapping information to the driver
2726 *
2727 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2728 *	given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2729 *	changes during the lifetime of the BSS.
2730 *
2731 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2732 *	with the given parameters; action frame exchange has been handled by
2733 *	userspace so this just has to modify the TX path to take the TS into
2734 *	account.
2735 *	If the admitted time is 0 just validate the parameters to make sure
2736 *	the session can be created at all; it is valid to just always return
2737 *	success for that but that may result in inefficient behaviour (handshake
2738 *	with the peer followed by immediate teardown when the addition is later
2739 *	rejected)
2740 * @del_tx_ts: remove an existing TX TS
2741 *
2742 * @join_ocb: join the OCB network with the specified parameters
2743 *	(invoked with the wireless_dev mutex held)
2744 * @leave_ocb: leave the current OCB network
2745 *	(invoked with the wireless_dev mutex held)
2746 *
2747 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2748 *	is responsible for continually initiating channel-switching operations
2749 *	and returning to the base channel for communication with the AP.
2750 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2751 *	peers must be on the base channel when the call completes.
2752 * @start_nan: Start the NAN interface.
2753 * @stop_nan: Stop the NAN interface.
2754 * @add_nan_func: Add a NAN function. Returns negative value on failure.
2755 *	On success @nan_func ownership is transferred to the driver and
2756 *	it may access it outside of the scope of this function. The driver
2757 *	should free the @nan_func when no longer needed by calling
2758 *	cfg80211_free_nan_func().
2759 *	On success the driver should assign an instance_id in the
2760 *	provided @nan_func.
2761 * @del_nan_func: Delete a NAN function.
2762 * @nan_change_conf: changes NAN configuration. The changed parameters must
2763 *	be specified in @changes (using &enum cfg80211_nan_conf_changes);
2764 *	All other parameters must be ignored.
2765 *
2766 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
2767 */
2768struct cfg80211_ops {
2769	int	(*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2770	int	(*resume)(struct wiphy *wiphy);
2771	void	(*set_wakeup)(struct wiphy *wiphy, bool enabled);
2772
2773	struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2774						  const char *name,
2775						  unsigned char name_assign_type,
2776						  enum nl80211_iftype type,
2777						  u32 *flags,
2778						  struct vif_params *params);
2779	int	(*del_virtual_intf)(struct wiphy *wiphy,
2780				    struct wireless_dev *wdev);
2781	int	(*change_virtual_intf)(struct wiphy *wiphy,
2782				       struct net_device *dev,
2783				       enum nl80211_iftype type, u32 *flags,
2784				       struct vif_params *params);
2785
2786	int	(*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2787			   u8 key_index, bool pairwise, const u8 *mac_addr,
2788			   struct key_params *params);
2789	int	(*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2790			   u8 key_index, bool pairwise, const u8 *mac_addr,
2791			   void *cookie,
2792			   void (*callback)(void *cookie, struct key_params*));
2793	int	(*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2794			   u8 key_index, bool pairwise, const u8 *mac_addr);
2795	int	(*set_default_key)(struct wiphy *wiphy,
2796				   struct net_device *netdev,
2797				   u8 key_index, bool unicast, bool multicast);
2798	int	(*set_default_mgmt_key)(struct wiphy *wiphy,
2799					struct net_device *netdev,
2800					u8 key_index);
2801
2802	int	(*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2803			    struct cfg80211_ap_settings *settings);
2804	int	(*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2805				 struct cfg80211_beacon_data *info);
2806	int	(*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2807
2808
2809	int	(*add_station)(struct wiphy *wiphy, struct net_device *dev,
2810			       const u8 *mac,
2811			       struct station_parameters *params);
2812	int	(*del_station)(struct wiphy *wiphy, struct net_device *dev,
2813			       struct station_del_parameters *params);
2814	int	(*change_station)(struct wiphy *wiphy, struct net_device *dev,
2815				  const u8 *mac,
2816				  struct station_parameters *params);
2817	int	(*get_station)(struct wiphy *wiphy, struct net_device *dev,
2818			       const u8 *mac, struct station_info *sinfo);
2819	int	(*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2820				int idx, u8 *mac, struct station_info *sinfo);
2821
2822	int	(*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2823			       const u8 *dst, const u8 *next_hop);
2824	int	(*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2825			       const u8 *dst);
2826	int	(*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2827				  const u8 *dst, const u8 *next_hop);
2828	int	(*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2829			     u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2830	int	(*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2831			      int idx, u8 *dst, u8 *next_hop,
2832			      struct mpath_info *pinfo);
2833	int	(*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2834			   u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2835	int	(*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2836			    int idx, u8 *dst, u8 *mpp,
2837			    struct mpath_info *pinfo);
2838	int	(*get_mesh_config)(struct wiphy *wiphy,
2839				struct net_device *dev,
2840				struct mesh_config *conf);
2841	int	(*update_mesh_config)(struct wiphy *wiphy,
2842				      struct net_device *dev, u32 mask,
2843				      const struct mesh_config *nconf);
2844	int	(*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2845			     const struct mesh_config *conf,
2846			     const struct mesh_setup *setup);
2847	int	(*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2848
2849	int	(*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2850			    struct ocb_setup *setup);
2851	int	(*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2852
2853	int	(*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2854			      struct bss_parameters *params);
2855
2856	int	(*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2857				  struct ieee80211_txq_params *params);
2858
2859	int	(*libertas_set_mesh_channel)(struct wiphy *wiphy,
2860					     struct net_device *dev,
2861					     struct ieee80211_channel *chan);
2862
2863	int	(*set_monitor_channel)(struct wiphy *wiphy,
2864				       struct cfg80211_chan_def *chandef);
2865
2866	int	(*scan)(struct wiphy *wiphy,
2867			struct cfg80211_scan_request *request);
2868	void	(*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
2869
2870	int	(*auth)(struct wiphy *wiphy, struct net_device *dev,
2871			struct cfg80211_auth_request *req);
2872	int	(*assoc)(struct wiphy *wiphy, struct net_device *dev,
2873			 struct cfg80211_assoc_request *req);
2874	int	(*deauth)(struct wiphy *wiphy, struct net_device *dev,
2875			  struct cfg80211_deauth_request *req);
2876	int	(*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2877			    struct cfg80211_disassoc_request *req);
2878
2879	int	(*connect)(struct wiphy *wiphy, struct net_device *dev,
2880			   struct cfg80211_connect_params *sme);
2881	int	(*update_connect_params)(struct wiphy *wiphy,
2882					 struct net_device *dev,
2883					 struct cfg80211_connect_params *sme,
2884					 u32 changed);
2885	int	(*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2886			      u16 reason_code);
2887
2888	int	(*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2889			     struct cfg80211_ibss_params *params);
2890	int	(*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2891
2892	int	(*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2893				  int rate[NUM_NL80211_BANDS]);
2894
2895	int	(*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2896
2897	int	(*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2898				enum nl80211_tx_power_setting type, int mbm);
2899	int	(*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2900				int *dbm);
2901
2902	int	(*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2903				const u8 *addr);
2904
2905	void	(*rfkill_poll)(struct wiphy *wiphy);
2906
2907#ifdef CONFIG_NL80211_TESTMODE
2908	int	(*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2909				void *data, int len);
2910	int	(*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2911				 struct netlink_callback *cb,
2912				 void *data, int len);
2913#endif
2914
2915	int	(*set_bitrate_mask)(struct wiphy *wiphy,
2916				    struct net_device *dev,
2917				    const u8 *peer,
2918				    const struct cfg80211_bitrate_mask *mask);
2919
2920	int	(*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2921			int idx, struct survey_info *info);
2922
2923	int	(*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2924			     struct cfg80211_pmksa *pmksa);
2925	int	(*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2926			     struct cfg80211_pmksa *pmksa);
2927	int	(*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2928
2929	int	(*remain_on_channel)(struct wiphy *wiphy,
2930				     struct wireless_dev *wdev,
2931				     struct ieee80211_channel *chan,
2932				     unsigned int duration,
2933				     u64 *cookie);
2934	int	(*cancel_remain_on_channel)(struct wiphy *wiphy,
2935					    struct wireless_dev *wdev,
2936					    u64 cookie);
2937
2938	int	(*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2939			   struct cfg80211_mgmt_tx_params *params,
2940			   u64 *cookie);
2941	int	(*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2942				       struct wireless_dev *wdev,
2943				       u64 cookie);
2944
2945	int	(*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2946				  bool enabled, int timeout);
2947
2948	int	(*set_cqm_rssi_config)(struct wiphy *wiphy,
2949				       struct net_device *dev,
2950				       s32 rssi_thold, u32 rssi_hyst);
2951
2952	int	(*set_cqm_txe_config)(struct wiphy *wiphy,
2953				      struct net_device *dev,
2954				      u32 rate, u32 pkts, u32 intvl);
2955
2956	void	(*mgmt_frame_register)(struct wiphy *wiphy,
2957				       struct wireless_dev *wdev,
2958				       u16 frame_type, bool reg);
2959
2960	int	(*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2961	int	(*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2962
2963	int	(*sched_scan_start)(struct wiphy *wiphy,
2964				struct net_device *dev,
2965				struct cfg80211_sched_scan_request *request);
2966	int	(*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2967
2968	int	(*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2969				  struct cfg80211_gtk_rekey_data *data);
2970
2971	int	(*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2972			     const u8 *peer, u8 action_code,  u8 dialog_token,
2973			     u16 status_code, u32 peer_capability,
2974			     bool initiator, const u8 *buf, size_t len);
2975	int	(*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2976			     const u8 *peer, enum nl80211_tdls_operation oper);
2977
2978	int	(*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2979				const u8 *peer, u64 *cookie);
2980
2981	int	(*set_noack_map)(struct wiphy *wiphy,
2982				  struct net_device *dev,
2983				  u16 noack_map);
2984
2985	int	(*get_channel)(struct wiphy *wiphy,
2986			       struct wireless_dev *wdev,
2987			       struct cfg80211_chan_def *chandef);
2988
2989	int	(*start_p2p_device)(struct wiphy *wiphy,
2990				    struct wireless_dev *wdev);
2991	void	(*stop_p2p_device)(struct wiphy *wiphy,
2992				   struct wireless_dev *wdev);
2993
2994	int	(*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2995			       const struct cfg80211_acl_data *params);
2996
2997	int	(*start_radar_detection)(struct wiphy *wiphy,
2998					 struct net_device *dev,
2999					 struct cfg80211_chan_def *chandef,
3000					 u32 cac_time_ms);
3001	int	(*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3002				 struct cfg80211_update_ft_ies_params *ftie);
3003	int	(*crit_proto_start)(struct wiphy *wiphy,
3004				    struct wireless_dev *wdev,
3005				    enum nl80211_crit_proto_id protocol,
3006				    u16 duration);
3007	void	(*crit_proto_stop)(struct wiphy *wiphy,
3008				   struct wireless_dev *wdev);
3009	int	(*set_coalesce)(struct wiphy *wiphy,
3010				struct cfg80211_coalesce *coalesce);
3011
3012	int	(*channel_switch)(struct wiphy *wiphy,
3013				  struct net_device *dev,
3014				  struct cfg80211_csa_settings *params);
3015
3016	int     (*set_qos_map)(struct wiphy *wiphy,
3017			       struct net_device *dev,
3018			       struct cfg80211_qos_map *qos_map);
3019
3020	int	(*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3021				    struct cfg80211_chan_def *chandef);
3022
3023	int	(*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3024			     u8 tsid, const u8 *peer, u8 user_prio,
3025			     u16 admitted_time);
3026	int	(*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3027			     u8 tsid, const u8 *peer);
3028
3029	int	(*tdls_channel_switch)(struct wiphy *wiphy,
3030				       struct net_device *dev,
3031				       const u8 *addr, u8 oper_class,
3032				       struct cfg80211_chan_def *chandef);
3033	void	(*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3034					      struct net_device *dev,
3035					      const u8 *addr);
3036	int	(*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3037			     struct cfg80211_nan_conf *conf);
3038	void	(*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3039	int	(*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3040				struct cfg80211_nan_func *nan_func);
3041	void	(*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3042			       u64 cookie);
3043	int	(*nan_change_conf)(struct wiphy *wiphy,
3044				   struct wireless_dev *wdev,
3045				   struct cfg80211_nan_conf *conf,
3046				   u32 changes);
3047
3048	int	(*set_multicast_to_unicast)(struct wiphy *wiphy,
3049					    struct net_device *dev,
3050					    const bool enabled);
3051};
3052
3053/*
3054 * wireless hardware and networking interfaces structures
3055 * and registration/helper functions
3056 */
3057
3058/**
3059 * enum wiphy_flags - wiphy capability flags
3060 *
3061 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3062 *	wiphy at all
3063 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3064 *	by default -- this flag will be set depending on the kernel's default
3065 *	on wiphy_new(), but can be changed by the driver if it has a good
3066 *	reason to override the default
3067 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3068 *	on a VLAN interface)
3069 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3070 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3071 *	control port protocol ethertype. The device also honours the
3072 *	control_port_no_encrypt flag.
3073 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3074 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3075 *	auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3076 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
3077 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3078 *	firmware.
3079 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3080 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3081 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3082 *	link setup/discovery operations internally. Setup, discovery and
3083 *	teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3084 *	command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3085 *	used for asking the driver/firmware to perform a TDLS operation.
3086 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3087 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3088 *	when there are virtual interfaces in AP mode by calling
3089 *	cfg80211_report_obss_beacon().
3090 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3091 *	responds to probe-requests in hardware.
3092 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3093 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3094 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3095 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3096 *	beaconing mode (AP, IBSS, Mesh, ...).
3097 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3098 *	before connection.
3099 */
3100enum wiphy_flags {
3101	/* use hole at 0 */
3102	/* use hole at 1 */
3103	/* use hole at 2 */
3104	WIPHY_FLAG_NETNS_OK			= BIT(3),
3105	WIPHY_FLAG_PS_ON_BY_DEFAULT		= BIT(4),
3106	WIPHY_FLAG_4ADDR_AP			= BIT(5),
3107	WIPHY_FLAG_4ADDR_STATION		= BIT(6),
3108	WIPHY_FLAG_CONTROL_PORT_PROTOCOL	= BIT(7),
3109	WIPHY_FLAG_IBSS_RSN			= BIT(8),
3110	WIPHY_FLAG_MESH_AUTH			= BIT(10),
3111	WIPHY_FLAG_SUPPORTS_SCHED_SCAN		= BIT(11),
3112	/* use hole at 12 */
3113	WIPHY_FLAG_SUPPORTS_FW_ROAM		= BIT(13),
3114	WIPHY_FLAG_AP_UAPSD			= BIT(14),
3115	WIPHY_FLAG_SUPPORTS_TDLS		= BIT(15),
3116	WIPHY_FLAG_TDLS_EXTERNAL_SETUP		= BIT(16),
3117	WIPHY_FLAG_HAVE_AP_SME			= BIT(17),
3118	WIPHY_FLAG_REPORTS_OBSS			= BIT(18),
3119	WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD	= BIT(19),
3120	WIPHY_FLAG_OFFCHAN_TX			= BIT(20),
3121	WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL	= BIT(21),
3122	WIPHY_FLAG_SUPPORTS_5_10_MHZ		= BIT(22),
3123	WIPHY_FLAG_HAS_CHANNEL_SWITCH		= BIT(23),
3124	WIPHY_FLAG_HAS_STATIC_WEP		= BIT(24),
3125};
3126
3127/**
3128 * struct ieee80211_iface_limit - limit on certain interface types
3129 * @max: maximum number of interfaces of these types
3130 * @types: interface types (bits)
3131 */
3132struct ieee80211_iface_limit {
3133	u16 max;
3134	u16 types;
3135};
3136
3137/**
3138 * struct ieee80211_iface_combination - possible interface combination
3139 * @limits: limits for the given interface types
3140 * @n_limits: number of limitations
3141 * @num_different_channels: can use up to this many different channels
3142 * @max_interfaces: maximum number of interfaces in total allowed in this
3143 *	group
3144 * @beacon_int_infra_match: In this combination, the beacon intervals
3145 *	between infrastructure and AP types must match. This is required
3146 *	only in special cases.
3147 * @radar_detect_widths: bitmap of channel widths supported for radar detection
3148 * @radar_detect_regions: bitmap of regions supported for radar detection
3149 * @beacon_int_min_gcd: This interface combination supports different
3150 *	beacon intervals.
3151 *	= 0 - all beacon intervals for different interface must be same.
3152 *	> 0 - any beacon interval for the interface part of this combination AND
3153 *	      *GCD* of all beacon intervals from beaconing interfaces of this
3154 *	      combination must be greater or equal to this value.
3155 *
3156 * With this structure the driver can describe which interface
3157 * combinations it supports concurrently.
3158 *
3159 * Examples:
3160 *
3161 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3162 *
3163 *    .. code-block:: c
3164 *
3165 *	struct ieee80211_iface_limit limits1[] = {
3166 *		{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3167 *		{ .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3168 *	};
3169 *	struct ieee80211_iface_combination combination1 = {
3170 *		.limits = limits1,
3171 *		.n_limits = ARRAY_SIZE(limits1),
3172 *		.max_interfaces = 2,
3173 *		.beacon_int_infra_match = true,
3174 *	};
3175 *
3176 *
3177 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3178 *
3179 *    .. code-block:: c
3180 *
3181 *	struct ieee80211_iface_limit limits2[] = {
3182 *		{ .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3183 *				     BIT(NL80211_IFTYPE_P2P_GO), },
3184 *	};
3185 *	struct ieee80211_iface_combination combination2 = {
3186 *		.limits = limits2,
3187 *		.n_limits = ARRAY_SIZE(limits2),
3188 *		.max_interfaces = 8,
3189 *		.num_different_channels = 1,
3190 *	};
3191 *
3192 *
3193 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3194 *
3195 *    This allows for an infrastructure connection and three P2P connections.
3196 *
3197 *    .. code-block:: c
3198 *
3199 *	struct ieee80211_iface_limit limits3[] = {
3200 *		{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3201 *		{ .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3202 *				     BIT(NL80211_IFTYPE_P2P_CLIENT), },
3203 *	};
3204 *	struct ieee80211_iface_combination combination3 = {
3205 *		.limits = limits3,
3206 *		.n_limits = ARRAY_SIZE(limits3),
3207 *		.max_interfaces = 4,
3208 *		.num_different_channels = 2,
3209 *	};
3210 *
 
 
 
 
 
 
 
 
 
 
 
3211 */
3212struct ieee80211_iface_combination {
3213	const struct ieee80211_iface_limit *limits;
3214	u32 num_different_channels;
3215	u16 max_interfaces;
3216	u8 n_limits;
3217	bool beacon_int_infra_match;
3218	u8 radar_detect_widths;
3219	u8 radar_detect_regions;
3220	u32 beacon_int_min_gcd;
3221};
3222
3223struct ieee80211_txrx_stypes {
3224	u16 tx, rx;
3225};
3226
3227/**
3228 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3229 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3230 *	trigger that keeps the device operating as-is and
3231 *	wakes up the host on any activity, for example a
3232 *	received packet that passed filtering; note that the
3233 *	packet should be preserved in that case
3234 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3235 *	(see nl80211.h)
3236 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3237 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3238 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3239 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3240 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3241 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3242 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3243 */
3244enum wiphy_wowlan_support_flags {
3245	WIPHY_WOWLAN_ANY		= BIT(0),
3246	WIPHY_WOWLAN_MAGIC_PKT		= BIT(1),
3247	WIPHY_WOWLAN_DISCONNECT		= BIT(2),
3248	WIPHY_WOWLAN_SUPPORTS_GTK_REKEY	= BIT(3),
3249	WIPHY_WOWLAN_GTK_REKEY_FAILURE	= BIT(4),
3250	WIPHY_WOWLAN_EAP_IDENTITY_REQ	= BIT(5),
3251	WIPHY_WOWLAN_4WAY_HANDSHAKE	= BIT(6),
3252	WIPHY_WOWLAN_RFKILL_RELEASE	= BIT(7),
3253	WIPHY_WOWLAN_NET_DETECT		= BIT(8),
3254};
3255
3256struct wiphy_wowlan_tcp_support {
3257	const struct nl80211_wowlan_tcp_data_token_feature *tok;
3258	u32 data_payload_max;
3259	u32 data_interval_max;
3260	u32 wake_payload_max;
3261	bool seq;
3262};
3263
3264/**
3265 * struct wiphy_wowlan_support - WoWLAN support data
3266 * @flags: see &enum wiphy_wowlan_support_flags
3267 * @n_patterns: number of supported wakeup patterns
3268 *	(see nl80211.h for the pattern definition)
3269 * @pattern_max_len: maximum length of each pattern
3270 * @pattern_min_len: minimum length of each pattern
3271 * @max_pkt_offset: maximum Rx packet offset
3272 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3273 *	similar, but not necessarily identical, to max_match_sets for
3274 *	scheduled scans.
3275 *	See &struct cfg80211_sched_scan_request.@match_sets for more
3276 *	details.
3277 * @tcp: TCP wakeup support information
3278 */
3279struct wiphy_wowlan_support {
3280	u32 flags;
3281	int n_patterns;
3282	int pattern_max_len;
3283	int pattern_min_len;
3284	int max_pkt_offset;
3285	int max_nd_match_sets;
3286	const struct wiphy_wowlan_tcp_support *tcp;
3287};
3288
3289/**
3290 * struct wiphy_coalesce_support - coalesce support data
3291 * @n_rules: maximum number of coalesce rules
3292 * @max_delay: maximum supported coalescing delay in msecs
3293 * @n_patterns: number of supported patterns in a rule
3294 *	(see nl80211.h for the pattern definition)
3295 * @pattern_max_len: maximum length of each pattern
3296 * @pattern_min_len: minimum length of each pattern
3297 * @max_pkt_offset: maximum Rx packet offset
3298 */
3299struct wiphy_coalesce_support {
3300	int n_rules;
3301	int max_delay;
3302	int n_patterns;
3303	int pattern_max_len;
3304	int pattern_min_len;
3305	int max_pkt_offset;
3306};
3307
3308/**
3309 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3310 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3311 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3312 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3313 *	(must be combined with %_WDEV or %_NETDEV)
3314 */
3315enum wiphy_vendor_command_flags {
3316	WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3317	WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3318	WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3319};
3320
3321/**
3322 * struct wiphy_vendor_command - vendor command definition
3323 * @info: vendor command identifying information, as used in nl80211
3324 * @flags: flags, see &enum wiphy_vendor_command_flags
3325 * @doit: callback for the operation, note that wdev is %NULL if the
3326 *	flags didn't ask for a wdev and non-%NULL otherwise; the data
3327 *	pointer may be %NULL if userspace provided no data at all
3328 * @dumpit: dump callback, for transferring bigger/multiple items. The
3329 *	@storage points to cb->args[5], ie. is preserved over the multiple
3330 *	dumpit calls.
3331 * It's recommended to not have the same sub command with both @doit and
3332 * @dumpit, so that userspace can assume certain ones are get and others
3333 * are used with dump requests.
3334 */
3335struct wiphy_vendor_command {
3336	struct nl80211_vendor_cmd_info info;
3337	u32 flags;
3338	int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3339		    const void *data, int data_len);
3340	int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3341		      struct sk_buff *skb, const void *data, int data_len,
3342		      unsigned long *storage);
3343};
3344
3345/**
3346 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3347 * @iftype: interface type
3348 * @extended_capabilities: extended capabilities supported by the driver,
3349 *	additional capabilities might be supported by userspace; these are the
3350 *	802.11 extended capabilities ("Extended Capabilities element") and are
3351 *	in the same format as in the information element. See IEEE Std
3352 *	802.11-2012 8.4.2.29 for the defined fields.
3353 * @extended_capabilities_mask: mask of the valid values
3354 * @extended_capabilities_len: length of the extended capabilities
3355 */
3356struct wiphy_iftype_ext_capab {
3357	enum nl80211_iftype iftype;
3358	const u8 *extended_capabilities;
3359	const u8 *extended_capabilities_mask;
3360	u8 extended_capabilities_len;
3361};
3362
3363/**
3364 * struct wiphy - wireless hardware description
3365 * @reg_notifier: the driver's regulatory notification callback,
3366 *	note that if your driver uses wiphy_apply_custom_regulatory()
3367 *	the reg_notifier's request can be passed as NULL
3368 * @regd: the driver's regulatory domain, if one was requested via
3369 * 	the regulatory_hint() API. This can be used by the driver
3370 *	on the reg_notifier() if it chooses to ignore future
3371 *	regulatory domain changes caused by other drivers.
3372 * @signal_type: signal type reported in &struct cfg80211_bss.
3373 * @cipher_suites: supported cipher suites
3374 * @n_cipher_suites: number of supported cipher suites
3375 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3376 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3377 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3378 *	-1 = fragmentation disabled, only odd values >= 256 used
3379 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3380 * @_net: the network namespace this wiphy currently lives in
3381 * @perm_addr: permanent MAC address of this device
3382 * @addr_mask: If the device supports multiple MAC addresses by masking,
3383 *	set this to a mask with variable bits set to 1, e.g. if the last
3384 *	four bits are variable then set it to 00-00-00-00-00-0f. The actual
3385 *	variable bits shall be determined by the interfaces added, with
3386 *	interfaces not matching the mask being rejected to be brought up.
3387 * @n_addresses: number of addresses in @addresses.
3388 * @addresses: If the device has more than one address, set this pointer
3389 *	to a list of addresses (6 bytes each). The first one will be used
3390 *	by default for perm_addr. In this case, the mask should be set to
3391 *	all-zeroes. In this case it is assumed that the device can handle
3392 *	the same number of arbitrary MAC addresses.
3393 * @registered: protects ->resume and ->suspend sysfs callbacks against
3394 *	unregister hardware
3395 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3396 *	automatically on wiphy renames
3397 * @dev: (virtual) struct device for this wiphy
3398 * @registered: helps synchronize suspend/resume with wiphy unregister
3399 * @wext: wireless extension handlers
3400 * @priv: driver private data (sized according to wiphy_new() parameter)
3401 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3402 *	must be set by driver
3403 * @iface_combinations: Valid interface combinations array, should not
3404 *	list single interface types.
3405 * @n_iface_combinations: number of entries in @iface_combinations array.
3406 * @software_iftypes: bitmask of software interface types, these are not
3407 *	subject to any restrictions since they are purely managed in SW.
3408 * @flags: wiphy flags, see &enum wiphy_flags
3409 * @regulatory_flags: wiphy regulatory flags, see
3410 *	&enum ieee80211_regulatory_flags
3411 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3412 * @ext_features: extended features advertised to nl80211, see
3413 *	&enum nl80211_ext_feature_index.
3414 * @bss_priv_size: each BSS struct has private data allocated with it,
3415 *	this variable determines its size
3416 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3417 *	any given scan
3418 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3419 *	for in any given scheduled scan
3420 * @max_match_sets: maximum number of match sets the device can handle
3421 *	when performing a scheduled scan, 0 if filtering is not
3422 *	supported.
3423 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3424 *	add to probe request frames transmitted during a scan, must not
3425 *	include fixed IEs like supported rates
3426 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3427 *	scans
3428 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3429 *	of iterations) for scheduled scan supported by the device.
3430 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3431 *	single scan plan supported by the device.
3432 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3433 *	scan plan supported by the device.
3434 * @coverage_class: current coverage class
3435 * @fw_version: firmware version for ethtool reporting
3436 * @hw_version: hardware version for ethtool reporting
3437 * @max_num_pmkids: maximum number of PMKIDs supported by device
3438 * @privid: a pointer that drivers can use to identify if an arbitrary
3439 *	wiphy is theirs, e.g. in global notifiers
3440 * @bands: information about bands/channels supported by this device
3441 *
3442 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3443 *	transmitted through nl80211, points to an array indexed by interface
3444 *	type
3445 *
3446 * @available_antennas_tx: bitmap of antennas which are available to be
3447 *	configured as TX antennas. Antenna configuration commands will be
3448 *	rejected unless this or @available_antennas_rx is set.
3449 *
3450 * @available_antennas_rx: bitmap of antennas which are available to be
3451 *	configured as RX antennas. Antenna configuration commands will be
3452 *	rejected unless this or @available_antennas_tx is set.
3453 *
3454 * @probe_resp_offload:
3455 *	 Bitmap of supported protocols for probe response offloading.
3456 *	 See &enum nl80211_probe_resp_offload_support_attr. Only valid
3457 *	 when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3458 *
3459 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3460 *	may request, if implemented.
3461 *
3462 * @wowlan: WoWLAN support information
3463 * @wowlan_config: current WoWLAN configuration; this should usually not be
3464 *	used since access to it is necessarily racy, use the parameter passed
3465 *	to the suspend() operation instead.
3466 *
3467 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3468 * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
3469 *	If null, then none can be over-ridden.
3470 * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
3471 *	If null, then none can be over-ridden.
3472 *
3473 * @wdev_list: the list of associated (virtual) interfaces; this list must
3474 *	not be modified by the driver, but can be read with RTNL/RCU protection.
3475 *
3476 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3477 *	supports for ACL.
3478 *
3479 * @extended_capabilities: extended capabilities supported by the driver,
3480 *	additional capabilities might be supported by userspace; these are
3481 *	the 802.11 extended capabilities ("Extended Capabilities element")
3482 *	and are in the same format as in the information element. See
3483 *	802.11-2012 8.4.2.29 for the defined fields. These are the default
3484 *	extended capabilities to be used if the capabilities are not specified
3485 *	for a specific interface type in iftype_ext_capab.
3486 * @extended_capabilities_mask: mask of the valid values
3487 * @extended_capabilities_len: length of the extended capabilities
3488 * @iftype_ext_capab: array of extended capabilities per interface type
3489 * @num_iftype_ext_capab: number of interface types for which extended
3490 *	capabilities are specified separately.
3491 * @coalesce: packet coalescing support information
3492 *
3493 * @vendor_commands: array of vendor commands supported by the hardware
3494 * @n_vendor_commands: number of vendor commands
3495 * @vendor_events: array of vendor events supported by the hardware
3496 * @n_vendor_events: number of vendor events
3497 *
3498 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3499 *	(including P2P GO) or 0 to indicate no such limit is advertised. The
3500 *	driver is allowed to advertise a theoretical limit that it can reach in
3501 *	some cases, but may not always reach.
3502 *
3503 * @max_num_csa_counters: Number of supported csa_counters in beacons
3504 *	and probe responses.  This value should be set if the driver
3505 *	wishes to limit the number of csa counters. Default (0) means
3506 *	infinite.
3507 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3508 *	frame was sent and the channel on which the frame was heard for which
3509 *	the reported rssi is still valid. If a driver is able to compensate the
3510 *	low rssi when a frame is heard on different channel, then it should set
3511 *	this variable to the maximal offset for which it can compensate.
3512 *	This value should be set in MHz.
3513 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3514 *	by the driver in the .connect() callback. The bit position maps to the
3515 *	attribute indices defined in &enum nl80211_bss_select_attr.
3516 *
3517 * @cookie_counter: unique generic cookie counter, used to identify objects.
3518 */
3519struct wiphy {
3520	/* assign these fields before you register the wiphy */
3521
3522	/* permanent MAC address(es) */
3523	u8 perm_addr[ETH_ALEN];
3524	u8 addr_mask[ETH_ALEN];
3525
3526	struct mac_address *addresses;
3527
3528	const struct ieee80211_txrx_stypes *mgmt_stypes;
3529
3530	const struct ieee80211_iface_combination *iface_combinations;
3531	int n_iface_combinations;
3532	u16 software_iftypes;
3533
3534	u16 n_addresses;
3535
3536	/* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3537	u16 interface_modes;
3538
3539	u16 max_acl_mac_addrs;
3540
3541	u32 flags, regulatory_flags, features;
3542	u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3543
3544	u32 ap_sme_capa;
3545
3546	enum cfg80211_signal_type signal_type;
3547
3548	int bss_priv_size;
3549	u8 max_scan_ssids;
3550	u8 max_sched_scan_ssids;
3551	u8 max_match_sets;
3552	u16 max_scan_ie_len;
3553	u16 max_sched_scan_ie_len;
3554	u32 max_sched_scan_plans;
3555	u32 max_sched_scan_plan_interval;
3556	u32 max_sched_scan_plan_iterations;
3557
3558	int n_cipher_suites;
3559	const u32 *cipher_suites;
3560
3561	u8 retry_short;
3562	u8 retry_long;
3563	u32 frag_threshold;
3564	u32 rts_threshold;
3565	u8 coverage_class;
3566
3567	char fw_version[ETHTOOL_FWVERS_LEN];
3568	u32 hw_version;
3569
3570#ifdef CONFIG_PM
3571	const struct wiphy_wowlan_support *wowlan;
3572	struct cfg80211_wowlan *wowlan_config;
3573#endif
3574
3575	u16 max_remain_on_channel_duration;
3576
3577	u8 max_num_pmkids;
3578
3579	u32 available_antennas_tx;
3580	u32 available_antennas_rx;
3581
3582	/*
3583	 * Bitmap of supported protocols for probe response offloading
3584	 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3585	 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3586	 */
3587	u32 probe_resp_offload;
3588
3589	const u8 *extended_capabilities, *extended_capabilities_mask;
3590	u8 extended_capabilities_len;
3591
3592	const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3593	unsigned int num_iftype_ext_capab;
3594
3595	/* If multiple wiphys are registered and you're handed e.g.
3596	 * a regular netdev with assigned ieee80211_ptr, you won't
3597	 * know whether it points to a wiphy your driver has registered
3598	 * or not. Assign this to something global to your driver to
3599	 * help determine whether you own this wiphy or not. */
3600	const void *privid;
3601
3602	struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
3603
3604	/* Lets us get back the wiphy on the callback */
3605	void (*reg_notifier)(struct wiphy *wiphy,
3606			     struct regulatory_request *request);
3607
3608	/* fields below are read-only, assigned by cfg80211 */
3609
3610	const struct ieee80211_regdomain __rcu *regd;
3611
3612	/* the item in /sys/class/ieee80211/ points to this,
3613	 * you need use set_wiphy_dev() (see below) */
3614	struct device dev;
3615
3616	/* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3617	bool registered;
3618
3619	/* dir in debugfs: ieee80211/<wiphyname> */
3620	struct dentry *debugfsdir;
3621
3622	const struct ieee80211_ht_cap *ht_capa_mod_mask;
3623	const struct ieee80211_vht_cap *vht_capa_mod_mask;
3624
3625	struct list_head wdev_list;
3626
3627	/* the network namespace this phy lives in currently */
3628	possible_net_t _net;
3629
3630#ifdef CONFIG_CFG80211_WEXT
3631	const struct iw_handler_def *wext;
3632#endif
3633
3634	const struct wiphy_coalesce_support *coalesce;
3635
3636	const struct wiphy_vendor_command *vendor_commands;
3637	const struct nl80211_vendor_cmd_info *vendor_events;
3638	int n_vendor_commands, n_vendor_events;
3639
3640	u16 max_ap_assoc_sta;
3641
3642	u8 max_num_csa_counters;
3643	u8 max_adj_channel_rssi_comp;
3644
3645	u32 bss_select_support;
3646
3647	u64 cookie_counter;
3648
3649	char priv[0] __aligned(NETDEV_ALIGN);
3650};
3651
3652static inline struct net *wiphy_net(struct wiphy *wiphy)
3653{
3654	return read_pnet(&wiphy->_net);
3655}
3656
3657static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3658{
3659	write_pnet(&wiphy->_net, net);
3660}
3661
3662/**
3663 * wiphy_priv - return priv from wiphy
3664 *
3665 * @wiphy: the wiphy whose priv pointer to return
3666 * Return: The priv of @wiphy.
3667 */
3668static inline void *wiphy_priv(struct wiphy *wiphy)
3669{
3670	BUG_ON(!wiphy);
3671	return &wiphy->priv;
3672}
3673
3674/**
3675 * priv_to_wiphy - return the wiphy containing the priv
3676 *
3677 * @priv: a pointer previously returned by wiphy_priv
3678 * Return: The wiphy of @priv.
3679 */
3680static inline struct wiphy *priv_to_wiphy(void *priv)
3681{
3682	BUG_ON(!priv);
3683	return container_of(priv, struct wiphy, priv);
3684}
3685
3686/**
3687 * set_wiphy_dev - set device pointer for wiphy
3688 *
3689 * @wiphy: The wiphy whose device to bind
3690 * @dev: The device to parent it to
3691 */
3692static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3693{
3694	wiphy->dev.parent = dev;
3695}
3696
3697/**
3698 * wiphy_dev - get wiphy dev pointer
3699 *
3700 * @wiphy: The wiphy whose device struct to look up
3701 * Return: The dev of @wiphy.
3702 */
3703static inline struct device *wiphy_dev(struct wiphy *wiphy)
3704{
3705	return wiphy->dev.parent;
3706}
3707
3708/**
3709 * wiphy_name - get wiphy name
3710 *
3711 * @wiphy: The wiphy whose name to return
3712 * Return: The name of @wiphy.
3713 */
3714static inline const char *wiphy_name(const struct wiphy *wiphy)
3715{
3716	return dev_name(&wiphy->dev);
3717}
3718
3719/**
3720 * wiphy_new_nm - create a new wiphy for use with cfg80211
3721 *
3722 * @ops: The configuration operations for this device
3723 * @sizeof_priv: The size of the private area to allocate
3724 * @requested_name: Request a particular name.
3725 *	NULL is valid value, and means use the default phy%d naming.
3726 *
3727 * Create a new wiphy and associate the given operations with it.
3728 * @sizeof_priv bytes are allocated for private use.
3729 *
3730 * Return: A pointer to the new wiphy. This pointer must be
3731 * assigned to each netdev's ieee80211_ptr for proper operation.
3732 */
3733struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3734			   const char *requested_name);
3735
3736/**
3737 * wiphy_new - create a new wiphy for use with cfg80211
3738 *
3739 * @ops: The configuration operations for this device
3740 * @sizeof_priv: The size of the private area to allocate
3741 *
3742 * Create a new wiphy and associate the given operations with it.
3743 * @sizeof_priv bytes are allocated for private use.
3744 *
3745 * Return: A pointer to the new wiphy. This pointer must be
3746 * assigned to each netdev's ieee80211_ptr for proper operation.
3747 */
3748static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3749				      int sizeof_priv)
3750{
3751	return wiphy_new_nm(ops, sizeof_priv, NULL);
3752}
3753
3754/**
3755 * wiphy_register - register a wiphy with cfg80211
3756 *
3757 * @wiphy: The wiphy to register.
3758 *
3759 * Return: A non-negative wiphy index or a negative error code.
3760 */
3761int wiphy_register(struct wiphy *wiphy);
3762
3763/**
3764 * wiphy_unregister - deregister a wiphy from cfg80211
3765 *
3766 * @wiphy: The wiphy to unregister.
3767 *
3768 * After this call, no more requests can be made with this priv
3769 * pointer, but the call may sleep to wait for an outstanding
3770 * request that is being handled.
3771 */
3772void wiphy_unregister(struct wiphy *wiphy);
3773
3774/**
3775 * wiphy_free - free wiphy
3776 *
3777 * @wiphy: The wiphy to free
3778 */
3779void wiphy_free(struct wiphy *wiphy);
3780
3781/* internal structs */
3782struct cfg80211_conn;
3783struct cfg80211_internal_bss;
3784struct cfg80211_cached_keys;
3785
3786/**
3787 * struct wireless_dev - wireless device state
3788 *
3789 * For netdevs, this structure must be allocated by the driver
3790 * that uses the ieee80211_ptr field in struct net_device (this
3791 * is intentional so it can be allocated along with the netdev.)
3792 * It need not be registered then as netdev registration will
3793 * be intercepted by cfg80211 to see the new wireless device.
3794 *
3795 * For non-netdev uses, it must also be allocated by the driver
3796 * in response to the cfg80211 callbacks that require it, as
3797 * there's no netdev registration in that case it may not be
3798 * allocated outside of callback operations that return it.
3799 *
3800 * @wiphy: pointer to hardware description
3801 * @iftype: interface type
3802 * @list: (private) Used to collect the interfaces
3803 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3804 * @identifier: (private) Identifier used in nl80211 to identify this
3805 *	wireless device if it has no netdev
3806 * @current_bss: (private) Used by the internal configuration code
3807 * @chandef: (private) Used by the internal configuration code to track
3808 *	the user-set channel definition.
3809 * @preset_chandef: (private) Used by the internal configuration code to
3810 *	track the channel to be used for AP later
3811 * @bssid: (private) Used by the internal configuration code
3812 * @ssid: (private) Used by the internal configuration code
3813 * @ssid_len: (private) Used by the internal configuration code
3814 * @mesh_id_len: (private) Used by the internal configuration code
3815 * @mesh_id_up_len: (private) Used by the internal configuration code
3816 * @wext: (private) Used by the internal wireless extensions compat code
3817 * @use_4addr: indicates 4addr mode is used on this interface, must be
3818 *	set by driver (if supported) on add_interface BEFORE registering the
3819 *	netdev and may otherwise be used by driver read-only, will be update
3820 *	by cfg80211 on change_interface
3821 * @mgmt_registrations: list of registrations for management frames
3822 * @mgmt_registrations_lock: lock for the list
3823 * @mtx: mutex used to lock data in this struct, may be used by drivers
3824 *	and some API functions require it held
3825 * @beacon_interval: beacon interval used on this device for transmitting
3826 *	beacons, 0 when not valid
3827 * @address: The address for this device, valid only if @netdev is %NULL
3828 * @is_running: true if this is a non-netdev device that has been started, e.g.
3829 *	the P2P Device.
3830 * @cac_started: true if DFS channel availability check has been started
3831 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3832 * @cac_time_ms: CAC time in ms
3833 * @ps: powersave mode is enabled
3834 * @ps_timeout: dynamic powersave timeout
3835 * @ap_unexpected_nlportid: (private) netlink port ID of application
3836 *	registered for unexpected class 3 frames (AP mode)
3837 * @conn: (private) cfg80211 software SME connection state machine data
3838 * @connect_keys: (private) keys to set after connection is established
3839 * @conn_bss_type: connecting/connected BSS type
3840 * @ibss_fixed: (private) IBSS is using fixed BSSID
3841 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3842 * @event_list: (private) list for internal event processing
3843 * @event_lock: (private) lock for event list
3844 * @owner_nlportid: (private) owner socket port ID
3845 */
3846struct wireless_dev {
3847	struct wiphy *wiphy;
3848	enum nl80211_iftype iftype;
3849
3850	/* the remainder of this struct should be private to cfg80211 */
3851	struct list_head list;
3852	struct net_device *netdev;
3853
3854	u32 identifier;
3855
3856	struct list_head mgmt_registrations;
3857	spinlock_t mgmt_registrations_lock;
3858
3859	struct mutex mtx;
3860
3861	bool use_4addr, is_running;
3862
3863	u8 address[ETH_ALEN] __aligned(sizeof(u16));
3864
3865	/* currently used for IBSS and SME - might be rearranged later */
3866	u8 ssid[IEEE80211_MAX_SSID_LEN];
3867	u8 ssid_len, mesh_id_len, mesh_id_up_len;
3868	struct cfg80211_conn *conn;
3869	struct cfg80211_cached_keys *connect_keys;
3870	enum ieee80211_bss_type conn_bss_type;
3871
3872	struct list_head event_list;
3873	spinlock_t event_lock;
3874
3875	struct cfg80211_internal_bss *current_bss; /* associated / joined */
3876	struct cfg80211_chan_def preset_chandef;
3877	struct cfg80211_chan_def chandef;
3878
3879	bool ibss_fixed;
3880	bool ibss_dfs_possible;
3881
3882	bool ps;
3883	int ps_timeout;
3884
3885	int beacon_interval;
3886
3887	u32 ap_unexpected_nlportid;
3888
3889	bool cac_started;
3890	unsigned long cac_start_time;
3891	unsigned int cac_time_ms;
3892
3893	u32 owner_nlportid;
3894
3895#ifdef CONFIG_CFG80211_WEXT
3896	/* wext data */
3897	struct {
3898		struct cfg80211_ibss_params ibss;
3899		struct cfg80211_connect_params connect;
3900		struct cfg80211_cached_keys *keys;
3901		const u8 *ie;
3902		size_t ie_len;
3903		u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3904		u8 ssid[IEEE80211_MAX_SSID_LEN];
3905		s8 default_key, default_mgmt_key;
3906		bool prev_bssid_valid;
3907	} wext;
3908#endif
3909};
3910
3911static inline u8 *wdev_address(struct wireless_dev *wdev)
3912{
3913	if (wdev->netdev)
3914		return wdev->netdev->dev_addr;
3915	return wdev->address;
3916}
3917
3918static inline bool wdev_running(struct wireless_dev *wdev)
3919{
3920	if (wdev->netdev)
3921		return netif_running(wdev->netdev);
3922	return wdev->is_running;
3923}
3924
3925/**
3926 * wdev_priv - return wiphy priv from wireless_dev
3927 *
3928 * @wdev: The wireless device whose wiphy's priv pointer to return
3929 * Return: The wiphy priv of @wdev.
3930 */
3931static inline void *wdev_priv(struct wireless_dev *wdev)
3932{
3933	BUG_ON(!wdev);
3934	return wiphy_priv(wdev->wiphy);
3935}
3936
3937/**
3938 * DOC: Utility functions
3939 *
3940 * cfg80211 offers a number of utility functions that can be useful.
3941 */
3942
3943/**
3944 * ieee80211_channel_to_frequency - convert channel number to frequency
3945 * @chan: channel number
3946 * @band: band, necessary due to channel number overlap
3947 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3948 */
3949int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
3950
3951/**
3952 * ieee80211_frequency_to_channel - convert frequency to channel number
3953 * @freq: center frequency
3954 * Return: The corresponding channel, or 0 if the conversion failed.
3955 */
3956int ieee80211_frequency_to_channel(int freq);
3957
3958/*
3959 * Name indirection necessary because the ieee80211 code also has
3960 * a function named "ieee80211_get_channel", so if you include
3961 * cfg80211's header file you get cfg80211's version, if you try
3962 * to include both header files you'll (rightfully!) get a symbol
3963 * clash.
3964 */
3965struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3966						  int freq);
3967/**
3968 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3969 * @wiphy: the struct wiphy to get the channel for
3970 * @freq: the center frequency of the channel
3971 * Return: The channel struct from @wiphy at @freq.
3972 */
3973static inline struct ieee80211_channel *
3974ieee80211_get_channel(struct wiphy *wiphy, int freq)
3975{
3976	return __ieee80211_get_channel(wiphy, freq);
3977}
3978
3979/**
3980 * ieee80211_get_response_rate - get basic rate for a given rate
3981 *
3982 * @sband: the band to look for rates in
3983 * @basic_rates: bitmap of basic rates
3984 * @bitrate: the bitrate for which to find the basic rate
3985 *
3986 * Return: The basic rate corresponding to a given bitrate, that
3987 * is the next lower bitrate contained in the basic rate map,
3988 * which is, for this function, given as a bitmap of indices of
3989 * rates in the band's bitrate table.
3990 */
3991struct ieee80211_rate *
3992ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3993			    u32 basic_rates, int bitrate);
3994
3995/**
3996 * ieee80211_mandatory_rates - get mandatory rates for a given band
3997 * @sband: the band to look for rates in
3998 * @scan_width: width of the control channel
3999 *
4000 * This function returns a bitmap of the mandatory rates for the given
4001 * band, bits are set according to the rate position in the bitrates array.
4002 */
4003u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4004			      enum nl80211_bss_scan_width scan_width);
4005
4006/*
4007 * Radiotap parsing functions -- for controlled injection support
4008 *
4009 * Implemented in net/wireless/radiotap.c
4010 * Documentation in Documentation/networking/radiotap-headers.txt
4011 */
4012
4013struct radiotap_align_size {
4014	uint8_t align:4, size:4;
4015};
4016
4017struct ieee80211_radiotap_namespace {
4018	const struct radiotap_align_size *align_size;
4019	int n_bits;
4020	uint32_t oui;
4021	uint8_t subns;
4022};
4023
4024struct ieee80211_radiotap_vendor_namespaces {
4025	const struct ieee80211_radiotap_namespace *ns;
4026	int n_ns;
4027};
4028
4029/**
4030 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4031 * @this_arg_index: index of current arg, valid after each successful call
4032 *	to ieee80211_radiotap_iterator_next()
4033 * @this_arg: pointer to current radiotap arg; it is valid after each
4034 *	call to ieee80211_radiotap_iterator_next() but also after
4035 *	ieee80211_radiotap_iterator_init() where it will point to
4036 *	the beginning of the actual data portion
4037 * @this_arg_size: length of the current arg, for convenience
4038 * @current_namespace: pointer to the current namespace definition
4039 *	(or internally %NULL if the current namespace is unknown)
4040 * @is_radiotap_ns: indicates whether the current namespace is the default
4041 *	radiotap namespace or not
4042 *
4043 * @_rtheader: pointer to the radiotap header we are walking through
4044 * @_max_length: length of radiotap header in cpu byte ordering
4045 * @_arg_index: next argument index
4046 * @_arg: next argument pointer
4047 * @_next_bitmap: internal pointer to next present u32
4048 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4049 * @_vns: vendor namespace definitions
4050 * @_next_ns_data: beginning of the next namespace's data
4051 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4052 *	next bitmap word
4053 *
4054 * Describes the radiotap parser state. Fields prefixed with an underscore
4055 * must not be used by users of the parser, only by the parser internally.
4056 */
4057
4058struct ieee80211_radiotap_iterator {
4059	struct ieee80211_radiotap_header *_rtheader;
4060	const struct ieee80211_radiotap_vendor_namespaces *_vns;
4061	const struct ieee80211_radiotap_namespace *current_namespace;
4062
4063	unsigned char *_arg, *_next_ns_data;
4064	__le32 *_next_bitmap;
4065
4066	unsigned char *this_arg;
4067	int this_arg_index;
4068	int this_arg_size;
4069
4070	int is_radiotap_ns;
4071
4072	int _max_length;
4073	int _arg_index;
4074	uint32_t _bitmap_shifter;
4075	int _reset_on_ext;
4076};
4077
4078int
4079ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
4080				 struct ieee80211_radiotap_header *radiotap_header,
4081				 int max_length,
4082				 const struct ieee80211_radiotap_vendor_namespaces *vns);
4083
4084int
4085ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
4086
4087
4088extern const unsigned char rfc1042_header[6];
4089extern const unsigned char bridge_tunnel_header[6];
4090
4091/**
4092 * ieee80211_get_hdrlen_from_skb - get header length from data
4093 *
4094 * @skb: the frame
4095 *
4096 * Given an skb with a raw 802.11 header at the data pointer this function
4097 * returns the 802.11 header length.
4098 *
4099 * Return: The 802.11 header length in bytes (not including encryption
4100 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4101 * 802.11 header.
4102 */
4103unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
4104
4105/**
4106 * ieee80211_hdrlen - get header length in bytes from frame control
4107 * @fc: frame control field in little-endian format
4108 * Return: The header length in bytes.
4109 */
4110unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
4111
4112/**
4113 * ieee80211_get_mesh_hdrlen - get mesh extension header length
4114 * @meshhdr: the mesh extension header, only the flags field
4115 *	(first byte) will be accessed
4116 * Return: The length of the extension header, which is always at
4117 * least 6 bytes and at most 18 if address 5 and 6 are present.
4118 */
4119unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
4120
4121/**
4122 * DOC: Data path helpers
4123 *
4124 * In addition to generic utilities, cfg80211 also offers
4125 * functions that help implement the data path for devices
4126 * that do not do the 802.11/802.3 conversion on the device.
4127 */
4128
4129/**
4130 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4131 * @skb: the 802.11 data frame
4132 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4133 *	of it being pushed into the SKB
4134 * @addr: the device MAC address
4135 * @iftype: the virtual interface type
4136 * Return: 0 on success. Non-zero on error.
4137 */
4138int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
4139				  const u8 *addr, enum nl80211_iftype iftype);
4140
4141/**
4142 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4143 * @skb: the 802.11 data frame
4144 * @addr: the device MAC address
4145 * @iftype: the virtual interface type
4146 * Return: 0 on success. Non-zero on error.
4147 */
4148static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
4149					 enum nl80211_iftype iftype)
4150{
4151	return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype);
4152}
4153
4154/**
4155 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
4156 * @skb: the 802.3 frame
4157 * @addr: the device MAC address
4158 * @iftype: the virtual interface type
4159 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
4160 * @qos: build 802.11 QoS data frame
4161 * Return: 0 on success, or a negative error code.
4162 */
4163int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
4164			     enum nl80211_iftype iftype, const u8 *bssid,
4165			     bool qos);
4166
4167/**
4168 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
4169 *
4170 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
4171 * The @list will be empty if the decode fails. The @skb must be fully
4172 * header-less before being passed in here; it is freed in this function.
4173 *
4174 * @skb: The input A-MSDU frame without any headers.
4175 * @list: The output list of 802.3 frames. It must be allocated and
4176 *	initialized by by the caller.
4177 * @addr: The device MAC address.
4178 * @iftype: The device interface type.
4179 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
4180 * @check_da: DA to check in the inner ethernet header, or NULL
4181 * @check_sa: SA to check in the inner ethernet header, or NULL
4182 */
4183void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
4184			      const u8 *addr, enum nl80211_iftype iftype,
4185			      const unsigned int extra_headroom,
4186			      const u8 *check_da, const u8 *check_sa);
4187
4188/**
4189 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
4190 * @skb: the data frame
4191 * @qos_map: Interworking QoS mapping or %NULL if not in use
4192 * Return: The 802.1p/1d tag.
4193 */
4194unsigned int cfg80211_classify8021d(struct sk_buff *skb,
4195				    struct cfg80211_qos_map *qos_map);
4196
4197/**
4198 * cfg80211_find_ie_match - match information element and byte array in data
4199 *
4200 * @eid: element ID
4201 * @ies: data consisting of IEs
4202 * @len: length of data
4203 * @match: byte array to match
4204 * @match_len: number of bytes in the match array
4205 * @match_offset: offset in the IE where the byte array should match.
4206 *	If match_len is zero, this must also be set to zero.
4207 *	Otherwise this must be set to 2 or more, because the first
4208 *	byte is the element id, which is already compared to eid, and
4209 *	the second byte is the IE length.
4210 *
4211 * Return: %NULL if the element ID could not be found or if
4212 * the element is invalid (claims to be longer than the given
4213 * data) or if the byte array doesn't match, or a pointer to the first
4214 * byte of the requested element, that is the byte containing the
4215 * element ID.
4216 *
4217 * Note: There are no checks on the element length other than
4218 * having to fit into the given data and being large enough for the
4219 * byte array to match.
4220 */
4221const u8 *cfg80211_find_ie_match(u8 eid, const u8 *ies, int len,
4222				 const u8 *match, int match_len,
4223				 int match_offset);
4224
4225/**
4226 * cfg80211_find_ie - find information element in data
4227 *
4228 * @eid: element ID
4229 * @ies: data consisting of IEs
4230 * @len: length of data
4231 *
4232 * Return: %NULL if the element ID could not be found or if
4233 * the element is invalid (claims to be longer than the given
4234 * data), or a pointer to the first byte of the requested
4235 * element, that is the byte containing the element ID.
4236 *
4237 * Note: There are no checks on the element length other than
4238 * having to fit into the given data.
4239 */
4240static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
4241{
4242	return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
4243}
4244
4245/**
4246 * cfg80211_find_ext_ie - find information element with EID Extension in data
4247 *
4248 * @ext_eid: element ID Extension
4249 * @ies: data consisting of IEs
4250 * @len: length of data
4251 *
4252 * Return: %NULL if the extended element ID could not be found or if
4253 * the element is invalid (claims to be longer than the given
4254 * data), or a pointer to the first byte of the requested
4255 * element, that is the byte containing the element ID.
4256 *
4257 * Note: There are no checks on the element length other than
4258 * having to fit into the given data.
4259 */
4260static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
4261{
4262	return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
4263				      &ext_eid, 1, 2);
4264}
4265
4266/**
4267 * cfg80211_find_vendor_ie - find vendor specific information element in data
4268 *
4269 * @oui: vendor OUI
4270 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
4271 * @ies: data consisting of IEs
4272 * @len: length of data
4273 *
4274 * Return: %NULL if the vendor specific element ID could not be found or if the
4275 * element is invalid (claims to be longer than the given data), or a pointer to
4276 * the first byte of the requested element, that is the byte containing the
4277 * element ID.
4278 *
4279 * Note: There are no checks on the element length other than having to fit into
4280 * the given data.
4281 */
4282const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
4283				  const u8 *ies, int len);
4284
4285/**
4286 * DOC: Regulatory enforcement infrastructure
4287 *
4288 * TODO
4289 */
4290
4291/**
4292 * regulatory_hint - driver hint to the wireless core a regulatory domain
4293 * @wiphy: the wireless device giving the hint (used only for reporting
4294 *	conflicts)
4295 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4296 * 	should be in. If @rd is set this should be NULL. Note that if you
4297 * 	set this to NULL you should still set rd->alpha2 to some accepted
4298 * 	alpha2.
4299 *
4300 * Wireless drivers can use this function to hint to the wireless core
4301 * what it believes should be the current regulatory domain by
4302 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4303 * domain should be in or by providing a completely build regulatory domain.
4304 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4305 * for a regulatory domain structure for the respective country.
4306 *
4307 * The wiphy must have been registered to cfg80211 prior to this call.
4308 * For cfg80211 drivers this means you must first use wiphy_register(),
4309 * for mac80211 drivers you must first use ieee80211_register_hw().
4310 *
4311 * Drivers should check the return value, its possible you can get
4312 * an -ENOMEM.
4313 *
4314 * Return: 0 on success. -ENOMEM.
4315 */
4316int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4317
4318/**
4319 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4320 * @wiphy: the wireless device we want to process the regulatory domain on
4321 * @rd: the regulatory domain informatoin to use for this wiphy
4322 *
4323 * Set the regulatory domain information for self-managed wiphys, only they
4324 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4325 * information.
4326 *
4327 * Return: 0 on success. -EINVAL, -EPERM
4328 */
4329int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4330			      struct ieee80211_regdomain *rd);
4331
4332/**
4333 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4334 * @wiphy: the wireless device we want to process the regulatory domain on
4335 * @rd: the regulatory domain information to use for this wiphy
4336 *
4337 * This functions requires the RTNL to be held and applies the new regdomain
4338 * synchronously to this wiphy. For more details see
4339 * regulatory_set_wiphy_regd().
4340 *
4341 * Return: 0 on success. -EINVAL, -EPERM
4342 */
4343int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4344					struct ieee80211_regdomain *rd);
4345
4346/**
4347 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4348 * @wiphy: the wireless device we want to process the regulatory domain on
4349 * @regd: the custom regulatory domain to use for this wiphy
4350 *
4351 * Drivers can sometimes have custom regulatory domains which do not apply
4352 * to a specific country. Drivers can use this to apply such custom regulatory
4353 * domains. This routine must be called prior to wiphy registration. The
4354 * custom regulatory domain will be trusted completely and as such previous
4355 * default channel settings will be disregarded. If no rule is found for a
4356 * channel on the regulatory domain the channel will be disabled.
4357 * Drivers using this for a wiphy should also set the wiphy flag
4358 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4359 * that called this helper.
4360 */
4361void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4362				   const struct ieee80211_regdomain *regd);
4363
4364/**
4365 * freq_reg_info - get regulatory information for the given frequency
4366 * @wiphy: the wiphy for which we want to process this rule for
4367 * @center_freq: Frequency in KHz for which we want regulatory information for
4368 *
4369 * Use this function to get the regulatory rule for a specific frequency on
4370 * a given wireless device. If the device has a specific regulatory domain
4371 * it wants to follow we respect that unless a country IE has been received
4372 * and processed already.
4373 *
4374 * Return: A valid pointer, or, when an error occurs, for example if no rule
4375 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4376 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4377 * value will be -ERANGE if we determine the given center_freq does not even
4378 * have a regulatory rule for a frequency range in the center_freq's band.
4379 * See freq_in_rule_band() for our current definition of a band -- this is
4380 * purely subjective and right now it's 802.11 specific.
4381 */
4382const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4383					       u32 center_freq);
4384
4385/**
4386 * reg_initiator_name - map regulatory request initiator enum to name
4387 * @initiator: the regulatory request initiator
4388 *
4389 * You can use this to map the regulatory request initiator enum to a
4390 * proper string representation.
4391 */
4392const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4393
4394/*
4395 * callbacks for asynchronous cfg80211 methods, notification
4396 * functions and BSS handling helpers
4397 */
4398
4399/**
4400 * cfg80211_scan_done - notify that scan finished
4401 *
4402 * @request: the corresponding scan request
4403 * @info: information about the completed scan
 
4404 */
4405void cfg80211_scan_done(struct cfg80211_scan_request *request,
4406			struct cfg80211_scan_info *info);
4407
4408/**
4409 * cfg80211_sched_scan_results - notify that new scan results are available
4410 *
4411 * @wiphy: the wiphy which got scheduled scan results
4412 */
4413void cfg80211_sched_scan_results(struct wiphy *wiphy);
4414
4415/**
4416 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4417 *
4418 * @wiphy: the wiphy on which the scheduled scan stopped
4419 *
4420 * The driver can call this function to inform cfg80211 that the
4421 * scheduled scan had to be stopped, for whatever reason.  The driver
4422 * is then called back via the sched_scan_stop operation when done.
4423 */
4424void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
4425
4426/**
4427 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4428 *
4429 * @wiphy: the wiphy on which the scheduled scan stopped
4430 *
4431 * The driver can call this function to inform cfg80211 that the
4432 * scheduled scan had to be stopped, for whatever reason.  The driver
4433 * is then called back via the sched_scan_stop operation when done.
4434 * This function should be called with rtnl locked.
4435 */
4436void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
4437
4438/**
4439 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4440 * @wiphy: the wiphy reporting the BSS
4441 * @data: the BSS metadata
4442 * @mgmt: the management frame (probe response or beacon)
4443 * @len: length of the management frame
4444 * @gfp: context flags
4445 *
4446 * This informs cfg80211 that BSS information was found and
4447 * the BSS should be updated/added.
4448 *
4449 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4450 * Or %NULL on error.
4451 */
4452struct cfg80211_bss * __must_check
4453cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4454			       struct cfg80211_inform_bss *data,
4455			       struct ieee80211_mgmt *mgmt, size_t len,
4456			       gfp_t gfp);
4457
4458static inline struct cfg80211_bss * __must_check
4459cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4460				struct ieee80211_channel *rx_channel,
4461				enum nl80211_bss_scan_width scan_width,
4462				struct ieee80211_mgmt *mgmt, size_t len,
4463				s32 signal, gfp_t gfp)
4464{
4465	struct cfg80211_inform_bss data = {
4466		.chan = rx_channel,
4467		.scan_width = scan_width,
4468		.signal = signal,
4469	};
4470
4471	return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4472}
4473
4474static inline struct cfg80211_bss * __must_check
4475cfg80211_inform_bss_frame(struct wiphy *wiphy,
4476			  struct ieee80211_channel *rx_channel,
4477			  struct ieee80211_mgmt *mgmt, size_t len,
4478			  s32 signal, gfp_t gfp)
4479{
4480	struct cfg80211_inform_bss data = {
4481		.chan = rx_channel,
4482		.scan_width = NL80211_BSS_CHAN_WIDTH_20,
4483		.signal = signal,
4484	};
4485
4486	return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4487}
4488
4489/**
4490 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4491 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4492 *	from a beacon or probe response
4493 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4494 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4495 */
4496enum cfg80211_bss_frame_type {
4497	CFG80211_BSS_FTYPE_UNKNOWN,
4498	CFG80211_BSS_FTYPE_BEACON,
4499	CFG80211_BSS_FTYPE_PRESP,
4500};
4501
4502/**
4503 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4504 *
4505 * @wiphy: the wiphy reporting the BSS
4506 * @data: the BSS metadata
4507 * @ftype: frame type (if known)
4508 * @bssid: the BSSID of the BSS
4509 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4510 * @capability: the capability field sent by the peer
4511 * @beacon_interval: the beacon interval announced by the peer
4512 * @ie: additional IEs sent by the peer
4513 * @ielen: length of the additional IEs
4514 * @gfp: context flags
4515 *
4516 * This informs cfg80211 that BSS information was found and
4517 * the BSS should be updated/added.
4518 *
4519 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4520 * Or %NULL on error.
4521 */
4522struct cfg80211_bss * __must_check
4523cfg80211_inform_bss_data(struct wiphy *wiphy,
4524			 struct cfg80211_inform_bss *data,
4525			 enum cfg80211_bss_frame_type ftype,
4526			 const u8 *bssid, u64 tsf, u16 capability,
4527			 u16 beacon_interval, const u8 *ie, size_t ielen,
4528			 gfp_t gfp);
4529
4530static inline struct cfg80211_bss * __must_check
4531cfg80211_inform_bss_width(struct wiphy *wiphy,
4532			  struct ieee80211_channel *rx_channel,
4533			  enum nl80211_bss_scan_width scan_width,
4534			  enum cfg80211_bss_frame_type ftype,
4535			  const u8 *bssid, u64 tsf, u16 capability,
4536			  u16 beacon_interval, const u8 *ie, size_t ielen,
4537			  s32 signal, gfp_t gfp)
4538{
4539	struct cfg80211_inform_bss data = {
4540		.chan = rx_channel,
4541		.scan_width = scan_width,
4542		.signal = signal,
4543	};
4544
4545	return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4546					capability, beacon_interval, ie, ielen,
4547					gfp);
4548}
4549
4550static inline struct cfg80211_bss * __must_check
4551cfg80211_inform_bss(struct wiphy *wiphy,
4552		    struct ieee80211_channel *rx_channel,
4553		    enum cfg80211_bss_frame_type ftype,
4554		    const u8 *bssid, u64 tsf, u16 capability,
4555		    u16 beacon_interval, const u8 *ie, size_t ielen,
4556		    s32 signal, gfp_t gfp)
4557{
4558	struct cfg80211_inform_bss data = {
4559		.chan = rx_channel,
4560		.scan_width = NL80211_BSS_CHAN_WIDTH_20,
4561		.signal = signal,
4562	};
4563
4564	return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4565					capability, beacon_interval, ie, ielen,
4566					gfp);
4567}
4568
4569struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4570				      struct ieee80211_channel *channel,
4571				      const u8 *bssid,
4572				      const u8 *ssid, size_t ssid_len,
4573				      enum ieee80211_bss_type bss_type,
4574				      enum ieee80211_privacy);
4575static inline struct cfg80211_bss *
4576cfg80211_get_ibss(struct wiphy *wiphy,
4577		  struct ieee80211_channel *channel,
4578		  const u8 *ssid, size_t ssid_len)
4579{
4580	return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4581				IEEE80211_BSS_TYPE_IBSS,
4582				IEEE80211_PRIVACY_ANY);
4583}
4584
4585/**
4586 * cfg80211_ref_bss - reference BSS struct
4587 * @wiphy: the wiphy this BSS struct belongs to
4588 * @bss: the BSS struct to reference
4589 *
4590 * Increments the refcount of the given BSS struct.
4591 */
4592void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4593
4594/**
4595 * cfg80211_put_bss - unref BSS struct
4596 * @wiphy: the wiphy this BSS struct belongs to
4597 * @bss: the BSS struct
4598 *
4599 * Decrements the refcount of the given BSS struct.
4600 */
4601void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4602
4603/**
4604 * cfg80211_unlink_bss - unlink BSS from internal data structures
4605 * @wiphy: the wiphy
4606 * @bss: the bss to remove
4607 *
4608 * This function removes the given BSS from the internal data structures
4609 * thereby making it no longer show up in scan results etc. Use this
4610 * function when you detect a BSS is gone. Normally BSSes will also time
4611 * out, so it is not necessary to use this function at all.
4612 */
4613void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4614
4615static inline enum nl80211_bss_scan_width
4616cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4617{
4618	switch (chandef->width) {
4619	case NL80211_CHAN_WIDTH_5:
4620		return NL80211_BSS_CHAN_WIDTH_5;
4621	case NL80211_CHAN_WIDTH_10:
4622		return NL80211_BSS_CHAN_WIDTH_10;
4623	default:
4624		return NL80211_BSS_CHAN_WIDTH_20;
4625	}
4626}
4627
4628/**
4629 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4630 * @dev: network device
4631 * @buf: authentication frame (header + body)
4632 * @len: length of the frame data
4633 *
4634 * This function is called whenever an authentication, disassociation or
4635 * deauthentication frame has been received and processed in station mode.
4636 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4637 * call either this function or cfg80211_auth_timeout().
4638 * After being asked to associate via cfg80211_ops::assoc() the driver must
4639 * call either this function or cfg80211_auth_timeout().
4640 * While connected, the driver must calls this for received and processed
4641 * disassociation and deauthentication frames. If the frame couldn't be used
4642 * because it was unprotected, the driver must call the function
4643 * cfg80211_rx_unprot_mlme_mgmt() instead.
4644 *
4645 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4646 */
4647void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4648
4649/**
4650 * cfg80211_auth_timeout - notification of timed out authentication
4651 * @dev: network device
4652 * @addr: The MAC address of the device with which the authentication timed out
4653 *
4654 * This function may sleep. The caller must hold the corresponding wdev's
4655 * mutex.
4656 */
4657void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4658
4659/**
4660 * cfg80211_rx_assoc_resp - notification of processed association response
4661 * @dev: network device
4662 * @bss: the BSS that association was requested with, ownership of the pointer
4663 *	moves to cfg80211 in this call
4664 * @buf: authentication frame (header + body)
4665 * @len: length of the frame data
4666 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
4667 *	as the AC bitmap in the QoS info field
4668 *
4669 * After being asked to associate via cfg80211_ops::assoc() the driver must
4670 * call either this function or cfg80211_auth_timeout().
4671 *
4672 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4673 */
4674void cfg80211_rx_assoc_resp(struct net_device *dev,
4675			    struct cfg80211_bss *bss,
4676			    const u8 *buf, size_t len,
4677			    int uapsd_queues);
4678
4679/**
4680 * cfg80211_assoc_timeout - notification of timed out association
4681 * @dev: network device
4682 * @bss: The BSS entry with which association timed out.
4683 *
4684 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4685 */
4686void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4687
4688/**
4689 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
4690 * @dev: network device
4691 * @bss: The BSS entry with which association was abandoned.
4692 *
4693 * Call this whenever - for reasons reported through other API, like deauth RX,
4694 * an association attempt was abandoned.
4695 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4696 */
4697void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
4698
4699/**
4700 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4701 * @dev: network device
4702 * @buf: 802.11 frame (header + body)
4703 * @len: length of the frame data
4704 *
4705 * This function is called whenever deauthentication has been processed in
4706 * station mode. This includes both received deauthentication frames and
4707 * locally generated ones. This function may sleep. The caller must hold the
4708 * corresponding wdev's mutex.
4709 */
4710void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4711
4712/**
4713 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4714 * @dev: network device
4715 * @buf: deauthentication frame (header + body)
4716 * @len: length of the frame data
4717 *
4718 * This function is called whenever a received deauthentication or dissassoc
4719 * frame has been dropped in station mode because of MFP being used but the
4720 * frame was not protected. This function may sleep.
4721 */
4722void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4723				  const u8 *buf, size_t len);
4724
4725/**
4726 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4727 * @dev: network device
4728 * @addr: The source MAC address of the frame
4729 * @key_type: The key type that the received frame used
4730 * @key_id: Key identifier (0..3). Can be -1 if missing.
4731 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4732 * @gfp: allocation flags
4733 *
4734 * This function is called whenever the local MAC detects a MIC failure in a
4735 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4736 * primitive.
4737 */
4738void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4739				  enum nl80211_key_type key_type, int key_id,
4740				  const u8 *tsc, gfp_t gfp);
4741
4742/**
4743 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4744 *
4745 * @dev: network device
4746 * @bssid: the BSSID of the IBSS joined
4747 * @channel: the channel of the IBSS joined
4748 * @gfp: allocation flags
4749 *
4750 * This function notifies cfg80211 that the device joined an IBSS or
4751 * switched to a different BSSID. Before this function can be called,
4752 * either a beacon has to have been received from the IBSS, or one of
4753 * the cfg80211_inform_bss{,_frame} functions must have been called
4754 * with the locally generated beacon -- this guarantees that there is
4755 * always a scan result for this IBSS. cfg80211 will handle the rest.
4756 */
4757void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4758			  struct ieee80211_channel *channel, gfp_t gfp);
4759
4760/**
4761 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4762 *
4763 * @dev: network device
4764 * @macaddr: the MAC address of the new candidate
4765 * @ie: information elements advertised by the peer candidate
4766 * @ie_len: lenght of the information elements buffer
4767 * @gfp: allocation flags
4768 *
4769 * This function notifies cfg80211 that the mesh peer candidate has been
4770 * detected, most likely via a beacon or, less likely, via a probe response.
4771 * cfg80211 then sends a notification to userspace.
4772 */
4773void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4774		const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4775
4776/**
4777 * DOC: RFkill integration
4778 *
4779 * RFkill integration in cfg80211 is almost invisible to drivers,
4780 * as cfg80211 automatically registers an rfkill instance for each
4781 * wireless device it knows about. Soft kill is also translated
4782 * into disconnecting and turning all interfaces off, drivers are
4783 * expected to turn off the device when all interfaces are down.
4784 *
4785 * However, devices may have a hard RFkill line, in which case they
4786 * also need to interact with the rfkill subsystem, via cfg80211.
4787 * They can do this with a few helper functions documented here.
4788 */
4789
4790/**
4791 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4792 * @wiphy: the wiphy
4793 * @blocked: block status
4794 */
4795void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4796
4797/**
4798 * wiphy_rfkill_start_polling - start polling rfkill
4799 * @wiphy: the wiphy
4800 */
4801void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4802
4803/**
4804 * wiphy_rfkill_stop_polling - stop polling rfkill
4805 * @wiphy: the wiphy
4806 */
4807void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4808
4809/**
4810 * DOC: Vendor commands
4811 *
4812 * Occasionally, there are special protocol or firmware features that
4813 * can't be implemented very openly. For this and similar cases, the
4814 * vendor command functionality allows implementing the features with
4815 * (typically closed-source) userspace and firmware, using nl80211 as
4816 * the configuration mechanism.
4817 *
4818 * A driver supporting vendor commands must register them as an array
4819 * in struct wiphy, with handlers for each one, each command has an
4820 * OUI and sub command ID to identify it.
4821 *
4822 * Note that this feature should not be (ab)used to implement protocol
4823 * features that could openly be shared across drivers. In particular,
4824 * it must never be required to use vendor commands to implement any
4825 * "normal" functionality that higher-level userspace like connection
4826 * managers etc. need.
4827 */
4828
4829struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4830					   enum nl80211_commands cmd,
4831					   enum nl80211_attrs attr,
4832					   int approxlen);
4833
4834struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4835					   struct wireless_dev *wdev,
4836					   enum nl80211_commands cmd,
4837					   enum nl80211_attrs attr,
4838					   int vendor_event_idx,
4839					   int approxlen, gfp_t gfp);
4840
4841void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4842
4843/**
4844 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4845 * @wiphy: the wiphy
4846 * @approxlen: an upper bound of the length of the data that will
4847 *	be put into the skb
4848 *
4849 * This function allocates and pre-fills an skb for a reply to
4850 * a vendor command. Since it is intended for a reply, calling
4851 * it outside of a vendor command's doit() operation is invalid.
4852 *
4853 * The returned skb is pre-filled with some identifying data in
4854 * a way that any data that is put into the skb (with skb_put(),
4855 * nla_put() or similar) will end up being within the
4856 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4857 * with the skb is adding data for the corresponding userspace tool
4858 * which can then read that data out of the vendor data attribute.
4859 * You must not modify the skb in any other way.
4860 *
4861 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4862 * its error code as the result of the doit() operation.
4863 *
4864 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4865 */
4866static inline struct sk_buff *
4867cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4868{
4869	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4870					  NL80211_ATTR_VENDOR_DATA, approxlen);
4871}
4872
4873/**
4874 * cfg80211_vendor_cmd_reply - send the reply skb
4875 * @skb: The skb, must have been allocated with
4876 *	cfg80211_vendor_cmd_alloc_reply_skb()
4877 *
4878 * Since calling this function will usually be the last thing
4879 * before returning from the vendor command doit() you should
4880 * return the error code.  Note that this function consumes the
4881 * skb regardless of the return value.
4882 *
4883 * Return: An error code or 0 on success.
4884 */
4885int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4886
4887/**
4888 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4889 * @wiphy: the wiphy
4890 * @wdev: the wireless device
4891 * @event_idx: index of the vendor event in the wiphy's vendor_events
4892 * @approxlen: an upper bound of the length of the data that will
4893 *	be put into the skb
4894 * @gfp: allocation flags
4895 *
4896 * This function allocates and pre-fills an skb for an event on the
4897 * vendor-specific multicast group.
4898 *
4899 * If wdev != NULL, both the ifindex and identifier of the specified
4900 * wireless device are added to the event message before the vendor data
4901 * attribute.
4902 *
4903 * When done filling the skb, call cfg80211_vendor_event() with the
4904 * skb to send the event.
4905 *
4906 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4907 */
4908static inline struct sk_buff *
4909cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4910			     int approxlen, int event_idx, gfp_t gfp)
4911{
4912	return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4913					  NL80211_ATTR_VENDOR_DATA,
4914					  event_idx, approxlen, gfp);
4915}
4916
4917/**
4918 * cfg80211_vendor_event - send the event
4919 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4920 * @gfp: allocation flags
4921 *
4922 * This function sends the given @skb, which must have been allocated
4923 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4924 */
4925static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4926{
4927	__cfg80211_send_event_skb(skb, gfp);
4928}
4929
4930#ifdef CONFIG_NL80211_TESTMODE
4931/**
4932 * DOC: Test mode
4933 *
4934 * Test mode is a set of utility functions to allow drivers to
4935 * interact with driver-specific tools to aid, for instance,
4936 * factory programming.
4937 *
4938 * This chapter describes how drivers interact with it, for more
4939 * information see the nl80211 book's chapter on it.
4940 */
4941
4942/**
4943 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4944 * @wiphy: the wiphy
4945 * @approxlen: an upper bound of the length of the data that will
4946 *	be put into the skb
4947 *
4948 * This function allocates and pre-fills an skb for a reply to
4949 * the testmode command. Since it is intended for a reply, calling
4950 * it outside of the @testmode_cmd operation is invalid.
4951 *
4952 * The returned skb is pre-filled with the wiphy index and set up in
4953 * a way that any data that is put into the skb (with skb_put(),
4954 * nla_put() or similar) will end up being within the
4955 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4956 * with the skb is adding data for the corresponding userspace tool
4957 * which can then read that data out of the testdata attribute. You
4958 * must not modify the skb in any other way.
4959 *
4960 * When done, call cfg80211_testmode_reply() with the skb and return
4961 * its error code as the result of the @testmode_cmd operation.
4962 *
4963 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4964 */
4965static inline struct sk_buff *
4966cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4967{
4968	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4969					  NL80211_ATTR_TESTDATA, approxlen);
4970}
4971
4972/**
4973 * cfg80211_testmode_reply - send the reply skb
4974 * @skb: The skb, must have been allocated with
4975 *	cfg80211_testmode_alloc_reply_skb()
4976 *
4977 * Since calling this function will usually be the last thing
4978 * before returning from the @testmode_cmd you should return
4979 * the error code.  Note that this function consumes the skb
4980 * regardless of the return value.
4981 *
4982 * Return: An error code or 0 on success.
4983 */
4984static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4985{
4986	return cfg80211_vendor_cmd_reply(skb);
4987}
4988
4989/**
4990 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4991 * @wiphy: the wiphy
4992 * @approxlen: an upper bound of the length of the data that will
4993 *	be put into the skb
4994 * @gfp: allocation flags
4995 *
4996 * This function allocates and pre-fills an skb for an event on the
4997 * testmode multicast group.
4998 *
4999 * The returned skb is set up in the same way as with
5000 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
5001 * there, you should simply add data to it that will then end up in the
5002 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
5003 * in any other way.
5004 *
5005 * When done filling the skb, call cfg80211_testmode_event() with the
5006 * skb to send the event.
5007 *
5008 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5009 */
5010static inline struct sk_buff *
5011cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
5012{
5013	return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
5014					  NL80211_ATTR_TESTDATA, -1,
5015					  approxlen, gfp);
5016}
5017
5018/**
5019 * cfg80211_testmode_event - send the event
5020 * @skb: The skb, must have been allocated with
5021 *	cfg80211_testmode_alloc_event_skb()
5022 * @gfp: allocation flags
5023 *
5024 * This function sends the given @skb, which must have been allocated
5025 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
5026 * consumes it.
5027 */
5028static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
5029{
5030	__cfg80211_send_event_skb(skb, gfp);
5031}
5032
5033#define CFG80211_TESTMODE_CMD(cmd)	.testmode_cmd = (cmd),
5034#define CFG80211_TESTMODE_DUMP(cmd)	.testmode_dump = (cmd),
5035#else
5036#define CFG80211_TESTMODE_CMD(cmd)
5037#define CFG80211_TESTMODE_DUMP(cmd)
5038#endif
5039
5040/**
5041 * cfg80211_connect_bss - notify cfg80211 of connection result
5042 *
5043 * @dev: network device
5044 * @bssid: the BSSID of the AP
5045 * @bss: entry of bss to which STA got connected to, can be obtained
5046 *	through cfg80211_get_bss (may be %NULL)
5047 * @req_ie: association request IEs (maybe be %NULL)
5048 * @req_ie_len: association request IEs length
5049 * @resp_ie: association response IEs (may be %NULL)
5050 * @resp_ie_len: assoc response IEs length
5051 * @status: status code, 0 for successful connection, use
5052 *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5053 *      the real status code for failures.
5054 * @gfp: allocation flags
5055 *
5056 * It should be called by the underlying driver whenever connect() has
5057 * succeeded. This is similar to cfg80211_connect_result(), but with the
5058 * option of identifying the exact bss entry for the connection. Only one of
5059 * these functions should be called.
5060 */
5061void cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
5062			  struct cfg80211_bss *bss, const u8 *req_ie,
5063			  size_t req_ie_len, const u8 *resp_ie,
5064			  size_t resp_ie_len, int status, gfp_t gfp);
5065
5066/**
5067 * cfg80211_connect_result - notify cfg80211 of connection result
5068 *
5069 * @dev: network device
5070 * @bssid: the BSSID of the AP
5071 * @req_ie: association request IEs (maybe be %NULL)
5072 * @req_ie_len: association request IEs length
5073 * @resp_ie: association response IEs (may be %NULL)
5074 * @resp_ie_len: assoc response IEs length
5075 * @status: status code, 0 for successful connection, use
5076 *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5077 *	the real status code for failures.
5078 * @gfp: allocation flags
5079 *
5080 * It should be called by the underlying driver whenever connect() has
5081 * succeeded.
5082 */
5083static inline void
5084cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
5085			const u8 *req_ie, size_t req_ie_len,
5086			const u8 *resp_ie, size_t resp_ie_len,
5087			u16 status, gfp_t gfp)
5088{
5089	cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
5090			     resp_ie_len, status, gfp);
5091}
5092
5093/**
5094 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
5095 *
5096 * @dev: network device
5097 * @bssid: the BSSID of the AP
5098 * @req_ie: association request IEs (maybe be %NULL)
5099 * @req_ie_len: association request IEs length
5100 * @gfp: allocation flags
5101 *
5102 * It should be called by the underlying driver whenever connect() has failed
5103 * in a sequence where no explicit authentication/association rejection was
5104 * received from the AP. This could happen, e.g., due to not being able to send
5105 * out the Authentication or Association Request frame or timing out while
5106 * waiting for the response.
5107 */
5108static inline void
5109cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
5110			 const u8 *req_ie, size_t req_ie_len, gfp_t gfp)
5111{
5112	cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
5113			     gfp);
5114}
5115
5116/**
5117 * cfg80211_roamed - notify cfg80211 of roaming
5118 *
5119 * @dev: network device
5120 * @channel: the channel of the new AP
5121 * @bssid: the BSSID of the new AP
5122 * @req_ie: association request IEs (maybe be %NULL)
5123 * @req_ie_len: association request IEs length
5124 * @resp_ie: association response IEs (may be %NULL)
5125 * @resp_ie_len: assoc response IEs length
5126 * @gfp: allocation flags
5127 *
5128 * It should be called by the underlying driver whenever it roamed
5129 * from one AP to another while connected.
5130 */
5131void cfg80211_roamed(struct net_device *dev,
5132		     struct ieee80211_channel *channel,
5133		     const u8 *bssid,
5134		     const u8 *req_ie, size_t req_ie_len,
5135		     const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
5136
5137/**
5138 * cfg80211_roamed_bss - notify cfg80211 of roaming
5139 *
5140 * @dev: network device
5141 * @bss: entry of bss to which STA got roamed
5142 * @req_ie: association request IEs (maybe be %NULL)
5143 * @req_ie_len: association request IEs length
5144 * @resp_ie: association response IEs (may be %NULL)
5145 * @resp_ie_len: assoc response IEs length
5146 * @gfp: allocation flags
5147 *
5148 * This is just a wrapper to notify cfg80211 of roaming event with driver
5149 * passing bss to avoid a race in timeout of the bss entry. It should be
5150 * called by the underlying driver whenever it roamed from one AP to another
5151 * while connected. Drivers which have roaming implemented in firmware
5152 * may use this function to avoid a race in bss entry timeout where the bss
5153 * entry of the new AP is seen in the driver, but gets timed out by the time
5154 * it is accessed in __cfg80211_roamed() due to delay in scheduling
5155 * rdev->event_work. In case of any failures, the reference is released
5156 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
5157 * it will be released while diconneting from the current bss.
5158 */
5159void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
5160			 const u8 *req_ie, size_t req_ie_len,
5161			 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
5162
5163/**
5164 * cfg80211_disconnected - notify cfg80211 that connection was dropped
5165 *
5166 * @dev: network device
5167 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
5168 * @ie_len: length of IEs
5169 * @reason: reason code for the disconnection, set it to 0 if unknown
5170 * @locally_generated: disconnection was requested locally
5171 * @gfp: allocation flags
5172 *
5173 * After it calls this function, the driver should enter an idle state
5174 * and not try to connect to any AP any more.
5175 */
5176void cfg80211_disconnected(struct net_device *dev, u16 reason,
5177			   const u8 *ie, size_t ie_len,
5178			   bool locally_generated, gfp_t gfp);
5179
5180/**
5181 * cfg80211_ready_on_channel - notification of remain_on_channel start
5182 * @wdev: wireless device
5183 * @cookie: the request cookie
5184 * @chan: The current channel (from remain_on_channel request)
5185 * @duration: Duration in milliseconds that the driver intents to remain on the
5186 *	channel
5187 * @gfp: allocation flags
5188 */
5189void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
5190			       struct ieee80211_channel *chan,
5191			       unsigned int duration, gfp_t gfp);
5192
5193/**
5194 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
5195 * @wdev: wireless device
5196 * @cookie: the request cookie
5197 * @chan: The current channel (from remain_on_channel request)
5198 * @gfp: allocation flags
5199 */
5200void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
5201					struct ieee80211_channel *chan,
5202					gfp_t gfp);
5203
5204
5205/**
5206 * cfg80211_new_sta - notify userspace about station
5207 *
5208 * @dev: the netdev
5209 * @mac_addr: the station's address
5210 * @sinfo: the station information
5211 * @gfp: allocation flags
5212 */
5213void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
5214		      struct station_info *sinfo, gfp_t gfp);
5215
5216/**
5217 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
5218 * @dev: the netdev
5219 * @mac_addr: the station's address
5220 * @sinfo: the station information/statistics
5221 * @gfp: allocation flags
5222 */
5223void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
5224			    struct station_info *sinfo, gfp_t gfp);
5225
5226/**
5227 * cfg80211_del_sta - notify userspace about deletion of a station
5228 *
5229 * @dev: the netdev
5230 * @mac_addr: the station's address
5231 * @gfp: allocation flags
5232 */
5233static inline void cfg80211_del_sta(struct net_device *dev,
5234				    const u8 *mac_addr, gfp_t gfp)
5235{
5236	cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
5237}
5238
5239/**
5240 * cfg80211_conn_failed - connection request failed notification
5241 *
5242 * @dev: the netdev
5243 * @mac_addr: the station's address
5244 * @reason: the reason for connection failure
5245 * @gfp: allocation flags
5246 *
5247 * Whenever a station tries to connect to an AP and if the station
5248 * could not connect to the AP as the AP has rejected the connection
5249 * for some reasons, this function is called.
5250 *
5251 * The reason for connection failure can be any of the value from
5252 * nl80211_connect_failed_reason enum
5253 */
5254void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
5255			  enum nl80211_connect_failed_reason reason,
5256			  gfp_t gfp);
5257
5258/**
5259 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
5260 * @wdev: wireless device receiving the frame
5261 * @freq: Frequency on which the frame was received in MHz
5262 * @sig_dbm: signal strength in mBm, or 0 if unknown
5263 * @buf: Management frame (header + body)
5264 * @len: length of the frame data
5265 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
5266 *
5267 * This function is called whenever an Action frame is received for a station
5268 * mode interface, but is not processed in kernel.
5269 *
5270 * Return: %true if a user space application has registered for this frame.
5271 * For action frames, that makes it responsible for rejecting unrecognized
5272 * action frames; %false otherwise, in which case for action frames the
5273 * driver is responsible for rejecting the frame.
5274 */
5275bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
5276		      const u8 *buf, size_t len, u32 flags);
5277
5278/**
5279 * cfg80211_mgmt_tx_status - notification of TX status for management frame
5280 * @wdev: wireless device receiving the frame
5281 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5282 * @buf: Management frame (header + body)
5283 * @len: length of the frame data
5284 * @ack: Whether frame was acknowledged
5285 * @gfp: context flags
5286 *
5287 * This function is called whenever a management frame was requested to be
5288 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
5289 * transmission attempt.
5290 */
5291void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
5292			     const u8 *buf, size_t len, bool ack, gfp_t gfp);
5293
5294
5295/**
5296 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5297 * @dev: network device
5298 * @rssi_event: the triggered RSSI event
5299 * @gfp: context flags
5300 *
5301 * This function is called when a configured connection quality monitoring
5302 * rssi threshold reached event occurs.
5303 */
5304void cfg80211_cqm_rssi_notify(struct net_device *dev,
5305			      enum nl80211_cqm_rssi_threshold_event rssi_event,
5306			      gfp_t gfp);
5307
5308/**
5309 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5310 * @dev: network device
5311 * @peer: peer's MAC address
5312 * @num_packets: how many packets were lost -- should be a fixed threshold
5313 *	but probably no less than maybe 50, or maybe a throughput dependent
5314 *	threshold (to account for temporary interference)
5315 * @gfp: context flags
5316 */
5317void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5318				 const u8 *peer, u32 num_packets, gfp_t gfp);
5319
5320/**
5321 * cfg80211_cqm_txe_notify - TX error rate event
5322 * @dev: network device
5323 * @peer: peer's MAC address
5324 * @num_packets: how many packets were lost
5325 * @rate: % of packets which failed transmission
5326 * @intvl: interval (in s) over which the TX failure threshold was breached.
5327 * @gfp: context flags
5328 *
5329 * Notify userspace when configured % TX failures over number of packets in a
5330 * given interval is exceeded.
5331 */
5332void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5333			     u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5334
5335/**
5336 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5337 * @dev: network device
5338 * @gfp: context flags
5339 *
5340 * Notify userspace about beacon loss from the connected AP.
5341 */
5342void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5343
5344/**
5345 * cfg80211_radar_event - radar detection event
5346 * @wiphy: the wiphy
5347 * @chandef: chandef for the current channel
5348 * @gfp: context flags
5349 *
5350 * This function is called when a radar is detected on the current chanenl.
5351 */
5352void cfg80211_radar_event(struct wiphy *wiphy,
5353			  struct cfg80211_chan_def *chandef, gfp_t gfp);
5354
5355/**
5356 * cfg80211_cac_event - Channel availability check (CAC) event
5357 * @netdev: network device
5358 * @chandef: chandef for the current channel
5359 * @event: type of event
5360 * @gfp: context flags
5361 *
5362 * This function is called when a Channel availability check (CAC) is finished
5363 * or aborted. This must be called to notify the completion of a CAC process,
5364 * also by full-MAC drivers.
5365 */
5366void cfg80211_cac_event(struct net_device *netdev,
5367			const struct cfg80211_chan_def *chandef,
5368			enum nl80211_radar_event event, gfp_t gfp);
5369
5370
5371/**
5372 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5373 * @dev: network device
5374 * @bssid: BSSID of AP (to avoid races)
5375 * @replay_ctr: new replay counter
5376 * @gfp: allocation flags
5377 */
5378void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5379			       const u8 *replay_ctr, gfp_t gfp);
5380
5381/**
5382 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5383 * @dev: network device
5384 * @index: candidate index (the smaller the index, the higher the priority)
5385 * @bssid: BSSID of AP
5386 * @preauth: Whether AP advertises support for RSN pre-authentication
5387 * @gfp: allocation flags
5388 */
5389void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5390				     const u8 *bssid, bool preauth, gfp_t gfp);
5391
5392/**
5393 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5394 * @dev: The device the frame matched to
5395 * @addr: the transmitter address
5396 * @gfp: context flags
5397 *
5398 * This function is used in AP mode (only!) to inform userspace that
5399 * a spurious class 3 frame was received, to be able to deauth the
5400 * sender.
5401 * Return: %true if the frame was passed to userspace (or this failed
5402 * for a reason other than not having a subscription.)
5403 */
5404bool cfg80211_rx_spurious_frame(struct net_device *dev,
5405				const u8 *addr, gfp_t gfp);
5406
5407/**
5408 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5409 * @dev: The device the frame matched to
5410 * @addr: the transmitter address
5411 * @gfp: context flags
5412 *
5413 * This function is used in AP mode (only!) to inform userspace that
5414 * an associated station sent a 4addr frame but that wasn't expected.
5415 * It is allowed and desirable to send this event only once for each
5416 * station to avoid event flooding.
5417 * Return: %true if the frame was passed to userspace (or this failed
5418 * for a reason other than not having a subscription.)
5419 */
5420bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5421					const u8 *addr, gfp_t gfp);
5422
5423/**
5424 * cfg80211_probe_status - notify userspace about probe status
5425 * @dev: the device the probe was sent on
5426 * @addr: the address of the peer
5427 * @cookie: the cookie filled in @probe_client previously
5428 * @acked: indicates whether probe was acked or not
5429 * @gfp: allocation flags
5430 */
5431void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
5432			   u64 cookie, bool acked, gfp_t gfp);
5433
5434/**
5435 * cfg80211_report_obss_beacon - report beacon from other APs
5436 * @wiphy: The wiphy that received the beacon
5437 * @frame: the frame
5438 * @len: length of the frame
5439 * @freq: frequency the frame was received on
5440 * @sig_dbm: signal strength in mBm, or 0 if unknown
5441 *
5442 * Use this function to report to userspace when a beacon was
5443 * received. It is not useful to call this when there is no
5444 * netdev that is in AP/GO mode.
5445 */
5446void cfg80211_report_obss_beacon(struct wiphy *wiphy,
5447				 const u8 *frame, size_t len,
5448				 int freq, int sig_dbm);
5449
5450/**
5451 * cfg80211_reg_can_beacon - check if beaconing is allowed
5452 * @wiphy: the wiphy
5453 * @chandef: the channel definition
5454 * @iftype: interface type
5455 *
5456 * Return: %true if there is no secondary channel or the secondary channel(s)
5457 * can be used for beaconing (i.e. is not a radar channel etc.)
5458 */
5459bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
5460			     struct cfg80211_chan_def *chandef,
5461			     enum nl80211_iftype iftype);
5462
5463/**
5464 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5465 * @wiphy: the wiphy
5466 * @chandef: the channel definition
5467 * @iftype: interface type
5468 *
5469 * Return: %true if there is no secondary channel or the secondary channel(s)
5470 * can be used for beaconing (i.e. is not a radar channel etc.). This version
5471 * also checks if IR-relaxation conditions apply, to allow beaconing under
5472 * more permissive conditions.
5473 *
5474 * Requires the RTNL to be held.
5475 */
5476bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
5477				   struct cfg80211_chan_def *chandef,
5478				   enum nl80211_iftype iftype);
5479
5480/*
5481 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5482 * @dev: the device which switched channels
5483 * @chandef: the new channel definition
5484 *
5485 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5486 * driver context!
5487 */
5488void cfg80211_ch_switch_notify(struct net_device *dev,
5489			       struct cfg80211_chan_def *chandef);
5490
5491/*
5492 * cfg80211_ch_switch_started_notify - notify channel switch start
5493 * @dev: the device on which the channel switch started
5494 * @chandef: the future channel definition
5495 * @count: the number of TBTTs until the channel switch happens
5496 *
5497 * Inform the userspace about the channel switch that has just
5498 * started, so that it can take appropriate actions (eg. starting
5499 * channel switch on other vifs), if necessary.
5500 */
5501void cfg80211_ch_switch_started_notify(struct net_device *dev,
5502				       struct cfg80211_chan_def *chandef,
5503				       u8 count);
5504
5505/**
5506 * ieee80211_operating_class_to_band - convert operating class to band
5507 *
5508 * @operating_class: the operating class to convert
5509 * @band: band pointer to fill
5510 *
5511 * Returns %true if the conversion was successful, %false otherwise.
5512 */
5513bool ieee80211_operating_class_to_band(u8 operating_class,
5514				       enum nl80211_band *band);
5515
5516/**
5517 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5518 *
5519 * @chandef: the chandef to convert
5520 * @op_class: a pointer to the resulting operating class
5521 *
5522 * Returns %true if the conversion was successful, %false otherwise.
5523 */
5524bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5525					  u8 *op_class);
5526
5527/*
5528 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5529 * @dev: the device on which the operation is requested
5530 * @peer: the MAC address of the peer device
5531 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5532 *	NL80211_TDLS_TEARDOWN)
5533 * @reason_code: the reason code for teardown request
5534 * @gfp: allocation flags
5535 *
5536 * This function is used to request userspace to perform TDLS operation that
5537 * requires knowledge of keys, i.e., link setup or teardown when the AP
5538 * connection uses encryption. This is optional mechanism for the driver to use
5539 * if it can automatically determine when a TDLS link could be useful (e.g.,
5540 * based on traffic and signal strength for a peer).
5541 */
5542void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5543				enum nl80211_tdls_operation oper,
5544				u16 reason_code, gfp_t gfp);
5545
5546/*
5547 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5548 * @rate: given rate_info to calculate bitrate from
5549 *
5550 * return 0 if MCS index >= 32
5551 */
5552u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5553
5554/**
5555 * cfg80211_unregister_wdev - remove the given wdev
5556 * @wdev: struct wireless_dev to remove
5557 *
5558 * Call this function only for wdevs that have no netdev assigned,
5559 * e.g. P2P Devices. It removes the device from the list so that
5560 * it can no longer be used. It is necessary to call this function
5561 * even when cfg80211 requests the removal of the interface by
5562 * calling the del_virtual_intf() callback. The function must also
5563 * be called when the driver wishes to unregister the wdev, e.g.
5564 * when the device is unbound from the driver.
5565 *
5566 * Requires the RTNL to be held.
5567 */
5568void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5569
5570/**
5571 * struct cfg80211_ft_event - FT Information Elements
5572 * @ies: FT IEs
5573 * @ies_len: length of the FT IE in bytes
5574 * @target_ap: target AP's MAC address
5575 * @ric_ies: RIC IE
5576 * @ric_ies_len: length of the RIC IE in bytes
5577 */
5578struct cfg80211_ft_event_params {
5579	const u8 *ies;
5580	size_t ies_len;
5581	const u8 *target_ap;
5582	const u8 *ric_ies;
5583	size_t ric_ies_len;
5584};
5585
5586/**
5587 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5588 * @netdev: network device
5589 * @ft_event: IE information
5590 */
5591void cfg80211_ft_event(struct net_device *netdev,
5592		       struct cfg80211_ft_event_params *ft_event);
5593
5594/**
5595 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5596 * @ies: the input IE buffer
5597 * @len: the input length
5598 * @attr: the attribute ID to find
5599 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5600 *	if the function is only called to get the needed buffer size
5601 * @bufsize: size of the output buffer
5602 *
5603 * The function finds a given P2P attribute in the (vendor) IEs and
5604 * copies its contents to the given buffer.
5605 *
5606 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5607 * malformed or the attribute can't be found (respectively), or the
5608 * length of the found attribute (which can be zero).
5609 */
5610int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5611			  enum ieee80211_p2p_attr_id attr,
5612			  u8 *buf, unsigned int bufsize);
5613
5614/**
5615 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5616 * @ies: the IE buffer
5617 * @ielen: the length of the IE buffer
5618 * @ids: an array with element IDs that are allowed before
5619 *	the split
5620 * @n_ids: the size of the element ID array
5621 * @after_ric: array IE types that come after the RIC element
5622 * @n_after_ric: size of the @after_ric array
5623 * @offset: offset where to start splitting in the buffer
5624 *
5625 * This function splits an IE buffer by updating the @offset
5626 * variable to point to the location where the buffer should be
5627 * split.
5628 *
5629 * It assumes that the given IE buffer is well-formed, this
5630 * has to be guaranteed by the caller!
5631 *
5632 * It also assumes that the IEs in the buffer are ordered
5633 * correctly, if not the result of using this function will not
5634 * be ordered correctly either, i.e. it does no reordering.
5635 *
5636 * The function returns the offset where the next part of the
5637 * buffer starts, which may be @ielen if the entire (remainder)
5638 * of the buffer should be used.
5639 */
5640size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5641			      const u8 *ids, int n_ids,
5642			      const u8 *after_ric, int n_after_ric,
5643			      size_t offset);
5644
5645/**
5646 * ieee80211_ie_split - split an IE buffer according to ordering
5647 * @ies: the IE buffer
5648 * @ielen: the length of the IE buffer
5649 * @ids: an array with element IDs that are allowed before
5650 *	the split
5651 * @n_ids: the size of the element ID array
5652 * @offset: offset where to start splitting in the buffer
5653 *
5654 * This function splits an IE buffer by updating the @offset
5655 * variable to point to the location where the buffer should be
5656 * split.
5657 *
5658 * It assumes that the given IE buffer is well-formed, this
5659 * has to be guaranteed by the caller!
5660 *
5661 * It also assumes that the IEs in the buffer are ordered
5662 * correctly, if not the result of using this function will not
5663 * be ordered correctly either, i.e. it does no reordering.
5664 *
5665 * The function returns the offset where the next part of the
5666 * buffer starts, which may be @ielen if the entire (remainder)
5667 * of the buffer should be used.
5668 */
5669static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5670					const u8 *ids, int n_ids, size_t offset)
5671{
5672	return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
5673}
5674
5675/**
5676 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5677 * @wdev: the wireless device reporting the wakeup
5678 * @wakeup: the wakeup report
5679 * @gfp: allocation flags
5680 *
5681 * This function reports that the given device woke up. If it
5682 * caused the wakeup, report the reason(s), otherwise you may
5683 * pass %NULL as the @wakeup parameter to advertise that something
5684 * else caused the wakeup.
5685 */
5686void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5687				   struct cfg80211_wowlan_wakeup *wakeup,
5688				   gfp_t gfp);
5689
5690/**
5691 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5692 *
5693 * @wdev: the wireless device for which critical protocol is stopped.
5694 * @gfp: allocation flags
5695 *
5696 * This function can be called by the driver to indicate it has reverted
5697 * operation back to normal. One reason could be that the duration given
5698 * by .crit_proto_start() has expired.
5699 */
5700void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5701
5702/**
5703 * ieee80211_get_num_supported_channels - get number of channels device has
5704 * @wiphy: the wiphy
5705 *
5706 * Return: the number of channels supported by the device.
5707 */
5708unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5709
5710/**
5711 * cfg80211_check_combinations - check interface combinations
5712 *
5713 * @wiphy: the wiphy
5714 * @params: the interface combinations parameter
 
 
 
 
 
 
 
5715 *
5716 * This function can be called by the driver to check whether a
5717 * combination of interfaces and their types are allowed according to
5718 * the interface combinations.
5719 */
5720int cfg80211_check_combinations(struct wiphy *wiphy,
5721				struct iface_combination_params *params);
 
 
5722
5723/**
5724 * cfg80211_iter_combinations - iterate over matching combinations
5725 *
5726 * @wiphy: the wiphy
5727 * @params: the interface combinations parameter
 
 
 
 
 
 
 
5728 * @iter: function to call for each matching combination
5729 * @data: pointer to pass to iter function
5730 *
5731 * This function can be called by the driver to check what possible
5732 * combinations it fits in at a given moment, e.g. for channel switching
5733 * purposes.
5734 */
5735int cfg80211_iter_combinations(struct wiphy *wiphy,
5736			       struct iface_combination_params *params,
 
 
5737			       void (*iter)(const struct ieee80211_iface_combination *c,
5738					    void *data),
5739			       void *data);
5740
5741/*
5742 * cfg80211_stop_iface - trigger interface disconnection
5743 *
5744 * @wiphy: the wiphy
5745 * @wdev: wireless device
5746 * @gfp: context flags
5747 *
5748 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5749 * disconnected.
5750 *
5751 * Note: This doesn't need any locks and is asynchronous.
5752 */
5753void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5754			 gfp_t gfp);
5755
5756/**
5757 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5758 * @wiphy: the wiphy to shut down
5759 *
5760 * This function shuts down all interfaces belonging to this wiphy by
5761 * calling dev_close() (and treating non-netdev interfaces as needed).
5762 * It shouldn't really be used unless there are some fatal device errors
5763 * that really can't be recovered in any other way.
5764 *
5765 * Callers must hold the RTNL and be able to deal with callbacks into
5766 * the driver while the function is running.
5767 */
5768void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5769
5770/**
5771 * wiphy_ext_feature_set - set the extended feature flag
5772 *
5773 * @wiphy: the wiphy to modify.
5774 * @ftidx: extended feature bit index.
5775 *
5776 * The extended features are flagged in multiple bytes (see
5777 * &struct wiphy.@ext_features)
5778 */
5779static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5780					 enum nl80211_ext_feature_index ftidx)
5781{
5782	u8 *ft_byte;
5783
5784	ft_byte = &wiphy->ext_features[ftidx / 8];
5785	*ft_byte |= BIT(ftidx % 8);
5786}
5787
5788/**
5789 * wiphy_ext_feature_isset - check the extended feature flag
5790 *
5791 * @wiphy: the wiphy to modify.
5792 * @ftidx: extended feature bit index.
5793 *
5794 * The extended features are flagged in multiple bytes (see
5795 * &struct wiphy.@ext_features)
5796 */
5797static inline bool
5798wiphy_ext_feature_isset(struct wiphy *wiphy,
5799			enum nl80211_ext_feature_index ftidx)
5800{
5801	u8 ft_byte;
5802
5803	ft_byte = wiphy->ext_features[ftidx / 8];
5804	return (ft_byte & BIT(ftidx % 8)) != 0;
5805}
5806
5807/**
5808 * cfg80211_free_nan_func - free NAN function
5809 * @f: NAN function that should be freed
5810 *
5811 * Frees all the NAN function and all it's allocated members.
5812 */
5813void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
5814
5815/**
5816 * struct cfg80211_nan_match_params - NAN match parameters
5817 * @type: the type of the function that triggered a match. If it is
5818 *	 %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
5819 *	 If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
5820 *	 result.
5821 *	 If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
5822 * @inst_id: the local instance id
5823 * @peer_inst_id: the instance id of the peer's function
5824 * @addr: the MAC address of the peer
5825 * @info_len: the length of the &info
5826 * @info: the Service Specific Info from the peer (if any)
5827 * @cookie: unique identifier of the corresponding function
5828 */
5829struct cfg80211_nan_match_params {
5830	enum nl80211_nan_function_type type;
5831	u8 inst_id;
5832	u8 peer_inst_id;
5833	const u8 *addr;
5834	u8 info_len;
5835	const u8 *info;
5836	u64 cookie;
5837};
5838
5839/**
5840 * cfg80211_nan_match - report a match for a NAN function.
5841 * @wdev: the wireless device reporting the match
5842 * @match: match notification parameters
5843 * @gfp: allocation flags
5844 *
5845 * This function reports that the a NAN function had a match. This
5846 * can be a subscribe that had a match or a solicited publish that
5847 * was sent. It can also be a follow up that was received.
5848 */
5849void cfg80211_nan_match(struct wireless_dev *wdev,
5850			struct cfg80211_nan_match_params *match, gfp_t gfp);
5851
5852/**
5853 * cfg80211_nan_func_terminated - notify about NAN function termination.
5854 *
5855 * @wdev: the wireless device reporting the match
5856 * @inst_id: the local instance id
5857 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
5858 * @cookie: unique NAN function identifier
5859 * @gfp: allocation flags
5860 *
5861 * This function reports that the a NAN function is terminated.
5862 */
5863void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
5864				  u8 inst_id,
5865				  enum nl80211_nan_func_term_reason reason,
5866				  u64 cookie, gfp_t gfp);
5867
5868/* ethtool helper */
5869void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5870
5871/* Logging, debugging and troubleshooting/diagnostic helpers. */
5872
5873/* wiphy_printk helpers, similar to dev_printk */
5874
5875#define wiphy_printk(level, wiphy, format, args...)		\
5876	dev_printk(level, &(wiphy)->dev, format, ##args)
5877#define wiphy_emerg(wiphy, format, args...)			\
5878	dev_emerg(&(wiphy)->dev, format, ##args)
5879#define wiphy_alert(wiphy, format, args...)			\
5880	dev_alert(&(wiphy)->dev, format, ##args)
5881#define wiphy_crit(wiphy, format, args...)			\
5882	dev_crit(&(wiphy)->dev, format, ##args)
5883#define wiphy_err(wiphy, format, args...)			\
5884	dev_err(&(wiphy)->dev, format, ##args)
5885#define wiphy_warn(wiphy, format, args...)			\
5886	dev_warn(&(wiphy)->dev, format, ##args)
5887#define wiphy_notice(wiphy, format, args...)			\
5888	dev_notice(&(wiphy)->dev, format, ##args)
5889#define wiphy_info(wiphy, format, args...)			\
5890	dev_info(&(wiphy)->dev, format, ##args)
5891
5892#define wiphy_debug(wiphy, format, args...)			\
5893	wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5894
5895#define wiphy_dbg(wiphy, format, args...)			\
5896	dev_dbg(&(wiphy)->dev, format, ##args)
5897
5898#if defined(VERBOSE_DEBUG)
5899#define wiphy_vdbg	wiphy_dbg
5900#else
5901#define wiphy_vdbg(wiphy, format, args...)				\
5902({									\
5903	if (0)								\
5904		wiphy_printk(KERN_DEBUG, wiphy, format, ##args);	\
5905	0;								\
5906})
5907#endif
5908
5909/*
5910 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5911 * of using a WARN/WARN_ON to get the message out, including the
5912 * file/line information and a backtrace.
5913 */
5914#define wiphy_WARN(wiphy, format, args...)			\
5915	WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5916
5917#endif /* __NET_CFG80211_H */