mac80211.h 69.7 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
	u8 pad[2];
345 346 347

	union {
		struct {
348 349 350 351 352 353 354 355 356 357
			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;
			};
358
			/* NB: vif can be NULL for injected frames */
359 360
			struct ieee80211_vif *vif;
			struct ieee80211_key_conf *hw_key;
361
			struct ieee80211_sta *sta;
362 363
		} control;
		struct {
364 365
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
			u8 ampdu_ack_len;
366 367
			u64 ampdu_ack_map;
			int ack_signal;
368
			/* 8 bytes free */
369
		} status;
370 371 372 373 374 375 376 377
		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 *)];
378
	};
379 380
};

381 382 383 384
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
{
	return (struct ieee80211_tx_info *)skb->cb;
}
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 420
/**
 * 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));
}

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

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

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

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

501 502 503 504 505 506 507
/* 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
508 509
struct ieee80211_ht_conf {
	bool enabled;
510 511 512
	int sec_chan_offset; /* 0 = HT40 disabled; -1 = HT40 enabled, secondary
			      * channel below primary; 1 = HT40 enabled,
			      * secondary channel above primary */
Johannes Berg's avatar
Johannes Berg committed
513 514
};

515 516 517 518 519 520 521 522 523 524
/**
 * 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
525
 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg's avatar
Johannes Berg committed
526
 * @IEEE80211_CONF_CHANGE_HT: HT configuration changed
527 528 529 530 531 532 533 534 535
 */
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),
536
	IEEE80211_CONF_CHANGE_RETRY_LIMITS	= BIT(7),
Johannes Berg's avatar
Johannes Berg committed
537
	IEEE80211_CONF_CHANGE_HT		= BIT(8),
538 539
};

540 541 542 543 544 545
/**
 * 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.
546
 * @beacon_int: beacon interval (TODO make interface config)
547
 * @listen_interval: listen interval in units of beacon interval
548
 * @flags: configuration flags defined above
549 550
 * @power_level: requested transmit power (in dBm)
 * @channel: the channel to tune to
Johannes Berg's avatar
Johannes Berg committed
551
 * @ht: the HT configuration for the device
552 553 554 555 556 557
 * @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
558 559 560
 */
struct ieee80211_conf {
	int beacon_int;
561
	u32 flags;
562
	int power_level;
563

564 565 566
	u16 listen_interval;
	bool radio_enabled;

567 568
	u8 long_frame_max_tx_count, short_frame_max_tx_count;

569
	struct ieee80211_channel *channel;
Johannes Berg's avatar
Johannes Berg committed
570
	struct ieee80211_ht_conf ht;
571 572
};

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

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

600 601 602
/**
 * struct ieee80211_if_init_conf - initial configuration of an interface
 *
603 604 605
 * @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().
606
 * @type: one of &enum nl80211_iftype constants. Determines the type of
607 608 609 610 611 612 613
 *	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.
614 615 616 617 618 619
 *
 * 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.
620 621
 */
struct ieee80211_if_init_conf {
622
	enum nl80211_iftype type;
623
	struct ieee80211_vif *vif;
624 625 626
	void *mac_addr;
};

627 628 629 630 631 632 633 634 635
/**
 * 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),
636
	IEEE80211_IFCC_BEACON	= BIT(1),
637 638
};

639 640 641
/**
 * struct ieee80211_if_conf - configuration of an interface
 *
642
 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
643 644 645 646 647 648
 * @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 {
649
	u32 changed;
650 651 652
	u8 *bssid;
};

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

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

/**
 * 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.
689 690
 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
 *	that the key is pairwise rather then a shared key.
691
 */
692 693 694 695
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,
696
	IEEE80211_KEY_FLAG_PAIRWISE	= 1<<3,
697
};
698

699 700 701 702 703 704 705 706
/**
 * 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
707
 *	encrypted in hardware.
708 709 710 711
 * @alg: The key algorithm.
 * @flags: key flags, see &enum ieee80211_key_flags.
 * @keyidx: the key index (0-3)
 * @keylen: key material length
712 713 714 715 716
 * @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
717 718
 * @icv_len: FIXME
 * @iv_len: FIXME
719
 */
720
struct ieee80211_key_conf {
721
	enum ieee80211_key_alg alg;
722 723
	u8 icv_len;
	u8 iv_len;
724
	u8 hw_key_idx;
725 726 727
	u8 flags;
	s8 keyidx;
	u8 keylen;
728 729 730
	u8 key[0];
};

731 732 733 734 735 736 737 738 739
/**
 * 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
 */
740
enum set_key_cmd {
741
	SET_KEY, DISABLE_KEY,
742
};
743

744 745 746 747 748 749 750 751 752 753 754 755
/**
 * 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
756
 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg's avatar
Johannes Berg committed
757
 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
758 759 760 761
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
 */
struct ieee80211_sta {
762
	u64 supp_rates[IEEE80211_NUM_BANDS];
763 764
	u8 addr[ETH_ALEN];
	u16 aid;
765
	struct ieee80211_sta_ht_cap ht_cap;
766 767 768 769 770

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

771 772 773 774
/**
 * enum sta_notify_cmd - sta notify command
 *
 * Used with the sta_notify() callback in &struct ieee80211_ops, this
775
 * indicates addition and removal of a station to station table.
776 777 778 779 780 781 782
 *
 * @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
};
783

784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
/**
 * 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,
};

799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
/**
 * 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
818
 *	the driver can fetch them with ieee80211_get_buffered_bc().
819
 *
820 821 822 823 824 825
 * @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.
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
 *
 * @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.
845 846 847 848
 *
 * @IEEE80211_HW_SPECTRUM_MGMT:
 * 	Hardware supports spectrum management defined in 802.11h
 * 	Measurement, Channel Switch, Quieting, TPC
Sujith's avatar
Sujith committed
849 850 851
 *
 * @IEEE80211_HW_AMPDU_AGGREGATION:
 *	Hardware supports 11n A-MPDU aggregation.
852 853 854 855
 */
enum ieee80211_hw_flags {
	IEEE80211_HW_RX_INCLUDES_FCS			= 1<<1,
	IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING	= 1<<2,
856 857
	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE		= 1<<3,
	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE	= 1<<4,
858 859 860 861
	IEEE80211_HW_SIGNAL_UNSPEC			= 1<<5,
	IEEE80211_HW_SIGNAL_DB				= 1<<6,
	IEEE80211_HW_SIGNAL_DBM				= 1<<7,
	IEEE80211_HW_NOISE_DBM				= 1<<8,
862
	IEEE80211_HW_SPECTRUM_MGMT			= 1<<9,
Sujith's avatar
Sujith committed
863
	IEEE80211_HW_AMPDU_AGGREGATION			= 1<<10,
864 865
};

866 867
/**
 * struct ieee80211_hw - hardware information and state
868 869 870 871 872 873 874
 *
 * 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()
875 876
 *	and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
 *	bands (with channels, bitrates) are registered here.
877 878 879 880
 *
 * @conf: &struct ieee80211_conf, device configuration, don't use.
 *
 * @workqueue: single threaded workqueue available for driver use,
881 882 883 884 885
 *	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())
886 887 888 889 890 891 892 893 894 895 896
 *
 * @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.
 *
897 898
 * @max_signal: Maximum value for signal (rssi) in RX information, used
 *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
899
 *
900 901 902
 * @max_listen_interval: max listen interval in units of beacon interval
 *     that HW supports
 *
903
 * @queues: number of available hardware transmit queues for
Johannes Berg's avatar
Johannes Berg committed
904 905 906 907 908 909 910 911
 *	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.
912 913 914 915
 *
 * @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().
916 917 918
 *
 * @vif_data_size: size (in bytes) of the drv_priv data area
 *	within &struct ieee80211_vif.
919 920
 * @sta_data_size: size (in bytes) of the drv_priv data area
 *	within &struct ieee80211_sta.
921
 *
922 923
 * @max_rates: maximum number of alternate rate retry stages
 * @max_rate_tries: maximum number of tries for each stage
924
 */
925 926
struct ieee80211_hw {
	struct ieee80211_conf conf;
927
	struct wiphy *wiphy;
928
	struct workqueue_struct *workqueue;
929
	const char *rate_control_algorithm;
930
	void *priv;
931
	u32 flags;
932 933
	unsigned int extra_tx_headroom;
	int channel_change_time;
934
	int vif_data_size;
935
	int sta_data_size;
936 937 938
	u16 queues;
	u16 ampdu_queues;
	u16 max_listen_interval;
939
	s8 max_signal;
940 941
	u8 max_rates;
	u8 max_rate_tries;
942 943
};

944 945 946 947 948 949
/**
 * 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
 */
950 951 952 953 954
static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
{
	set_wiphy_dev(hw->wiphy, dev);
}

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

966 967 968 969 970 971 972 973 974 975
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;
}

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

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

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

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
/**
 * DOC: Hardware crypto acceleration
 *
 * mac80211 is capable of taking advantage of many hardware
 * acceleration designs for encryption and decryption operations.
 *
 * The set_key() callback in the &struct ieee80211_ops for a given
 * device is called to enable hardware acceleration of encryption and
 * decryption. The callback takes an @address parameter that will be
 * the broadcast address for default keys, the other station's hardware
 * address for individual keys or the zero address for keys that will
 * be used only for transmission.
 * Multiple transmission keys with the same key index may be used when
 * VLANs are configured for an access point.
1017
 *
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
 * The @local_address parameter will always be set to our own address,
 * this is only relevant if you support multiple local addresses.
 *
 * When transmitting, the TX control data will use the @hw_key_idx
 * selected by the driver by modifying the &struct ieee80211_key_conf
 * pointed to by the @key parameter to the set_key() function.
 *
 * The set_key() call for the %SET_KEY command should return 0 if
 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
 * added; if you return 0 then hw_key_idx must be assigned to the
 * hardware key index, you are free to use the full u8 range.
 *
 * When the cmd is %DISABLE_KEY then it must succeed.
 *
 * Note that it is permissible to not decrypt a frame even if a key
 * for it has been uploaded to hardware, the stack will not make any
 * decision based on whether a key has been uploaded or not but rather
 * based on the receive flags.
 *
 * The &struct ieee80211_key_conf structure pointed to by the @key
 * parameter is guaranteed to be valid until another call to set_key()
 * removes it, but it can only be used as a cookie to differentiate
 * keys.
1041 1042 1043 1044 1045 1046 1047 1048
 *
 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
 * handler.
 * The update_tkip_key() call updates the driver with the new phase 1 key.
 * This happens everytime the iv16 wraps around (every 65536 packets). The
 * set_key() call will happen only once for each key (unless the AP did
 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1049
 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1050
 * handler is software decryption with wrap around of iv16.
1051
 */
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075

/**
 * DOC: Frame filtering
 *
 * mac80211 requires to see many management frames for proper
 * operation, and users may want to see many more frames when
 * in monitor mode. However, for best CPU usage and power consumption,
 * having as few frames as possible percolate through the stack is
 * desirable. Hence, the hardware should filter as much as possible.
 *
 * To achieve this, mac80211 uses filter flags (see below) to tell
 * the driver's configure_filter() function which frames should be
 * passed to mac80211 and which should be filtered out.
 *
 * The configure_filter() callback is invoked with the parameters
 * @mc_count and @mc_list for the combined multicast address list
 * of all virtual interfaces, @changed_flags telling which flags
 * were changed and @total_flags with the new flag states.
 *
 * If your device has no multicast address filters your driver will
 * need to check both the %FIF_ALLMULTI flag and the @mc_count
 * parameter to see whether multicast frames should be accepted
 * or dropped.
 *
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
 * All unsupported flags in @total_flags must be cleared.
 * Hardware does not support a flag if it is incapable of _passing_
 * the frame to the stack. Otherwise the driver must ignore
 * the flag, but not clear it.
 * You must _only_ clear the flag (announce no support for the
 * flag to mac80211) if you are not able to pass the packet type
 * to the stack (so the hardware always filters it).
 * So for example, you should clear @FIF_CONTROL, if your hardware
 * always filters control frames. If your hardware always passes
 * control frames to the kernel and is incapable of filtering them,
 * you do _not_ clear the @FIF_CONTROL flag.
 * This rule applies to all other FIF flags as well.
1088
 */
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121

/**
 * enum ieee80211_filter_flags - hardware filter flags
 *
 * These flags determine what the filter in hardware should be
 * programmed to let through and what should not be passed to the
 * stack. It is always safe to pass more frames than requested,
 * but this has negative impact on power consumption.
 *
 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
 *	think of the BSS as your network segment and then this corresponds
 *	to the regular ethernet device promiscuous mode.
 *
 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
 *	by the user or if the hardware is not capable of filtering by
 *	multicast address.
 *
 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
 *	%RX_FLAG_FAILED_FCS_CRC for them)
 *
 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
 *	the %RX_FLAG_FAILED_PLCP_CRC for them
 *
 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
 *	to the hardware that it should not filter beacons or probe responses
 *	by BSSID. Filtering them can greatly reduce the amount of processing
 *	mac80211 needs to do and the amount of CPU wakeups, so you should
 *	honour this flag if possible.
 *
 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
 *	only those addressed to this station
 *
 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1122
 */
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
enum ieee80211_filter_flags {
	FIF_PROMISC_IN_BSS	= 1<<0,
	FIF_ALLMULTI		= 1<<1,
	FIF_FCSFAIL		= 1<<2,
	FIF_PLCPFAIL		= 1<<3,
	FIF_BCN_PRBRESP_PROMISC	= 1<<4,
	FIF_CONTROL		= 1<<5,
	FIF_OTHER_BSS		= 1<<6,
};

1133 1134 1135