xref: /linux/include/net/mac80211.h (revision f7511d5f66f01fc451747b24e79f3ada7a3af9af)
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 /**
26  * DOC: Introduction
27  *
28  * mac80211 is the Linux stack for 802.11 hardware that implements
29  * only partial functionality in hard- or firmware. This document
30  * defines the interface between mac80211 and low-level hardware
31  * drivers.
32  */
33 
34 /**
35  * DOC: Calling mac80211 from interrupts
36  *
37  * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38  * called in hardware interrupt context. The low-level driver must not call any
39  * other functions in hardware interrupt context. If there is a need for such
40  * call, the low-level driver should first ACK the interrupt and perform the
41  * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
42  * tasklet function.
43  *
44  * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45  *	 use the non-irqsafe functions!
46  */
47 
48 /**
49  * DOC: Warning
50  *
51  * If you're reading this document and not the header file itself, it will
52  * be incomplete because not all documentation has been converted yet.
53  */
54 
55 /**
56  * DOC: Frame format
57  *
58  * As a general rule, when frames are passed between mac80211 and the driver,
59  * they start with the IEEE 802.11 header and include the same octets that are
60  * sent over the air except for the FCS which should be calculated by the
61  * hardware.
62  *
63  * There are, however, various exceptions to this rule for advanced features:
64  *
65  * The first exception is for hardware encryption and decryption offload
66  * where the IV/ICV may or may not be generated in hardware.
67  *
68  * Secondly, when the hardware handles fragmentation, the frame handed to
69  * the driver from mac80211 is the MSDU, not the MPDU.
70  *
71  * Finally, for received frames, the driver is able to indicate that it has
72  * filled a radiotap header and put that in front of the frame; if it does
73  * not do so then mac80211 may add this under certain circumstances.
74  */
75 
76 /**
77  * enum ieee80211_notification_type - Low level driver notification
78  * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
79  */
80 enum ieee80211_notification_types {
81 	IEEE80211_NOTIFY_RE_ASSOC,
82 };
83 
84 /**
85  * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
86  *
87  * This structure describes most essential parameters needed
88  * to describe 802.11n HT characteristics in a BSS
89  *
90  * @primary_channel: channel number of primery channel
91  * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
92  * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
93  */
94 struct ieee80211_ht_bss_info {
95 	u8 primary_channel;
96 	u8 bss_cap;  /* use IEEE80211_HT_IE_CHA_ */
97 	u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
98 };
99 
100 /**
101  * struct ieee80211_tx_queue_params - transmit queue configuration
102  *
103  * The information provided in this structure is required for QoS
104  * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
105  *
106  * @aifs: arbitration interface space [0..255, -1: use default]
107  * @cw_min: minimum contention window [will be a value of the form
108  *	2^n-1 in the range 1..1023; 0: use default]
109  * @cw_max: maximum contention window [like @cw_min]
110  * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
111  */
112 struct ieee80211_tx_queue_params {
113 	s16 aifs;
114 	u16 cw_min;
115 	u16 cw_max;
116 	u16 txop;
117 };
118 
119 /**
120  * struct ieee80211_tx_queue_stats_data - transmit queue statistics
121  *
122  * @len: number of packets in queue
123  * @limit: queue length limit
124  * @count: number of frames sent
125  */
126 struct ieee80211_tx_queue_stats_data {
127 	unsigned int len;
128 	unsigned int limit;
129 	unsigned int count;
130 };
131 
132 /**
133  * enum ieee80211_tx_queue - transmit queue number
134  *
135  * These constants are used with some callbacks that take a
136  * queue number to set parameters for a queue.
137  *
138  * @IEEE80211_TX_QUEUE_DATA0: data queue 0
139  * @IEEE80211_TX_QUEUE_DATA1: data queue 1
140  * @IEEE80211_TX_QUEUE_DATA2: data queue 2
141  * @IEEE80211_TX_QUEUE_DATA3: data queue 3
142  * @IEEE80211_TX_QUEUE_DATA4: data queue 4
143  * @IEEE80211_TX_QUEUE_SVP: ??
144  * @NUM_TX_DATA_QUEUES: number of data queues
145  * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
146  *	sent after a beacon
147  * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
148  * @NUM_TX_DATA_QUEUES_AMPDU: adding more queues for A-MPDU
149  */
150 enum ieee80211_tx_queue {
151 	IEEE80211_TX_QUEUE_DATA0,
152 	IEEE80211_TX_QUEUE_DATA1,
153 	IEEE80211_TX_QUEUE_DATA2,
154 	IEEE80211_TX_QUEUE_DATA3,
155 	IEEE80211_TX_QUEUE_DATA4,
156 	IEEE80211_TX_QUEUE_SVP,
157 
158 	NUM_TX_DATA_QUEUES,
159 
160 /* due to stupidity in the sub-ioctl userspace interface, the items in
161  * this struct need to have fixed values. As soon as it is removed, we can
162  * fix these entries. */
163 	IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
164 	IEEE80211_TX_QUEUE_BEACON = 7,
165 	NUM_TX_DATA_QUEUES_AMPDU = 16
166 };
167 
168 struct ieee80211_tx_queue_stats {
169 	struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES_AMPDU];
170 };
171 
172 struct ieee80211_low_level_stats {
173 	unsigned int dot11ACKFailureCount;
174 	unsigned int dot11RTSFailureCount;
175 	unsigned int dot11FCSErrorCount;
176 	unsigned int dot11RTSSuccessCount;
177 };
178 
179 /**
180  * enum ieee80211_bss_change - BSS change notification flags
181  *
182  * These flags are used with the bss_info_changed() callback
183  * to indicate which BSS parameter changed.
184  *
185  * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
186  *	also implies a change in the AID.
187  * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
188  * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
189  * @BSS_CHANGED_HT: 802.11n parameters changed
190  */
191 enum ieee80211_bss_change {
192 	BSS_CHANGED_ASSOC		= 1<<0,
193 	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
194 	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
195 	BSS_CHANGED_HT                  = 1<<4,
196 };
197 
198 /**
199  * struct ieee80211_bss_conf - holds the BSS's changing parameters
200  *
201  * This structure keeps information about a BSS (and an association
202  * to that BSS) that can change during the lifetime of the BSS.
203  *
204  * @assoc: association status
205  * @aid: association ID number, valid only when @assoc is true
206  * @use_cts_prot: use CTS protection
207  * @use_short_preamble: use 802.11b short preamble
208  * @timestamp: beacon timestamp
209  * @beacon_int: beacon interval
210  * @assoc_capability: capabbilities taken from assoc resp
211  * @assoc_ht: association in HT mode
212  * @ht_conf: ht capabilities
213  * @ht_bss_conf: ht extended capabilities
214  */
215 struct ieee80211_bss_conf {
216 	/* association related data */
217 	bool assoc;
218 	u16 aid;
219 	/* erp related data */
220 	bool use_cts_prot;
221 	bool use_short_preamble;
222 	u16 beacon_int;
223 	u16 assoc_capability;
224 	u64 timestamp;
225 	/* ht related data */
226 	bool assoc_ht;
227 	struct ieee80211_ht_info *ht_conf;
228 	struct ieee80211_ht_bss_info *ht_bss_conf;
229 };
230 
231 /**
232  * enum mac80211_tx_control_flags - flags to describe Tx configuration for
233  * 				    the Tx frame
234  *
235  * These flags are used with the @flags member of &ieee80211_tx_control
236  *
237  * @IEEE80211_TXCTL_REQ_TX_STATUS: request TX status callback for this frame.
238  * @IEEE80211_TXCTL_DO_NOT_ENCRYPT: send this frame without encryption;
239  * 				    e.g., for EAPOL frame
240  * @IEEE80211_TXCTL_USE_RTS_CTS: use RTS-CTS before sending frame
241  * @IEEE80211_TXCTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
242  * 				     for combined 802.11g / 802.11b networks)
243  * @IEEE80211_TXCTL_NO_ACK: tell the low level not to wait for an ack
244  * @IEEE80211_TXCTL_RATE_CTRL_PROBE
245  * @EEE80211_TXCTL_CLEAR_PS_FILT: clear powersave filter
246  *                                 for destination station
247  * @IEEE80211_TXCTL_REQUEUE:
248  * @IEEE80211_TXCTL_FIRST_FRAGMENT: this is a first fragment of the frame
249  * @IEEE80211_TXCTL_LONG_RETRY_LIMIT: this frame should be send using the
250  * 				      through set_retry_limit configured long
251  * 				      retry value
252  * @IEEE80211_TXCTL_EAPOL_FRAME: internal to mac80211
253  * @IEEE80211_TXCTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
254  * @IEEE80211_TXCTL_AMPDU: this frame should be sent as part of an A-MPDU
255  * @IEEE80211_TXCTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
256  * 			     of streams when this flag is on can be extracted
257  *			     from antenna_sel_tx, so if 1 antenna is marked
258  *			     use SISO, 2 antennas marked use MIMO, n antennas
259  *			     marked use MIMO_n.
260  * @IEEE80211_TXCTL_GREEN_FIELD: use green field protection for this frame
261  * @IEEE80211_TXCTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
262  * @IEEE80211_TXCTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
263  * @IEEE80211_TXCTL_SHORT_GI: send this frame using short guard interval
264  */
265 enum mac80211_tx_control_flags {
266 	IEEE80211_TXCTL_REQ_TX_STATUS		= (1<<0),
267 	IEEE80211_TXCTL_DO_NOT_ENCRYPT		= (1<<1),
268 	IEEE80211_TXCTL_USE_RTS_CTS		= (1<<2),
269 	IEEE80211_TXCTL_USE_CTS_PROTECT		= (1<<3),
270 	IEEE80211_TXCTL_NO_ACK			= (1<<4),
271 	IEEE80211_TXCTL_RATE_CTRL_PROBE		= (1<<5),
272 	IEEE80211_TXCTL_CLEAR_PS_FILT		= (1<<6),
273 	IEEE80211_TXCTL_REQUEUE			= (1<<7),
274 	IEEE80211_TXCTL_FIRST_FRAGMENT		= (1<<8),
275 	IEEE80211_TXCTL_SHORT_PREAMBLE		= (1<<9),
276 	IEEE80211_TXCTL_LONG_RETRY_LIMIT	= (1<<10),
277 	IEEE80211_TXCTL_EAPOL_FRAME		= (1<<11),
278 	IEEE80211_TXCTL_SEND_AFTER_DTIM		= (1<<12),
279 	IEEE80211_TXCTL_AMPDU			= (1<<13),
280 	IEEE80211_TXCTL_OFDM_HT			= (1<<14),
281 	IEEE80211_TXCTL_GREEN_FIELD		= (1<<15),
282 	IEEE80211_TXCTL_40_MHZ_WIDTH		= (1<<16),
283 	IEEE80211_TXCTL_DUP_DATA		= (1<<17),
284 	IEEE80211_TXCTL_SHORT_GI		= (1<<18),
285 };
286 
287 /* Transmit control fields. This data structure is passed to low-level driver
288  * with each TX frame. The low-level driver is responsible for configuring
289  * the hardware to use given values (depending on what is supported). */
290 
291 struct ieee80211_tx_control {
292 	struct ieee80211_vif *vif;
293 	struct ieee80211_rate *tx_rate;
294 
295 	/* Transmit rate for RTS/CTS frame */
296 	struct ieee80211_rate *rts_cts_rate;
297 
298 	/* retry rate for the last retries */
299 	struct ieee80211_rate *alt_retry_rate;
300 
301 	u32 flags;		/* tx control flags defined above */
302 	u8 key_idx;		/* keyidx from hw->set_key(), undefined if
303 				 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
304 	u8 retry_limit;		/* 1 = only first attempt, 2 = one retry, ..
305 				 * This could be used when set_retry_limit
306 				 * is not implemented by the driver */
307 	u8 antenna_sel_tx; 	/* 0 = default/diversity, otherwise bit
308 				 * position represents antenna number used */
309 	u8 icv_len;		/* length of the ICV/MIC field in octets */
310 	u8 iv_len;		/* length of the IV field in octets */
311 	u8 queue;		/* hardware queue to use for this frame;
312 				 * 0 = highest, hw->queues-1 = lowest */
313 	u16 aid;		/* Station AID */
314 	int type;	/* internal */
315 };
316 
317 
318 /**
319  * enum mac80211_rx_flags - receive flags
320  *
321  * These flags are used with the @flag member of &struct ieee80211_rx_status.
322  * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
323  *	Use together with %RX_FLAG_MMIC_STRIPPED.
324  * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
325  * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
326  * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
327  *	verification has been done by the hardware.
328  * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
329  *	If this flag is set, the stack cannot do any replay detection
330  *	hence the driver or hardware will have to do that.
331  * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
332  *	the frame.
333  * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
334  *	the frame.
335  * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
336  *	is valid. This is useful in monitor mode and necessary for beacon frames
337  *	to enable IBSS merging.
338  */
339 enum mac80211_rx_flags {
340 	RX_FLAG_MMIC_ERROR	= 1<<0,
341 	RX_FLAG_DECRYPTED	= 1<<1,
342 	RX_FLAG_RADIOTAP	= 1<<2,
343 	RX_FLAG_MMIC_STRIPPED	= 1<<3,
344 	RX_FLAG_IV_STRIPPED	= 1<<4,
345 	RX_FLAG_FAILED_FCS_CRC	= 1<<5,
346 	RX_FLAG_FAILED_PLCP_CRC = 1<<6,
347 	RX_FLAG_TSFT		= 1<<7,
348 };
349 
350 /**
351  * struct ieee80211_rx_status - receive status
352  *
353  * The low-level driver should provide this information (the subset
354  * supported by hardware) to the 802.11 code with each received
355  * frame.
356  * @mactime: value in microseconds of the 64-bit Time Synchronization Function
357  * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
358  * @band: the active band when this frame was received
359  * @freq: frequency the radio was tuned to when receiving this frame, in MHz
360  * @ssi: signal strength when receiving this frame
361  * @signal: used as 'qual' in statistics reporting
362  * @noise: PHY noise when receiving this frame
363  * @antenna: antenna used
364  * @rate_idx: index of data rate into band's supported rates
365  * @flag: %RX_FLAG_*
366  */
367 struct ieee80211_rx_status {
368 	u64 mactime;
369 	enum ieee80211_band band;
370 	int freq;
371 	int ssi;
372 	int signal;
373 	int noise;
374 	int antenna;
375 	int rate_idx;
376 	int flag;
377 };
378 
379 /**
380  * enum ieee80211_tx_status_flags - transmit status flags
381  *
382  * Status flags to indicate various transmit conditions.
383  *
384  * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
385  *	because the destination STA was in powersave mode.
386  * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
387  * @IEEE80211_TX_STATUS_AMPDU: The frame was aggregated, so status
388  * 	is for the whole aggregation.
389  */
390 enum ieee80211_tx_status_flags {
391 	IEEE80211_TX_STATUS_TX_FILTERED	= 1<<0,
392 	IEEE80211_TX_STATUS_ACK		= 1<<1,
393 	IEEE80211_TX_STATUS_AMPDU	= 1<<2,
394 };
395 
396 /**
397  * struct ieee80211_tx_status - transmit status
398  *
399  * As much information as possible should be provided for each transmitted
400  * frame with ieee80211_tx_status().
401  *
402  * @control: a copy of the &struct ieee80211_tx_control passed to the driver
403  *	in the tx() callback.
404  * @flags: transmit status flags, defined above
405  * @retry_count: number of retries
406  * @excessive_retries: set to 1 if the frame was retried many times
407  *	but not acknowledged
408  * @ampdu_ack_len: number of aggregated frames.
409  * 	relevant only if IEEE80211_TX_STATUS_AMPDU was set.
410  * @ampdu_ack_map: block ack bit map for the aggregation.
411  * 	relevant only if IEEE80211_TX_STATUS_AMPDU was set.
412  * @ack_signal: signal strength of the ACK frame
413  * @queue_length: ?? REMOVE
414  * @queue_number: ?? REMOVE
415  */
416 struct ieee80211_tx_status {
417 	struct ieee80211_tx_control control;
418 	u8 flags;
419 	u8 retry_count;
420 	bool excessive_retries;
421 	u8 ampdu_ack_len;
422 	u64 ampdu_ack_map;
423 	int ack_signal;
424 	int queue_length;
425 	int queue_number;
426 };
427 
428 /**
429  * enum ieee80211_conf_flags - configuration flags
430  *
431  * Flags to define PHY configuration options
432  *
433  * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
434  * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
435  * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
436  */
437 enum ieee80211_conf_flags {
438 	IEEE80211_CONF_SHORT_SLOT_TIME	= (1<<0),
439 	IEEE80211_CONF_RADIOTAP		= (1<<1),
440 	IEEE80211_CONF_SUPPORT_HT_MODE	= (1<<2),
441 };
442 
443 /**
444  * struct ieee80211_conf - configuration of the device
445  *
446  * This struct indicates how the driver shall configure the hardware.
447  *
448  * @radio_enabled: when zero, driver is required to switch off the radio.
449  *	TODO make a flag
450  * @beacon_int: beacon interval (TODO make interface config)
451  * @flags: configuration flags defined above
452  * @power_level: requested transmit power (in dBm)
453  * @max_antenna_gain: maximum antenna gain (in dBi)
454  * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
455  *	1/2: antenna 0/1
456  * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
457  * @ht_conf: describes current self configuration of 802.11n HT capabilies
458  * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
459  * @channel: the channel to tune to
460  */
461 struct ieee80211_conf {
462 	int radio_enabled;
463 
464 	int beacon_int;
465 	u32 flags;
466 	int power_level;
467 	int max_antenna_gain;
468 	u8 antenna_sel_tx;
469 	u8 antenna_sel_rx;
470 
471 	struct ieee80211_channel *channel;
472 
473 	struct ieee80211_ht_info ht_conf;
474 	struct ieee80211_ht_bss_info ht_bss_conf;
475 };
476 
477 /**
478  * enum ieee80211_if_types - types of 802.11 network interfaces
479  *
480  * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
481  *	by mac80211 itself
482  * @IEEE80211_IF_TYPE_AP: interface in AP mode.
483  * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
484  *	daemon. Drivers should never see this type.
485  * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
486  * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
487  * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
488  * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
489  * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
490  *	will never see this type.
491  * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
492  */
493 enum ieee80211_if_types {
494 	IEEE80211_IF_TYPE_INVALID,
495 	IEEE80211_IF_TYPE_AP,
496 	IEEE80211_IF_TYPE_STA,
497 	IEEE80211_IF_TYPE_IBSS,
498 	IEEE80211_IF_TYPE_MESH_POINT,
499 	IEEE80211_IF_TYPE_MNTR,
500 	IEEE80211_IF_TYPE_WDS,
501 	IEEE80211_IF_TYPE_VLAN,
502 };
503 
504 /**
505  * struct ieee80211_vif - per-interface data
506  *
507  * Data in this structure is continually present for driver
508  * use during the life of a virtual interface.
509  *
510  * @type: type of this virtual interface
511  * @drv_priv: data area for driver use, will always be aligned to
512  *	sizeof(void *).
513  */
514 struct ieee80211_vif {
515 	enum ieee80211_if_types type;
516 	/* must be last */
517 	u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
518 };
519 
520 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
521 {
522 #ifdef CONFIG_MAC80211_MESH
523 	return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
524 #endif
525 	return false;
526 }
527 
528 /**
529  * struct ieee80211_if_init_conf - initial configuration of an interface
530  *
531  * @vif: pointer to a driver-use per-interface structure. The pointer
532  *	itself is also used for various functions including
533  *	ieee80211_beacon_get() and ieee80211_get_buffered_bc().
534  * @type: one of &enum ieee80211_if_types constants. Determines the type of
535  *	added/removed interface.
536  * @mac_addr: pointer to MAC address of the interface. This pointer is valid
537  *	until the interface is removed (i.e. it cannot be used after
538  *	remove_interface() callback was called for this interface).
539  *
540  * This structure is used in add_interface() and remove_interface()
541  * callbacks of &struct ieee80211_hw.
542  *
543  * When you allow multiple interfaces to be added to your PHY, take care
544  * that the hardware can actually handle multiple MAC addresses. However,
545  * also take care that when there's no interface left with mac_addr != %NULL
546  * you remove the MAC address from the device to avoid acknowledging packets
547  * in pure monitor mode.
548  */
549 struct ieee80211_if_init_conf {
550 	enum ieee80211_if_types type;
551 	struct ieee80211_vif *vif;
552 	void *mac_addr;
553 };
554 
555 /**
556  * struct ieee80211_if_conf - configuration of an interface
557  *
558  * @type: type of the interface. This is always the same as was specified in
559  *	&struct ieee80211_if_init_conf. The type of an interface never changes
560  *	during the life of the interface; this field is present only for
561  *	convenience.
562  * @bssid: BSSID of the network we are associated to/creating.
563  * @ssid: used (together with @ssid_len) by drivers for hardware that
564  *	generate beacons independently. The pointer is valid only during the
565  *	config_interface() call, so copy the value somewhere if you need
566  *	it.
567  * @ssid_len: length of the @ssid field.
568  * @beacon: beacon template. Valid only if @host_gen_beacon_template in
569  *	&struct ieee80211_hw is set. The driver is responsible of freeing
570  *	the sk_buff.
571  * @beacon_control: tx_control for the beacon template, this field is only
572  *	valid when the @beacon field was set.
573  *
574  * This structure is passed to the config_interface() callback of
575  * &struct ieee80211_hw.
576  */
577 struct ieee80211_if_conf {
578 	int type;
579 	u8 *bssid;
580 	u8 *ssid;
581 	size_t ssid_len;
582 	struct sk_buff *beacon;
583 	struct ieee80211_tx_control *beacon_control;
584 };
585 
586 /**
587  * enum ieee80211_key_alg - key algorithm
588  * @ALG_WEP: WEP40 or WEP104
589  * @ALG_TKIP: TKIP
590  * @ALG_CCMP: CCMP (AES)
591  */
592 enum ieee80211_key_alg {
593 	ALG_WEP,
594 	ALG_TKIP,
595 	ALG_CCMP,
596 };
597 
598 
599 /**
600  * enum ieee80211_key_flags - key flags
601  *
602  * These flags are used for communication about keys between the driver
603  * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
604  *
605  * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
606  *	that the STA this key will be used with could be using QoS.
607  * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
608  *	driver to indicate that it requires IV generation for this
609  *	particular key.
610  * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
611  *	the driver for a TKIP key if it requires Michael MIC
612  *	generation in software.
613  */
614 enum ieee80211_key_flags {
615 	IEEE80211_KEY_FLAG_WMM_STA	= 1<<0,
616 	IEEE80211_KEY_FLAG_GENERATE_IV	= 1<<1,
617 	IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
618 };
619 
620 /**
621  * struct ieee80211_key_conf - key information
622  *
623  * This key information is given by mac80211 to the driver by
624  * the set_key() callback in &struct ieee80211_ops.
625  *
626  * @hw_key_idx: To be set by the driver, this is the key index the driver
627  *	wants to be given when a frame is transmitted and needs to be
628  *	encrypted in hardware.
629  * @alg: The key algorithm.
630  * @flags: key flags, see &enum ieee80211_key_flags.
631  * @keyidx: the key index (0-3)
632  * @keylen: key material length
633  * @key: key material
634  */
635 struct ieee80211_key_conf {
636 	enum ieee80211_key_alg alg;
637 	u8 hw_key_idx;
638 	u8 flags;
639 	s8 keyidx;
640 	u8 keylen;
641 	u8 key[0];
642 };
643 
644 /**
645  * enum set_key_cmd - key command
646  *
647  * Used with the set_key() callback in &struct ieee80211_ops, this
648  * indicates whether a key is being removed or added.
649  *
650  * @SET_KEY: a key is set
651  * @DISABLE_KEY: a key must be disabled
652  */
653 enum set_key_cmd {
654 	SET_KEY, DISABLE_KEY,
655 };
656 
657 /**
658  * enum sta_notify_cmd - sta notify command
659  *
660  * Used with the sta_notify() callback in &struct ieee80211_ops, this
661  * indicates addition and removal of a station to station table
662  *
663  * @STA_NOTIFY_ADD: a station was added to the station table
664  * @STA_NOTIFY_REMOVE: a station being removed from the station table
665  */
666 enum sta_notify_cmd {
667 	STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
668 };
669 
670 /**
671  * enum ieee80211_tkip_key_type - get tkip key
672  *
673  * Used by drivers which need to get a tkip key for skb. Some drivers need a
674  * phase 1 key, others need a phase 2 key. A single function allows the driver
675  * to get the key, this enum indicates what type of key is required.
676  *
677  * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
678  * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
679  */
680 enum ieee80211_tkip_key_type {
681 	IEEE80211_TKIP_P1_KEY,
682 	IEEE80211_TKIP_P2_KEY,
683 };
684 
685 /**
686  * enum ieee80211_hw_flags - hardware flags
687  *
688  * These flags are used to indicate hardware capabilities to
689  * the stack. Generally, flags here should have their meaning
690  * done in a way that the simplest hardware doesn't need setting
691  * any particular flags. There are some exceptions to this rule,
692  * however, so you are advised to review these flags carefully.
693  *
694  * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
695  *	The device only needs to be supplied with a beacon template.
696  *	If you need the host to generate each beacon then don't use
697  *	this flag and call ieee80211_beacon_get() when you need the
698  *	next beacon frame. Note that if you set this flag, you must
699  *	implement the set_tim() callback for powersave mode to work
700  *	properly.
701  *	This flag is only relevant for access-point mode.
702  *
703  * @IEEE80211_HW_RX_INCLUDES_FCS:
704  *	Indicates that received frames passed to the stack include
705  *	the FCS at the end.
706  *
707  * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
708  *	Some wireless LAN chipsets buffer broadcast/multicast frames
709  *	for power saving stations in the hardware/firmware and others
710  *	rely on the host system for such buffering. This option is used
711  *	to configure the IEEE 802.11 upper layer to buffer broadcast and
712  *	multicast frames when there are power saving stations so that
713  *	the driver can fetch them with ieee80211_get_buffered_bc(). Note
714  *	that not setting this flag works properly only when the
715  *	%IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
716  *	otherwise the stack will not know when the DTIM beacon was sent.
717  *
718  * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
719  *	Hardware is not capable of short slot operation on the 2.4 GHz band.
720  *
721  * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
722  *	Hardware is not capable of receiving frames with short preamble on
723  *	the 2.4 GHz band.
724  */
725 enum ieee80211_hw_flags {
726 	IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE		= 1<<0,
727 	IEEE80211_HW_RX_INCLUDES_FCS			= 1<<1,
728 	IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING	= 1<<2,
729 	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE		= 1<<3,
730 	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE	= 1<<4,
731 };
732 
733 /**
734  * struct ieee80211_hw - hardware information and state
735  *
736  * This structure contains the configuration and hardware
737  * information for an 802.11 PHY.
738  *
739  * @wiphy: This points to the &struct wiphy allocated for this
740  *	802.11 PHY. You must fill in the @perm_addr and @dev
741  *	members of this structure using SET_IEEE80211_DEV()
742  *	and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
743  *	bands (with channels, bitrates) are registered here.
744  *
745  * @conf: &struct ieee80211_conf, device configuration, don't use.
746  *
747  * @workqueue: single threaded workqueue available for driver use,
748  *	allocated by mac80211 on registration and flushed on
749  *	unregistration.
750  *
751  * @priv: pointer to private area that was allocated for driver use
752  *	along with this structure.
753  *
754  * @flags: hardware flags, see &enum ieee80211_hw_flags.
755  *
756  * @extra_tx_headroom: headroom to reserve in each transmit skb
757  *	for use by the driver (e.g. for transmit headers.)
758  *
759  * @channel_change_time: time (in microseconds) it takes to change channels.
760  *
761  * @max_rssi: Maximum value for ssi in RX information, use
762  *	negative numbers for dBm and 0 to indicate no support.
763  *
764  * @max_signal: like @max_rssi, but for the signal value.
765  *
766  * @max_noise: like @max_rssi, but for the noise value.
767  *
768  * @queues: number of available hardware transmit queues for
769  *	data packets. WMM/QoS requires at least four.
770  *
771  * @rate_control_algorithm: rate control algorithm for this hardware.
772  *	If unset (NULL), the default algorithm will be used. Must be
773  *	set before calling ieee80211_register_hw().
774  *
775  * @vif_data_size: size (in bytes) of the drv_priv data area
776  *	within &struct ieee80211_vif.
777  */
778 struct ieee80211_hw {
779 	struct ieee80211_conf conf;
780 	struct wiphy *wiphy;
781 	struct workqueue_struct *workqueue;
782 	const char *rate_control_algorithm;
783 	void *priv;
784 	u32 flags;
785 	unsigned int extra_tx_headroom;
786 	int channel_change_time;
787 	int vif_data_size;
788 	u8 queues;
789 	s8 max_rssi;
790 	s8 max_signal;
791 	s8 max_noise;
792 };
793 
794 /**
795  * SET_IEEE80211_DEV - set device for 802.11 hardware
796  *
797  * @hw: the &struct ieee80211_hw to set the device for
798  * @dev: the &struct device of this 802.11 device
799  */
800 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
801 {
802 	set_wiphy_dev(hw->wiphy, dev);
803 }
804 
805 /**
806  * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
807  *
808  * @hw: the &struct ieee80211_hw to set the MAC address for
809  * @addr: the address to set
810  */
811 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
812 {
813 	memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
814 }
815 
816 /**
817  * DOC: Hardware crypto acceleration
818  *
819  * mac80211 is capable of taking advantage of many hardware
820  * acceleration designs for encryption and decryption operations.
821  *
822  * The set_key() callback in the &struct ieee80211_ops for a given
823  * device is called to enable hardware acceleration of encryption and
824  * decryption. The callback takes an @address parameter that will be
825  * the broadcast address for default keys, the other station's hardware
826  * address for individual keys or the zero address for keys that will
827  * be used only for transmission.
828  * Multiple transmission keys with the same key index may be used when
829  * VLANs are configured for an access point.
830  *
831  * The @local_address parameter will always be set to our own address,
832  * this is only relevant if you support multiple local addresses.
833  *
834  * When transmitting, the TX control data will use the @hw_key_idx
835  * selected by the driver by modifying the &struct ieee80211_key_conf
836  * pointed to by the @key parameter to the set_key() function.
837  *
838  * The set_key() call for the %SET_KEY command should return 0 if
839  * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
840  * added; if you return 0 then hw_key_idx must be assigned to the
841  * hardware key index, you are free to use the full u8 range.
842  *
843  * When the cmd is %DISABLE_KEY then it must succeed.
844  *
845  * Note that it is permissible to not decrypt a frame even if a key
846  * for it has been uploaded to hardware, the stack will not make any
847  * decision based on whether a key has been uploaded or not but rather
848  * based on the receive flags.
849  *
850  * The &struct ieee80211_key_conf structure pointed to by the @key
851  * parameter is guaranteed to be valid until another call to set_key()
852  * removes it, but it can only be used as a cookie to differentiate
853  * keys.
854  *
855  * In TKIP some HW need to be provided a phase 1 key, for RX decryption
856  * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
857  * handler.
858  * The update_tkip_key() call updates the driver with the new phase 1 key.
859  * This happens everytime the iv16 wraps around (every 65536 packets). The
860  * set_key() call will happen only once for each key (unless the AP did
861  * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
862  * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
863  * handler is software decryption with wrap around of iv16.
864  */
865 
866 /**
867  * DOC: Frame filtering
868  *
869  * mac80211 requires to see many management frames for proper
870  * operation, and users may want to see many more frames when
871  * in monitor mode. However, for best CPU usage and power consumption,
872  * having as few frames as possible percolate through the stack is
873  * desirable. Hence, the hardware should filter as much as possible.
874  *
875  * To achieve this, mac80211 uses filter flags (see below) to tell
876  * the driver's configure_filter() function which frames should be
877  * passed to mac80211 and which should be filtered out.
878  *
879  * The configure_filter() callback is invoked with the parameters
880  * @mc_count and @mc_list for the combined multicast address list
881  * of all virtual interfaces, @changed_flags telling which flags
882  * were changed and @total_flags with the new flag states.
883  *
884  * If your device has no multicast address filters your driver will
885  * need to check both the %FIF_ALLMULTI flag and the @mc_count
886  * parameter to see whether multicast frames should be accepted
887  * or dropped.
888  *
889  * All unsupported flags in @total_flags must be cleared.
890  * Hardware does not support a flag if it is incapable of _passing_
891  * the frame to the stack. Otherwise the driver must ignore
892  * the flag, but not clear it.
893  * You must _only_ clear the flag (announce no support for the
894  * flag to mac80211) if you are not able to pass the packet type
895  * to the stack (so the hardware always filters it).
896  * So for example, you should clear @FIF_CONTROL, if your hardware
897  * always filters control frames. If your hardware always passes
898  * control frames to the kernel and is incapable of filtering them,
899  * you do _not_ clear the @FIF_CONTROL flag.
900  * This rule applies to all other FIF flags as well.
901  */
902 
903 /**
904  * enum ieee80211_filter_flags - hardware filter flags
905  *
906  * These flags determine what the filter in hardware should be
907  * programmed to let through and what should not be passed to the
908  * stack. It is always safe to pass more frames than requested,
909  * but this has negative impact on power consumption.
910  *
911  * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
912  *	think of the BSS as your network segment and then this corresponds
913  *	to the regular ethernet device promiscuous mode.
914  *
915  * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
916  *	by the user or if the hardware is not capable of filtering by
917  *	multicast address.
918  *
919  * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
920  *	%RX_FLAG_FAILED_FCS_CRC for them)
921  *
922  * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
923  *	the %RX_FLAG_FAILED_PLCP_CRC for them
924  *
925  * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
926  *	to the hardware that it should not filter beacons or probe responses
927  *	by BSSID. Filtering them can greatly reduce the amount of processing
928  *	mac80211 needs to do and the amount of CPU wakeups, so you should
929  *	honour this flag if possible.
930  *
931  * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
932  *	only those addressed to this station
933  *
934  * @FIF_OTHER_BSS: pass frames destined to other BSSes
935  */
936 enum ieee80211_filter_flags {
937 	FIF_PROMISC_IN_BSS	= 1<<0,
938 	FIF_ALLMULTI		= 1<<1,
939 	FIF_FCSFAIL		= 1<<2,
940 	FIF_PLCPFAIL		= 1<<3,
941 	FIF_BCN_PRBRESP_PROMISC	= 1<<4,
942 	FIF_CONTROL		= 1<<5,
943 	FIF_OTHER_BSS		= 1<<6,
944 };
945 
946 /**
947  * enum ieee80211_ampdu_mlme_action - A-MPDU actions
948  *
949  * These flags are used with the ampdu_action() callback in
950  * &struct ieee80211_ops to indicate which action is needed.
951  * @IEEE80211_AMPDU_RX_START: start Rx aggregation
952  * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
953  * @IEEE80211_AMPDU_TX_START: start Tx aggregation
954  * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
955  */
956 enum ieee80211_ampdu_mlme_action {
957 	IEEE80211_AMPDU_RX_START,
958 	IEEE80211_AMPDU_RX_STOP,
959 	IEEE80211_AMPDU_TX_START,
960 	IEEE80211_AMPDU_TX_STOP,
961 };
962 
963 /**
964  * struct ieee80211_ops - callbacks from mac80211 to the driver
965  *
966  * This structure contains various callbacks that the driver may
967  * handle or, in some cases, must handle, for example to configure
968  * the hardware to a new channel or to transmit a frame.
969  *
970  * @tx: Handler that 802.11 module calls for each transmitted frame.
971  *	skb contains the buffer starting from the IEEE 802.11 header.
972  *	The low-level driver should send the frame out based on
973  *	configuration in the TX control data. Must be implemented and
974  *	atomic.
975  *
976  * @start: Called before the first netdevice attached to the hardware
977  *	is enabled. This should turn on the hardware and must turn on
978  *	frame reception (for possibly enabled monitor interfaces.)
979  *	Returns negative error codes, these may be seen in userspace,
980  *	or zero.
981  *	When the device is started it should not have a MAC address
982  *	to avoid acknowledging frames before a non-monitor device
983  *	is added.
984  *	Must be implemented.
985  *
986  * @stop: Called after last netdevice attached to the hardware
987  *	is disabled. This should turn off the hardware (at least
988  *	it must turn off frame reception.)
989  *	May be called right after add_interface if that rejects
990  *	an interface.
991  *	Must be implemented.
992  *
993  * @add_interface: Called when a netdevice attached to the hardware is
994  *	enabled. Because it is not called for monitor mode devices, @open
995  *	and @stop must be implemented.
996  *	The driver should perform any initialization it needs before
997  *	the device can be enabled. The initial configuration for the
998  *	interface is given in the conf parameter.
999  *	The callback may refuse to add an interface by returning a
1000  *	negative error code (which will be seen in userspace.)
1001  *	Must be implemented.
1002  *
1003  * @remove_interface: Notifies a driver that an interface is going down.
1004  *	The @stop callback is called after this if it is the last interface
1005  *	and no monitor interfaces are present.
1006  *	When all interfaces are removed, the MAC address in the hardware
1007  *	must be cleared so the device no longer acknowledges packets,
1008  *	the mac_addr member of the conf structure is, however, set to the
1009  *	MAC address of the device going away.
1010  *	Hence, this callback must be implemented.
1011  *
1012  * @config: Handler for configuration requests. IEEE 802.11 code calls this
1013  *	function to change hardware configuration, e.g., channel.
1014  *
1015  * @config_interface: Handler for configuration requests related to interfaces
1016  *	(e.g. BSSID changes.)
1017  *
1018  * @bss_info_changed: Handler for configuration requests related to BSS
1019  *	parameters that may vary during BSS's lifespan, and may affect low
1020  *	level driver (e.g. assoc/disassoc status, erp parameters).
1021  *	This function should not be used if no BSS has been set, unless
1022  *	for association indication. The @changed parameter indicates which
1023  *	of the bss parameters has changed when a call is made.
1024  *
1025  * @configure_filter: Configure the device's RX filter.
1026  *	See the section "Frame filtering" for more information.
1027  *	This callback must be implemented and atomic.
1028  *
1029  * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1030  *	generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1031  *	mac80211 calls this function when a TIM bit must be set or cleared
1032  *	for a given AID. Must be atomic.
1033  *
1034  * @set_key: See the section "Hardware crypto acceleration"
1035  *	This callback can sleep, and is only called between add_interface
1036  *	and remove_interface calls, i.e. while the interface with the
1037  *	given local_address is enabled.
1038  *
1039  * @update_tkip_key: See the section "Hardware crypto acceleration"
1040  * 	This callback will be called in the context of Rx. Called for drivers
1041  * 	which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1042  *
1043  * @hw_scan: Ask the hardware to service the scan request, no need to start
1044  *	the scan state machine in stack. The scan must honour the channel
1045  *	configuration done by the regulatory agent in the wiphy's registered
1046  *	bands.
1047  *
1048  * @get_stats: return low-level statistics
1049  *
1050  * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1051  *	callback should be provided to read the TKIP transmit IVs (both IV32
1052  *	and IV16) for the given key from hardware.
1053  *
1054  * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1055  *
1056  * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1057  *	the device does fragmentation by itself; if this method is assigned then
1058  *	the stack will not do fragmentation.
1059  *
1060  * @set_retry_limit: Configuration of retry limits (if device needs it)
1061  *
1062  * @sta_notify: Notifies low level driver about addition or removal
1063  *	of assocaited station or AP.
1064  *
1065  * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1066  *	bursting) for a hardware TX queue. The @queue parameter uses the
1067  *	%IEEE80211_TX_QUEUE_* constants. Must be atomic.
1068  *
1069  * @get_tx_stats: Get statistics of the current TX queue status. This is used
1070  *	to get number of currently queued packets (queue length), maximum queue
1071  *	size (limit), and total number of packets sent using each TX queue
1072  *	(count). This information is used for WMM to find out which TX
1073  *	queues have room for more packets and by hostapd to provide
1074  *	statistics about the current queueing state to external programs.
1075  *
1076  * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1077  *	this is only used for IBSS mode debugging and, as such, is not a
1078  *	required function. Must be atomic.
1079  *
1080  * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1081  *	with other STAs in the IBSS. This is only used in IBSS mode. This
1082  *	function is optional if the firmware/hardware takes full care of
1083  *	TSF synchronization.
1084  *
1085  * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1086  *	IBSS uses a fixed beacon frame which is configured using this
1087  *	function.
1088  *	If the driver returns success (0) from this callback, it owns
1089  *	the skb. That means the driver is responsible to kfree_skb() it.
1090  *	The control structure is not dynamically allocated. That means the
1091  *	driver does not own the pointer and if it needs it somewhere
1092  *	outside of the context of this function, it must copy it
1093  *	somewhere else.
1094  *	This handler is required only for IBSS mode.
1095  *
1096  * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1097  *	This is needed only for IBSS mode and the result of this function is
1098  *	used to determine whether to reply to Probe Requests.
1099  *
1100  * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1101  *
1102  * @ampdu_action: Perform a certain A-MPDU action
1103  * 	The RA/TID combination determines the destination and TID we want
1104  * 	the ampdu action to be performed for. The action is defined through
1105  * 	ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1106  * 	is the first frame we expect to perform the action on. notice
1107  * 	that TX/RX_STOP can pass NULL for this parameter.
1108  */
1109 struct ieee80211_ops {
1110 	int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
1111 		  struct ieee80211_tx_control *control);
1112 	int (*start)(struct ieee80211_hw *hw);
1113 	void (*stop)(struct ieee80211_hw *hw);
1114 	int (*add_interface)(struct ieee80211_hw *hw,
1115 			     struct ieee80211_if_init_conf *conf);
1116 	void (*remove_interface)(struct ieee80211_hw *hw,
1117 				 struct ieee80211_if_init_conf *conf);
1118 	int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1119 	int (*config_interface)(struct ieee80211_hw *hw,
1120 				struct ieee80211_vif *vif,
1121 				struct ieee80211_if_conf *conf);
1122 	void (*bss_info_changed)(struct ieee80211_hw *hw,
1123 				 struct ieee80211_vif *vif,
1124 				 struct ieee80211_bss_conf *info,
1125 				 u32 changed);
1126 	void (*configure_filter)(struct ieee80211_hw *hw,
1127 				 unsigned int changed_flags,
1128 				 unsigned int *total_flags,
1129 				 int mc_count, struct dev_addr_list *mc_list);
1130 	int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1131 	int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1132 		       const u8 *local_address, const u8 *address,
1133 		       struct ieee80211_key_conf *key);
1134 	void (*update_tkip_key)(struct ieee80211_hw *hw,
1135 			struct ieee80211_key_conf *conf, const u8 *address,
1136 			u32 iv32, u16 *phase1key);
1137 	int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1138 	int (*get_stats)(struct ieee80211_hw *hw,
1139 			 struct ieee80211_low_level_stats *stats);
1140 	void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1141 			     u32 *iv32, u16 *iv16);
1142 	int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1143 	int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1144 	int (*set_retry_limit)(struct ieee80211_hw *hw,
1145 			       u32 short_retry, u32 long_retr);
1146 	void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1147 			enum sta_notify_cmd, const u8 *addr);
1148 	int (*conf_tx)(struct ieee80211_hw *hw, int queue,
1149 		       const struct ieee80211_tx_queue_params *params);
1150 	int (*get_tx_stats)(struct ieee80211_hw *hw,
1151 			    struct ieee80211_tx_queue_stats *stats);
1152 	u64 (*get_tsf)(struct ieee80211_hw *hw);
1153 	void (*reset_tsf)(struct ieee80211_hw *hw);
1154 	int (*beacon_update)(struct ieee80211_hw *hw,
1155 			     struct sk_buff *skb,
1156 			     struct ieee80211_tx_control *control);
1157 	int (*tx_last_beacon)(struct ieee80211_hw *hw);
1158 	int (*ampdu_action)(struct ieee80211_hw *hw,
1159 			    enum ieee80211_ampdu_mlme_action action,
1160 			    const u8 *addr, u16 tid, u16 *ssn);
1161 };
1162 
1163 /**
1164  * ieee80211_alloc_hw -  Allocate a new hardware device
1165  *
1166  * This must be called once for each hardware device. The returned pointer
1167  * must be used to refer to this device when calling other functions.
1168  * mac80211 allocates a private data area for the driver pointed to by
1169  * @priv in &struct ieee80211_hw, the size of this area is given as
1170  * @priv_data_len.
1171  *
1172  * @priv_data_len: length of private data
1173  * @ops: callbacks for this device
1174  */
1175 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1176 					const struct ieee80211_ops *ops);
1177 
1178 /**
1179  * ieee80211_register_hw - Register hardware device
1180  *
1181  * You must call this function before any other functions in
1182  * mac80211. Note that before a hardware can be registered, you
1183  * need to fill the contained wiphy's information.
1184  *
1185  * @hw: the device to register as returned by ieee80211_alloc_hw()
1186  */
1187 int ieee80211_register_hw(struct ieee80211_hw *hw);
1188 
1189 #ifdef CONFIG_MAC80211_LEDS
1190 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1191 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1192 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1193 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1194 #endif
1195 /**
1196  * ieee80211_get_tx_led_name - get name of TX LED
1197  *
1198  * mac80211 creates a transmit LED trigger for each wireless hardware
1199  * that can be used to drive LEDs if your driver registers a LED device.
1200  * This function returns the name (or %NULL if not configured for LEDs)
1201  * of the trigger so you can automatically link the LED device.
1202  *
1203  * @hw: the hardware to get the LED trigger name for
1204  */
1205 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1206 {
1207 #ifdef CONFIG_MAC80211_LEDS
1208 	return __ieee80211_get_tx_led_name(hw);
1209 #else
1210 	return NULL;
1211 #endif
1212 }
1213 
1214 /**
1215  * ieee80211_get_rx_led_name - get name of RX LED
1216  *
1217  * mac80211 creates a receive LED trigger for each wireless hardware
1218  * that can be used to drive LEDs if your driver registers a LED device.
1219  * This function returns the name (or %NULL if not configured for LEDs)
1220  * of the trigger so you can automatically link the LED device.
1221  *
1222  * @hw: the hardware to get the LED trigger name for
1223  */
1224 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1225 {
1226 #ifdef CONFIG_MAC80211_LEDS
1227 	return __ieee80211_get_rx_led_name(hw);
1228 #else
1229 	return NULL;
1230 #endif
1231 }
1232 
1233 /**
1234  * ieee80211_get_assoc_led_name - get name of association LED
1235  *
1236  * mac80211 creates a association LED trigger for each wireless hardware
1237  * that can be used to drive LEDs if your driver registers a LED device.
1238  * This function returns the name (or %NULL if not configured for LEDs)
1239  * of the trigger so you can automatically link the LED device.
1240  *
1241  * @hw: the hardware to get the LED trigger name for
1242  */
1243 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1244 {
1245 #ifdef CONFIG_MAC80211_LEDS
1246 	return __ieee80211_get_assoc_led_name(hw);
1247 #else
1248 	return NULL;
1249 #endif
1250 }
1251 
1252 /**
1253  * ieee80211_get_radio_led_name - get name of radio LED
1254  *
1255  * mac80211 creates a radio change LED trigger for each wireless hardware
1256  * that can be used to drive LEDs if your driver registers a LED device.
1257  * This function returns the name (or %NULL if not configured for LEDs)
1258  * of the trigger so you can automatically link the LED device.
1259  *
1260  * @hw: the hardware to get the LED trigger name for
1261  */
1262 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1263 {
1264 #ifdef CONFIG_MAC80211_LEDS
1265 	return __ieee80211_get_radio_led_name(hw);
1266 #else
1267 	return NULL;
1268 #endif
1269 }
1270 
1271 /**
1272  * ieee80211_unregister_hw - Unregister a hardware device
1273  *
1274  * This function instructs mac80211 to free allocated resources
1275  * and unregister netdevices from the networking subsystem.
1276  *
1277  * @hw: the hardware to unregister
1278  */
1279 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1280 
1281 /**
1282  * ieee80211_free_hw - free hardware descriptor
1283  *
1284  * This function frees everything that was allocated, including the
1285  * private data for the driver. You must call ieee80211_unregister_hw()
1286  * before calling this function
1287  *
1288  * @hw: the hardware to free
1289  */
1290 void ieee80211_free_hw(struct ieee80211_hw *hw);
1291 
1292 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1293 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1294 		    struct ieee80211_rx_status *status);
1295 
1296 /**
1297  * ieee80211_rx - receive frame
1298  *
1299  * Use this function to hand received frames to mac80211. The receive
1300  * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1301  * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1302  *
1303  * This function may not be called in IRQ context. Calls to this function
1304  * for a single hardware must be synchronized against each other. Calls
1305  * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1306  * single hardware.
1307  *
1308  * @hw: the hardware this frame came in on
1309  * @skb: the buffer to receive, owned by mac80211 after this call
1310  * @status: status of this frame; the status pointer need not be valid
1311  *	after this function returns
1312  */
1313 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1314 				struct ieee80211_rx_status *status)
1315 {
1316 	__ieee80211_rx(hw, skb, status);
1317 }
1318 
1319 /**
1320  * ieee80211_rx_irqsafe - receive frame
1321  *
1322  * Like ieee80211_rx() but can be called in IRQ context
1323  * (internally defers to a tasklet.)
1324  *
1325  * Calls to this function and ieee80211_rx() may not be mixed for a
1326  * single hardware.
1327  *
1328  * @hw: the hardware this frame came in on
1329  * @skb: the buffer to receive, owned by mac80211 after this call
1330  * @status: status of this frame; the status pointer need not be valid
1331  *	after this function returns and is not freed by mac80211,
1332  *	it is recommended that it points to a stack area
1333  */
1334 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1335 			  struct sk_buff *skb,
1336 			  struct ieee80211_rx_status *status);
1337 
1338 /**
1339  * ieee80211_tx_status - transmit status callback
1340  *
1341  * Call this function for all transmitted frames after they have been
1342  * transmitted. It is permissible to not call this function for
1343  * multicast frames but this can affect statistics.
1344  *
1345  * This function may not be called in IRQ context. Calls to this function
1346  * for a single hardware must be synchronized against each other. Calls
1347  * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1348  * for a single hardware.
1349  *
1350  * @hw: the hardware the frame was transmitted by
1351  * @skb: the frame that was transmitted, owned by mac80211 after this call
1352  * @status: status information for this frame; the status pointer need not
1353  *	be valid after this function returns and is not freed by mac80211,
1354  *	it is recommended that it points to a stack area
1355  */
1356 void ieee80211_tx_status(struct ieee80211_hw *hw,
1357 			 struct sk_buff *skb,
1358 			 struct ieee80211_tx_status *status);
1359 
1360 /**
1361  * ieee80211_tx_status_irqsafe - irq-safe transmit status callback
1362  *
1363  * Like ieee80211_tx_status() but can be called in IRQ context
1364  * (internally defers to a tasklet.)
1365  *
1366  * Calls to this function and ieee80211_tx_status() may not be mixed for a
1367  * single hardware.
1368  *
1369  * @hw: the hardware the frame was transmitted by
1370  * @skb: the frame that was transmitted, owned by mac80211 after this call
1371  * @status: status information for this frame; the status pointer need not
1372  *	be valid after this function returns and is not freed by mac80211,
1373  *	it is recommended that it points to a stack area
1374  */
1375 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1376 				 struct sk_buff *skb,
1377 				 struct ieee80211_tx_status *status);
1378 
1379 /**
1380  * ieee80211_beacon_get - beacon generation function
1381  * @hw: pointer obtained from ieee80211_alloc_hw().
1382  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1383  * @control: will be filled with information needed to send this beacon.
1384  *
1385  * If the beacon frames are generated by the host system (i.e., not in
1386  * hardware/firmware), the low-level driver uses this function to receive
1387  * the next beacon frame from the 802.11 code. The low-level is responsible
1388  * for calling this function before beacon data is needed (e.g., based on
1389  * hardware interrupt). Returned skb is used only once and low-level driver
1390  * is responsible of freeing it.
1391  */
1392 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1393 				     struct ieee80211_vif *vif,
1394 				     struct ieee80211_tx_control *control);
1395 
1396 /**
1397  * ieee80211_rts_get - RTS frame generation function
1398  * @hw: pointer obtained from ieee80211_alloc_hw().
1399  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1400  * @frame: pointer to the frame that is going to be protected by the RTS.
1401  * @frame_len: the frame length (in octets).
1402  * @frame_txctl: &struct ieee80211_tx_control of the frame.
1403  * @rts: The buffer where to store the RTS frame.
1404  *
1405  * If the RTS frames are generated by the host system (i.e., not in
1406  * hardware/firmware), the low-level driver uses this function to receive
1407  * the next RTS frame from the 802.11 code. The low-level is responsible
1408  * for calling this function before and RTS frame is needed.
1409  */
1410 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1411 		       const void *frame, size_t frame_len,
1412 		       const struct ieee80211_tx_control *frame_txctl,
1413 		       struct ieee80211_rts *rts);
1414 
1415 /**
1416  * ieee80211_rts_duration - Get the duration field for an RTS frame
1417  * @hw: pointer obtained from ieee80211_alloc_hw().
1418  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1419  * @frame_len: the length of the frame that is going to be protected by the RTS.
1420  * @frame_txctl: &struct ieee80211_tx_control of the frame.
1421  *
1422  * If the RTS is generated in firmware, but the host system must provide
1423  * the duration field, the low-level driver uses this function to receive
1424  * the duration field value in little-endian byteorder.
1425  */
1426 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1427 			      struct ieee80211_vif *vif, size_t frame_len,
1428 			      const struct ieee80211_tx_control *frame_txctl);
1429 
1430 /**
1431  * ieee80211_ctstoself_get - CTS-to-self frame generation function
1432  * @hw: pointer obtained from ieee80211_alloc_hw().
1433  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1434  * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1435  * @frame_len: the frame length (in octets).
1436  * @frame_txctl: &struct ieee80211_tx_control of the frame.
1437  * @cts: The buffer where to store the CTS-to-self frame.
1438  *
1439  * If the CTS-to-self frames are generated by the host system (i.e., not in
1440  * hardware/firmware), the low-level driver uses this function to receive
1441  * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1442  * for calling this function before and CTS-to-self frame is needed.
1443  */
1444 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1445 			     struct ieee80211_vif *vif,
1446 			     const void *frame, size_t frame_len,
1447 			     const struct ieee80211_tx_control *frame_txctl,
1448 			     struct ieee80211_cts *cts);
1449 
1450 /**
1451  * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1452  * @hw: pointer obtained from ieee80211_alloc_hw().
1453  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1454  * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1455  * @frame_txctl: &struct ieee80211_tx_control of the frame.
1456  *
1457  * If the CTS-to-self is generated in firmware, but the host system must provide
1458  * the duration field, the low-level driver uses this function to receive
1459  * the duration field value in little-endian byteorder.
1460  */
1461 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1462 				    struct ieee80211_vif *vif,
1463 				    size_t frame_len,
1464 				    const struct ieee80211_tx_control *frame_txctl);
1465 
1466 /**
1467  * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1468  * @hw: pointer obtained from ieee80211_alloc_hw().
1469  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1470  * @frame_len: the length of the frame.
1471  * @rate: the rate at which the frame is going to be transmitted.
1472  *
1473  * Calculate the duration field of some generic frame, given its
1474  * length and transmission rate (in 100kbps).
1475  */
1476 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1477 					struct ieee80211_vif *vif,
1478 					size_t frame_len,
1479 					struct ieee80211_rate *rate);
1480 
1481 /**
1482  * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1483  * @hw: pointer as obtained from ieee80211_alloc_hw().
1484  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1485  * @control: will be filled with information needed to send returned frame.
1486  *
1487  * Function for accessing buffered broadcast and multicast frames. If
1488  * hardware/firmware does not implement buffering of broadcast/multicast
1489  * frames when power saving is used, 802.11 code buffers them in the host
1490  * memory. The low-level driver uses this function to fetch next buffered
1491  * frame. In most cases, this is used when generating beacon frame. This
1492  * function returns a pointer to the next buffered skb or NULL if no more
1493  * buffered frames are available.
1494  *
1495  * Note: buffered frames are returned only after DTIM beacon frame was
1496  * generated with ieee80211_beacon_get() and the low-level driver must thus
1497  * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1498  * NULL if the previous generated beacon was not DTIM, so the low-level driver
1499  * does not need to check for DTIM beacons separately and should be able to
1500  * use common code for all beacons.
1501  */
1502 struct sk_buff *
1503 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1504 			  struct ieee80211_tx_control *control);
1505 
1506 /**
1507  * ieee80211_get_hdrlen_from_skb - get header length from data
1508  *
1509  * Given an skb with a raw 802.11 header at the data pointer this function
1510  * returns the 802.11 header length in bytes (not including encryption
1511  * headers). If the data in the sk_buff is too short to contain a valid 802.11
1512  * header the function returns 0.
1513  *
1514  * @skb: the frame
1515  */
1516 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1517 
1518 /**
1519  * ieee80211_get_hdrlen - get header length from frame control
1520  *
1521  * This function returns the 802.11 header length in bytes (not including
1522  * encryption headers.)
1523  *
1524  * @fc: the frame control field (in CPU endianness)
1525  */
1526 int ieee80211_get_hdrlen(u16 fc);
1527 
1528 /**
1529  * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1530  *
1531  * This function computes a TKIP rc4 key for an skb. It computes
1532  * a phase 1 key if needed (iv16 wraps around). This function is to
1533  * be used by drivers which can do HW encryption but need to compute
1534  * to phase 1/2 key in SW.
1535  *
1536  * @keyconf: the parameter passed with the set key
1537  * @skb: the skb for which the key is needed
1538  * @rc4key: a buffer to which the key will be written
1539  */
1540 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1541 				struct sk_buff *skb,
1542 				enum ieee80211_tkip_key_type type, u8 *key);
1543 /**
1544  * ieee80211_wake_queue - wake specific queue
1545  * @hw: pointer as obtained from ieee80211_alloc_hw().
1546  * @queue: queue number (counted from zero).
1547  *
1548  * Drivers should use this function instead of netif_wake_queue.
1549  */
1550 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1551 
1552 /**
1553  * ieee80211_stop_queue - stop specific queue
1554  * @hw: pointer as obtained from ieee80211_alloc_hw().
1555  * @queue: queue number (counted from zero).
1556  *
1557  * Drivers should use this function instead of netif_stop_queue.
1558  */
1559 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1560 
1561 /**
1562  * ieee80211_start_queues - start all queues
1563  * @hw: pointer to as obtained from ieee80211_alloc_hw().
1564  *
1565  * Drivers should use this function instead of netif_start_queue.
1566  */
1567 void ieee80211_start_queues(struct ieee80211_hw *hw);
1568 
1569 /**
1570  * ieee80211_stop_queues - stop all queues
1571  * @hw: pointer as obtained from ieee80211_alloc_hw().
1572  *
1573  * Drivers should use this function instead of netif_stop_queue.
1574  */
1575 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1576 
1577 /**
1578  * ieee80211_wake_queues - wake all queues
1579  * @hw: pointer as obtained from ieee80211_alloc_hw().
1580  *
1581  * Drivers should use this function instead of netif_wake_queue.
1582  */
1583 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1584 
1585 /**
1586  * ieee80211_scan_completed - completed hardware scan
1587  *
1588  * When hardware scan offload is used (i.e. the hw_scan() callback is
1589  * assigned) this function needs to be called by the driver to notify
1590  * mac80211 that the scan finished.
1591  *
1592  * @hw: the hardware that finished the scan
1593  */
1594 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1595 
1596 /**
1597  * ieee80211_iterate_active_interfaces - iterate active interfaces
1598  *
1599  * This function iterates over the interfaces associated with a given
1600  * hardware that are currently active and calls the callback for them.
1601  *
1602  * @hw: the hardware struct of which the interfaces should be iterated over
1603  * @iterator: the iterator function to call, cannot sleep
1604  * @data: first argument of the iterator function
1605  */
1606 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1607 					 void (*iterator)(void *data, u8 *mac,
1608 						struct ieee80211_vif *vif),
1609 					 void *data);
1610 
1611 /**
1612  * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1613  * @hw: pointer as obtained from ieee80211_alloc_hw().
1614  * @ra: receiver address of the BA session recipient
1615  * @tid: the TID to BA on.
1616  * @return: success if addBA request was sent, failure otherwise
1617  *
1618  * Although mac80211/low level driver/user space application can estimate
1619  * the need to start aggregation on a certain RA/TID, the session level
1620  * will be managed by the mac80211.
1621  */
1622 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1623 
1624 /**
1625  * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1626  * @hw: pointer as obtained from ieee80211_alloc_hw().
1627  * @ra: receiver address of the BA session recipient.
1628  * @tid: the TID to BA on.
1629  *
1630  * This function must be called by low level driver once it has
1631  * finished with preparations for the BA session.
1632  */
1633 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1634 
1635 /**
1636  * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1637  * @hw: pointer as obtained from ieee80211_alloc_hw().
1638  * @ra: receiver address of the BA session recipient.
1639  * @tid: the TID to BA on.
1640  *
1641  * This function must be called by low level driver once it has
1642  * finished with preparations for the BA session.
1643  * This version of the function is irq safe.
1644  */
1645 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1646 				      u16 tid);
1647 
1648 /**
1649  * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1650  * @hw: pointer as obtained from ieee80211_alloc_hw().
1651  * @ra: receiver address of the BA session recipient
1652  * @tid: the TID to stop BA.
1653  * @initiator: if indicates initiator DELBA frame will be sent.
1654  * @return: error if no sta with matching da found, success otherwise
1655  *
1656  * Although mac80211/low level driver/user space application can estimate
1657  * the need to stop aggregation on a certain RA/TID, the session level
1658  * will be managed by the mac80211.
1659  */
1660 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1661 				 u8 *ra, u16 tid,
1662 				 enum ieee80211_back_parties initiator);
1663 
1664 /**
1665  * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1666  * @hw: pointer as obtained from ieee80211_alloc_hw().
1667  * @ra: receiver address of the BA session recipient.
1668  * @tid: the desired TID to BA on.
1669  *
1670  * This function must be called by low level driver once it has
1671  * finished with preparations for the BA session tear down.
1672  */
1673 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1674 
1675 /**
1676  * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1677  * @hw: pointer as obtained from ieee80211_alloc_hw().
1678  * @ra: receiver address of the BA session recipient.
1679  * @tid: the desired TID to BA on.
1680  *
1681  * This function must be called by low level driver once it has
1682  * finished with preparations for the BA session tear down.
1683  * This version of the function is irq safe.
1684  */
1685 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1686 				     u16 tid);
1687 
1688 /**
1689  * ieee80211_notify_mac - low level driver notification
1690  * @hw: pointer as obtained from ieee80211_alloc_hw().
1691  * @notification_types: enum ieee80211_notification_types
1692  *
1693  * This function must be called by low level driver to inform mac80211 of
1694  * low level driver status change or force mac80211 to re-assoc for low
1695  * level driver internal error that require re-assoc.
1696  */
1697 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1698 			  enum ieee80211_notification_types  notif_type);
1699 #endif /* MAC80211_H */
1700