mac80211.h revision 1bc0826c8f5f3fa26644a8e878aae0be304a670f
1/*
2 * mac80211 <-> driver interface
3 *
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007	Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007	Johannes Berg <johannes@sipsolutions.net>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/kernel.h>
17#include <linux/if_ether.h>
18#include <linux/skbuff.h>
19#include <linux/wireless.h>
20#include <linux/device.h>
21#include <linux/ieee80211.h>
22#include <net/wireless.h>
23#include <net/cfg80211.h>
24
25/* Note! Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
26 * called in hardware interrupt context. The low-level driver must not call any
27 * other functions in hardware interrupt context. If there is a need for such
28 * call, the low-level driver should first ACK the interrupt and perform the
29 * IEEE 802.11 code call after this, e.g., from a scheduled tasklet (in
30 * software interrupt context).
31 */
32
33/*
34 * Frame format used when passing frame between low-level hardware drivers
35 * and IEEE 802.11 driver the same as used in the wireless media, i.e.,
36 * buffers start with IEEE 802.11 header and include the same octets that
37 * are sent over air.
38 *
39 * If hardware uses IEEE 802.3 headers (and perform 802.3 <-> 802.11
40 * conversion in firmware), upper layer 802.11 code needs to be changed to
41 * support this.
42 *
43 * If the receive frame format is not the same as the real frame sent
44 * on the wireless media (e.g., due to padding etc.), upper layer 802.11 code
45 * could be updated to provide support for such format assuming this would
46 * optimize the performance, e.g., by removing need to re-allocation and
47 * copying of the data.
48 */
49
50#define IEEE80211_CHAN_W_SCAN 0x00000001
51#define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002
52#define IEEE80211_CHAN_W_IBSS 0x00000004
53
54/* Channel information structure. Low-level driver is expected to fill in chan,
55 * freq, and val fields. Other fields will be filled in by 80211.o based on
56 * hostapd information and low-level driver does not need to use them. The
57 * limits for each channel will be provided in 'struct ieee80211_conf' when
58 * configuring the low-level driver with hw->config callback. If a device has
59 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED
60 * can be set to let the driver configure all fields */
61struct ieee80211_channel {
62	short chan; /* channel number (IEEE 802.11) */
63	short freq; /* frequency in MHz */
64	int val; /* hw specific value for the channel */
65	int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */
66	unsigned char power_level;
67	unsigned char antenna_max;
68};
69
70#define IEEE80211_RATE_ERP 0x00000001
71#define IEEE80211_RATE_BASIC 0x00000002
72#define IEEE80211_RATE_PREAMBLE2 0x00000004
73#define IEEE80211_RATE_SUPPORTED 0x00000010
74#define IEEE80211_RATE_OFDM 0x00000020
75#define IEEE80211_RATE_CCK 0x00000040
76#define IEEE80211_RATE_MANDATORY 0x00000100
77
78#define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
79#define IEEE80211_RATE_MODULATION(f) \
80	(f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
81
82/* Low-level driver should set PREAMBLE2, OFDM and CCK flags.
83 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
84 * configuration. */
85struct ieee80211_rate {
86	int rate; /* rate in 100 kbps */
87	int val; /* hw specific value for the rate */
88	int flags; /* IEEE80211_RATE_ flags */
89	int val2; /* hw specific value for the rate when using short preamble
90		   * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for
91		   * 2, 5.5, and 11 Mbps) */
92	signed char min_rssi_ack;
93	unsigned char min_rssi_ack_delta;
94
95	/* following fields are set by 80211.o and need not be filled by the
96	 * low-level driver */
97	int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for
98		       * optimizing channel utilization estimates */
99};
100
101/**
102 * enum ieee80211_phymode - PHY modes
103 *
104 * @MODE_IEEE80211A: 5GHz as defined by 802.11a/802.11h
105 * @MODE_IEEE80211B: 2.4 GHz as defined by 802.11b
106 * @MODE_IEEE80211G: 2.4 GHz as defined by 802.11g (with OFDM),
107 *	backwards compatible with 11b mode
108 * @NUM_IEEE80211_MODES: internal
109 */
110enum ieee80211_phymode {
111	MODE_IEEE80211A,
112	MODE_IEEE80211B,
113	MODE_IEEE80211G,
114
115	/* keep last */
116	NUM_IEEE80211_MODES
117};
118
119/**
120 * struct ieee80211_hw_mode - PHY mode definition
121 *
122 * This structure describes the capabilities supported by the device
123 * in a single PHY mode.
124 *
125 * @mode: the PHY mode for this definition
126 * @num_channels: number of supported channels
127 * @channels: pointer to array of supported channels
128 * @num_rates: number of supported bitrates
129 * @rates: pointer to array of supported bitrates
130 * @list: internal
131 */
132struct ieee80211_hw_mode {
133	struct list_head list;
134	struct ieee80211_channel *channels;
135	struct ieee80211_rate *rates;
136	enum ieee80211_phymode mode;
137	int num_channels;
138	int num_rates;
139};
140
141/**
142 * struct ieee80211_tx_queue_params - transmit queue configuration
143 *
144 * The information provided in this structure is required for QoS
145 * transmit queue configuration.
146 *
147 * @aifs: arbitration interface space [0..255, -1: use default]
148 * @cw_min: minimum contention window [will be a value of the form
149 *	2^n-1 in the range 1..1023; 0: use default]
150 * @cw_max: maximum contention window [like @cw_min]
151 * @burst_time: maximum burst time in units of 0.1ms, 0 meaning disabled
152 */
153struct ieee80211_tx_queue_params {
154	int aifs;
155	int cw_min;
156	int cw_max;
157	int burst_time;
158};
159
160/**
161 * struct ieee80211_tx_queue_stats_data - transmit queue statistics
162 *
163 * @len: number of packets in queue
164 * @limit: queue length limit
165 * @count: number of frames sent
166 */
167struct ieee80211_tx_queue_stats_data {
168	unsigned int len;
169	unsigned int limit;
170	unsigned int count;
171};
172
173/**
174 * enum ieee80211_tx_queue - transmit queue number
175 *
176 * These constants are used with some callbacks that take a
177 * queue number to set parameters for a queue.
178 *
179 * @IEEE80211_TX_QUEUE_DATA0: data queue 0
180 * @IEEE80211_TX_QUEUE_DATA1: data queue 1
181 * @IEEE80211_TX_QUEUE_DATA2: data queue 2
182 * @IEEE80211_TX_QUEUE_DATA3: data queue 3
183 * @IEEE80211_TX_QUEUE_DATA4: data queue 4
184 * @IEEE80211_TX_QUEUE_SVP: ??
185 * @NUM_TX_DATA_QUEUES: number of data queues
186 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
187 *	sent after a beacon
188 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
189 */
190enum ieee80211_tx_queue {
191	IEEE80211_TX_QUEUE_DATA0,
192	IEEE80211_TX_QUEUE_DATA1,
193	IEEE80211_TX_QUEUE_DATA2,
194	IEEE80211_TX_QUEUE_DATA3,
195	IEEE80211_TX_QUEUE_DATA4,
196	IEEE80211_TX_QUEUE_SVP,
197
198	NUM_TX_DATA_QUEUES,
199
200/* due to stupidity in the sub-ioctl userspace interface, the items in
201 * this struct need to have fixed values. As soon as it is removed, we can
202 * fix these entries. */
203	IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
204	IEEE80211_TX_QUEUE_BEACON = 7
205};
206
207struct ieee80211_tx_queue_stats {
208	struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES];
209};
210
211struct ieee80211_low_level_stats {
212	unsigned int dot11ACKFailureCount;
213	unsigned int dot11RTSFailureCount;
214	unsigned int dot11FCSErrorCount;
215	unsigned int dot11RTSSuccessCount;
216};
217
218/* Transmit control fields. This data structure is passed to low-level driver
219 * with each TX frame. The low-level driver is responsible for configuring
220 * the hardware to use given values (depending on what is supported). */
221
222struct ieee80211_tx_control {
223	int tx_rate; /* Transmit rate, given as the hw specific value for the
224		      * rate (from struct ieee80211_rate) */
225	int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
226			   * specific value for the rate (from
227			   * struct ieee80211_rate) */
228
229#define IEEE80211_TXCTL_REQ_TX_STATUS	(1<<0)/* request TX status callback for
230						* this frame */
231#define IEEE80211_TXCTL_DO_NOT_ENCRYPT	(1<<1) /* send this frame without
232						* encryption; e.g., for EAPOL
233						* frames */
234#define IEEE80211_TXCTL_USE_RTS_CTS	(1<<2) /* use RTS-CTS before sending
235						* frame */
236#define IEEE80211_TXCTL_USE_CTS_PROTECT	(1<<3) /* use CTS protection for the
237						* frame (e.g., for combined
238						* 802.11g / 802.11b networks) */
239#define IEEE80211_TXCTL_NO_ACK		(1<<4) /* tell the low level not to
240						* wait for an ack */
241#define IEEE80211_TXCTL_RATE_CTRL_PROBE	(1<<5)
242#define IEEE80211_TXCTL_CLEAR_DST_MASK	(1<<6)
243#define IEEE80211_TXCTL_REQUEUE		(1<<7)
244#define IEEE80211_TXCTL_FIRST_FRAGMENT	(1<<8) /* this is a first fragment of
245						* the frame */
246#define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
247						  * using the through
248						  * set_retry_limit configured
249						  * long retry value */
250	u32 flags;			       /* tx control flags defined
251						* above */
252	u8 key_idx;		/* keyidx from hw->set_key(), undefined if
253				 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
254	u8 retry_limit;		/* 1 = only first attempt, 2 = one retry, ..
255				 * This could be used when set_retry_limit
256				 * is not implemented by the driver */
257	u8 power_level;		/* per-packet transmit power level, in dBm */
258	u8 antenna_sel_tx; 	/* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
259	u8 icv_len;		/* length of the ICV/MIC field in octets */
260	u8 iv_len;		/* length of the IV field in octets */
261	u8 queue;		/* hardware queue to use for this frame;
262				 * 0 = highest, hw->queues-1 = lowest */
263	struct ieee80211_rate *rate;		/* internal 80211.o rate */
264	struct ieee80211_rate *rts_rate;	/* internal 80211.o rate
265						 * for RTS/CTS */
266	int alt_retry_rate; /* retry rate for the last retries, given as the
267			     * hw specific value for the rate (from
268			     * struct ieee80211_rate). To be used to limit
269			     * packet dropping when probing higher rates, if hw
270			     * supports multiple retry rates. -1 = not used */
271	int type;	/* internal */
272	int ifindex;	/* internal */
273};
274
275
276/**
277 * enum mac80211_rx_flags - receive flags
278 *
279 * These flags are used with the @flag member of &struct ieee80211_rx_status.
280 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
281 *	Use together with %RX_FLAG_MMIC_STRIPPED.
282 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
283 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
284 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
285 *	verification has been done by the hardware.
286 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
287 *	If this flag is set, the stack cannot do any replay detection
288 *	hence the driver or hardware will have to do that.
289 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
290 *	the frame.
291 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
292 *	the frame.
293 */
294enum mac80211_rx_flags {
295	RX_FLAG_MMIC_ERROR	= 1<<0,
296	RX_FLAG_DECRYPTED	= 1<<1,
297	RX_FLAG_RADIOTAP	= 1<<2,
298	RX_FLAG_MMIC_STRIPPED	= 1<<3,
299	RX_FLAG_IV_STRIPPED	= 1<<4,
300	RX_FLAG_FAILED_FCS_CRC	= 1<<5,
301	RX_FLAG_FAILED_PLCP_CRC = 1<<6,
302};
303
304/**
305 * struct ieee80211_rx_status - receive status
306 *
307 * The low-level driver should provide this information (the subset
308 * supported by hardware) to the 802.11 code with each received
309 * frame.
310 * @mactime: MAC timestamp as defined by 802.11
311 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
312 * @channel: channel the radio was tuned to
313 * @phymode: active PHY mode
314 * @ssi: signal strength when receiving this frame
315 * @signal: used as 'qual' in statistics reporting
316 * @noise: PHY noise when receiving this frame
317 * @antenna: antenna used
318 * @rate: data rate
319 * @flag: %RX_FLAG_*
320 */
321struct ieee80211_rx_status {
322	u64 mactime;
323	int freq;
324	int channel;
325	enum ieee80211_phymode phymode;
326	int ssi;
327	int signal;
328	int noise;
329	int antenna;
330	int rate;
331	int flag;
332};
333
334/**
335 * enum ieee80211_tx_status_flags - transmit status flags
336 *
337 * Status flags to indicate various transmit conditions.
338 *
339 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
340 *	because the destination STA was in powersave mode.
341 *
342 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
343 */
344enum ieee80211_tx_status_flags {
345	IEEE80211_TX_STATUS_TX_FILTERED	= 1<<0,
346	IEEE80211_TX_STATUS_ACK		= 1<<1,
347};
348
349/**
350 * struct ieee80211_tx_status - transmit status
351 *
352 * As much information as possible should be provided for each transmitted
353 * frame with ieee80211_tx_status().
354 *
355 * @control: a copy of the &struct ieee80211_tx_control passed to the driver
356 *	in the tx() callback.
357 *
358 * @flags: transmit status flags, defined above
359 *
360 * @ack_signal: signal strength of the ACK frame
361 *
362 * @excessive_retries: set to 1 if the frame was retried many times
363 *	but not acknowledged
364 *
365 * @retry_count: number of retries
366 *
367 * @queue_length: ?? REMOVE
368 * @queue_number: ?? REMOVE
369 */
370struct ieee80211_tx_status {
371	struct ieee80211_tx_control control;
372	u8 flags;
373	bool excessive_retries;
374	u8 retry_count;
375	int ack_signal;
376	int queue_length;
377	int queue_number;
378};
379
380/**
381 * enum ieee80211_conf_flags - configuration flags
382 *
383 * Flags to define PHY configuration options
384 *
385 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
386 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
387 *
388 */
389enum ieee80211_conf_flags {
390	IEEE80211_CONF_SHORT_SLOT_TIME	= 1<<0,
391	IEEE80211_CONF_RADIOTAP		= 1<<1,
392};
393
394/**
395 * struct ieee80211_conf - configuration of the device
396 *
397 * This struct indicates how the driver shall configure the hardware.
398 *
399 * @radio_enabled: when zero, driver is required to switch off the radio.
400 *	TODO make a flag
401 * @channel: IEEE 802.11 channel number
402 * @freq: frequency in MHz
403 * @channel_val: hardware specific channel value for the channel
404 * @phymode: PHY mode to activate (REMOVE)
405 * @chan: channel to switch to, pointer to the channel information
406 * @mode: pointer to mode definition
407 * @regulatory_domain: ??
408 * @beacon_int: beacon interval (TODO make interface config)
409 * @flags: configuration flags defined above
410 * @power_level: transmit power limit for current regulatory domain in dBm
411 * @antenna_max: maximum antenna gain
412 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
413 *	1/2: antenna 0/1
414 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
415 */
416struct ieee80211_conf {
417	int channel;			/* IEEE 802.11 channel number */
418	int freq;			/* MHz */
419	int channel_val;		/* hw specific value for the channel */
420
421	enum ieee80211_phymode phymode;
422	struct ieee80211_channel *chan;
423	struct ieee80211_hw_mode *mode;
424	unsigned int regulatory_domain;
425	int radio_enabled;
426
427	int beacon_int;
428	u32 flags;
429	u8 power_level;
430	u8 antenna_max;
431	u8 antenna_sel_tx;
432	u8 antenna_sel_rx;
433};
434
435/**
436 * enum ieee80211_if_types - types of 802.11 network interfaces
437 *
438 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
439 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
440 *	daemon. Drivers should never see this type.
441 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
442 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
443 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
444 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
445 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
446 *	will never see this type.
447 */
448enum ieee80211_if_types {
449	IEEE80211_IF_TYPE_AP,
450	IEEE80211_IF_TYPE_MGMT,
451	IEEE80211_IF_TYPE_STA,
452	IEEE80211_IF_TYPE_IBSS,
453	IEEE80211_IF_TYPE_MNTR,
454	IEEE80211_IF_TYPE_WDS,
455	IEEE80211_IF_TYPE_VLAN,
456};
457
458/**
459 * struct ieee80211_if_init_conf - initial configuration of an interface
460 *
461 * @if_id: internal interface ID. This number has no particular meaning to
462 *	drivers and the only allowed usage is to pass it to
463 *	ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions.
464 *	This field is not valid for monitor interfaces
465 *	(interfaces of %IEEE80211_IF_TYPE_MNTR type).
466 * @type: one of &enum ieee80211_if_types constants. Determines the type of
467 *	added/removed interface.
468 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
469 *	until the interface is removed (i.e. it cannot be used after
470 *	remove_interface() callback was called for this interface).
471 *
472 * This structure is used in add_interface() and remove_interface()
473 * callbacks of &struct ieee80211_hw.
474 *
475 * When you allow multiple interfaces to be added to your PHY, take care
476 * that the hardware can actually handle multiple MAC addresses. However,
477 * also take care that when there's no interface left with mac_addr != %NULL
478 * you remove the MAC address from the device to avoid acknowledging packets
479 * in pure monitor mode.
480 */
481struct ieee80211_if_init_conf {
482	int if_id;
483	int type;
484	void *mac_addr;
485};
486
487/**
488 * struct ieee80211_if_conf - configuration of an interface
489 *
490 * @type: type of the interface. This is always the same as was specified in
491 *	&struct ieee80211_if_init_conf. The type of an interface never changes
492 *	during the life of the interface; this field is present only for
493 *	convenience.
494 * @bssid: BSSID of the network we are associated to/creating.
495 * @ssid: used (together with @ssid_len) by drivers for hardware that
496 *	generate beacons independently. The pointer is valid only during the
497 *	config_interface() call, so copy the value somewhere if you need
498 *	it.
499 * @ssid_len: length of the @ssid field.
500 * @generic_elem: used (together with @generic_elem_len) by drivers for
501 *	hardware that generate beacons independently. The pointer is valid
502 *	only during the config_interface() call, so copy the value somewhere
503 *	if you need it.
504 * @generic_elem_len: length of the generic element.
505 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
506 *	&struct ieee80211_hw is set. The driver is responsible of freeing
507 *	the sk_buff.
508 * @beacon_control: tx_control for the beacon template, this field is only
509 *	valid when the @beacon field was set.
510 *
511 * This structure is passed to the config_interface() callback of
512 * &struct ieee80211_hw.
513 */
514struct ieee80211_if_conf {
515	int type;
516	u8 *bssid;
517	u8 *ssid;
518	size_t ssid_len;
519	u8 *generic_elem;
520	size_t generic_elem_len;
521	struct sk_buff *beacon;
522	struct ieee80211_tx_control *beacon_control;
523};
524
525/**
526 * enum ieee80211_key_alg - key algorithm
527 * @ALG_NONE: Unset key algorithm, will never be passed to the driver
528 * @ALG_WEP: WEP40 or WEP104
529 * @ALG_TKIP: TKIP
530 * @ALG_CCMP: CCMP (AES)
531 */
532typedef enum ieee80211_key_alg {
533	ALG_NONE,
534	ALG_WEP,
535	ALG_TKIP,
536	ALG_CCMP,
537} ieee80211_key_alg;
538
539
540/**
541 * enum ieee80211_key_flags - key flags
542 *
543 * These flags are used for communication about keys between the driver
544 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
545 *
546 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
547 *	that the STA this key will be used with could be using QoS.
548 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
549 *	driver to indicate that it requires IV generation for this
550 *	particular key.
551 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
552 *	the driver for a TKIP key if it requires Michael MIC
553 *	generation in software.
554 */
555enum ieee80211_key_flags {
556	IEEE80211_KEY_FLAG_WMM_STA	= 1<<0,
557	IEEE80211_KEY_FLAG_GENERATE_IV	= 1<<1,
558	IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
559};
560
561/**
562 * struct ieee80211_key_conf - key information
563 *
564 * This key information is given by mac80211 to the driver by
565 * the set_key() callback in &struct ieee80211_ops.
566 *
567 * @hw_key_idx: To be set by the driver, this is the key index the driver
568 *	wants to be given when a frame is transmitted and needs to be
569 *	encrypted in hardware.
570 * @alg: The key algorithm.
571 * @flags: key flags, see &enum ieee80211_key_flags.
572 * @keyidx: the key index (0-3)
573 * @keylen: key material length
574 * @key: key material
575 */
576struct ieee80211_key_conf {
577	ieee80211_key_alg alg;
578	u8 hw_key_idx;
579	u8 flags;
580	s8 keyidx;
581	u8 keylen;
582	u8 key[0];
583};
584
585#define IEEE80211_SEQ_COUNTER_RX	0
586#define IEEE80211_SEQ_COUNTER_TX	1
587
588/**
589 * enum set_key_cmd - key command
590 *
591 * Used with the set_key() callback in &struct ieee80211_ops, this
592 * indicates whether a key is being removed or added.
593 *
594 * @SET_KEY: a key is set
595 * @DISABLE_KEY: a key must be disabled
596 */
597typedef enum set_key_cmd {
598	SET_KEY, DISABLE_KEY,
599} set_key_cmd;
600
601
602/**
603 * enum ieee80211_hw_flags - hardware flags
604 *
605 * These flags are used to indicate hardware capabilities to
606 * the stack. Generally, flags here should have their meaning
607 * done in a way that the simplest hardware doesn't need setting
608 * any particular flags. There are some exceptions to this rule,
609 * however, so you are advised to review these flags carefully.
610 *
611 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
612 *	The device only needs to be supplied with a beacon template.
613 *	If you need the host to generate each beacon then don't use
614 *	this flag and call ieee80211_beacon_get() when you need the
615 *	next beacon frame. Note that if you set this flag, you must
616 *	implement the set_tim() callback for powersave mode to work
617 *	properly.
618 *	This flag is only relevant for access-point mode.
619 *
620 * @IEEE80211_HW_RX_INCLUDES_FCS:
621 *	Indicates that received frames passed to the stack include
622 *	the FCS at the end.
623 *
624 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
625 *	Some wireless LAN chipsets buffer broadcast/multicast frames
626 *	for power saving stations in the hardware/firmware and others
627 *	rely on the host system for such buffering. This option is used
628 *	to configure the IEEE 802.11 upper layer to buffer broadcast and
629 *	multicast frames when there are power saving stations so that
630 *	the driver can fetch them with ieee80211_get_buffered_bc(). Note
631 *	that not setting this flag works properly only when the
632 *	%IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
633 *	otherwise the stack will not know when the DTIM beacon was sent.
634 *
635 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED:
636 *	Channels are already configured to the default regulatory domain
637 *	specified in the device's EEPROM
638 */
639enum ieee80211_hw_flags {
640	IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE		= 1<<0,
641	IEEE80211_HW_RX_INCLUDES_FCS			= 1<<1,
642	IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING	= 1<<2,
643	IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED	= 1<<3,
644};
645
646/**
647 * struct ieee80211_hw - hardware information and state
648 * TODO: move documentation into kernel-doc format
649 */
650struct ieee80211_hw {
651	/* points to the cfg80211 wiphy for this piece. Note
652	 * that you must fill in the perm_addr and dev fields
653	 * of this structure, use the macros provided below. */
654	struct wiphy *wiphy;
655
656	/* assigned by mac80211, don't write */
657	struct ieee80211_conf conf;
658
659	/* Single thread workqueue available for driver use
660	 * Allocated by mac80211 on registration */
661	struct workqueue_struct *workqueue;
662
663	/* Pointer to the private area that was
664	 * allocated with this struct for you. */
665	void *priv;
666
667	/* The rest is information about your hardware */
668
669	u32 flags;			/* hardware flags defined above */
670
671	/* Set to the size of a needed device specific skb headroom for TX skbs. */
672	unsigned int extra_tx_headroom;
673
674	/* This is the time in us to change channels
675	 */
676	int channel_change_time;
677	/* Maximum values for various statistics.
678	 * Leave at 0 to indicate no support. Use negative numbers for dBm. */
679	s8 max_rssi;
680	s8 max_signal;
681	s8 max_noise;
682
683	/* Number of available hardware TX queues for data packets.
684	 * WMM requires at least four queues. */
685	int queues;
686};
687
688static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
689{
690	set_wiphy_dev(hw->wiphy, dev);
691}
692
693static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
694{
695	memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
696}
697
698/*
699 * flags for change_filter_flags()
700 *
701 * Note that e.g. if PROMISC_IN_BSS is unset then
702 * you should still do MAC address filtering if
703 * possible even if OTHER_BSS is set to indicate
704 * no BSSID filtering should be done.
705 */
706/*
707 * promiscuous mode within your BSS,
708 * think of the BSS as your network segment and then this corresponds
709 * to the regular ethernet device promiscuous mode
710 */
711#define FIF_PROMISC_IN_BSS	0x01
712/* show all multicast frames */
713#define FIF_ALLMULTI		0x02
714/* show frames with failed FCS, but set RX_FLAG_FAILED_FCS_CRC for them */
715#define FIF_FCSFAIL		0x04
716/* show frames with failed PLCP CRC, but set RX_FLAG_FAILED_PLCP_CRC for them */
717#define FIF_PLCPFAIL		0x08
718/*
719 * This flag is set during scanning to indicate to the hardware
720 * that it should not filter beacons or probe responses by BSSID.
721 */
722#define FIF_BCN_PRBRESP_PROMISC	0x10
723/*
724 * show control frames, if PROMISC_IN_BSS is not set then
725 * only those addressed to this station
726 */
727#define FIF_CONTROL		0x20
728/* show frames from other BSSes */
729#define FIF_OTHER_BSS		0x40
730
731/* Configuration block used by the low-level driver to tell the 802.11 code
732 * about supported hardware features and to pass function pointers to callback
733 * functions. */
734struct ieee80211_ops {
735	/* Handler that 802.11 module calls for each transmitted frame.
736	 * skb contains the buffer starting from the IEEE 802.11 header.
737	 * The low-level driver should send the frame out based on
738	 * configuration in the TX control data.
739	 * Must be atomic. */
740	int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
741		  struct ieee80211_tx_control *control);
742
743	/*
744	 * Called before the first netdevice attached to the hardware
745	 * is enabled. This should turn on the hardware and must turn on
746	 * frame reception (for possibly enabled monitor interfaces.)
747	 * Returns negative error codes, these may be seen in userspace,
748	 * or zero.
749	 * When the device is started it should not have a MAC address
750	 * to avoid acknowledging frames before a non-monitor device
751	 * is added.
752	 *
753	 * Must be implemented.
754	 */
755	int (*start)(struct ieee80211_hw *hw);
756
757	/*
758	 * Called after last netdevice attached to the hardware
759	 * is disabled. This should turn off the hardware (at least
760	 * it must turn off frame reception.)
761	 * May be called right after add_interface if that rejects
762	 * an interface.
763	 *
764	 * Must be implemented.
765	 */
766	void (*stop)(struct ieee80211_hw *hw);
767
768	/*
769	 * Called when a netdevice attached to the hardware is enabled.
770	 * Because it is not called for monitor mode devices, open()
771	 * and stop() must be implemented.
772	 * The driver should perform any initialization it needs before
773	 * the device can be enabled. The initial configuration for the
774	 * interface is given in the conf parameter.
775	 *
776	 * Must be implemented.
777	 */
778	int (*add_interface)(struct ieee80211_hw *hw,
779			     struct ieee80211_if_init_conf *conf);
780
781	/*
782	 * Notifies a driver that an interface is going down. The stop() handler
783	 * is called after this if it is the last interface and no monitor
784	 * interfaces are present.
785	 * When all interfaces are removed, the MAC address in the hardware
786	 * must be cleared so the device no longer acknowledges packets,
787	 * the mac_addr member of the conf structure is, however, set to the
788	 * MAC address of the device going away.
789	 *
790	 * Hence, this callback must be implemented.
791	 */
792	void (*remove_interface)(struct ieee80211_hw *hw,
793				 struct ieee80211_if_init_conf *conf);
794
795	/* Handler for configuration requests. IEEE 802.11 code calls this
796	 * function to change hardware configuration, e.g., channel. */
797	int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
798
799	/* Handler for configuration requests related to interfaces (e.g.
800	 * BSSID). */
801	int (*config_interface)(struct ieee80211_hw *hw,
802				int if_id, struct ieee80211_if_conf *conf);
803
804	/*
805	 * Configure the device's RX filter.
806	 *
807	 * The multicast address filter must be changed if the hardware flags
808	 * indicate that one is present.
809	 *
810	 * All unsupported flags in 'total_flags' must be cleared,
811	 * clear all bits except those you honoured.
812	 *
813	 * The callback must be implemented and must be atomic.
814	 */
815	void (*configure_filter)(struct ieee80211_hw *hw,
816				 unsigned int changed_flags,
817				 unsigned int *total_flags,
818				 int mc_count, struct dev_addr_list *mc_list);
819
820	/* Set TIM bit handler. If the hardware/firmware takes care of beacon
821	 * generation, IEEE 802.11 code uses this function to tell the
822	 * low-level to set (or clear if set==0) TIM bit for the given aid. If
823	 * host system is used to generate beacons, this handler is not used
824	 * and low-level driver should set it to NULL.
825	 * Must be atomic. */
826	int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
827
828	/*
829	 * Set encryption key.
830	 *
831	 * This is called to enable hardware acceleration of encryption and
832	 * decryption. The address will be the broadcast address for default
833	 * keys, the other station's hardware address for individual keys or
834	 * the zero address for keys that will be used only for transmission.
835	 *
836	 * The local_address parameter will always be set to our own address,
837	 * this is only relevant if you support multiple local addresses.
838	 *
839	 * When transmitting, the TX control data will use the hw_key_idx
840	 * selected by the low-level driver.
841	 *
842	 * Return 0 if the key is now in use, -EOPNOTSUPP or -ENOSPC if it
843	 * couldn't be added; if you return 0 then hw_key_idx must be assigned
844	 * to the hardware key index, you are free to use the full u8 range.
845	 *
846	 * When the cmd is DISABLE_KEY then it must succeed.
847	 *
848	 * Note that it is permissible to not decrypt a frame even if a key
849	 * for it has been uploaded to hardware, the stack will not make any
850	 * decision based on whether a key has been uploaded or not but rather
851	 * based on the receive flags.
852	 *
853	 * This callback can sleep, and is only called between add_interface
854	 * and remove_interface calls, i.e. while the interface with the
855	 * given local_address is enabled.
856	 *
857	 * The ieee80211_key_conf structure pointed to by the key parameter
858	 * is guaranteed to be valid until another call to set_key removes
859	 * it, but it can only be used as a cookie to differentiate keys.
860	 */
861	int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd,
862		       const u8 *local_address, const u8 *address,
863		       struct ieee80211_key_conf *key);
864
865	/* Enable/disable IEEE 802.1X. This item requests wlan card to pass
866	 * unencrypted EAPOL-Key frames even when encryption is configured.
867	 * If the wlan card does not require such a configuration, this
868	 * function pointer can be set to NULL. */
869	int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x);
870
871	/* Set port authorization state (IEEE 802.1X PAE) to be authorized
872	 * (authorized=1) or unauthorized (authorized=0). This function can be
873	 * used if the wlan hardware or low-level driver implements PAE.
874	 * 80211.o module will anyway filter frames based on authorization
875	 * state, so this function pointer can be NULL if low-level driver does
876	 * not require event notification about port state changes.
877	 * Currently unused. */
878	int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr,
879			     int authorized);
880
881	/* Ask the hardware to service the scan request, no need to start
882	 * the scan state machine in stack. */
883	int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
884
885	/* return low-level statistics */
886	int (*get_stats)(struct ieee80211_hw *hw,
887			 struct ieee80211_low_level_stats *stats);
888
889	/* For devices that generate their own beacons and probe response
890	 * or association responses this updates the state of privacy_invoked
891	 * returns 0 for success or an error number */
892	int (*set_privacy_invoked)(struct ieee80211_hw *hw,
893				   int privacy_invoked);
894
895	/* For devices that have internal sequence counters, allow 802.11
896	 * code to access the current value of a counter */
897	int (*get_sequence_counter)(struct ieee80211_hw *hw,
898				    u8* addr, u8 keyidx, u8 txrx,
899				    u32* iv32, u16* iv16);
900
901	/* Configuration of RTS threshold (if device needs it) */
902	int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
903
904	/* Configuration of fragmentation threshold.
905	 * Assign this if the device does fragmentation by itself,
906	 * if this method is assigned then the stack will not do
907	 * fragmentation. */
908	int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
909
910	/* Configuration of retry limits (if device needs it) */
911	int (*set_retry_limit)(struct ieee80211_hw *hw,
912			       u32 short_retry, u32 long_retr);
913
914	/* Number of STAs in STA table notification (NULL = disabled).
915	 * Must be atomic. */
916	void (*sta_table_notification)(struct ieee80211_hw *hw,
917				       int num_sta);
918
919	/* Handle ERP IE change notifications. Must be atomic. */
920	void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
921			       int cts_protection, int preamble);
922
923	/* Flags for the erp_ie_changed changes parameter */
924#define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */
925#define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */
926
927	/* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
928	 * bursting) for a hardware TX queue.
929	 * queue = IEEE80211_TX_QUEUE_*.
930	 * Must be atomic. */
931	int (*conf_tx)(struct ieee80211_hw *hw, int queue,
932		       const struct ieee80211_tx_queue_params *params);
933
934	/* Get statistics of the current TX queue status. This is used to get
935	 * number of currently queued packets (queue length), maximum queue
936	 * size (limit), and total number of packets sent using each TX queue
937	 * (count).
938	 * Currently unused. */
939	int (*get_tx_stats)(struct ieee80211_hw *hw,
940			    struct ieee80211_tx_queue_stats *stats);
941
942	/* Get the current TSF timer value from firmware/hardware. Currently,
943	 * this is only used for IBSS mode debugging and, as such, is not a
944	 * required function.
945	 * Must be atomic. */
946	u64 (*get_tsf)(struct ieee80211_hw *hw);
947
948	/* Reset the TSF timer and allow firmware/hardware to synchronize with
949	 * other STAs in the IBSS. This is only used in IBSS mode. This
950	 * function is optional if the firmware/hardware takes full care of
951	 * TSF synchronization. */
952	void (*reset_tsf)(struct ieee80211_hw *hw);
953
954	/* Setup beacon data for IBSS beacons. Unlike access point (Master),
955	 * IBSS uses a fixed beacon frame which is configured using this
956	 * function. This handler is required only for IBSS mode. */
957	int (*beacon_update)(struct ieee80211_hw *hw,
958			     struct sk_buff *skb,
959			     struct ieee80211_tx_control *control);
960
961	/* Determine whether the last IBSS beacon was sent by us. This is
962	 * needed only for IBSS mode and the result of this function is used to
963	 * determine whether to reply to Probe Requests. */
964	int (*tx_last_beacon)(struct ieee80211_hw *hw);
965};
966
967/* Allocate a new hardware device. This must be called once for each
968 * hardware device. The returned pointer must be used to refer to this
969 * device when calling other functions. 802.11 code allocates a private data
970 * area for the low-level driver. The size of this area is given as
971 * priv_data_len.
972 */
973struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
974					const struct ieee80211_ops *ops);
975
976/* Register hardware device to the IEEE 802.11 code and kernel. Low-level
977 * drivers must call this function before using any other IEEE 802.11
978 * function except ieee80211_register_hwmode. */
979int ieee80211_register_hw(struct ieee80211_hw *hw);
980
981/* driver can use this and ieee80211_get_rx_led_name to get the
982 * name of the registered LEDs after ieee80211_register_hw
983 * was called.
984 * This is useful to set the default trigger on the LED class
985 * device that your driver should export for each LED the device
986 * has, that way the default behaviour will be as expected but
987 * the user can still change it/turn off the LED etc.
988 */
989#ifdef CONFIG_MAC80211_LEDS
990extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
991extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
992#endif
993static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
994{
995#ifdef CONFIG_MAC80211_LEDS
996	return __ieee80211_get_tx_led_name(hw);
997#else
998	return NULL;
999#endif
1000}
1001
1002static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1003{
1004#ifdef CONFIG_MAC80211_LEDS
1005	return __ieee80211_get_rx_led_name(hw);
1006#else
1007	return NULL;
1008#endif
1009}
1010
1011/* Register a new hardware PHYMODE capability to the stack. */
1012int ieee80211_register_hwmode(struct ieee80211_hw *hw,
1013			      struct ieee80211_hw_mode *mode);
1014
1015/* Unregister a hardware device. This function instructs 802.11 code to free
1016 * allocated resources and unregister netdevices from the kernel. */
1017void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1018
1019/* Free everything that was allocated including private data of a driver. */
1020void ieee80211_free_hw(struct ieee80211_hw *hw);
1021
1022/* Receive frame callback function. The low-level driver uses this function to
1023 * send received frames to the IEEE 802.11 code. Receive buffer (skb) must
1024 * start with IEEE 802.11 header. */
1025void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1026		    struct ieee80211_rx_status *status);
1027void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1028			  struct sk_buff *skb,
1029			  struct ieee80211_rx_status *status);
1030
1031/* Transmit status callback function. The low-level driver must call this
1032 * function to report transmit status for all the TX frames that had
1033 * req_tx_status set in the transmit control fields. In addition, this should
1034 * be called at least for all unicast frames to provide information for TX rate
1035 * control algorithm. In order to maintain all statistics, this function is
1036 * recommended to be called after each frame, including multicast/broadcast, is
1037 * sent. */
1038void ieee80211_tx_status(struct ieee80211_hw *hw,
1039			 struct sk_buff *skb,
1040			 struct ieee80211_tx_status *status);
1041void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1042				 struct sk_buff *skb,
1043				 struct ieee80211_tx_status *status);
1044
1045/**
1046 * ieee80211_beacon_get - beacon generation function
1047 * @hw: pointer obtained from ieee80211_alloc_hw().
1048 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1049 * @control: will be filled with information needed to send this beacon.
1050 *
1051 * If the beacon frames are generated by the host system (i.e., not in
1052 * hardware/firmware), the low-level driver uses this function to receive
1053 * the next beacon frame from the 802.11 code. The low-level is responsible
1054 * for calling this function before beacon data is needed (e.g., based on
1055 * hardware interrupt). Returned skb is used only once and low-level driver
1056 * is responsible of freeing it.
1057 */
1058struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1059				     int if_id,
1060				     struct ieee80211_tx_control *control);
1061
1062/**
1063 * ieee80211_rts_get - RTS frame generation function
1064 * @hw: pointer obtained from ieee80211_alloc_hw().
1065 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1066 * @frame: pointer to the frame that is going to be protected by the RTS.
1067 * @frame_len: the frame length (in octets).
1068 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1069 * @rts: The buffer where to store the RTS frame.
1070 *
1071 * If the RTS frames are generated by the host system (i.e., not in
1072 * hardware/firmware), the low-level driver uses this function to receive
1073 * the next RTS frame from the 802.11 code. The low-level is responsible
1074 * for calling this function before and RTS frame is needed.
1075 */
1076void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id,
1077		       const void *frame, size_t frame_len,
1078		       const struct ieee80211_tx_control *frame_txctl,
1079		       struct ieee80211_rts *rts);
1080
1081/**
1082 * ieee80211_rts_duration - Get the duration field for an RTS frame
1083 * @hw: pointer obtained from ieee80211_alloc_hw().
1084 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1085 * @frame_len: the length of the frame that is going to be protected by the RTS.
1086 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1087 *
1088 * If the RTS is generated in firmware, but the host system must provide
1089 * the duration field, the low-level driver uses this function to receive
1090 * the duration field value in little-endian byteorder.
1091 */
1092__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id,
1093			      size_t frame_len,
1094			      const struct ieee80211_tx_control *frame_txctl);
1095
1096/**
1097 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1098 * @hw: pointer obtained from ieee80211_alloc_hw().
1099 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1100 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1101 * @frame_len: the frame length (in octets).
1102 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1103 * @cts: The buffer where to store the CTS-to-self frame.
1104 *
1105 * If the CTS-to-self frames are generated by the host system (i.e., not in
1106 * hardware/firmware), the low-level driver uses this function to receive
1107 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1108 * for calling this function before and CTS-to-self frame is needed.
1109 */
1110void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id,
1111			     const void *frame, size_t frame_len,
1112			     const struct ieee80211_tx_control *frame_txctl,
1113			     struct ieee80211_cts *cts);
1114
1115/**
1116 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1117 * @hw: pointer obtained from ieee80211_alloc_hw().
1118 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1119 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1120 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1121 *
1122 * If the CTS-to-self is generated in firmware, but the host system must provide
1123 * the duration field, the low-level driver uses this function to receive
1124 * the duration field value in little-endian byteorder.
1125 */
1126__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id,
1127				    size_t frame_len,
1128				    const struct ieee80211_tx_control *frame_txctl);
1129
1130/**
1131 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1132 * @hw: pointer obtained from ieee80211_alloc_hw().
1133 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1134 * @frame_len: the length of the frame.
1135 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
1136 *
1137 * Calculate the duration field of some generic frame, given its
1138 * length and transmission rate (in 100kbps).
1139 */
1140__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id,
1141					size_t frame_len,
1142					int rate);
1143
1144/**
1145 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1146 * @hw: pointer as obtained from ieee80211_alloc_hw().
1147 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1148 * @control: will be filled with information needed to send returned frame.
1149 *
1150 * Function for accessing buffered broadcast and multicast frames. If
1151 * hardware/firmware does not implement buffering of broadcast/multicast
1152 * frames when power saving is used, 802.11 code buffers them in the host
1153 * memory. The low-level driver uses this function to fetch next buffered
1154 * frame. In most cases, this is used when generating beacon frame. This
1155 * function returns a pointer to the next buffered skb or NULL if no more
1156 * buffered frames are available.
1157 *
1158 * Note: buffered frames are returned only after DTIM beacon frame was
1159 * generated with ieee80211_beacon_get() and the low-level driver must thus
1160 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1161 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1162 * does not need to check for DTIM beacons separately and should be able to
1163 * use common code for all beacons.
1164 */
1165struct sk_buff *
1166ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id,
1167			  struct ieee80211_tx_control *control);
1168
1169/* Given an sk_buff with a raw 802.11 header at the data pointer this function
1170 * returns the 802.11 header length in bytes (not including encryption
1171 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1172 * header the function returns 0.
1173 */
1174int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1175
1176/* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */
1177int ieee80211_get_hdrlen(u16 fc);
1178
1179/**
1180 * ieee80211_wake_queue - wake specific queue
1181 * @hw: pointer as obtained from ieee80211_alloc_hw().
1182 * @queue: queue number (counted from zero).
1183 *
1184 * Drivers should use this function instead of netif_wake_queue.
1185 */
1186void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1187
1188/**
1189 * ieee80211_stop_queue - stop specific queue
1190 * @hw: pointer as obtained from ieee80211_alloc_hw().
1191 * @queue: queue number (counted from zero).
1192 *
1193 * Drivers should use this function instead of netif_stop_queue.
1194 */
1195void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1196
1197/**
1198 * ieee80211_start_queues - start all queues
1199 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1200 *
1201 * Drivers should use this function instead of netif_start_queue.
1202 */
1203void ieee80211_start_queues(struct ieee80211_hw *hw);
1204
1205/**
1206 * ieee80211_stop_queues - stop all queues
1207 * @hw: pointer as obtained from ieee80211_alloc_hw().
1208 *
1209 * Drivers should use this function instead of netif_stop_queue.
1210 */
1211void ieee80211_stop_queues(struct ieee80211_hw *hw);
1212
1213/**
1214 * ieee80211_wake_queues - wake all queues
1215 * @hw: pointer as obtained from ieee80211_alloc_hw().
1216 *
1217 * Drivers should use this function instead of netif_wake_queue.
1218 */
1219void ieee80211_wake_queues(struct ieee80211_hw *hw);
1220
1221/* called by driver to notify scan status completed */
1222void ieee80211_scan_completed(struct ieee80211_hw *hw);
1223
1224/* return a pointer to the source address (SA) */
1225static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr)
1226{
1227	u8 *raw = (u8 *) hdr;
1228	u8 tofrom = (*(raw+1)) & 3; /* get the TODS and FROMDS bits */
1229
1230	switch (tofrom) {
1231		case 2:
1232			return hdr->addr3;
1233		case 3:
1234			return hdr->addr4;
1235	}
1236	return hdr->addr2;
1237}
1238
1239/* return a pointer to the destination address (DA) */
1240static inline u8 *ieee80211_get_DA(struct ieee80211_hdr *hdr)
1241{
1242	u8 *raw = (u8 *) hdr;
1243	u8 to_ds = (*(raw+1)) & 1; /* get the TODS bit */
1244
1245	if (to_ds)
1246		return hdr->addr3;
1247	return hdr->addr1;
1248}
1249
1250static inline int ieee80211_get_morefrag(struct ieee80211_hdr *hdr)
1251{
1252	return (le16_to_cpu(hdr->frame_control) &
1253		IEEE80211_FCTL_MOREFRAGS) != 0;
1254}
1255
1256#endif /* MAC80211_H */
1257