mac80211.h 249 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0-only */
2
/*
3 4
 * mac80211 <-> driver interface
 *
5 6
 * Copyright 2002-2005, Devicescape Software, Inc.
 * Copyright 2006-2007	Jiri Benc <jbenc@suse.cz>
7
 * Copyright 2007-2010	Johannes Berg <johannes@sipsolutions.net>
8
 * Copyright 2013-2014  Intel Mobile Communications GmbH
9
 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH
10
 * Copyright (C) 2018 - 2019 Intel Corporation
11 12 13 14 15
 */

#ifndef MAC80211_H
#define MAC80211_H

16
#include <linux/bug.h>
17 18 19 20 21
#include <linux/kernel.h>
#include <linux/if_ether.h>
#include <linux/skbuff.h>
#include <linux/ieee80211.h>
#include <net/cfg80211.h>
22
#include <net/codel.h>
Luca Coelho's avatar
Luca Coelho committed
23
#include <net/ieee80211_radiotap.h>
24
#include <asm/unaligned.h>
25

26 27 28 29 30 31 32 33 34 35 36 37 38
/**
 * DOC: Introduction
 *
 * mac80211 is the Linux stack for 802.11 hardware that implements
 * only partial functionality in hard- or firmware. This document
 * defines the interface between mac80211 and low-level hardware
 * drivers.
 */

/**
 * DOC: Calling mac80211 from interrupts
 *
 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
39 40 41
 * called in hardware interrupt context. The low-level driver must not call any
 * other functions in hardware interrupt context. If there is a need for such
 * call, the low-level driver should first ACK the interrupt and perform the
42 43 44 45
 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
 * tasklet function.
 *
 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
46
 *	 use the non-IRQ-safe functions!
47 48
 */

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
/**
 * DOC: Warning
 *
 * If you're reading this document and not the header file itself, it will
 * be incomplete because not all documentation has been converted yet.
 */

/**
 * DOC: Frame format
 *
 * As a general rule, when frames are passed between mac80211 and the driver,
 * they start with the IEEE 802.11 header and include the same octets that are
 * sent over the air except for the FCS which should be calculated by the
 * hardware.
 *
 * There are, however, various exceptions to this rule for advanced features:
 *
 * The first exception is for hardware encryption and decryption offload
 * where the IV/ICV may or may not be generated in hardware.
 *
 * Secondly, when the hardware handles fragmentation, the frame handed to
 * the driver from mac80211 is the MSDU, not the MPDU.
71 72
 */

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
/**
 * DOC: mac80211 workqueue
 *
 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
 * The workqueue is a single threaded workqueue and can only be accessed by
 * helpers for sanity checking. Drivers must ensure all work added onto the
 * mac80211 workqueue should be cancelled on the driver stop() callback.
 *
 * mac80211 will flushed the workqueue upon interface removal and during
 * suspend.
 *
 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
 *
 */

88 89 90 91 92 93 94 95 96 97 98 99 100
/**
 * DOC: mac80211 software tx queueing
 *
 * mac80211 provides an optional intermediate queueing implementation designed
 * to allow the driver to keep hardware queues short and provide some fairness
 * between different stations/interfaces.
 * In this model, the driver pulls data frames from the mac80211 queue instead
 * of letting mac80211 push them via drv_tx().
 * Other frames (e.g. control or management) are still pushed using drv_tx().
 *
 * Drivers indicate that they use this model by implementing the .wake_tx_queue
 * driver operation.
 *
101 102 103
 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with
 * another per-sta for non-data/non-mgmt and bufferable management frames, and
 * a single per-vif queue for multicast data frames.
104 105 106 107
 *
 * The driver is expected to initialize its private per-queue data for stations
 * and interfaces in the .add_interface and .sta_add ops.
 *
108 109 110 111 112 113 114 115 116
 * The driver can't access the queue directly. To dequeue a frame from a
 * txq, it calls ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a
 * queue, it calls the .wake_tx_queue driver op.
 *
 * Drivers can optionally delegate responsibility for scheduling queues to
 * mac80211, to take advantage of airtime fairness accounting. In this case, to
 * obtain the next queue to pull frames from, the driver calls
 * ieee80211_next_txq(). The driver is then expected to return the txq using
 * ieee80211_return_txq().
117 118 119 120 121 122 123 124 125 126 127
 *
 * For AP powersave TIM handling, the driver only needs to indicate if it has
 * buffered packets in the driver specific data structures by calling
 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
 * struct, mac80211 sets the appropriate TIM PVB bits and calls
 * .release_buffered_frames().
 * In that callback the driver is therefore expected to release its own
 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
 * via the usual ieee80211_tx_dequeue).
 */

128 129
struct device;

Johannes Berg's avatar
Johannes Berg committed
130 131 132 133
/**
 * enum ieee80211_max_queues - maximum number of queues
 *
 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
134
 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
Johannes Berg's avatar
Johannes Berg committed
135 136
 */
enum ieee80211_max_queues {
137
	IEEE80211_MAX_QUEUES =		16,
138
	IEEE80211_MAX_QUEUE_MAP =	BIT(IEEE80211_MAX_QUEUES) - 1,
Johannes Berg's avatar
Johannes Berg committed
139 140
};

141 142
#define IEEE80211_INVAL_HW_QUEUE	0xff

143 144 145 146 147 148 149 150 151 152 153 154 155 156
/**
 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
 * @IEEE80211_AC_VO: voice
 * @IEEE80211_AC_VI: video
 * @IEEE80211_AC_BE: best effort
 * @IEEE80211_AC_BK: background
 */
enum ieee80211_ac_numbers {
	IEEE80211_AC_VO		= 0,
	IEEE80211_AC_VI		= 1,
	IEEE80211_AC_BE		= 2,
	IEEE80211_AC_BK		= 3,
};

157 158 159 160
/**
 * struct ieee80211_tx_queue_params - transmit queue configuration
 *
 * The information provided in this structure is required for QoS
161
 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
162
 *
163
 * @aifs: arbitration interframe space [0..255]
164 165
 * @cw_min: minimum contention window [a value of the form
 *	2^n-1 in the range 1..32767]
166
 * @cw_max: maximum contention window [like @cw_min]
167
 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
168
 * @acm: is mandatory admission control required for the access category
169
 * @uapsd: is U-APSD mode enabled for the queue
Luca Coelho's avatar
Luca Coelho committed
170 171
 * @mu_edca: is the MU EDCA configured
 * @mu_edca_param_rec: MU EDCA Parameter Record for HE
172
 */
173
struct ieee80211_tx_queue_params {
174
	u16 txop;
175 176
	u16 cw_min;
	u16 cw_max;
177
	u8 aifs;
178
	bool acm;
179
	bool uapsd;
Luca Coelho's avatar
Luca Coelho committed
180 181
	bool mu_edca;
	struct ieee80211_he_mu_edca_param_ac_rec mu_edca_param_rec;
182 183 184 185 186 187 188 189 190
};

struct ieee80211_low_level_stats {
	unsigned int dot11ACKFailureCount;
	unsigned int dot11RTSFailureCount;
	unsigned int dot11FCSErrorCount;
	unsigned int dot11RTSSuccessCount;
};

191 192
/**
 * enum ieee80211_chanctx_change - change flag for channel context
193
 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
194
 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
195
 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
196 197
 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
 *	this is used only with channel switching with CSA
198
 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
199 200
 */
enum ieee80211_chanctx_change {
201
	IEEE80211_CHANCTX_CHANGE_WIDTH		= BIT(0),
202
	IEEE80211_CHANCTX_CHANGE_RX_CHAINS	= BIT(1),
203
	IEEE80211_CHANCTX_CHANGE_RADAR		= BIT(2),
204
	IEEE80211_CHANCTX_CHANGE_CHANNEL	= BIT(3),
205
	IEEE80211_CHANCTX_CHANGE_MIN_WIDTH	= BIT(4),
206 207 208 209 210 211 212 213
};

/**
 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
 *
 * This is the driver-visible part. The ieee80211_chanctx
 * that contains it is visible in mac80211 only.
 *
214
 * @def: the channel definition
215
 * @min_def: the minimum channel definition currently required.
216 217 218 219
 * @rx_chains_static: The number of RX chains that must always be
 *	active on the channel to receive MIMO transmissions
 * @rx_chains_dynamic: The number of RX chains that must be enabled
 *	after RTS/CTS handshake to receive SMPS MIMO transmissions;
220
 *	this will always be >= @rx_chains_static.
221
 * @radar_enabled: whether radar detection is enabled on this channel.
222 223 224 225
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
 */
struct ieee80211_chanctx_conf {
226
	struct cfg80211_chan_def def;
227
	struct cfg80211_chan_def min_def;
228

229 230
	u8 rx_chains_static, rx_chains_dynamic;

231 232
	bool radar_enabled;

Johannes Berg's avatar
Johannes Berg committed
233
	u8 drv_priv[0] __aligned(sizeof(void *));
234 235
};

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
/**
 * enum ieee80211_chanctx_switch_mode - channel context switch mode
 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
 *	exist (and will continue to exist), but the virtual interface
 *	needs to be switched from one to the other.
 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
 *      to exist with this call, the new context doesn't exist but
 *      will be active after this call, the virtual interface switches
 *      from the old to the new (note that the driver may of course
 *      implement this as an on-the-fly chandef switch of the existing
 *      hardware context, but the mac80211 pointer for the old context
 *      will cease to exist and only the new one will later be used
 *      for changes/removal.)
 */
enum ieee80211_chanctx_switch_mode {
	CHANCTX_SWMODE_REASSIGN_VIF,
	CHANCTX_SWMODE_SWAP_CONTEXTS,
};

/**
 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
 *
 * This is structure is used to pass information about a vif that
 * needs to switch from one chanctx to another.  The
 * &ieee80211_chanctx_switch_mode defines how the switch should be
 * done.
 *
 * @vif: the vif that should be switched from old_ctx to new_ctx
 * @old_ctx: the old context to which the vif was assigned
 * @new_ctx: the new context to which the vif must be assigned
 */
struct ieee80211_vif_chanctx_switch {
	struct ieee80211_vif *vif;
	struct ieee80211_chanctx_conf *old_ctx;
	struct ieee80211_chanctx_conf *new_ctx;
};

273 274 275 276 277 278 279 280 281 282
/**
 * enum ieee80211_bss_change - BSS change notification flags
 *
 * These flags are used with the bss_info_changed() callback
 * to indicate which BSS parameter changed.
 *
 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
 *	also implies a change in the AID.
 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
283
 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler's avatar
Tomas Winkler committed
284
 * @BSS_CHANGED_HT: 802.11n parameters changed
285
 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
286
 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
287 288 289 290 291 292
 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
 *	reason (IBSS and managed mode)
 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
 *	new beacon (beaconing modes)
 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
 *	enabled/disabled (beaconing modes)
293
 * @BSS_CHANGED_CQM: Connection quality monitor config changed
294
 * @BSS_CHANGED_IBSS: IBSS join status changed
295
 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
296 297
 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
 *	that it is only ever disabled for station mode.
298
 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
299
 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
300
 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
301
 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
302
 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
303
 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
304
 *	changed
305 306
 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
 *	currently dtim_period only is under consideration.
307 308 309
 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
 *	note that this is only called when it changes after the channel
 *	context had been assigned.
310
 * @BSS_CHANGED_OCB: OCB join status changed
311
 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
312 313
 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
 *	keep alive) changed.
314
 * @BSS_CHANGED_MCAST_RATE: Multicast Rate setting changed for this interface
315 316
 * @BSS_CHANGED_FTM_RESPONDER: fime timing reasurement request responder
 *	functionality changed for this BSS (AP mode).
317
 * @BSS_CHANGED_TWT: TWT status changed
318
 *
319 320 321 322 323
 */
enum ieee80211_bss_change {
	BSS_CHANGED_ASSOC		= 1<<0,
	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
324
	BSS_CHANGED_ERP_SLOT		= 1<<3,
Alexander Simon's avatar
Alexander Simon committed
325
	BSS_CHANGED_HT			= 1<<4,
326
	BSS_CHANGED_BASIC_RATES		= 1<<5,
327
	BSS_CHANGED_BEACON_INT		= 1<<6,
328 329 330
	BSS_CHANGED_BSSID		= 1<<7,
	BSS_CHANGED_BEACON		= 1<<8,
	BSS_CHANGED_BEACON_ENABLED	= 1<<9,
331
	BSS_CHANGED_CQM			= 1<<10,
332
	BSS_CHANGED_IBSS		= 1<<11,
333
	BSS_CHANGED_ARP_FILTER		= 1<<12,
334
	BSS_CHANGED_QOS			= 1<<13,
335
	BSS_CHANGED_IDLE		= 1<<14,
336
	BSS_CHANGED_SSID		= 1<<15,
337
	BSS_CHANGED_AP_PROBE_RESP	= 1<<16,
338
	BSS_CHANGED_PS			= 1<<17,
339
	BSS_CHANGED_TXPOWER		= 1<<18,
340
	BSS_CHANGED_P2P_PS		= 1<<19,
341
	BSS_CHANGED_BEACON_INFO		= 1<<20,
342
	BSS_CHANGED_BANDWIDTH		= 1<<21,
343
	BSS_CHANGED_OCB                 = 1<<22,
344
	BSS_CHANGED_MU_GROUPS		= 1<<23,
345
	BSS_CHANGED_KEEP_ALIVE		= 1<<24,
346
	BSS_CHANGED_MCAST_RATE		= 1<<25,
347
	BSS_CHANGED_FTM_RESPONDER	= 1<<26,
348
	BSS_CHANGED_TWT			= 1<<27,
349 350

	/* when adding here, make sure to change ieee80211_reconfig */
351 352
};

353 354 355 356 357 358 359
/*
 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
 * of addresses for an interface increase beyond this value, hardware ARP
 * filtering will be disabled.
 */
#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4

360
/**
361 362
 * enum ieee80211_event_type - event to be notified to the low level driver
 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
363
 * @MLME_EVENT: event related to MLME
364
 * @BAR_RX_EVENT: a BAR was received
365 366 367
 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
 *	they timed out. This won't be called for each frame released, but only
 *	once each time the timeout triggers.
368
 */
369 370
enum ieee80211_event_type {
	RSSI_EVENT,
371
	MLME_EVENT,
372
	BAR_RX_EVENT,
373
	BA_FRAME_TIMEOUT,
374 375 376 377 378 379 380 381
};

/**
 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
 */
enum ieee80211_rssi_event_data {
382 383 384 385
	RSSI_EVENT_HIGH,
	RSSI_EVENT_LOW,
};

386
/**
387
 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
388 389 390 391 392 393
 * @data: See &enum ieee80211_rssi_event_data
 */
struct ieee80211_rssi_event {
	enum ieee80211_rssi_event_data data;
};

394 395 396
/**
 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
 * @AUTH_EVENT: the MLME operation is authentication
397
 * @ASSOC_EVENT: the MLME operation is association
398 399
 * @DEAUTH_RX_EVENT: deauth received..
 * @DEAUTH_TX_EVENT: deauth sent.
400 401 402
 */
enum ieee80211_mlme_event_data {
	AUTH_EVENT,
403
	ASSOC_EVENT,
404 405
	DEAUTH_RX_EVENT,
	DEAUTH_TX_EVENT,
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
};

/**
 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
 * @MLME_SUCCESS: the MLME operation completed successfully.
 * @MLME_DENIED: the MLME operation was denied by the peer.
 * @MLME_TIMEOUT: the MLME operation timed out.
 */
enum ieee80211_mlme_event_status {
	MLME_SUCCESS,
	MLME_DENIED,
	MLME_TIMEOUT,
};

/**
421
 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
422 423 424 425 426 427 428 429 430 431
 * @data: See &enum ieee80211_mlme_event_data
 * @status: See &enum ieee80211_mlme_event_status
 * @reason: the reason code if applicable
 */
struct ieee80211_mlme_event {
	enum ieee80211_mlme_event_data data;
	enum ieee80211_mlme_event_status status;
	u16 reason;
};

432 433 434 435
/**
 * struct ieee80211_ba_event - data attached for BlockAck related events
 * @sta: pointer to the &ieee80211_sta to which this event relates
 * @tid: the tid
436
 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
437 438 439 440 441 442 443
 */
struct ieee80211_ba_event {
	struct ieee80211_sta *sta;
	u16 tid;
	u16 ssn;
};

444 445
/**
 * struct ieee80211_event - event to be sent to the driver
446
 * @type: The event itself. See &enum ieee80211_event_type.
447
 * @rssi: relevant if &type is %RSSI_EVENT
448
 * @mlme: relevant if &type is %AUTH_EVENT
449
 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
450
 * @u:union holding the fields above
451 452 453 454 455
 */
struct ieee80211_event {
	enum ieee80211_event_type type;
	union {
		struct ieee80211_rssi_event rssi;
456
		struct ieee80211_mlme_event mlme;
457
		struct ieee80211_ba_event ba;
458 459 460
	} u;
};

461 462 463 464 465 466 467 468 469 470 471 472 473
/**
 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
 *
 * This structure describes the group id data of VHT MU-MIMO
 *
 * @membership: 64 bits array - a bit is set if station is member of the group
 * @position: 2 bits per group id indicating the position in the group
 */
struct ieee80211_mu_group_data {
	u8 membership[WLAN_MEMBERSHIP_LEN];
	u8 position[WLAN_USER_POSITION_LEN];
};

474
/**
475
 * struct ieee80211_ftm_responder_params - FTM responder parameters
476 477 478 479 480 481 482 483 484 485 486 487 488
 *
 * @lci: LCI subelement content
 * @civicloc: CIVIC location subelement content
 * @lci_len: LCI data length
 * @civicloc_len: Civic data length
 */
struct ieee80211_ftm_responder_params {
	const u8 *lci;
	const u8 *civicloc;
	size_t lci_len;
	size_t civicloc_len;
};

489 490 491 492 493 494
/**
 * struct ieee80211_bss_conf - holds the BSS's changing parameters
 *
 * This structure keeps information about a BSS (and an association
 * to that BSS) that can change during the lifetime of the BSS.
 *
Luca Coelho's avatar
Luca Coelho committed
495 496 497 498 499 500 501 502 503
 * @bss_color: 6-bit value to mark inter-BSS frame, if BSS supports HE
 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
 * @multi_sta_back_32bit: supports BA bitmap of 32-bits in Multi-STA BACK
 * @uora_exists: is the UORA element advertised by AP
 * @ack_enabled: indicates support to receive a multi-TID that solicits either
 *	ACK, BACK or both
 * @uora_ocw_range: UORA element's OCW Range field
 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
 * @he_support: does this BSS support HE
504 505
 * @twt_requester: does this BSS support TWT requester (relevant for managed
 *	mode only, set if the AP advertises TWT responder role)
506 507
 * @twt_responder: does this BSS support TWT requester (relevant for managed
 *	mode only, set if the AP advertises TWT responder role)
508
 * @assoc: association status
509 510
 * @ibss_joined: indicates whether this station is part of an IBSS
 *	or not
511
 * @ibss_creator: indicates if a new IBSS network is being created
512 513
 * @aid: association ID number, valid only when @assoc is true
 * @use_cts_prot: use CTS protection
514 515
 * @use_short_preamble: use 802.11b short preamble
 * @use_short_slot: use short slot time (only relevant for ERP)
516
 * @dtim_period: num of beacons before the next DTIM, for beaconing,
517
 *	valid in station mode only if after the driver was notified
518
 *	with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
519
 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
520 521 522 523
 *	as it may have been received during scanning long ago). If the
 *	HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
 *	only come from a beacon, but might not become valid until after
 *	association when a beacon is received (which is notified with the
524
 *	%BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
525 526
 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
 *	the driver/device can use this to calculate synchronisation
527
 *	(see @sync_tsf). See also sync_dtim_count important notice.
528 529
 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
 *	is requested, see @sync_tsf/@sync_device_ts.
530 531 532
 *	IMPORTANT: These three sync_* parameters would possibly be out of sync
 *	by the time the driver will use them. The synchronized view is currently
 *	guaranteed only in certain callbacks.
533
 * @beacon_int: beacon interval
534
 * @assoc_capability: capabilities taken from assoc resp
535 536 537
 * @basic_rates: bitmap of basic rates, each bit stands for an
 *	index into the rate table configured by the driver in
 *	the current band.
538
 * @beacon_rate: associated AP's beacon TX rate
539
 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
540 541
 * @bssid: The BSSID for this BSS
 * @enable_beacon: whether beaconing should be enabled or not
542 543
 * @chandef: Channel definition for this BSS -- the hardware might be
 *	configured a higher bandwidth than this BSS uses, for example.
544
 * @mu_group: VHT MU-MIMO group membership data
545
 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
546 547 548
 *	This field is only valid when the channel is a wide HT/VHT channel.
 *	Note that with TDLS this can be the case (channel is HT, protection must
 *	be used from this field) even when the BSS association isn't using HT.
549
 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
550 551 552
 *	implies disabled. As with the cfg80211 callback, a change here should
 *	cause an event to be sent indicating where the current value is in
 *	relation to the newly configured threshold.
553 554 555 556
 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
 *	implies disabled.  This is an alternative mechanism to the single
 *	threshold event and can't be enabled simultaneously with it.
 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
557
 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
558 559 560 561
 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
 *	may filter ARP queries targeted for other addresses than listed here.
 *	The driver must allow ARP queries targeted for all address listed here
 *	to pass through. An empty list implies no ARP queries need to pass.
562 563 564
 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
 *	may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
 *	array size), it's up to the driver what to do in that case.
565
 * @qos: This is a QoS-enabled BSS.
566 567 568
 * @idle: This interface is idle. There's also a global idle flag in the
 *	hardware config which may be more appropriate depending on what
 *	your driver/device needs to do.
569 570
 * @ps: power-save mode (STA only). This flag is NOT affected by
 *	offchannel/dynamic_ps operations.
571
 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
572 573
 * @ssid_len: Length of SSID given in @ssid.
 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
574
 * @txpower: TX power in dBm
575 576 577 578 579 580
 * @txpower_type: TX power adjustment used to control per packet Transmit
 *	Power Control (TPC) in lower driver for the current vif. In particular
 *	TPC is enabled if value passed in %txpower_type is
 *	NL80211_TX_POWER_LIMITED (allow using less than specified from
 *	userspace), whereas TPC is disabled if %txpower_type is set to
 *	NL80211_TX_POWER_FIXED (use value configured from userspace)
581
 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
582 583 584
 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
 *	to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
 *	if it has associated clients without P2P PS support.
585 586 587 588 589 590 591
 * @max_idle_period: the time period during which the station can refrain from
 *	transmitting frames to its associated AP without being disassociated.
 *	In units of 1000 TUs. Zero value indicates that the AP did not include
 *	a (valid) BSS Max Idle Period Element.
 * @protected_keep_alive: if set, indicates that the station should send an RSN
 *	protected frame to the AP to reset the idle timer at the AP for the
 *	station.
592 593 594
 * @ftm_responder: whether to enable or disable fine timing measurement FTM
 *	responder functionality.
 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
Sara Sharon's avatar
Sara Sharon committed
595 596 597 598 599 600 601 602
 * @nontransmitted: this BSS is a nontransmitted BSS profile
 * @transmitter_bssid: the address of transmitter AP
 * @bssid_index: index inside the multiple BSSID set
 * @bssid_indicator: 2^bssid_indicator is the maximum number of APs in set
 * @ema_ap: AP supports enhancements of discovery and advertisement of
 *	nontransmitted BSSIDs
 * @profile_periodicity: the least number of beacon frames need to be received
 *	in order to discover all the nontransmitted BSSIDs in the set.
603 604
 */
struct ieee80211_bss_conf {
605
	const u8 *bssid;
Luca Coelho's avatar
Luca Coelho committed
606 607 608 609 610 611 612 613
	u8 bss_color;
	u8 htc_trig_based_pkt_ext;
	bool multi_sta_back_32bit;
	bool uora_exists;
	bool ack_enabled;
	u8 uora_ocw_range;
	u16 frame_time_rts_th;
	bool he_support;
614
	bool twt_requester;
615
	bool twt_responder;
616
	/* association related data */
617
	bool assoc, ibss_joined;
618
	bool ibss_creator;
619 620 621 622
	u16 aid;
	/* erp related data */
	bool use_cts_prot;
	bool use_short_preamble;
623
	bool use_short_slot;
624
	bool enable_beacon;
625
	u8 dtim_period;
626 627
	u16 beacon_int;
	u16 assoc_capability;
628 629
	u64 sync_tsf;
	u32 sync_device_ts;
630
	u8 sync_dtim_count;
631
	u32 basic_rates;
632
	struct ieee80211_rate *beacon_rate;
633
	int mcast_rate[NUM_NL80211_BANDS];
634
	u16 ht_operation_mode;
635 636
	s32 cqm_rssi_thold;
	u32 cqm_rssi_hyst;
637 638
	s32 cqm_rssi_low;
	s32 cqm_rssi_high;
639
	struct cfg80211_chan_def chandef;
640
	struct ieee80211_mu_group_data mu_group;
641
	__be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
642
	int arp_addr_cnt;
643
	bool qos;
644
	bool idle;
645
	bool ps;
646 647 648
	u8 ssid[IEEE80211_MAX_SSID_LEN];
	size_t ssid_len;
	bool hidden_ssid;
649
	int txpower;
650
	enum nl80211_tx_power_setting txpower_type;
651
	struct ieee80211_p2p_noa_attr p2p_noa_attr;
652
	bool allow_p2p_go_ps;
653 654
	u16 max_idle_period;
	bool protected_keep_alive;
655 656
	bool ftm_responder;
	struct ieee80211_ftm_responder_params *ftmr_params;
Sara Sharon's avatar
Sara Sharon committed
657 658 659 660 661 662 663
	/* Multiple BSSID data */
	bool nontransmitted;
	u8 transmitter_bssid[ETH_ALEN];
	u8 bssid_index;
	u8 bssid_indicator;
	bool ema_ap;
	u8 profile_periodicity;
664 665
};

666
/**
667
 * enum mac80211_tx_info_flags - flags to describe transmission information/status
668
 *
669
 * These flags are used with the @flags member of &ieee80211_tx_info.
670
 *
671
 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
672 673 674 675 676 677 678 679 680 681 682
 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
 *	number to this frame, taking care of not overwriting the fragment
 *	number and increasing the sequence number only when the
 *	IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
 *	assign sequence numbers to QoS-data frames but cannot do so correctly
 *	for non-QoS-data and management frames because beacons need them from
 *	that counter as well and mac80211 cannot guarantee proper sequencing.
 *	If this flag is set, the driver should instruct the hardware to
 *	assign a sequence number to the frame or assign one itself. Cf. IEEE
 *	802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
 *	beacons and always be clear for frames without a sequence number field.
683 684 685 686 687 688
 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
 *	station
 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
689
 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
690
 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
691 692 693 694 695 696 697 698
 *	because the destination STA was in powersave mode. Note that to
 *	avoid race conditions, the filter must be set by the hardware or
 *	firmware upon receiving a frame that indicates that the station
 *	went to sleep (must be done on device to filter frames already on
 *	the queue) and may only be unset after mac80211 gives the OK for
 *	that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
 *	since only then is it guaranteed that no more frames are in the
 *	hardware queue.
699 700 701
 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 * 	is for the whole aggregation.
702 703
 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 * 	so consider using block ack request (BAR).
704 705 706
 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
 *	set by rate control algorithms to indicate probe rate, will
 *	be cleared for fragmented frames (except on the last fragment)
707 708 709
 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
 *	that a frame can be transmitted while the queues are stopped for
 *	off-channel operation.
710 711 712
 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
 *	used to indicate that a pending frame requires TX processing before
 *	it can be sent out.
713 714
 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
 *	used to indicate that a frame was already retried due to PS
Johannes Berg's avatar
Johannes Berg committed
715 716
 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 *	used to indicate frame should not be encrypted
717 718 719
 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
 *	frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
 *	be sent although the station is in powersave mode.
720 721 722 723
 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
 *	transmit function after the current frame, this can be used
 *	by drivers to kick the DMA queue only if unset or when the
 *	queue gets full.
724 725 726
 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
 *	after TX status because the destination was asleep, it must not
 *	be modified again (no seqno assignment, crypto, etc.)
727 728 729
 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
 *	code for connection establishment, this indicates that its status
 *	should kick the MLME state machine.
730 731 732
 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
 *	MLME command (internal to mac80211 to figure out whether to send TX
 *	status to user space)
733
 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
734 735
 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
 *	frame and selects the maximum number of streams that it can use.
736 737 738 739
 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
 *	the off-channel channel when a remain-on-channel offload is done
 *	in hardware -- normal packets still flow and are expected to be
 *	handled properly by the device.
740 741 742
 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
 *	testing. It will be sent out with incorrect Michael MIC key to allow
 *	TKIP countermeasures to be tested.
743 744 745
 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
 *	This flag is actually used for management frame especially for P2P
 *	frames not being sent at CCK rate in 2GHz band.
Johannes Berg's avatar
Johannes Berg committed
746 747 748
 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
 *	when its status is reported the service period ends. For frames in
 *	an SP that mac80211 transmits, it is already set; for driver frames
749 750
 *	the driver may set this flag. It is also used to do the same for
 *	PS-Poll responses.
751 752 753
 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
 *	This flag is used to send nullfunc frame at minimum rate when
 *	the nullfunc is used for connection monitoring purpose.
754 755 756
 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
 *	would be fragmented by size (this is optional, only used for
 *	monitor injection).
757 758 759 760 761
 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
 *	IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
 *	any errors (like issues specific to the driver/HW).
 *	This flag must not be set for frames that don't request no-ack
 *	behaviour with IEEE80211_TX_CTL_NO_ACK.
762 763 764
 *
 * Note: If you have to add new flags to the enumeration, then don't
 *	 forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
765
 */
766
enum mac80211_tx_info_flags {
767
	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
768 769 770 771 772 773 774 775 776 777 778 779
	IEEE80211_TX_CTL_ASSIGN_SEQ		= BIT(1),
	IEEE80211_TX_CTL_NO_ACK			= BIT(2),
	IEEE80211_TX_CTL_CLEAR_PS_FILT		= BIT(3),
	IEEE80211_TX_CTL_FIRST_FRAGMENT		= BIT(4),
	IEEE80211_TX_CTL_SEND_AFTER_DTIM	= BIT(5),
	IEEE80211_TX_CTL_AMPDU			= BIT(6),
	IEEE80211_TX_CTL_INJECTED		= BIT(7),
	IEEE80211_TX_STAT_TX_FILTERED		= BIT(8),
	IEEE80211_TX_STAT_ACK			= BIT(9),
	IEEE80211_TX_STAT_AMPDU			= BIT(10),
	IEEE80211_TX_STAT_AMPDU_NO_BACK		= BIT(11),
	IEEE80211_TX_CTL_RATE_CTRL_PROBE	= BIT(12),
780
	IEEE80211_TX_INTFL_OFFCHAN_TX_OK	= BIT(13),
781
	IEEE80211_TX_INTFL_NEED_TXPROCESSING	= BIT(14),
782
	IEEE80211_TX_INTFL_RETRIED		= BIT(15),
Johannes Berg's avatar
Johannes Berg committed
783
	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
784
	IEEE80211_TX_CTL_NO_PS_BUFFER		= BIT(17),
785
	IEEE80211_TX_CTL_MORE_FRAMES		= BIT(18),
786
	IEEE80211_TX_INTFL_RETRANSMISSION	= BIT(19),
787
	IEEE80211_TX_INTFL_MLME_CONN_TX		= BIT(20),
788
	IEEE80211_TX_INTFL_NL80211_FRAME_TX	= BIT(21),
789
	IEEE80211_TX_CTL_LDPC			= BIT(22),
790
	IEEE80211_TX_CTL_STBC			= BIT(23) | BIT(24),
791
	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(25),
792
	IEEE80211_TX_INTFL_TKIP_MIC_FAILURE	= BIT(26),
793
	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(27),
Johannes Berg's avatar
Johannes Berg committed
794
	IEEE80211_TX_STATUS_EOSP		= BIT(28),
795
	IEEE80211_TX_CTL_USE_MINRATE		= BIT(29),
796
	IEEE80211_TX_CTL_DONTFRAG		= BIT(30),
797
	IEEE80211_TX_STAT_NOACK_TRANSMITTED	= BIT(31),
798 799
};

Johannes Berg's avatar
Johannes Berg committed
800 801
#define IEEE80211_TX_CTL_STBC_SHIFT		23

802 803 804 805 806
/**
 * enum mac80211_tx_control_flags - flags to describe transmit control
 *
 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
 *	protocol frame (e.g. EAP)
807 808
 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
 *	frame (PS-Poll or uAPSD).
809
 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
810
 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
811
 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
812
 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup
813 814 815 816 817
 *
 * These flags are used in tx_info->control.flags.
 */
enum mac80211_tx_control_flags {
	IEEE80211_TX_CTRL_PORT_CTRL_PROTO	= BIT(0),
818
	IEEE80211_TX_CTRL_PS_RESPONSE		= BIT(1),
819
	IEEE80211_TX_CTRL_RATE_INJECT		= BIT(2),
820
	IEEE80211_TX_CTRL_AMSDU			= BIT(3),
821
	IEEE80211_TX_CTRL_FAST_XMIT		= BIT(4),
822
	IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP	= BIT(5),
823 824
};

825 826 827 828 829 830 831 832 833
/*
 * This definition is used as a mask to clear all temporary flags, which are
 * set by the tx handlers for each transmission attempt by the mac80211 stack.
 */
#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK |		      \
	IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT |    \
	IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU |	      \
	IEEE80211_TX_STAT_TX_FILTERED |	IEEE80211_TX_STAT_ACK |		      \
	IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK |	      \
834
	IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER |    \
835
	IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |		      \
Johannes Berg's avatar
Johannes Berg committed
836
	IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
837

838 839 840 841 842 843 844 845 846 847 848 849
/**
 * enum mac80211_rate_control_flags - per-rate flags set by the
 *	Rate Control algorithm.
 *
 * These flags are set by the Rate control algorithm for each rate during tx,
 * in the @flags member of struct ieee80211_tx_rate.
 *
 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
 *	This is set if the current BSS requires ERP protection.
 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
 * @IEEE80211_TX_RC_MCS: HT rate.
850 851
 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
 *	into a higher 4 bits (Nss) and lower 4 bits (MCS number)
852 853 854
 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
 *	Greenfield mode.
 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
855 856 857
 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
 *	(80+80 isn't supported yet)
858 859 860 861 862
 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
 *	adjacent 20 MHz channels, if the current channel type is
 *	NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
 */
863 864 865 866 867
enum mac80211_rate_control_flags {
	IEEE80211_TX_RC_USE_RTS_CTS		= BIT(0),
	IEEE80211_TX_RC_USE_CTS_PROTECT		= BIT(1),
	IEEE80211_TX_RC_USE_SHORT_PREAMBLE	= BIT(2),

868
	/* rate index is an HT/VHT MCS instead of an index */
869 870 871 872 873
	IEEE80211_TX_RC_MCS			= BIT(3),
	IEEE80211_TX_RC_GREEN_FIELD		= BIT(4),
	IEEE80211_TX_RC_40_MHZ_WIDTH		= BIT(5),
	IEEE80211_TX_RC_DUP_DATA		= BIT(6),
	IEEE80211_TX_RC_SHORT_GI		= BIT(7),
874 875 876
	IEEE80211_TX_RC_VHT_MCS			= BIT(8),
	IEEE80211_TX_RC_80_MHZ_WIDTH		= BIT(9),
	IEEE80211_TX_RC_160_MHZ_WIDTH		= BIT(10),
877 878 879 880 881
};


/* there are 40 bytes if you don't need the rateset to be kept */
#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
882

883 884
/* if you do need the rateset, then you have less space */
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
885

886
/* maximum number of rate stages */
887
#define IEEE80211_TX_MAX_RATES	4
888

889 890 891
/* maximum number of rate table entries */
#define IEEE80211_TX_RATE_TABLE_SIZE	4

892
/**
893
 * struct ieee80211_tx_rate - rate selection/status
894
 *
895 896
 * @idx: rate index to attempt to send with
 * @flags: rate control flags (&enum mac80211_rate_control_flags)
897
 * @count: number of tries in this rate before going to the next rate
898 899 900 901 902 903
 *
 * A value of -1 for @idx indicates an invalid rate and, if used
 * in an array of retry rates, that no more rates should be tried.
 *
 * When used for transmit status reporting, the driver should
 * always report the rate along with the flags it used.
904 905 906 907 908
 *
 * &struct ieee80211_tx_info contains an array of these structs
 * in the control information, and it will be filled by the rate
 * control algorithm according to what should be sent. For example,
 * if this array contains, in the format { <idx>, <count> } the
909 910
 * information::
 *
911
 *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
912
 *
913 914 915 916
 * then this means that the frame should be transmitted
 * up to twice at rate 3, up to twice at rate 2, and up to four
 * times at rate 1 if it doesn't get acknowledged. Say it gets
 * acknowledged by the peer after the fifth attempt, the status
917 918
 * information should then contain::
 *
919
 *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
920
 *
921 922
 * since it was transmitted twice at rate 3, twice at rate 2
 * and once at rate 1 after which we received an acknowledgement.
923
 */
924 925
struct ieee80211_tx_rate {
	s8 idx;
926 927
	u16 count:5,
	    flags:11;
928
} __packed;
929

930 931 932 933 934 935
#define IEEE80211_MAX_TX_RETRY		31

static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
					  u8 mcs, u8 nss)
{
	WARN_ON(mcs & ~0xF);
Karl Beldan's avatar
Karl Beldan committed
936 937
	WARN_ON((nss - 1) & ~0x7);
	rate->idx = ((nss - 1) << 4) | mcs;
938 939 940 941 942 943 944 945 946 947 948
}

static inline u8
ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
{
	return rate->idx & 0xF;
}

static inline u8
ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
{
Karl Beldan's avatar
Karl Beldan committed
949
	return (rate->idx >> 4) + 1;
950 951
}

952 953 954 955 956 957 958 959 960
/**
 * struct ieee80211_tx_info - skb transmit information
 *
 * This structure is placed in skb->cb for three uses:
 *  (1) mac80211 TX control - mac80211 tells the driver what to do
 *  (2) driver internal use (if applicable)
 *  (3) TX status information - driver tells mac80211 what happened
 *
 * @flags: transmit info flags, defined above
961
 * @band: the band to transmit on (use for checking for races)
962
 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
963
 * @ack_frame_id: internal frame ID for TX status, used internally
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
 * @control: union part for control data
 * @control.rates: TX rates array to try
 * @control.rts_cts_rate_idx: rate for RTS or CTS
 * @control.use_rts: use RTS
 * @control.use_cts_prot: use RTS/CTS
 * @control.short_preamble: use short preamble (CCK only)
 * @control.skip_table: skip externally configured rate table
 * @control.jiffies: timestamp for expiry on powersave clients
 * @control.vif: virtual interface (may be NULL)
 * @control.hw_key: key to encrypt with (may be NULL)
 * @control.flags: control flags, see &enum mac80211_tx_control_flags
 * @control.enqueue_time: enqueue time (for iTXQs)
 * @driver_rates: alias to @control.rates to reserve space
 * @pad: padding
 * @rate_driver_data: driver use area if driver needs @control.rates
 * @status: union part for status data
 * @status.rates: attempted rates
 * @status.ack_signal: ACK signal
 * @status.ampdu_ack_len: AMPDU ack length
 * @status.ampdu_len: AMPDU length
 * @status.antenna: (legacy, kept only for iwlegacy)
 * @status.tx_time: airtime consumed for transmission
 * @status.is_valid_ack_signal: ACK signal is valid
 * @status.status_driver_data: driver use area
 * @ack: union part for pure ACK data
 * @ack.cookie: cookie for the ACK
990
 * @driver_data: array of driver_data pointers
991
 * @ampdu_ack_len: number of acked aggregated frames.
992
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
993
 * @ampdu_len: number of aggregated frames.
994
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
995
 * @ack_signal: signal strength of the ACK frame
996
 */
997 998 999 1000
struct ieee80211_tx_info {
	/* common information */
	u32 flags;
	u8 band;
1001

1002
	u8 hw_queue;
1003

1004
	u16 ack_frame_id;
1005 1006 1007

	union {
		struct {
1008 1009 1010 1011 1012 1013
			union {
				/* rate control */
				struct {
					struct ieee80211_tx_rate rates[
						IEEE80211_TX_MAX_RATES];
					s8 rts_cts_rate_idx;
1014 1015
					u8 use_rts:1;
					u8 use_cts_prot:1;
1016 1017
					u8 short_preamble:1;
					u8 skip_table:1;
1018
					/* 2 bytes free */
1019 1020 1021 1022
				};
				/* only needed before rate control */
				unsigned long jiffies;
			};
1023
			/* NB: vif can be NULL for injected frames */
1024
			struct ieee80211_vif *vif;
1025
			struct ieee80211_key_conf *hw_key;
1026
			u32 flags;
1027
			codel_time_t enqueue_time;
1028
		} control;
1029 1030 1031
		struct {
			u64 cookie;
		} ack;
1032
		struct {
1033
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
1034
			s32 ack_signal;
1035
			u8 ampdu_ack_len;
1036
			u8 ampdu_len;
1037
			u8 antenna;
1038
			u16 tx_time;
1039
			bool is_valid_ack_signal;
1040
			void *status_driver_data[19 / sizeof(void *)];
1041
		} status;
1042 1043 1044
		struct {
			struct ieee80211_tx_rate driver_rates[
				IEEE80211_TX_MAX_RATES];
Felix Fietkau's avatar