mac80211.h 219 KB
Newer Older
1
/*
2
3
 * mac80211 <-> driver interface
 *
4
5
 * Copyright 2002-2005, Devicescape Software, Inc.
 * Copyright 2006-2007	Jiri Benc <jbenc@suse.cz>
6
 * Copyright 2007-2010	Johannes Berg <johannes@sipsolutions.net>
7
 * Copyright 2013-2014  Intel Mobile Communications GmbH
8
 * Copyright (C) 2015 - 2016 Intel Deutschland GmbH
9
10
11
12
13
14
15
16
17
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef MAC80211_H
#define MAC80211_H

18
#include <linux/bug.h>
19
20
21
22
23
#include <linux/kernel.h>
#include <linux/if_ether.h>
#include <linux/skbuff.h>
#include <linux/ieee80211.h>
#include <net/cfg80211.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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/**
 * 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.
 *
 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
 * single per-vif queue for multicast data frames.
 *
 * The driver is expected to initialize its private per-queue data for stations
 * and interfaces in the .add_interface and .sta_add ops.
 *
 * The driver can't access the queue directly. To dequeue a frame, it calls
 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
 * calls the .wake_tx_queue driver op.
 *
 * 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).
 */

121
122
struct device;

Johannes Berg's avatar
Johannes Berg committed
123
124
125
126
/**
 * enum ieee80211_max_queues - maximum number of queues
 *
 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
127
 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
Johannes Berg's avatar
Johannes Berg committed
128
129
 */
enum ieee80211_max_queues {
130
	IEEE80211_MAX_QUEUES =		16,
131
	IEEE80211_MAX_QUEUE_MAP =	BIT(IEEE80211_MAX_QUEUES) - 1,
Johannes Berg's avatar
Johannes Berg committed
132
133
};

134
135
#define IEEE80211_INVAL_HW_QUEUE	0xff

136
137
138
139
140
141
142
143
144
145
146
147
148
/**
 * 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,
};
149
#define IEEE80211_NUM_ACS	4
150

151
152
153
154
/**
 * struct ieee80211_tx_queue_params - transmit queue configuration
 *
 * The information provided in this structure is required for QoS
155
 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
156
 *
157
 * @aifs: arbitration interframe space [0..255]
158
159
 * @cw_min: minimum contention window [a value of the form
 *	2^n-1 in the range 1..32767]
160
 * @cw_max: maximum contention window [like @cw_min]
161
 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
162
 * @acm: is mandatory admission control required for the access category
163
 * @uapsd: is U-APSD mode enabled for the queue
164
 */
165
struct ieee80211_tx_queue_params {
166
	u16 txop;
167
168
	u16 cw_min;
	u16 cw_max;
169
	u8 aifs;
170
	bool acm;
171
	bool uapsd;
172
173
174
175
176
177
178
179
180
};

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

181
182
/**
 * enum ieee80211_chanctx_change - change flag for channel context
183
 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
184
 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
185
 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
186
187
 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
 *	this is used only with channel switching with CSA
188
 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
189
190
 */
enum ieee80211_chanctx_change {
191
	IEEE80211_CHANCTX_CHANGE_WIDTH		= BIT(0),
192
	IEEE80211_CHANCTX_CHANGE_RX_CHAINS	= BIT(1),
193
	IEEE80211_CHANCTX_CHANGE_RADAR		= BIT(2),
194
	IEEE80211_CHANCTX_CHANGE_CHANNEL	= BIT(3),
195
	IEEE80211_CHANCTX_CHANGE_MIN_WIDTH	= BIT(4),
196
197
198
199
200
201
202
203
};

/**
 * 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.
 *
204
 * @def: the channel definition
205
 * @min_def: the minimum channel definition currently required.
206
207
208
209
 * @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;
210
 *	this will always be >= @rx_chains_static.
211
 * @radar_enabled: whether radar detection is enabled on this channel.
212
213
214
215
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
 */
struct ieee80211_chanctx_conf {
216
	struct cfg80211_chan_def def;
217
	struct cfg80211_chan_def min_def;
218

219
220
	u8 rx_chains_static, rx_chains_dynamic;

221
222
	bool radar_enabled;

Johannes Berg's avatar
Johannes Berg committed
223
	u8 drv_priv[0] __aligned(sizeof(void *));
224
225
};

226
227
228
229
230
231
232
233
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
/**
 * 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;
};

263
264
265
266
267
268
269
270
271
272
/**
 * 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
273
 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler's avatar
Tomas Winkler committed
274
 * @BSS_CHANGED_HT: 802.11n parameters changed
275
 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
276
 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
277
278
279
280
281
282
 * @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)
283
 * @BSS_CHANGED_CQM: Connection quality monitor config changed
284
 * @BSS_CHANGED_IBSS: IBSS join status changed
285
 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
286
287
 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
 *	that it is only ever disabled for station mode.
288
 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
289
 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
290
 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
291
 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
292
 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
293
294
 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
 *	changed (currently only in P2P client mode, GO mode will be later)
295
296
 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
 *	currently dtim_period only is under consideration.
297
298
299
 * @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.
300
 * @BSS_CHANGED_OCB: OCB join status changed
301
 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
302
303
304
305
306
 */
enum ieee80211_bss_change {
	BSS_CHANGED_ASSOC		= 1<<0,
	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
307
	BSS_CHANGED_ERP_SLOT		= 1<<3,
Alexander Simon's avatar
Alexander Simon committed
308
	BSS_CHANGED_HT			= 1<<4,
309
	BSS_CHANGED_BASIC_RATES		= 1<<5,
310
	BSS_CHANGED_BEACON_INT		= 1<<6,
311
312
313
	BSS_CHANGED_BSSID		= 1<<7,
	BSS_CHANGED_BEACON		= 1<<8,
	BSS_CHANGED_BEACON_ENABLED	= 1<<9,
314
	BSS_CHANGED_CQM			= 1<<10,
315
	BSS_CHANGED_IBSS		= 1<<11,
316
	BSS_CHANGED_ARP_FILTER		= 1<<12,
317
	BSS_CHANGED_QOS			= 1<<13,
318
	BSS_CHANGED_IDLE		= 1<<14,
319
	BSS_CHANGED_SSID		= 1<<15,
320
	BSS_CHANGED_AP_PROBE_RESP	= 1<<16,
321
	BSS_CHANGED_PS			= 1<<17,
322
	BSS_CHANGED_TXPOWER		= 1<<18,
323
	BSS_CHANGED_P2P_PS		= 1<<19,
324
	BSS_CHANGED_BEACON_INFO		= 1<<20,
325
	BSS_CHANGED_BANDWIDTH		= 1<<21,
326
	BSS_CHANGED_OCB                 = 1<<22,
327
	BSS_CHANGED_MU_GROUPS		= 1<<23,
328
329

	/* when adding here, make sure to change ieee80211_reconfig */
330
331
};

332
333
334
335
336
337
338
/*
 * 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

339
/**
340
341
 * 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.
342
 * @MLME_EVENT: event related to MLME
343
 * @BAR_RX_EVENT: a BAR was received
344
345
346
 * @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.
347
 */
348
349
enum ieee80211_event_type {
	RSSI_EVENT,
350
	MLME_EVENT,
351
	BAR_RX_EVENT,
352
	BA_FRAME_TIMEOUT,
353
354
355
356
357
358
359
360
};

/**
 * 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 {
361
362
363
364
	RSSI_EVENT_HIGH,
	RSSI_EVENT_LOW,
};

365
/**
366
 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
367
368
369
370
371
372
 * @data: See &enum ieee80211_rssi_event_data
 */
struct ieee80211_rssi_event {
	enum ieee80211_rssi_event_data data;
};

373
374
375
/**
 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
 * @AUTH_EVENT: the MLME operation is authentication
376
 * @ASSOC_EVENT: the MLME operation is association
377
378
 * @DEAUTH_RX_EVENT: deauth received..
 * @DEAUTH_TX_EVENT: deauth sent.
379
380
381
 */
enum ieee80211_mlme_event_data {
	AUTH_EVENT,
382
	ASSOC_EVENT,
383
384
	DEAUTH_RX_EVENT,
	DEAUTH_TX_EVENT,
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
};

/**
 * 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,
};

/**
400
 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
401
402
403
404
405
406
407
408
409
410
 * @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;
};

411
412
413
414
/**
 * struct ieee80211_ba_event - data attached for BlockAck related events
 * @sta: pointer to the &ieee80211_sta to which this event relates
 * @tid: the tid
415
 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
416
417
418
419
420
421
422
 */
struct ieee80211_ba_event {
	struct ieee80211_sta *sta;
	u16 tid;
	u16 ssn;
};

423
424
/**
 * struct ieee80211_event - event to be sent to the driver
425
 * @type: The event itself. See &enum ieee80211_event_type.
426
 * @rssi: relevant if &type is %RSSI_EVENT
427
 * @mlme: relevant if &type is %AUTH_EVENT
428
 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
429
 * @u:union holding the fields above
430
431
432
433
434
 */
struct ieee80211_event {
	enum ieee80211_event_type type;
	union {
		struct ieee80211_rssi_event rssi;
435
		struct ieee80211_mlme_event mlme;
436
		struct ieee80211_ba_event ba;
437
438
439
	} u;
};

440
441
442
443
444
445
446
447
448
449
450
451
452
/**
 * 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];
};

453
454
455
456
457
458
459
/**
 * 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.
 *
 * @assoc: association status
460
461
 * @ibss_joined: indicates whether this station is part of an IBSS
 *	or not
462
 * @ibss_creator: indicates if a new IBSS network is being created
463
464
 * @aid: association ID number, valid only when @assoc is true
 * @use_cts_prot: use CTS protection
465
466
 * @use_short_preamble: use 802.11b short preamble
 * @use_short_slot: use short slot time (only relevant for ERP)
467
 * @dtim_period: num of beacons before the next DTIM, for beaconing,
468
 *	valid in station mode only if after the driver was notified
469
 *	with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
470
 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
471
472
473
474
 *	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
475
 *	%BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
476
477
 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
 *	the driver/device can use this to calculate synchronisation
478
 *	(see @sync_tsf). See also sync_dtim_count important notice.
479
480
 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
 *	is requested, see @sync_tsf/@sync_device_ts.
481
482
483
 *	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.
484
 * @beacon_int: beacon interval
485
 * @assoc_capability: capabilities taken from assoc resp
486
487
488
 * @basic_rates: bitmap of basic rates, each bit stands for an
 *	index into the rate table configured by the driver in
 *	the current band.
489
 * @beacon_rate: associated AP's beacon TX rate
490
 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
491
492
 * @bssid: The BSSID for this BSS
 * @enable_beacon: whether beaconing should be enabled or not
493
494
 * @chandef: Channel definition for this BSS -- the hardware might be
 *	configured a higher bandwidth than this BSS uses, for example.
495
 * @mu_group: VHT MU-MIMO group membership data
496
 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
497
498
499
 *	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.
500
 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
501
502
503
 *	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.
504
 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
505
506
507
508
 * @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.
509
510
511
 * @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.
512
 * @qos: This is a QoS-enabled BSS.
513
514
515
 * @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.
516
517
 * @ps: power-save mode (STA only). This flag is NOT affected by
 *	offchannel/dynamic_ps operations.
518
 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
519
520
 * @ssid_len: Length of SSID given in @ssid.
 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
521
 * @txpower: TX power in dBm
522
523
524
525
526
527
 * @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)
528
 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
529
530
 */
struct ieee80211_bss_conf {
531
	const u8 *bssid;
532
	/* association related data */
533
	bool assoc, ibss_joined;
534
	bool ibss_creator;
535
536
537
538
	u16 aid;
	/* erp related data */
	bool use_cts_prot;
	bool use_short_preamble;
539
	bool use_short_slot;
540
	bool enable_beacon;
541
	u8 dtim_period;
542
543
	u16 beacon_int;
	u16 assoc_capability;
544
545
	u64 sync_tsf;
	u32 sync_device_ts;
546
	u8 sync_dtim_count;
547
	u32 basic_rates;
548
	struct ieee80211_rate *beacon_rate;
549
	int mcast_rate[IEEE80211_NUM_BANDS];
550
	u16 ht_operation_mode;
551
552
	s32 cqm_rssi_thold;
	u32 cqm_rssi_hyst;
553
	struct cfg80211_chan_def chandef;
554
	struct ieee80211_mu_group_data mu_group;
555
	__be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
556
	int arp_addr_cnt;
557
	bool qos;
558
	bool idle;
559
	bool ps;
560
561
562
	u8 ssid[IEEE80211_MAX_SSID_LEN];
	size_t ssid_len;
	bool hidden_ssid;
563
	int txpower;
564
	enum nl80211_tx_power_setting txpower_type;
565
	struct ieee80211_p2p_noa_attr p2p_noa_attr;
566
567
};

568
/**
569
 * enum mac80211_tx_info_flags - flags to describe transmission information/status
570
 *
571
 * These flags are used with the @flags member of &ieee80211_tx_info.
572
 *
573
 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
574
575
576
577
578
579
580
581
582
583
584
 * @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.
585
586
587
588
589
590
 * @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
591
 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
592
 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
593
594
595
596
597
598
599
600
 *	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.
601
602
603
 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 * 	is for the whole aggregation.
604
605
 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 * 	so consider using block ack request (BAR).
606
607
608
 * @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)
609
610
611
 * @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.
612
613
614
 * @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.
615
616
 * @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
617
618
 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 *	used to indicate frame should not be encrypted
619
620
621
 * @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.
622
623
624
625
 * @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.
626
627
628
 * @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.)
629
630
631
 * @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.
632
633
634
 * @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)
635
 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
636
637
 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
 *	frame and selects the maximum number of streams that it can use.
638
639
640
641
 * @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.
642
643
644
 * @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.
645
646
647
 * @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
648
649
650
 * @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
651
652
 *	the driver may set this flag. It is also used to do the same for
 *	PS-Poll responses.
653
654
655
 * @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.
656
657
658
 * @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).
659
660
661
662
663
 * @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.
664
665
666
 *
 * Note: If you have to add new flags to the enumeration, then don't
 *	 forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
667
 */
668
enum mac80211_tx_info_flags {
669
	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
670
671
672
673
674
675
676
677
678
679
680
681
	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),
682
	IEEE80211_TX_INTFL_OFFCHAN_TX_OK	= BIT(13),
683
	IEEE80211_TX_INTFL_NEED_TXPROCESSING	= BIT(14),
684
	IEEE80211_TX_INTFL_RETRIED		= BIT(15),
Johannes Berg's avatar
Johannes Berg committed
685
	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
686
	IEEE80211_TX_CTL_NO_PS_BUFFER		= BIT(17),
687
	IEEE80211_TX_CTL_MORE_FRAMES		= BIT(18),
688
	IEEE80211_TX_INTFL_RETRANSMISSION	= BIT(19),
689
	IEEE80211_TX_INTFL_MLME_CONN_TX		= BIT(20),
690
	IEEE80211_TX_INTFL_NL80211_FRAME_TX	= BIT(21),
691
	IEEE80211_TX_CTL_LDPC			= BIT(22),
692
	IEEE80211_TX_CTL_STBC			= BIT(23) | BIT(24),
693
	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(25),
694
	IEEE80211_TX_INTFL_TKIP_MIC_FAILURE	= BIT(26),
695
	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(27),
Johannes Berg's avatar
Johannes Berg committed
696
	IEEE80211_TX_STATUS_EOSP		= BIT(28),
697
	IEEE80211_TX_CTL_USE_MINRATE		= BIT(29),
698
	IEEE80211_TX_CTL_DONTFRAG		= BIT(30),
699
	IEEE80211_TX_STAT_NOACK_TRANSMITTED	= BIT(31),
700
701
};

Johannes Berg's avatar
Johannes Berg committed
702
703
#define IEEE80211_TX_CTL_STBC_SHIFT		23

704
705
706
707
708
/**
 * 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)
709
710
 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
 *	frame (PS-Poll or uAPSD).
711
 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
712
713
714
715
716
 *
 * These flags are used in tx_info->control.flags.
 */
enum mac80211_tx_control_flags {
	IEEE80211_TX_CTRL_PORT_CTRL_PROTO	= BIT(0),
717
	IEEE80211_TX_CTRL_PS_RESPONSE		= BIT(1),
718
	IEEE80211_TX_CTRL_RATE_INJECT		= BIT(2),
719
720
};

721
722
723
724
725
726
727
728
729
/*
 * 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 |	      \
730
	IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER |    \
731
	IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |		      \
Johannes Berg's avatar
Johannes Berg committed
732
	IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
733

734
735
736
737
738
739
740
741
742
743
744
745
/**
 * 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.
746
747
 * @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)
748
749
750
 * @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.
751
752
753
 * @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)
754
755
756
757
758
 * @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.
 */
759
760
761
762
763
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),

764
	/* rate index is an HT/VHT MCS instead of an index */
765
766
767
768
769
	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),
770
771
772
	IEEE80211_TX_RC_VHT_MCS			= BIT(8),
	IEEE80211_TX_RC_80_MHZ_WIDTH		= BIT(9),
	IEEE80211_TX_RC_160_MHZ_WIDTH		= BIT(10),
773
774
775
776
777
};


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

779
780
/* if you do need the rateset, then you have less space */
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
781

782
/* maximum number of rate stages */
783
#define IEEE80211_TX_MAX_RATES	4
784

785
786
787
/* maximum number of rate table entries */
#define IEEE80211_TX_RATE_TABLE_SIZE	4

788
/**
789
 * struct ieee80211_tx_rate - rate selection/status
790
 *
791
792
 * @idx: rate index to attempt to send with
 * @flags: rate control flags (&enum mac80211_rate_control_flags)
793
 * @count: number of tries in this rate before going to the next rate
794
795
796
797
798
799
 *
 * 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.
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
 *
 * &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
 * information
 *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
 * 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
 * information should then contain
 *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
 * since it was transmitted twice at rate 3, twice at rate 2
 * and once at rate 1 after which we received an acknowledgement.
815
 */
816
817
struct ieee80211_tx_rate {
	s8 idx;
818
819
	u16 count:5,
	    flags:11;
820
} __packed;
821

822
823
824
825
826
827
#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
828
829
	WARN_ON((nss - 1) & ~0x7);
	rate->idx = ((nss - 1) << 4) | mcs;
830
831
832
833
834
835
836
837
838
839
840
}

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
841
	return (rate->idx >> 4) + 1;
842
843
}

844
845
846
847
848
849
850
851
852
/**
 * 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
853
 * @band: the band to transmit on (use for checking for races)
854
 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
855
 * @ack_frame_id: internal frame ID for TX status, used internally
856
857
858
 * @control: union for control data
 * @status: union for status data
 * @driver_data: array of driver_data pointers
859
 * @ampdu_ack_len: number of acked aggregated frames.
860
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
861
 * @ampdu_len: number of aggregated frames.
862
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
863
 * @ack_signal: signal strength of the ACK frame
864
 */
865
866
867
868
struct ieee80211_tx_info {
	/* common information */
	u32 flags;
	u8 band;
869

870
	u8 hw_queue;
871

872
	u16 ack_frame_id;
873
874
875

	union {
		struct {
876
877
878
879
880
881
			union {
				/* rate control */
				struct {
					struct ieee80211_tx_rate rates[
						IEEE80211_TX_MAX_RATES];
					s8 rts_cts_rate_idx;
882
883
					u8 use_rts:1;
					u8 use_cts_prot:1;
884
885
					u8 short_preamble:1;
					u8 skip_table:1;
886
					/* 2 bytes free */
887
888
889
890
				};
				/* only needed before rate control */
				unsigned long jiffies;
			};
891
			/* NB: vif can be NULL for injected frames */
892
893
			struct ieee80211_vif *vif;
			struct ieee80211_key_conf *hw_key;
894
895
			u32 flags;
			/* 4 bytes free */
896
		} control;
897
898
899
		struct {
			u64 cookie;
		} ack;
900
		struct {
901
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
902
			s32 ack_signal;
903
			u8 ampdu_ack_len;
904
			u8 ampdu_len;
905
			u8 antenna;
906
907
			u16 tx_time;
			void *status_driver_data[19 / sizeof(void *)];
908
		} status;
909
910
911
		struct {
			struct ieee80211_tx_rate driver_rates[
				IEEE80211_TX_MAX_RATES];
912
913
			u8 pad[4];

914
915
916
917
918
			void *rate_driver_data[
				IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
		};
		void *driver_data[
			IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
919
	};
920
921
};

922
923
924
/**
 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
 *
925
926
927
 * This structure is used to point to different blocks of IEs in HW scan
 * and scheduled scan. These blocks contain the IEs passed by userspace
 * and the ones generated by mac80211.
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 *
 * @ies: pointers to band specific IEs.
 * @len: lengths of band_specific IEs.
 * @common_ies: IEs for all bands (especially vendor specific ones)
 * @common_ie_len: length of the common_ies
 */
struct ieee80211_scan_ies {
	const u8 *ies[IEEE80211_NUM_BANDS];
	size_t len[IEEE80211_NUM_BANDS];
	const u8 *common_ies;
	size_t common_ie_len;
};


942
943
944
945
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
{
	return (struct ieee80211_tx_info *)skb->cb;
}
946

947
948
949
950
951
static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
{
	return (struct ieee80211_rx_status *)skb->cb;
}

952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
/**
 * ieee80211_tx_info_clear_status - clear TX status
 *
 * @info: The &struct ieee80211_tx_info to be cleared.
 *
 * When the driver passes an skb back to mac80211, it must report
 * a number of things in TX status. This function clears everything
 * in the TX status but the rate control information (it does clear
 * the count since you need to fill that in anyway).
 *
 * NOTE: You can only use this function if you do NOT use
 *	 info->driver_data! Use info->rate_driver_data
 *	 instead if you need only the less space that allows.
 */
static inline void
ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
{
	int i;

	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
		     offsetof(struct ieee80211_tx_info, control.rates));
	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
		     offsetof(struct ieee80211_tx_info, driver_rates));
	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
	/* clear the rate counts */
	for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
		info->status.rates[i].count = 0;

	BUILD_BUG_ON(
981
	    offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
982
983
984
985
986
	memset(&info->status.ampdu_ack_len, 0,
	       sizeof(struct ieee80211_tx_info) -
	       offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
}

987
988
989
990
991
992
993
994
995
996
997
998
999

/**
 * enum mac80211_rx_flags - receive flags
 *
 * These flags are used with the @flag member of &struct ieee80211_rx_status.
 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
 *	Use together with %RX_FLAG_MMIC_STRIPPED.
 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
 *	verification has been done by the hardware.
 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
 *	If this flag is set, the stack cannot do any replay detection
 *	hence the driver or hardware will have to do that.
1000
1001
1002
1003
 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
 *	flag indicates that the PN was verified for replay protection.
 *	Note that this flag is also currently only supported when a frame
 *	is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1004
1005
 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
 *	de-duplication by itself.
1006
1007
1008
1009
 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
 *	the frame.
 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
 *	the frame.
1010
 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
Johannes Berg's avatar
Johannes Berg committed
1011
1012
1013
 *	field) is valid and contains the time the first symbol of the MPDU
 *	was received. This is useful in monitor mode and for proper IBSS
 *	merging.
1014
1015
1016
 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
 *	field) is valid and contains the time the last symbol of the MPDU
 *	(including FCS) was received.
1017
1018
 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
 *	field) is valid and contains the time the SYNC preamble was received.
1019
 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
1020
 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
1021
 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
1022
1023
 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
 * @RX_FLAG_SHORT_GI: Short guard interval was used
1024
1025
 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
 *	Valid only for data frames (mainly A-MPDU)
1026
1027
1028
 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
 *	the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
 *	to hw.radiotap_mcs_details to advertise that fact
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
 *	number (@ampdu_reference) must be populated and be a distinct number for
 *	each A-MPDU
 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
 *	subframes of a single A-MPDU
 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
 *	on this subframe
 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
 *	is stored in the @ampdu_delimiter_crc field)
1039
 * @RX_FLAG_LDPC: LDPC was used
1040
1041
1042
1043
1044
1045
1046
1047
 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
 *	processing it in any regular way.
 *	This is useful if drivers offload some frames but still want to report
 *	them for sniffing purposes.
 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
 *	monitor interfaces.
 *	This is useful if drivers offload some frames but still want to report
 *	them for sniffing purposes.
1048
 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1049
1050
 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
1051
1052
1053
1054
1055
1056
1057
1058
1059
 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
 *	subframes instead of a one huge frame for performance reasons.
 *	All, but the last MSDU from an A-MSDU should have this flag set. E.g.
 *	if an A-MSDU has 3 frames, the first 2 must have the flag set, while
 *	the 3rd (last) one must not have this flag set. The flag is used to
 *	deal with retransmission/duplication recovery properly since A-MSDU
 *	subframes share the same sequence number. Reported subframes can be
 *	either regular MSDU or singly A-MSDUs. Subframes must not be
 *	interleaved with other frames.
1060
1061
1062
 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
 *	radiotap data in the skb->data (before the frame) as described by
 *	the &struct ieee80211_vendor_radiotap.
1063
1064
 */
enum mac80211_rx_flags {
1065
1066
	RX_FLAG_MMIC_ERROR		= BIT(0),
	RX_FLAG_DECRYPTED		= BIT(1),
1067
	RX_FLAG_MACTIME_PLCP_START	= BIT(2),
1068
1069
1070
1071
	RX_FLAG_MMIC_STRIPPED		= BIT(3),
	RX_FLAG_IV_STRIPPED		= BIT(4),
	RX_FLAG_FAILED_FCS_CRC		= BIT(5),
	RX_FLAG_FAILED_PLCP_CRC 	= BIT(6),
1072
	RX_FLAG_MACTIME_START		= BIT(7),
1073
1074
1075
1076
1077
1078
1079
	RX_FLAG_SHORTPRE		= BIT(8),
	RX_FLAG_HT			= BIT(9),
	RX_FLAG_40MHZ			= BIT(10),
	RX_FLAG_SHORT_GI		= BIT(11),
	RX_FLAG_NO_SIGNAL_VAL		= BIT(12),
	RX_FLAG_HT_GF			= BIT(13),
	RX_FLAG_AMPDU_DETAILS		= BIT(14),
1080
	RX_FLAG_PN_VALIDATED		= BIT(15),
1081
	RX_FLAG_DUP_VALIDATED		= BIT(16),
1082
1083
1084
1085
	RX_FLAG_AMPDU_LAST_KNOWN	= BIT(17),
	RX_FLAG_AMPDU_IS_LAST		= BIT(18),
	RX_FLAG_AMPDU_DELIM_CRC_ERROR	= BIT(19),
	RX_FLAG_AMPDU_DELIM_CRC_KNOWN	= BIT(20),
1086
	RX_FLAG_MACTIME_END		= BIT(21),
1087
	RX_FLAG_VHT			= BIT(22),
1088
	RX_FLAG_LDPC			= BIT(23),
1089
1090
	RX_FLAG_ONLY_MONITOR		= BIT(24),
	RX_FLAG_SKIP_MONITOR		= BIT(25),
1091
	RX_FLAG_STBC_MASK		= BIT(26) | BIT(27),
1092
1093
	RX_FLAG_10MHZ			= BIT(28),
	RX_FLAG_5MHZ			= BIT(29),
1094
	RX_FLAG_AMSDU_MORE		= BIT(30),
1095
	RX_FLAG_RADIOTAP_VENDOR_DATA	= BIT(31),
1096
1097
};

1098
1099
#define RX_FLAG_STBC_SHIFT		26

1100
1101
1102
1103
1104
1105
1106
/**
 * enum mac80211_rx_vht_flags - receive VHT flags
 *
 * These flags are used with the @vht_flag member of
 *	&struct ieee80211_rx_status.
 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1107
 * @RX_VHT_FLAG_BF: packet was beamformed
1108
 */
1109

1110
1111
enum mac80211_rx_vht_flags {
	RX_VHT_FLAG_80MHZ		= BIT(0),
1112
1113
	RX_VHT_FLAG_160MHZ		= BIT(1),
	RX_VHT_FLAG_BF			= BIT(2),
1114
1115
};

1116
1117
1118
1119
1120
/**
 * struct ieee80211_rx_status - receive status
 *
 * The low-level driver should provide this information (the subset
 * supported by hardware) to the 802.11 code with each received
1121
 * frame, in the skb's control buffer (cb).
1122
 *
1123
1124
 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
 * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1125
1126
 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
 *	it but can store it and pass it back to the driver for synchronisation
1127
 * @band: the active band when this frame was received