mac80211.h 69.5 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>
Johannes Berg's avatar
Johannes Berg committed
6
 * Copyright 2007-2008	Johannes Berg <johannes@sipsolutions.net>
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *
 * 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

#include <linux/kernel.h>
#include <linux/if_ether.h>
#include <linux/skbuff.h>
#include <linux/wireless.h>
#include <linux/device.h>
#include <linux/ieee80211.h>
#include <net/wireless.h>
#include <net/cfg80211.h>

25
26
27
28
29
30
31
32
33
34
35
36
37
/**
 * 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
38
39
40
 * 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
41
42
43
44
 * 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
45
 *	 use the non-IRQ-safe functions!
46
47
 */

48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/**
 * 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.
 *
 * Finally, for received frames, the driver is able to indicate that it has
 * filled a radiotap header and put that in front of the frame; if it does
 * not do so then mac80211 may add this under certain circumstances.
74
75
 */

76
/**
77
78
79
 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
 *
 * This structure describes most essential parameters needed
80
 * to describe 802.11n HT characteristics in a BSS.
81
82
83
84
 *
 * @primary_channel: channel number of primery channel
 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
85
 */
86
87
88
89
struct ieee80211_ht_bss_info {
	u8 primary_channel;
	u8 bss_cap;  /* use IEEE80211_HT_IE_CHA_ */
	u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
90
91
};

Johannes Berg's avatar
Johannes Berg committed
92
93
94
95
96
97
98
99
100
101
102
103
/**
 * enum ieee80211_max_queues - maximum number of queues
 *
 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
 *	for A-MPDU operation.
 */
enum ieee80211_max_queues {
	IEEE80211_MAX_QUEUES =		16,
	IEEE80211_MAX_AMPDU_QUEUES =	16,
};

104
105
106
107
/**
 * struct ieee80211_tx_queue_params - transmit queue configuration
 *
 * The information provided in this structure is required for QoS
108
 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
109
 *
110
 * @aifs: arbitration interframe space [0..255]
111
112
 * @cw_min: minimum contention window [a value of the form
 *	2^n-1 in the range 1..32767]
113
 * @cw_max: maximum contention window [like @cw_min]
114
 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
115
 */
116
struct ieee80211_tx_queue_params {
117
	u16 txop;
118
119
	u16 cw_min;
	u16 cw_max;
120
	u8 aifs;
121
122
};

123
/**
124
 * struct ieee80211_tx_queue_stats - transmit queue statistics
125
126
127
128
129
 *
 * @len: number of packets in queue
 * @limit: queue length limit
 * @count: number of frames sent
 */
130
struct ieee80211_tx_queue_stats {
131
132
133
	unsigned int len;
	unsigned int limit;
	unsigned int count;
134
135
136
137
138
139
140
141
142
};

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

143
144
145
146
147
148
149
150
151
152
/**
 * 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
153
 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler's avatar
Tomas Winkler committed
154
 * @BSS_CHANGED_HT: 802.11n parameters changed
155
 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
156
157
158
159
160
 */
enum ieee80211_bss_change {
	BSS_CHANGED_ASSOC		= 1<<0,
	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
161
	BSS_CHANGED_ERP_SLOT		= 1<<3,
Tomas Winkler's avatar
Tomas Winkler committed
162
	BSS_CHANGED_HT                  = 1<<4,
163
	BSS_CHANGED_BASIC_RATES		= 1<<5,
164
165
};

Johannes Berg's avatar
Johannes Berg committed
166
167
168
169
170
171
172
173
174
175
176
177
178
/**
 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration
 * @secondary_channel_offset: secondary channel offset, uses
 *	%IEEE80211_HT_PARAM_CHA_SEC_ values
 * @width_40_ok: indicates that 40 MHz bandwidth may be used for TX
 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info)
 */
struct ieee80211_bss_ht_conf {
	u8 secondary_channel_offset;
	bool width_40_ok;
	u16 operation_mode;
};

179
180
181
182
183
184
185
186
187
/**
 * 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
 * @aid: association ID number, valid only when @assoc is true
 * @use_cts_prot: use CTS protection
188
189
190
191
192
193
 * @use_short_preamble: use 802.11b short preamble;
 *	if the hardware cannot handle this it must set the
 *	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
 * @use_short_slot: use short slot time (only relevant for ERP);
 *	if the hardware cannot handle this it must set the
 *	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
194
 * @dtim_period: num of beacons before the next DTIM, for PSM
195
196
 * @timestamp: beacon timestamp
 * @beacon_int: beacon interval
197
 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg's avatar
Johannes Berg committed
198
 * @ht: BSS's HT configuration
199
200
201
 * @basic_rates: bitmap of basic rates, each bit stands for an
 *	index into the rate table configured by the driver in
 *	the current band.
202
203
204
205
206
207
208
209
 */
struct ieee80211_bss_conf {
	/* association related data */
	bool assoc;
	u16 aid;
	/* erp related data */
	bool use_cts_prot;
	bool use_short_preamble;
210
	bool use_short_slot;
211
	u8 dtim_period;
212
213
214
	u16 beacon_int;
	u16 assoc_capability;
	u64 timestamp;
215
	u64 basic_rates;
Johannes Berg's avatar
Johannes Berg committed
216
	struct ieee80211_bss_ht_conf ht;
217
218
};

219
/**
220
 * enum mac80211_tx_control_flags - flags to describe transmission information/status
221
 *
222
 * These flags are used with the @flags member of &ieee80211_tx_info.
223
224
 *
 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
225
226
227
228
229
230
231
232
233
234
235
 * @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.
236
237
238
239
240
241
 * @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
242
 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
243
244
245
246
247
 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
 *	because the destination STA was in powersave mode.
 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 * 	is for the whole aggregation.
248
249
 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 * 	so consider using block ack request (BAR).
250
251
252
 * @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)
253
254
 */
enum mac80211_tx_control_flags {
255
	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
256
257
258
259
260
261
262
263
264
265
266
267
	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),
268
269
};

270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
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),

	/* rate index is an MCS rate number instead of an index */
	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),
};


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

287
288
/* if you do need the rateset, then you have less space */
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
289

290
291
/* maximum number of rate stages */
#define IEEE80211_TX_MAX_RATES	5
292
293

/**
294
 * struct ieee80211_tx_rate - rate selection/status
295
 *
296
297
 * @idx: rate index to attempt to send with
 * @flags: rate control flags (&enum mac80211_rate_control_flags)
298
 * @count: number of tries in this rate before going to the next rate
299
300
301
302
303
304
 *
 * 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.
305
 */
306
307
308
309
struct ieee80211_tx_rate {
	s8 idx;
	u8 count;
	u8 flags;
310
} __attribute__((packed));
311

312
313
314
315
316
317
318
319
/**
 * 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
 *
320
321
322
 * The TX control's sta pointer is only valid during the ->tx call,
 * it may be NULL.
 *
323
 * @flags: transmit info flags, defined above
324
 * @band: the band to transmit on (use for checking for races)
325
 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
326
327
328
 * @control: union for control data
 * @status: union for status data
 * @driver_data: array of driver_data pointers
329
330
331
332
333
334
 * @retry_count: number of retries
 * @ampdu_ack_len: number of aggregated frames.
 * 	relevant only if IEEE80211_TX_STATUS_AMPDU was set.
 * @ampdu_ack_map: block ack bit map for the aggregation.
 * 	relevant only if IEEE80211_TX_STATUS_AMPDU was set.
 * @ack_signal: signal strength of the ACK frame
335
 */
336
337
338
339
struct ieee80211_tx_info {
	/* common information */
	u32 flags;
	u8 band;
340

341
	u8 antenna_sel_tx;
342

343
	/* 2 byte hole */
344
345
346

	union {
		struct {
347
348
349
350
351
352
353
354
355
356
			union {
				/* rate control */
				struct {
					struct ieee80211_tx_rate rates[
						IEEE80211_TX_MAX_RATES];
					s8 rts_cts_rate_idx;
				};
				/* only needed before rate control */
				unsigned long jiffies;
			};
357
			/* NB: vif can be NULL for injected frames */
358
359
			struct ieee80211_vif *vif;
			struct ieee80211_key_conf *hw_key;
360
			struct ieee80211_sta *sta;
361
362
		} control;
		struct {
363
364
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
			u8 ampdu_ack_len;
365
366
			u64 ampdu_ack_map;
			int ack_signal;
367
			/* 8 bytes free */
368
		} status;
369
370
371
372
373
374
375
376
		struct {
			struct ieee80211_tx_rate driver_rates[
				IEEE80211_TX_MAX_RATES];
			void *rate_driver_data[
				IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
		};
		void *driver_data[
			IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
377
	};
378
379
};

380
381
382
383
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
{
	return (struct ieee80211_tx_info *)skb->cb;
}
384

385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
/**
 * 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(
	    offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
	memset(&info->status.ampdu_ack_len, 0,
	       sizeof(struct ieee80211_tx_info) -
	       offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
}

420
421
422
423
424
425
426
427
428
429
430
431
432
433

/**
 * 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_RADIOTAP: This frame starts with a radiotap header.
 * @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.
434
435
436
437
 * @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.
438
 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf's avatar
Bruno Randolf committed
439
440
 *	is valid. This is useful in monitor mode and necessary for beacon frames
 *	to enable IBSS merging.
441
 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
442
443
444
445
446
447
448
 */
enum mac80211_rx_flags {
	RX_FLAG_MMIC_ERROR	= 1<<0,
	RX_FLAG_DECRYPTED	= 1<<1,
	RX_FLAG_RADIOTAP	= 1<<2,
	RX_FLAG_MMIC_STRIPPED	= 1<<3,
	RX_FLAG_IV_STRIPPED	= 1<<4,
449
450
	RX_FLAG_FAILED_FCS_CRC	= 1<<5,
	RX_FLAG_FAILED_PLCP_CRC = 1<<6,
451
	RX_FLAG_TSFT		= 1<<7,
452
	RX_FLAG_SHORTPRE	= 1<<8
453
454
455
456
457
458
459
460
};

/**
 * 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
 * frame.
461
 *
462
463
 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
 * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
464
 * @band: the active band when this frame was received
465
 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
466
467
468
469
470
 * @signal: signal strength when receiving this frame, either in dBm, in dB or
 *	unspecified depending on the hardware capabilities flags
 *	@IEEE80211_HW_SIGNAL_*
 * @noise: noise when receiving this frame, in dBm.
 * @qual: overall signal quality indication, in percent (0-100).
471
 * @antenna: antenna used
472
 * @rate_idx: index of data rate into band's supported rates
473
474
 * @flag: %RX_FLAG_*
 */
475
476
struct ieee80211_rx_status {
	u64 mactime;
477
	enum ieee80211_band band;
478
479
	int freq;
	int signal;
480
	int noise;
481
	int qual;
482
	int antenna;
483
	int rate_idx;
484
485
486
	int flag;
};

487
488
489
490
491
492
/**
 * enum ieee80211_conf_flags - configuration flags
 *
 * Flags to define PHY configuration options
 *
 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
493
 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
494
495
 */
enum ieee80211_conf_flags {
496
	IEEE80211_CONF_RADIOTAP		= (1<<0),
Johannes Berg's avatar
Johannes Berg committed
497
	IEEE80211_CONF_PS		= (1<<1),
498
};
499

500
501
502
503
504
505
506
/* XXX: remove all this once drivers stop trying to use it */
static inline int __deprecated __IEEE80211_CONF_SHORT_SLOT_TIME(void)
{
	return 0;
}
#define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME())

Johannes Berg's avatar
Johannes Berg committed
507
508
509
510
struct ieee80211_ht_conf {
	bool enabled;
};

511
512
513
514
515
516
517
518
519
520
/**
 * enum ieee80211_conf_changed - denotes which configuration changed
 *
 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel changed
521
 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg's avatar
Johannes Berg committed
522
 * @IEEE80211_CONF_CHANGE_HT: HT configuration changed
523
524
525
526
527
528
529
530
531
 */
enum ieee80211_conf_changed {
	IEEE80211_CONF_CHANGE_RADIO_ENABLED	= BIT(0),
	IEEE80211_CONF_CHANGE_BEACON_INTERVAL	= BIT(1),
	IEEE80211_CONF_CHANGE_LISTEN_INTERVAL	= BIT(2),
	IEEE80211_CONF_CHANGE_RADIOTAP		= BIT(3),
	IEEE80211_CONF_CHANGE_PS		= BIT(4),
	IEEE80211_CONF_CHANGE_POWER		= BIT(5),
	IEEE80211_CONF_CHANGE_CHANNEL		= BIT(6),
532
	IEEE80211_CONF_CHANGE_RETRY_LIMITS	= BIT(7),
Johannes Berg's avatar
Johannes Berg committed
533
	IEEE80211_CONF_CHANGE_HT		= BIT(8),
534
535
};

536
537
538
539
540
541
/**
 * struct ieee80211_conf - configuration of the device
 *
 * This struct indicates how the driver shall configure the hardware.
 *
 * @radio_enabled: when zero, driver is required to switch off the radio.
542
 * @beacon_int: beacon interval (TODO make interface config)
543
 * @listen_interval: listen interval in units of beacon interval
544
 * @flags: configuration flags defined above
545
546
 * @power_level: requested transmit power (in dBm)
 * @channel: the channel to tune to
Johannes Berg's avatar
Johannes Berg committed
547
 * @ht: the HT configuration for the device
548
549
550
551
552
553
 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
 *    (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
 *    but actually means the number of transmissions not the number of retries
 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
 *    frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
 *    number of transmissions not the number of retries
554
555
556
 */
struct ieee80211_conf {
	int beacon_int;
557
	u32 flags;
558
	int power_level;
559

560
561
562
	u16 listen_interval;
	bool radio_enabled;

563
564
	u8 long_frame_max_tx_count, short_frame_max_tx_count;

565
	struct ieee80211_channel *channel;
Johannes Berg's avatar
Johannes Berg committed
566
	struct ieee80211_ht_conf ht;
567
568
};

569
570
571
572
573
574
/**
 * struct ieee80211_vif - per-interface data
 *
 * Data in this structure is continually present for driver
 * use during the life of a virtual interface.
 *
575
 * @type: type of this virtual interface
576
577
 * @bss_conf: BSS configuration for this interface, either our own
 *	or the BSS we're associated to
578
579
580
581
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *).
 */
struct ieee80211_vif {
582
	enum nl80211_iftype type;
583
	struct ieee80211_bss_conf bss_conf;
584
585
586
587
	/* must be last */
	u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
};

Johannes Berg's avatar
Johannes Berg committed
588
589
590
static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
{
#ifdef CONFIG_MAC80211_MESH
591
	return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg's avatar
Johannes Berg committed
592
593
594
595
#endif
	return false;
}

596
597
598
/**
 * struct ieee80211_if_init_conf - initial configuration of an interface
 *
599
600
601
 * @vif: pointer to a driver-use per-interface structure. The pointer
 *	itself is also used for various functions including
 *	ieee80211_beacon_get() and ieee80211_get_buffered_bc().
602
 * @type: one of &enum nl80211_iftype constants. Determines the type of
603
604
605
606
607
608
609
 *	added/removed interface.
 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
 *	until the interface is removed (i.e. it cannot be used after
 *	remove_interface() callback was called for this interface).
 *
 * This structure is used in add_interface() and remove_interface()
 * callbacks of &struct ieee80211_hw.
610
611
612
613
614
615
 *
 * When you allow multiple interfaces to be added to your PHY, take care
 * that the hardware can actually handle multiple MAC addresses. However,
 * also take care that when there's no interface left with mac_addr != %NULL
 * you remove the MAC address from the device to avoid acknowledging packets
 * in pure monitor mode.
616
617
 */
struct ieee80211_if_init_conf {
618
	enum nl80211_iftype type;
619
	struct ieee80211_vif *vif;
620
621
622
	void *mac_addr;
};

623
624
625
626
627
628
629
630
631
/**
 * enum ieee80211_if_conf_change - interface config change flags
 *
 * @IEEE80211_IFCC_BSSID: The BSSID changed.
 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
 *	(currently AP and MESH only), use ieee80211_beacon_get().
 */
enum ieee80211_if_conf_change {
	IEEE80211_IFCC_BSSID	= BIT(0),
632
	IEEE80211_IFCC_BEACON	= BIT(1),
633
634
};

635
636
637
/**
 * struct ieee80211_if_conf - configuration of an interface
 *
638
 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
639
640
641
642
643
644
 * @bssid: BSSID of the network we are associated to/creating.
 *
 * This structure is passed to the config_interface() callback of
 * &struct ieee80211_hw.
 */
struct ieee80211_if_conf {
645
	u32 changed;
646
647
648
	u8 *bssid;
};

649
650
651
652
653
654
/**
 * enum ieee80211_key_alg - key algorithm
 * @ALG_WEP: WEP40 or WEP104
 * @ALG_TKIP: TKIP
 * @ALG_CCMP: CCMP (AES)
 */
655
enum ieee80211_key_alg {
656
657
658
	ALG_WEP,
	ALG_TKIP,
	ALG_CCMP,
659
};
660

661
662
/**
 * enum ieee80211_key_len - key length
663
664
 * @LEN_WEP40: WEP 5-byte long key
 * @LEN_WEP104: WEP 13-byte long key
665
666
667
668
669
 */
enum ieee80211_key_len {
	LEN_WEP40 = 5,
	LEN_WEP104 = 13,
};
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684

/**
 * enum ieee80211_key_flags - key flags
 *
 * These flags are used for communication about keys between the driver
 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
 *
 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
 *	that the STA this key will be used with could be using QoS.
 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
 *	driver to indicate that it requires IV generation for this
 *	particular key.
 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
 *	the driver for a TKIP key if it requires Michael MIC
 *	generation in software.
685
686
 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
 *	that the key is pairwise rather then a shared key.
687
 */
688
689
690
691
enum ieee80211_key_flags {
	IEEE80211_KEY_FLAG_WMM_STA	= 1<<0,
	IEEE80211_KEY_FLAG_GENERATE_IV	= 1<<1,
	IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
692
	IEEE80211_KEY_FLAG_PAIRWISE	= 1<<3,
693
};
694

695
696
697
698
699
700
701
702
/**
 * struct ieee80211_key_conf - key information
 *
 * This key information is given by mac80211 to the driver by
 * the set_key() callback in &struct ieee80211_ops.
 *
 * @hw_key_idx: To be set by the driver, this is the key index the driver
 *	wants to be given when a frame is transmitted and needs to be
703
 *	encrypted in hardware.
704
705
706
707
 * @alg: The key algorithm.
 * @flags: key flags, see &enum ieee80211_key_flags.
 * @keyidx: the key index (0-3)
 * @keylen: key material length
708
709
710
711
712
 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
 * 	data block:
 * 	- Temporal Encryption Key (128 bits)
 * 	- Temporal Authenticator Tx MIC Key (64 bits)
 * 	- Temporal Authenticator Rx MIC Key (64 bits)
Randy Dunlap's avatar
Randy Dunlap committed
713
714
 * @icv_len: FIXME
 * @iv_len: FIXME
715
 */
716
struct ieee80211_key_conf {
717
	enum ieee80211_key_alg alg;
718
719
	u8 icv_len;
	u8 iv_len;
720
	u8 hw_key_idx;
721
722
723
	u8 flags;
	s8 keyidx;
	u8 keylen;
724
725
726
	u8 key[0];
};

727
728
729
730
731
732
733
734
735
/**
 * enum set_key_cmd - key command
 *
 * Used with the set_key() callback in &struct ieee80211_ops, this
 * indicates whether a key is being removed or added.
 *
 * @SET_KEY: a key is set
 * @DISABLE_KEY: a key must be disabled
 */
736
enum set_key_cmd {
737
	SET_KEY, DISABLE_KEY,
738
};
739

740
741
742
743
744
745
746
747
748
749
750
751
/**
 * struct ieee80211_sta - station table entry
 *
 * A station table entry represents a station we are possibly
 * communicating with. Since stations are RCU-managed in
 * mac80211, any ieee80211_sta pointer you get access to must
 * either be protected by rcu_read_lock() explicitly or implicitly,
 * or you must take good care to not use such a pointer after a
 * call to your sta_notify callback that removed it.
 *
 * @addr: MAC address
 * @aid: AID we assigned to the station if we're an AP
752
 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg's avatar
Johannes Berg committed
753
 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
754
755
756
757
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
 */
struct ieee80211_sta {
758
	u64 supp_rates[IEEE80211_NUM_BANDS];
759
760
	u8 addr[ETH_ALEN];
	u16 aid;
761
	struct ieee80211_sta_ht_cap ht_cap;
762
763
764
765
766

	/* must be last */
	u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
};

767
768
769
770
/**
 * enum sta_notify_cmd - sta notify command
 *
 * Used with the sta_notify() callback in &struct ieee80211_ops, this
771
 * indicates addition and removal of a station to station table.
772
773
774
775
776
777
778
 *
 * @STA_NOTIFY_ADD: a station was added to the station table
 * @STA_NOTIFY_REMOVE: a station being removed from the station table
 */
enum sta_notify_cmd {
	STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
};
779

780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
/**
 * enum ieee80211_tkip_key_type - get tkip key
 *
 * Used by drivers which need to get a tkip key for skb. Some drivers need a
 * phase 1 key, others need a phase 2 key. A single function allows the driver
 * to get the key, this enum indicates what type of key is required.
 *
 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
 */
enum ieee80211_tkip_key_type {
	IEEE80211_TKIP_P1_KEY,
	IEEE80211_TKIP_P2_KEY,
};

795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
/**
 * enum ieee80211_hw_flags - hardware flags
 *
 * These flags are used to indicate hardware capabilities to
 * the stack. Generally, flags here should have their meaning
 * done in a way that the simplest hardware doesn't need setting
 * any particular flags. There are some exceptions to this rule,
 * however, so you are advised to review these flags carefully.
 *
 * @IEEE80211_HW_RX_INCLUDES_FCS:
 *	Indicates that received frames passed to the stack include
 *	the FCS at the end.
 *
 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
 *	Some wireless LAN chipsets buffer broadcast/multicast frames
 *	for power saving stations in the hardware/firmware and others
 *	rely on the host system for such buffering. This option is used
 *	to configure the IEEE 802.11 upper layer to buffer broadcast and
 *	multicast frames when there are power saving stations so that
814
 *	the driver can fetch them with ieee80211_get_buffered_bc().
815
 *
816
817
818
819
820
821
 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
 *	Hardware is not capable of short slot operation on the 2.4 GHz band.
 *
 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
 *	Hardware is not capable of receiving frames with short preamble on
 *	the 2.4 GHz band.
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 *
 * @IEEE80211_HW_SIGNAL_UNSPEC:
 *	Hardware can provide signal values but we don't know its units. We
 *	expect values between 0 and @max_signal.
 *	If possible please provide dB or dBm instead.
 *
 * @IEEE80211_HW_SIGNAL_DB:
 *	Hardware gives signal values in dB, decibel difference from an
 *	arbitrary, fixed reference. We expect values between 0 and @max_signal.
 *	If possible please provide dBm instead.
 *
 * @IEEE80211_HW_SIGNAL_DBM:
 *	Hardware gives signal values in dBm, decibel difference from
 *	one milliwatt. This is the preferred method since it is standardized
 *	between different devices. @max_signal does not need to be set.
 *
 * @IEEE80211_HW_NOISE_DBM:
 *	Hardware can provide noise (radio interference) values in units dBm,
 *      decibel difference from one milliwatt.
841
842
843
844
 *
 * @IEEE80211_HW_SPECTRUM_MGMT:
 * 	Hardware supports spectrum management defined in 802.11h
 * 	Measurement, Channel Switch, Quieting, TPC
Sujith's avatar
Sujith committed
845
846
847
 *
 * @IEEE80211_HW_AMPDU_AGGREGATION:
 *	Hardware supports 11n A-MPDU aggregation.
848
849
850
851
 */
enum ieee80211_hw_flags {
	IEEE80211_HW_RX_INCLUDES_FCS			= 1<<1,
	IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING	= 1<<2,
852
853
	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE		= 1<<3,
	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE	= 1<<4,
854
855
856
857
	IEEE80211_HW_SIGNAL_UNSPEC			= 1<<5,
	IEEE80211_HW_SIGNAL_DB				= 1<<6,
	IEEE80211_HW_SIGNAL_DBM				= 1<<7,
	IEEE80211_HW_NOISE_DBM				= 1<<8,
858
	IEEE80211_HW_SPECTRUM_MGMT			= 1<<9,
Sujith's avatar
Sujith committed
859
	IEEE80211_HW_AMPDU_AGGREGATION			= 1<<10,
860
861
};

862
863
/**
 * struct ieee80211_hw - hardware information and state
864
865
866
867
868
869
870
 *
 * This structure contains the configuration and hardware
 * information for an 802.11 PHY.
 *
 * @wiphy: This points to the &struct wiphy allocated for this
 *	802.11 PHY. You must fill in the @perm_addr and @dev
 *	members of this structure using SET_IEEE80211_DEV()
871
872
 *	and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
 *	bands (with channels, bitrates) are registered here.
873
874
875
876
 *
 * @conf: &struct ieee80211_conf, device configuration, don't use.
 *
 * @workqueue: single threaded workqueue available for driver use,
877
878
879
880
881
 *	allocated by mac80211 on registration and flushed when an
 *	interface is removed.
 *	NOTICE: All work performed on this workqueue should NEVER
 *	acquire the RTNL lock (i.e. Don't use the function
 *	ieee80211_iterate_active_interfaces())
882
883
884
885
886
887
888
889
890
891
892
 *
 * @priv: pointer to private area that was allocated for driver use
 *	along with this structure.
 *
 * @flags: hardware flags, see &enum ieee80211_hw_flags.
 *
 * @extra_tx_headroom: headroom to reserve in each transmit skb
 *	for use by the driver (e.g. for transmit headers.)
 *
 * @channel_change_time: time (in microseconds) it takes to change channels.
 *
893
894
 * @max_signal: Maximum value for signal (rssi) in RX information, used
 *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
895
 *
896
897
898
 * @max_listen_interval: max listen interval in units of beacon interval
 *     that HW supports
 *
899
 * @queues: number of available hardware transmit queues for
Johannes Berg's avatar
Johannes Berg committed
900
901
902
903
904
905
906
907
 *	data packets. WMM/QoS requires at least four, these
 *	queues need to have configurable access parameters.
 *
 * @ampdu_queues: number of available hardware transmit queues
 *	for A-MPDU packets, these have no access parameters
 *	because they're used only for A-MPDU frames. Note that
 *	mac80211 will not currently use any of the regular queues
 *	for aggregation.
908
909
910
911
 *
 * @rate_control_algorithm: rate control algorithm for this hardware.
 *	If unset (NULL), the default algorithm will be used. Must be
 *	set before calling ieee80211_register_hw().
912
913
914
 *
 * @vif_data_size: size (in bytes) of the drv_priv data area
 *	within &struct ieee80211_vif.
915
916
 * @sta_data_size: size (in bytes) of the drv_priv data area
 *	within &struct ieee80211_sta.
917
 *
918
919
 * @max_rates: maximum number of alternate rate retry stages
 * @max_rate_tries: maximum number of tries for each stage
920
 */
921
922
struct ieee80211_hw {
	struct ieee80211_conf conf;
923
	struct wiphy *wiphy;
924
	struct workqueue_struct *workqueue;
925
	const char *rate_control_algorithm;
926
	void *priv;
927
	u32 flags;
928
929
	unsigned int extra_tx_headroom;
	int channel_change_time;
930
	int vif_data_size;
931
	int sta_data_size;
932
933
934
	u16 queues;
	u16 ampdu_queues;
	u16 max_listen_interval;
935
	s8 max_signal;
936
937
	u8 max_rates;
	u8 max_rate_tries;
938
939
};

940
941
942
943
944
945
/**
 * SET_IEEE80211_DEV - set device for 802.11 hardware
 *
 * @hw: the &struct ieee80211_hw to set the device for
 * @dev: the &struct device of this 802.11 device
 */
946
947
948
949
950
static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
{
	set_wiphy_dev(hw->wiphy, dev);
}

951
/**
952
 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
953
954
955
956
 *
 * @hw: the &struct ieee80211_hw to set the MAC address for
 * @addr: the address to set
 */
957
958
959
960
961
static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
{
	memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
}

962
963
964
965
966
967
968
969
970
971
static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
{
	return hw->queues;
}

static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
{
	return hw->queues + hw->ampdu_queues;
}

972
973
static inline struct ieee80211_rate *
ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
974
		      const struct ieee80211_tx_info *c)
975
{
976
	if (WARN_ON(c->control.rates[0].idx < 0))
977
		return NULL;
978
	return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
979
980
981
982
}

static inline struct ieee80211_rate *
ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
983
			   const struct ieee80211_tx_info *c)
984
{
985
	if (c->control.rts_cts_rate_idx < 0)
986
		return NULL;
987
	return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
988
989
990
991
}

static inline struct ieee80211_rate *
ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
992
			     const struct ieee80211_tx_info *c, int idx)
993
{
994
	if (c->control.rates[idx + 1].idx < 0)
995
		return NULL;
996
	return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
997
998
}

999
1000
/**
 * DOC: Hardware crypto acceleration
For faster browsing, not all history is shown. View entire blame