mac80211: extend/document powersave API
[linux-2.6.git] / include / net / mac80211.h
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-2008  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-IRQ-safe 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  * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
78  *
79  * This structure describes most essential parameters needed
80  * to describe 802.11n HT characteristics in a BSS.
81  *
82  * @primary_channel: channel number of primery channel
83  * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
84  * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
85  */
86 struct ieee80211_ht_bss_info {
87         u8 primary_channel;
88         u8 bss_cap;  /* use IEEE80211_HT_IE_CHA_ */
89         u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
90 };
91
92 /**
93  * enum ieee80211_max_queues - maximum number of queues
94  *
95  * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96  * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
97  *      for A-MPDU operation.
98  */
99 enum ieee80211_max_queues {
100         IEEE80211_MAX_QUEUES =          16,
101         IEEE80211_MAX_AMPDU_QUEUES =    16,
102 };
103
104 /**
105  * struct ieee80211_tx_queue_params - transmit queue configuration
106  *
107  * The information provided in this structure is required for QoS
108  * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
109  *
110  * @aifs: arbitration interframe space [0..255]
111  * @cw_min: minimum contention window [a value of the form
112  *      2^n-1 in the range 1..32767]
113  * @cw_max: maximum contention window [like @cw_min]
114  * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
115  */
116 struct ieee80211_tx_queue_params {
117         u16 txop;
118         u16 cw_min;
119         u16 cw_max;
120         u8 aifs;
121 };
122
123 /**
124  * struct ieee80211_tx_queue_stats - transmit queue statistics
125  *
126  * @len: number of packets in queue
127  * @limit: queue length limit
128  * @count: number of frames sent
129  */
130 struct ieee80211_tx_queue_stats {
131         unsigned int len;
132         unsigned int limit;
133         unsigned int count;
134 };
135
136 struct ieee80211_low_level_stats {
137         unsigned int dot11ACKFailureCount;
138         unsigned int dot11RTSFailureCount;
139         unsigned int dot11FCSErrorCount;
140         unsigned int dot11RTSSuccessCount;
141 };
142
143 /**
144  * enum ieee80211_bss_change - BSS change notification flags
145  *
146  * These flags are used with the bss_info_changed() callback
147  * to indicate which BSS parameter changed.
148  *
149  * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
150  *      also implies a change in the AID.
151  * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
152  * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
153  * @BSS_CHANGED_ERP_SLOT: slot timing changed
154  * @BSS_CHANGED_HT: 802.11n parameters changed
155  * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
156  */
157 enum ieee80211_bss_change {
158         BSS_CHANGED_ASSOC               = 1<<0,
159         BSS_CHANGED_ERP_CTS_PROT        = 1<<1,
160         BSS_CHANGED_ERP_PREAMBLE        = 1<<2,
161         BSS_CHANGED_ERP_SLOT            = 1<<3,
162         BSS_CHANGED_HT                  = 1<<4,
163         BSS_CHANGED_BASIC_RATES         = 1<<5,
164 };
165
166 /**
167  * struct ieee80211_bss_ht_conf - BSS's changing HT configuration
168  * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info)
169  */
170 struct ieee80211_bss_ht_conf {
171         u16 operation_mode;
172 };
173
174 /**
175  * struct ieee80211_bss_conf - holds the BSS's changing parameters
176  *
177  * This structure keeps information about a BSS (and an association
178  * to that BSS) that can change during the lifetime of the BSS.
179  *
180  * @assoc: association status
181  * @aid: association ID number, valid only when @assoc is true
182  * @use_cts_prot: use CTS protection
183  * @use_short_preamble: use 802.11b short preamble;
184  *      if the hardware cannot handle this it must set the
185  *      IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
186  * @use_short_slot: use short slot time (only relevant for ERP);
187  *      if the hardware cannot handle this it must set the
188  *      IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
189  * @dtim_period: num of beacons before the next DTIM, for PSM
190  * @timestamp: beacon timestamp
191  * @beacon_int: beacon interval
192  * @assoc_capability: capabilities taken from assoc resp
193  * @ht: BSS's HT configuration
194  * @basic_rates: bitmap of basic rates, each bit stands for an
195  *      index into the rate table configured by the driver in
196  *      the current band.
197  */
198 struct ieee80211_bss_conf {
199         /* association related data */
200         bool assoc;
201         u16 aid;
202         /* erp related data */
203         bool use_cts_prot;
204         bool use_short_preamble;
205         bool use_short_slot;
206         u8 dtim_period;
207         u16 beacon_int;
208         u16 assoc_capability;
209         u64 timestamp;
210         u64 basic_rates;
211         struct ieee80211_bss_ht_conf ht;
212 };
213
214 /**
215  * enum mac80211_tx_control_flags - flags to describe transmission information/status
216  *
217  * These flags are used with the @flags member of &ieee80211_tx_info.
218  *
219  * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
220  * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
221  *      number to this frame, taking care of not overwriting the fragment
222  *      number and increasing the sequence number only when the
223  *      IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
224  *      assign sequence numbers to QoS-data frames but cannot do so correctly
225  *      for non-QoS-data and management frames because beacons need them from
226  *      that counter as well and mac80211 cannot guarantee proper sequencing.
227  *      If this flag is set, the driver should instruct the hardware to
228  *      assign a sequence number to the frame or assign one itself. Cf. IEEE
229  *      802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
230  *      beacons and always be clear for frames without a sequence number field.
231  * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
232  * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
233  *      station
234  * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
235  * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
236  * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
237  * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
238  * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
239  *      because the destination STA was in powersave mode.
240  * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
241  * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
242  *      is for the whole aggregation.
243  * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
244  *      so consider using block ack request (BAR).
245  * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
246  *      set by rate control algorithms to indicate probe rate, will
247  *      be cleared for fragmented frames (except on the last fragment)
248  */
249 enum mac80211_tx_control_flags {
250         IEEE80211_TX_CTL_REQ_TX_STATUS          = BIT(0),
251         IEEE80211_TX_CTL_ASSIGN_SEQ             = BIT(1),
252         IEEE80211_TX_CTL_NO_ACK                 = BIT(2),
253         IEEE80211_TX_CTL_CLEAR_PS_FILT          = BIT(3),
254         IEEE80211_TX_CTL_FIRST_FRAGMENT         = BIT(4),
255         IEEE80211_TX_CTL_SEND_AFTER_DTIM        = BIT(5),
256         IEEE80211_TX_CTL_AMPDU                  = BIT(6),
257         IEEE80211_TX_CTL_INJECTED               = BIT(7),
258         IEEE80211_TX_STAT_TX_FILTERED           = BIT(8),
259         IEEE80211_TX_STAT_ACK                   = BIT(9),
260         IEEE80211_TX_STAT_AMPDU                 = BIT(10),
261         IEEE80211_TX_STAT_AMPDU_NO_BACK         = BIT(11),
262         IEEE80211_TX_CTL_RATE_CTRL_PROBE        = BIT(12),
263 };
264
265 enum mac80211_rate_control_flags {
266         IEEE80211_TX_RC_USE_RTS_CTS             = BIT(0),
267         IEEE80211_TX_RC_USE_CTS_PROTECT         = BIT(1),
268         IEEE80211_TX_RC_USE_SHORT_PREAMBLE      = BIT(2),
269
270         /* rate index is an MCS rate number instead of an index */
271         IEEE80211_TX_RC_MCS                     = BIT(3),
272         IEEE80211_TX_RC_GREEN_FIELD             = BIT(4),
273         IEEE80211_TX_RC_40_MHZ_WIDTH            = BIT(5),
274         IEEE80211_TX_RC_DUP_DATA                = BIT(6),
275         IEEE80211_TX_RC_SHORT_GI                = BIT(7),
276 };
277
278
279 /* there are 40 bytes if you don't need the rateset to be kept */
280 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
281
282 /* if you do need the rateset, then you have less space */
283 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
284
285 /* maximum number of rate stages */
286 #define IEEE80211_TX_MAX_RATES  5
287
288 /**
289  * struct ieee80211_tx_rate - rate selection/status
290  *
291  * @idx: rate index to attempt to send with
292  * @flags: rate control flags (&enum mac80211_rate_control_flags)
293  * @count: number of tries in this rate before going to the next rate
294  *
295  * A value of -1 for @idx indicates an invalid rate and, if used
296  * in an array of retry rates, that no more rates should be tried.
297  *
298  * When used for transmit status reporting, the driver should
299  * always report the rate along with the flags it used.
300  */
301 struct ieee80211_tx_rate {
302         s8 idx;
303         u8 count;
304         u8 flags;
305 } __attribute__((packed));
306
307 /**
308  * struct ieee80211_tx_info - skb transmit information
309  *
310  * This structure is placed in skb->cb for three uses:
311  *  (1) mac80211 TX control - mac80211 tells the driver what to do
312  *  (2) driver internal use (if applicable)
313  *  (3) TX status information - driver tells mac80211 what happened
314  *
315  * The TX control's sta pointer is only valid during the ->tx call,
316  * it may be NULL.
317  *
318  * @flags: transmit info flags, defined above
319  * @band: the band to transmit on (use for checking for races)
320  * @antenna_sel_tx: antenna to use, 0 for automatic diversity
321  * @pad: padding, ignore
322  * @control: union for control data
323  * @status: union for status data
324  * @driver_data: array of driver_data pointers
325  * @ampdu_ack_len: number of aggregated frames.
326  *      relevant only if IEEE80211_TX_STATUS_AMPDU was set.
327  * @ampdu_ack_map: block ack bit map for the aggregation.
328  *      relevant only if IEEE80211_TX_STATUS_AMPDU was set.
329  * @ack_signal: signal strength of the ACK frame
330  */
331 struct ieee80211_tx_info {
332         /* common information */
333         u32 flags;
334         u8 band;
335
336         u8 antenna_sel_tx;
337
338         /* 2 byte hole */
339         u8 pad[2];
340
341         union {
342                 struct {
343                         union {
344                                 /* rate control */
345                                 struct {
346                                         struct ieee80211_tx_rate rates[
347                                                 IEEE80211_TX_MAX_RATES];
348                                         s8 rts_cts_rate_idx;
349                                 };
350                                 /* only needed before rate control */
351                                 unsigned long jiffies;
352                         };
353                         /* NB: vif can be NULL for injected frames */
354                         struct ieee80211_vif *vif;
355                         struct ieee80211_key_conf *hw_key;
356                         struct ieee80211_sta *sta;
357                 } control;
358                 struct {
359                         struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
360                         u8 ampdu_ack_len;
361                         u64 ampdu_ack_map;
362                         int ack_signal;
363                         /* 8 bytes free */
364                 } status;
365                 struct {
366                         struct ieee80211_tx_rate driver_rates[
367                                 IEEE80211_TX_MAX_RATES];
368                         void *rate_driver_data[
369                                 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
370                 };
371                 void *driver_data[
372                         IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
373         };
374 };
375
376 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
377 {
378         return (struct ieee80211_tx_info *)skb->cb;
379 }
380
381 /**
382  * ieee80211_tx_info_clear_status - clear TX status
383  *
384  * @info: The &struct ieee80211_tx_info to be cleared.
385  *
386  * When the driver passes an skb back to mac80211, it must report
387  * a number of things in TX status. This function clears everything
388  * in the TX status but the rate control information (it does clear
389  * the count since you need to fill that in anyway).
390  *
391  * NOTE: You can only use this function if you do NOT use
392  *       info->driver_data! Use info->rate_driver_data
393  *       instead if you need only the less space that allows.
394  */
395 static inline void
396 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
397 {
398         int i;
399
400         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
401                      offsetof(struct ieee80211_tx_info, control.rates));
402         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
403                      offsetof(struct ieee80211_tx_info, driver_rates));
404         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
405         /* clear the rate counts */
406         for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
407                 info->status.rates[i].count = 0;
408
409         BUILD_BUG_ON(
410             offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
411         memset(&info->status.ampdu_ack_len, 0,
412                sizeof(struct ieee80211_tx_info) -
413                offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
414 }
415
416
417 /**
418  * enum mac80211_rx_flags - receive flags
419  *
420  * These flags are used with the @flag member of &struct ieee80211_rx_status.
421  * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
422  *      Use together with %RX_FLAG_MMIC_STRIPPED.
423  * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
424  * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
425  * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
426  *      verification has been done by the hardware.
427  * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
428  *      If this flag is set, the stack cannot do any replay detection
429  *      hence the driver or hardware will have to do that.
430  * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
431  *      the frame.
432  * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
433  *      the frame.
434  * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
435  *      is valid. This is useful in monitor mode and necessary for beacon frames
436  *      to enable IBSS merging.
437  * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
438  * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
439  * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
440  * @RX_FLAG_SHORT_GI: Short guard interval was used
441  */
442 enum mac80211_rx_flags {
443         RX_FLAG_MMIC_ERROR      = 1<<0,
444         RX_FLAG_DECRYPTED       = 1<<1,
445         RX_FLAG_RADIOTAP        = 1<<2,
446         RX_FLAG_MMIC_STRIPPED   = 1<<3,
447         RX_FLAG_IV_STRIPPED     = 1<<4,
448         RX_FLAG_FAILED_FCS_CRC  = 1<<5,
449         RX_FLAG_FAILED_PLCP_CRC = 1<<6,
450         RX_FLAG_TSFT            = 1<<7,
451         RX_FLAG_SHORTPRE        = 1<<8,
452         RX_FLAG_HT              = 1<<9,
453         RX_FLAG_40MHZ           = 1<<10,
454         RX_FLAG_SHORT_GI        = 1<<11,
455 };
456
457 /**
458  * struct ieee80211_rx_status - receive status
459  *
460  * The low-level driver should provide this information (the subset
461  * supported by hardware) to the 802.11 code with each received
462  * frame.
463  *
464  * @mactime: value in microseconds of the 64-bit Time Synchronization Function
465  *      (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
466  * @band: the active band when this frame was received
467  * @freq: frequency the radio was tuned to when receiving this frame, in MHz
468  * @signal: signal strength when receiving this frame, either in dBm, in dB or
469  *      unspecified depending on the hardware capabilities flags
470  *      @IEEE80211_HW_SIGNAL_*
471  * @noise: noise when receiving this frame, in dBm.
472  * @qual: overall signal quality indication, in percent (0-100).
473  * @antenna: antenna used
474  * @rate_idx: index of data rate into band's supported rates or MCS index if
475  *      HT rates are use (RX_FLAG_HT)
476  * @flag: %RX_FLAG_*
477  */
478 struct ieee80211_rx_status {
479         u64 mactime;
480         enum ieee80211_band band;
481         int freq;
482         int signal;
483         int noise;
484         int qual;
485         int antenna;
486         int rate_idx;
487         int flag;
488 };
489
490 /**
491  * enum ieee80211_conf_flags - configuration flags
492  *
493  * Flags to define PHY configuration options
494  *
495  * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
496  * @IEEE80211_CONF_PS: Enable 802.11 power save mode
497  */
498 enum ieee80211_conf_flags {
499         IEEE80211_CONF_RADIOTAP         = (1<<0),
500         IEEE80211_CONF_PS               = (1<<1),
501 };
502
503 /* XXX: remove all this once drivers stop trying to use it */
504 static inline int __deprecated __IEEE80211_CONF_SHORT_SLOT_TIME(void)
505 {
506         return 0;
507 }
508 #define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME())
509
510 /**
511  * enum ieee80211_conf_changed - denotes which configuration changed
512  *
513  * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
514  * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
515  * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
516  * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
517  * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
518  * @IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT: the dynamic PS timeout changed
519  * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
520  * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
521  * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
522  */
523 enum ieee80211_conf_changed {
524         IEEE80211_CONF_CHANGE_RADIO_ENABLED     = BIT(0),
525         IEEE80211_CONF_CHANGE_BEACON_INTERVAL   = BIT(1),
526         IEEE80211_CONF_CHANGE_LISTEN_INTERVAL   = BIT(2),
527         IEEE80211_CONF_CHANGE_RADIOTAP          = BIT(3),
528         IEEE80211_CONF_CHANGE_PS                = BIT(4),
529         IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT     = BIT(5),
530         IEEE80211_CONF_CHANGE_POWER             = BIT(6),
531         IEEE80211_CONF_CHANGE_CHANNEL           = BIT(7),
532         IEEE80211_CONF_CHANGE_RETRY_LIMITS      = BIT(8),
533 };
534
535 /**
536  * struct ieee80211_conf - configuration of the device
537  *
538  * This struct indicates how the driver shall configure the hardware.
539  *
540  * @radio_enabled: when zero, driver is required to switch off the radio.
541  * @beacon_int: beacon interval (TODO make interface config)
542  * @listen_interval: listen interval in units of beacon interval
543  * @flags: configuration flags defined above
544  * @power_level: requested transmit power (in dBm)
545  * @dynamic_ps_timeout: dynamic powersave timeout (in ms)
546  * @channel: the channel to tune to
547  * @channel_type: the channel (HT) type
548  * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
549  *    (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
550  *    but actually means the number of transmissions not the number of retries
551  * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
552  *    frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
553  *    number of transmissions not the number of retries
554  */
555 struct ieee80211_conf {
556         int beacon_int;
557         u32 flags;
558         int power_level, dynamic_ps_timeout;
559
560         u16 listen_interval;
561         bool radio_enabled;
562
563         u8 long_frame_max_tx_count, short_frame_max_tx_count;
564
565         struct ieee80211_channel *channel;
566         enum nl80211_channel_type channel_type;
567 };
568
569 /**
570  * struct ieee80211_vif - per-interface data
571  *
572  * Data in this structure is continually present for driver
573  * use during the life of a virtual interface.
574  *
575  * @type: type of this virtual interface
576  * @bss_conf: BSS configuration for this interface, either our own
577  *      or the BSS we're associated to
578  * @drv_priv: data area for driver use, will always be aligned to
579  *      sizeof(void *).
580  */
581 struct ieee80211_vif {
582         enum nl80211_iftype type;
583         struct ieee80211_bss_conf bss_conf;
584         /* must be last */
585         u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
586 };
587
588 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
589 {
590 #ifdef CONFIG_MAC80211_MESH
591         return vif->type == NL80211_IFTYPE_MESH_POINT;
592 #endif
593         return false;
594 }
595
596 /**
597  * struct ieee80211_if_init_conf - initial configuration of an interface
598  *
599  * @vif: pointer to a driver-use per-interface structure. The pointer
600  *      itself is also used for various functions including
601  *      ieee80211_beacon_get() and ieee80211_get_buffered_bc().
602  * @type: one of &enum nl80211_iftype constants. Determines the type of
603  *      added/removed interface.
604  * @mac_addr: pointer to MAC address of the interface. This pointer is valid
605  *      until the interface is removed (i.e. it cannot be used after
606  *      remove_interface() callback was called for this interface).
607  *
608  * This structure is used in add_interface() and remove_interface()
609  * callbacks of &struct ieee80211_hw.
610  *
611  * When you allow multiple interfaces to be added to your PHY, take care
612  * that the hardware can actually handle multiple MAC addresses. However,
613  * also take care that when there's no interface left with mac_addr != %NULL
614  * you remove the MAC address from the device to avoid acknowledging packets
615  * in pure monitor mode.
616  */
617 struct ieee80211_if_init_conf {
618         enum nl80211_iftype type;
619         struct ieee80211_vif *vif;
620         void *mac_addr;
621 };
622
623 /**
624  * enum ieee80211_if_conf_change - interface config change flags
625  *
626  * @IEEE80211_IFCC_BSSID: The BSSID changed.
627  * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
628  *      (currently AP and MESH only), use ieee80211_beacon_get().
629  */
630 enum ieee80211_if_conf_change {
631         IEEE80211_IFCC_BSSID    = BIT(0),
632         IEEE80211_IFCC_BEACON   = BIT(1),
633 };
634
635 /**
636  * struct ieee80211_if_conf - configuration of an interface
637  *
638  * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
639  * @bssid: BSSID of the network we are associated to/creating.
640  *
641  * This structure is passed to the config_interface() callback of
642  * &struct ieee80211_hw.
643  */
644 struct ieee80211_if_conf {
645         u32 changed;
646         u8 *bssid;
647 };
648
649 /**
650  * enum ieee80211_key_alg - key algorithm
651  * @ALG_WEP: WEP40 or WEP104
652  * @ALG_TKIP: TKIP
653  * @ALG_CCMP: CCMP (AES)
654  */
655 enum ieee80211_key_alg {
656         ALG_WEP,
657         ALG_TKIP,
658         ALG_CCMP,
659 };
660
661 /**
662  * enum ieee80211_key_len - key length
663  * @LEN_WEP40: WEP 5-byte long key
664  * @LEN_WEP104: WEP 13-byte long key
665  */
666 enum ieee80211_key_len {
667         LEN_WEP40 = 5,
668         LEN_WEP104 = 13,
669 };
670
671 /**
672  * enum ieee80211_key_flags - key flags
673  *
674  * These flags are used for communication about keys between the driver
675  * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
676  *
677  * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
678  *      that the STA this key will be used with could be using QoS.
679  * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
680  *      driver to indicate that it requires IV generation for this
681  *      particular key.
682  * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
683  *      the driver for a TKIP key if it requires Michael MIC
684  *      generation in software.
685  * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
686  *      that the key is pairwise rather then a shared key.
687  */
688 enum ieee80211_key_flags {
689         IEEE80211_KEY_FLAG_WMM_STA      = 1<<0,
690         IEEE80211_KEY_FLAG_GENERATE_IV  = 1<<1,
691         IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
692         IEEE80211_KEY_FLAG_PAIRWISE     = 1<<3,
693 };
694
695 /**
696  * struct ieee80211_key_conf - key information
697  *
698  * This key information is given by mac80211 to the driver by
699  * the set_key() callback in &struct ieee80211_ops.
700  *
701  * @hw_key_idx: To be set by the driver, this is the key index the driver
702  *      wants to be given when a frame is transmitted and needs to be
703  *      encrypted in hardware.
704  * @alg: The key algorithm.
705  * @flags: key flags, see &enum ieee80211_key_flags.
706  * @keyidx: the key index (0-3)
707  * @keylen: key material length
708  * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
709  *      data block:
710  *      - Temporal Encryption Key (128 bits)
711  *      - Temporal Authenticator Tx MIC Key (64 bits)
712  *      - Temporal Authenticator Rx MIC Key (64 bits)
713  * @icv_len: The ICV length for this key type
714  * @iv_len: The IV length for this key type
715  */
716 struct ieee80211_key_conf {
717         enum ieee80211_key_alg alg;
718         u8 icv_len;
719         u8 iv_len;
720         u8 hw_key_idx;
721         u8 flags;
722         s8 keyidx;
723         u8 keylen;
724         u8 key[0];
725 };
726
727 /**
728  * enum set_key_cmd - key command
729  *
730  * Used with the set_key() callback in &struct ieee80211_ops, this
731  * indicates whether a key is being removed or added.
732  *
733  * @SET_KEY: a key is set
734  * @DISABLE_KEY: a key must be disabled
735  */
736 enum set_key_cmd {
737         SET_KEY, DISABLE_KEY,
738 };
739
740 /**
741  * struct ieee80211_sta - station table entry
742  *
743  * A station table entry represents a station we are possibly
744  * communicating with. Since stations are RCU-managed in
745  * mac80211, any ieee80211_sta pointer you get access to must
746  * either be protected by rcu_read_lock() explicitly or implicitly,
747  * or you must take good care to not use such a pointer after a
748  * call to your sta_notify callback that removed it.
749  *
750  * @addr: MAC address
751  * @aid: AID we assigned to the station if we're an AP
752  * @supp_rates: Bitmap of supported rates (per band)
753  * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
754  * @drv_priv: data area for driver use, will always be aligned to
755  *      sizeof(void *), size is determined in hw information.
756  */
757 struct ieee80211_sta {
758         u64 supp_rates[IEEE80211_NUM_BANDS];
759         u8 addr[ETH_ALEN];
760         u16 aid;
761         struct ieee80211_sta_ht_cap ht_cap;
762
763         /* must be last */
764         u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
765 };
766
767 /**
768  * enum sta_notify_cmd - sta notify command
769  *
770  * Used with the sta_notify() callback in &struct ieee80211_ops, this
771  * indicates addition and removal of a station to station table,
772  * or if a associated station made a power state transition.
773  *
774  * @STA_NOTIFY_ADD: a station was added to the station table
775  * @STA_NOTIFY_REMOVE: a station being removed from the station table
776  * @STA_NOTIFY_SLEEP: a station is now sleeping
777  * @STA_NOTIFY_AWAKE: a sleeping station woke up
778  */
779 enum sta_notify_cmd {
780         STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
781         STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
782 };
783
784 /**
785  * enum ieee80211_tkip_key_type - get tkip key
786  *
787  * Used by drivers which need to get a tkip key for skb. Some drivers need a
788  * phase 1 key, others need a phase 2 key. A single function allows the driver
789  * to get the key, this enum indicates what type of key is required.
790  *
791  * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
792  * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
793  */
794 enum ieee80211_tkip_key_type {
795         IEEE80211_TKIP_P1_KEY,
796         IEEE80211_TKIP_P2_KEY,
797 };
798
799 /**
800  * enum ieee80211_hw_flags - hardware flags
801  *
802  * These flags are used to indicate hardware capabilities to
803  * the stack. Generally, flags here should have their meaning
804  * done in a way that the simplest hardware doesn't need setting
805  * any particular flags. There are some exceptions to this rule,
806  * however, so you are advised to review these flags carefully.
807  *
808  * @IEEE80211_HW_RX_INCLUDES_FCS:
809  *      Indicates that received frames passed to the stack include
810  *      the FCS at the end.
811  *
812  * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
813  *      Some wireless LAN chipsets buffer broadcast/multicast frames
814  *      for power saving stations in the hardware/firmware and others
815  *      rely on the host system for such buffering. This option is used
816  *      to configure the IEEE 802.11 upper layer to buffer broadcast and
817  *      multicast frames when there are power saving stations so that
818  *      the driver can fetch them with ieee80211_get_buffered_bc().
819  *
820  * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
821  *      Hardware is not capable of short slot operation on the 2.4 GHz band.
822  *
823  * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
824  *      Hardware is not capable of receiving frames with short preamble on
825  *      the 2.4 GHz band.
826  *
827  * @IEEE80211_HW_SIGNAL_UNSPEC:
828  *      Hardware can provide signal values but we don't know its units. We
829  *      expect values between 0 and @max_signal.
830  *      If possible please provide dB or dBm instead.
831  *
832  * @IEEE80211_HW_SIGNAL_DB:
833  *      Hardware gives signal values in dB, decibel difference from an
834  *      arbitrary, fixed reference. We expect values between 0 and @max_signal.
835  *      If possible please provide dBm instead.
836  *
837  * @IEEE80211_HW_SIGNAL_DBM:
838  *      Hardware gives signal values in dBm, decibel difference from
839  *      one milliwatt. This is the preferred method since it is standardized
840  *      between different devices. @max_signal does not need to be set.
841  *
842  * @IEEE80211_HW_NOISE_DBM:
843  *      Hardware can provide noise (radio interference) values in units dBm,
844  *      decibel difference from one milliwatt.
845  *
846  * @IEEE80211_HW_SPECTRUM_MGMT:
847  *      Hardware supports spectrum management defined in 802.11h
848  *      Measurement, Channel Switch, Quieting, TPC
849  *
850  * @IEEE80211_HW_AMPDU_AGGREGATION:
851  *      Hardware supports 11n A-MPDU aggregation.
852  *
853  * @IEEE80211_HW_SUPPORTS_PS:
854  *      Hardware has power save support (i.e. can go to sleep).
855  *
856  * @IEEE80211_HW_PS_NULLFUNC_STACK:
857  *      Hardware requires nullfunc frame handling in stack, implies
858  *      stack support for dynamic PS.
859  *
860  * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
861  *      Hardware has support for dynamic PS.
862  */
863 enum ieee80211_hw_flags {
864         IEEE80211_HW_RX_INCLUDES_FCS                    = 1<<1,
865         IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING        = 1<<2,
866         IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE          = 1<<3,
867         IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE      = 1<<4,
868         IEEE80211_HW_SIGNAL_UNSPEC                      = 1<<5,
869         IEEE80211_HW_SIGNAL_DB                          = 1<<6,
870         IEEE80211_HW_SIGNAL_DBM                         = 1<<7,
871         IEEE80211_HW_NOISE_DBM                          = 1<<8,
872         IEEE80211_HW_SPECTRUM_MGMT                      = 1<<9,
873         IEEE80211_HW_AMPDU_AGGREGATION                  = 1<<10,
874         IEEE80211_HW_SUPPORTS_PS                        = 1<<11,
875         IEEE80211_HW_PS_NULLFUNC_STACK                  = 1<<12,
876         IEEE80211_HW_SUPPORTS_DYNAMIC_PS                = 1<<13,
877 };
878
879 /**
880  * struct ieee80211_hw - hardware information and state
881  *
882  * This structure contains the configuration and hardware
883  * information for an 802.11 PHY.
884  *
885  * @wiphy: This points to the &struct wiphy allocated for this
886  *      802.11 PHY. You must fill in the @perm_addr and @dev
887  *      members of this structure using SET_IEEE80211_DEV()
888  *      and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
889  *      bands (with channels, bitrates) are registered here.
890  *
891  * @conf: &struct ieee80211_conf, device configuration, don't use.
892  *
893  * @workqueue: single threaded workqueue available for driver use,
894  *      allocated by mac80211 on registration and flushed when an
895  *      interface is removed.
896  *      NOTICE: All work performed on this workqueue should NEVER
897  *      acquire the RTNL lock (i.e. Don't use the function
898  *      ieee80211_iterate_active_interfaces())
899  *
900  * @priv: pointer to private area that was allocated for driver use
901  *      along with this structure.
902  *
903  * @flags: hardware flags, see &enum ieee80211_hw_flags.
904  *
905  * @extra_tx_headroom: headroom to reserve in each transmit skb
906  *      for use by the driver (e.g. for transmit headers.)
907  *
908  * @channel_change_time: time (in microseconds) it takes to change channels.
909  *
910  * @max_signal: Maximum value for signal (rssi) in RX information, used
911  *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
912  *
913  * @max_listen_interval: max listen interval in units of beacon interval
914  *     that HW supports
915  *
916  * @queues: number of available hardware transmit queues for
917  *      data packets. WMM/QoS requires at least four, these
918  *      queues need to have configurable access parameters.
919  *
920  * @ampdu_queues: number of available hardware transmit queues
921  *      for A-MPDU packets, these have no access parameters
922  *      because they're used only for A-MPDU frames. Note that
923  *      mac80211 will not currently use any of the regular queues
924  *      for aggregation.
925  *
926  * @rate_control_algorithm: rate control algorithm for this hardware.
927  *      If unset (NULL), the default algorithm will be used. Must be
928  *      set before calling ieee80211_register_hw().
929  *
930  * @vif_data_size: size (in bytes) of the drv_priv data area
931  *      within &struct ieee80211_vif.
932  * @sta_data_size: size (in bytes) of the drv_priv data area
933  *      within &struct ieee80211_sta.
934  *
935  * @max_rates: maximum number of alternate rate retry stages
936  * @max_rate_tries: maximum number of tries for each stage
937  */
938 struct ieee80211_hw {
939         struct ieee80211_conf conf;
940         struct wiphy *wiphy;
941         struct workqueue_struct *workqueue;
942         const char *rate_control_algorithm;
943         void *priv;
944         u32 flags;
945         unsigned int extra_tx_headroom;
946         int channel_change_time;
947         int vif_data_size;
948         int sta_data_size;
949         u16 queues;
950         u16 ampdu_queues;
951         u16 max_listen_interval;
952         s8 max_signal;
953         u8 max_rates;
954         u8 max_rate_tries;
955 };
956
957 /**
958  * SET_IEEE80211_DEV - set device for 802.11 hardware
959  *
960  * @hw: the &struct ieee80211_hw to set the device for
961  * @dev: the &struct device of this 802.11 device
962  */
963 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
964 {
965         set_wiphy_dev(hw->wiphy, dev);
966 }
967
968 /**
969  * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
970  *
971  * @hw: the &struct ieee80211_hw to set the MAC address for
972  * @addr: the address to set
973  */
974 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
975 {
976         memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
977 }
978
979 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
980 {
981         return hw->queues;
982 }
983
984 static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
985 {
986         return hw->queues + hw->ampdu_queues;
987 }
988
989 static inline struct ieee80211_rate *
990 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
991                       const struct ieee80211_tx_info *c)
992 {
993         if (WARN_ON(c->control.rates[0].idx < 0))
994                 return NULL;
995         return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
996 }
997
998 static inline struct ieee80211_rate *
999 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1000                            const struct ieee80211_tx_info *c)
1001 {
1002         if (c->control.rts_cts_rate_idx < 0)
1003                 return NULL;
1004         return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1005 }
1006
1007 static inline struct ieee80211_rate *
1008 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1009                              const struct ieee80211_tx_info *c, int idx)
1010 {
1011         if (c->control.rates[idx + 1].idx < 0)
1012                 return NULL;
1013         return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1014 }
1015
1016 /**
1017  * DOC: Hardware crypto acceleration
1018  *
1019  * mac80211 is capable of taking advantage of many hardware
1020  * acceleration designs for encryption and decryption operations.
1021  *
1022  * The set_key() callback in the &struct ieee80211_ops for a given
1023  * device is called to enable hardware acceleration of encryption and
1024  * decryption. The callback takes a @sta parameter that will be NULL
1025  * for default keys or keys used for transmission only, or point to
1026  * the station information for the peer for individual keys.
1027  * Multiple transmission keys with the same key index may be used when
1028  * VLANs are configured for an access point.
1029  *
1030  * When transmitting, the TX control data will use the @hw_key_idx
1031  * selected by the driver by modifying the &struct ieee80211_key_conf
1032  * pointed to by the @key parameter to the set_key() function.
1033  *
1034  * The set_key() call for the %SET_KEY command should return 0 if
1035  * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1036  * added; if you return 0 then hw_key_idx must be assigned to the
1037  * hardware key index, you are free to use the full u8 range.
1038  *
1039  * When the cmd is %DISABLE_KEY then it must succeed.
1040  *
1041  * Note that it is permissible to not decrypt a frame even if a key
1042  * for it has been uploaded to hardware, the stack will not make any
1043  * decision based on whether a key has been uploaded or not but rather
1044  * based on the receive flags.
1045  *
1046  * The &struct ieee80211_key_conf structure pointed to by the @key
1047  * parameter is guaranteed to be valid until another call to set_key()
1048  * removes it, but it can only be used as a cookie to differentiate
1049  * keys.
1050  *
1051  * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1052  * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1053  * handler.
1054  * The update_tkip_key() call updates the driver with the new phase 1 key.
1055  * This happens everytime the iv16 wraps around (every 65536 packets). The
1056  * set_key() call will happen only once for each key (unless the AP did
1057  * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1058  * provided by update_tkip_key only. The trigger that makes mac80211 call this
1059  * handler is software decryption with wrap around of iv16.
1060  */
1061
1062 /**
1063  * DOC: Powersave support
1064  *
1065  * mac80211 has support for various powersave implementations.
1066  *
1067  * First, it can support hardware that handles all powersaving by
1068  * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1069  * hardware flag. In that case, it will be told about the desired
1070  * powersave mode depending on the association status, and the driver
1071  * must take care of sending nullfunc frames when necessary, i.e. when
1072  * entering and leaving powersave mode. The driver is required to look at
1073  * the AID in beacons and signal to the AP that it woke up when it finds
1074  * traffic directed to it. This mode supports dynamic PS by simply
1075  * enabling/disabling PS.
1076  *
1077  * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1078  * flag to indicate that it can support dynamic PS mode itself (see below).
1079  *
1080  * Other hardware designs cannot send nullfunc frames by themselves and also
1081  * need software support for parsing the TIM bitmap. This is also supported
1082  * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1083  * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1084  * required to pass up beacons. Additionally, in this case, mac80211 will
1085  * wake up the hardware when multicast traffic is announced in the beacon.
1086  *
1087  * FIXME: I don't think we can be fast enough in software when we want to
1088  *        receive multicast traffic?
1089  *
1090  * Dynamic powersave mode is an extension to normal powersave mode in which
1091  * the hardware stays awake for a user-specified period of time after sending
1092  * a frame so that reply frames need not be buffered and therefore delayed
1093  * to the next wakeup. This can either be supported by hardware, in which case
1094  * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1095  * value, or by the stack if all nullfunc handling is in the stack.
1096  */
1097
1098 /**
1099  * DOC: Frame filtering
1100  *
1101  * mac80211 requires to see many management frames for proper
1102  * operation, and users may want to see many more frames when
1103  * in monitor mode. However, for best CPU usage and power consumption,
1104  * having as few frames as possible percolate through the stack is
1105  * desirable. Hence, the hardware should filter as much as possible.
1106  *
1107  * To achieve this, mac80211 uses filter flags (see below) to tell
1108  * the driver's configure_filter() function which frames should be
1109  * passed to mac80211 and which should be filtered out.
1110  *
1111  * The configure_filter() callback is invoked with the parameters
1112  * @mc_count and @mc_list for the combined multicast address list
1113  * of all virtual interfaces, @changed_flags telling which flags
1114  * were changed and @total_flags with the new flag states.
1115  *
1116  * If your device has no multicast address filters your driver will
1117  * need to check both the %FIF_ALLMULTI flag and the @mc_count
1118  * parameter to see whether multicast frames should be accepted
1119  * or dropped.
1120  *
1121  * All unsupported flags in @total_flags must be cleared.
1122  * Hardware does not support a flag if it is incapable of _passing_
1123  * the frame to the stack. Otherwise the driver must ignore
1124  * the flag, but not clear it.
1125  * You must _only_ clear the flag (announce no support for the
1126  * flag to mac80211) if you are not able to pass the packet type
1127  * to the stack (so the hardware always filters it).
1128  * So for example, you should clear @FIF_CONTROL, if your hardware
1129  * always filters control frames. If your hardware always passes
1130  * control frames to the kernel and is incapable of filtering them,
1131  * you do _not_ clear the @FIF_CONTROL flag.
1132  * This rule applies to all other FIF flags as well.
1133  */
1134
1135 /**
1136  * enum ieee80211_filter_flags - hardware filter flags
1137  *
1138  * These flags determine what the filter in hardware should be
1139  * programmed to let through and what should not be passed to the
1140  * stack. It is always safe to pass more frames than requested,
1141  * but this has negative impact on power consumption.
1142  *
1143  * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1144  *      think of the BSS as your network segment and then this corresponds
1145  *      to the regular ethernet device promiscuous mode.
1146  *
1147  * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1148  *      by the user or if the hardware is not capable of filtering by
1149  *      multicast address.
1150  *
1151  * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1152  *      %RX_FLAG_FAILED_FCS_CRC for them)
1153  *
1154  * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1155  *      the %RX_FLAG_FAILED_PLCP_CRC for them
1156  *
1157  * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1158  *      to the hardware that it should not filter beacons or probe responses
1159  *      by BSSID. Filtering them can greatly reduce the amount of processing
1160  *      mac80211 needs to do and the amount of CPU wakeups, so you should
1161  *      honour this flag if possible.
1162  *
1163  * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1164  *      only those addressed to this station
1165  *
1166  * @FIF_OTHER_BSS: pass frames destined to other BSSes
1167  */
1168 enum ieee80211_filter_flags {
1169         FIF_PROMISC_IN_BSS      = 1<<0,
1170         FIF_ALLMULTI            = 1<<1,
1171         FIF_FCSFAIL             = 1<<2,
1172         FIF_PLCPFAIL            = 1<<3,
1173         FIF_BCN_PRBRESP_PROMISC = 1<<4,
1174         FIF_CONTROL             = 1<<5,
1175         FIF_OTHER_BSS           = 1<<6,
1176 };
1177
1178 /**
1179  * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1180  *
1181  * These flags are used with the ampdu_action() callback in
1182  * &struct ieee80211_ops to indicate which action is needed.
1183  * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1184  * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1185  * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1186  * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1187  * @IEEE80211_AMPDU_TX_RESUME: resume TX aggregation
1188  */
1189 enum ieee80211_ampdu_mlme_action {
1190         IEEE80211_AMPDU_RX_START,
1191         IEEE80211_AMPDU_RX_STOP,
1192         IEEE80211_AMPDU_TX_START,
1193         IEEE80211_AMPDU_TX_STOP,
1194         IEEE80211_AMPDU_TX_RESUME,
1195 };
1196
1197 /**
1198  * struct ieee80211_ops - callbacks from mac80211 to the driver
1199  *
1200  * This structure contains various callbacks that the driver may
1201  * handle or, in some cases, must handle, for example to configure
1202  * the hardware to a new channel or to transmit a frame.
1203  *
1204  * @tx: Handler that 802.11 module calls for each transmitted frame.
1205  *      skb contains the buffer starting from the IEEE 802.11 header.
1206  *      The low-level driver should send the frame out based on
1207  *      configuration in the TX control data. This handler should,
1208  *      preferably, never fail and stop queues appropriately, more
1209  *      importantly, however, it must never fail for A-MPDU-queues.
1210  *      Must be implemented and atomic.
1211  *
1212  * @start: Called before the first netdevice attached to the hardware
1213  *      is enabled. This should turn on the hardware and must turn on
1214  *      frame reception (for possibly enabled monitor interfaces.)
1215  *      Returns negative error codes, these may be seen in userspace,
1216  *      or zero.
1217  *      When the device is started it should not have a MAC address
1218  *      to avoid acknowledging frames before a non-monitor device
1219  *      is added.
1220  *      Must be implemented.
1221  *
1222  * @stop: Called after last netdevice attached to the hardware
1223  *      is disabled. This should turn off the hardware (at least
1224  *      it must turn off frame reception.)
1225  *      May be called right after add_interface if that rejects
1226  *      an interface.
1227  *      Must be implemented.
1228  *
1229  * @add_interface: Called when a netdevice attached to the hardware is
1230  *      enabled. Because it is not called for monitor mode devices, @start
1231  *      and @stop must be implemented.
1232  *      The driver should perform any initialization it needs before
1233  *      the device can be enabled. The initial configuration for the
1234  *      interface is given in the conf parameter.
1235  *      The callback may refuse to add an interface by returning a
1236  *      negative error code (which will be seen in userspace.)
1237  *      Must be implemented.
1238  *
1239  * @remove_interface: Notifies a driver that an interface is going down.
1240  *      The @stop callback is called after this if it is the last interface
1241  *      and no monitor interfaces are present.
1242  *      When all interfaces are removed, the MAC address in the hardware
1243  *      must be cleared so the device no longer acknowledges packets,
1244  *      the mac_addr member of the conf structure is, however, set to the
1245  *      MAC address of the device going away.
1246  *      Hence, this callback must be implemented.
1247  *
1248  * @config: Handler for configuration requests. IEEE 802.11 code calls this
1249  *      function to change hardware configuration, e.g., channel.
1250  *
1251  * @config_interface: Handler for configuration requests related to interfaces
1252  *      (e.g. BSSID changes.)
1253  *
1254  * @bss_info_changed: Handler for configuration requests related to BSS
1255  *      parameters that may vary during BSS's lifespan, and may affect low
1256  *      level driver (e.g. assoc/disassoc status, erp parameters).
1257  *      This function should not be used if no BSS has been set, unless
1258  *      for association indication. The @changed parameter indicates which
1259  *      of the bss parameters has changed when a call is made.
1260  *
1261  * @configure_filter: Configure the device's RX filter.
1262  *      See the section "Frame filtering" for more information.
1263  *      This callback must be implemented and atomic.
1264  *
1265  * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1266  *      must be set or cleared for a given STA. Must be atomic.
1267  *
1268  * @set_key: See the section "Hardware crypto acceleration"
1269  *      This callback can sleep, and is only called between add_interface
1270  *      and remove_interface calls, i.e. while the given virtual interface
1271  *      is enabled.
1272  *
1273  * @update_tkip_key: See the section "Hardware crypto acceleration"
1274  *      This callback will be called in the context of Rx. Called for drivers
1275  *      which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1276  *
1277  * @hw_scan: Ask the hardware to service the scan request, no need to start
1278  *      the scan state machine in stack. The scan must honour the channel
1279  *      configuration done by the regulatory agent in the wiphy's registered
1280  *      bands. When the scan finishes, ieee80211_scan_completed() must be
1281  *      called; note that it also must be called when the scan cannot finish
1282  *      because the hardware is turned off! Anything else is a bug!
1283  *
1284  * @get_stats: return low-level statistics
1285  *
1286  * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1287  *      callback should be provided to read the TKIP transmit IVs (both IV32
1288  *      and IV16) for the given key from hardware.
1289  *
1290  * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1291  *
1292  * @sta_notify: Notifies low level driver about addition, removal or power
1293  *      state transition of an associated station, AP,  IBSS/WDS/mesh peer etc.
1294  *      Must be atomic.
1295  *
1296  * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1297  *      bursting) for a hardware TX queue.
1298  *
1299  * @get_tx_stats: Get statistics of the current TX queue status. This is used
1300  *      to get number of currently queued packets (queue length), maximum queue
1301  *      size (limit), and total number of packets sent using each TX queue
1302  *      (count). The 'stats' pointer points to an array that has hw->queues +
1303  *      hw->ampdu_queues items.
1304  *
1305  * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1306  *      this is only used for IBSS mode debugging and, as such, is not a
1307  *      required function. Must be atomic.
1308  *
1309  * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1310  *      with other STAs in the IBSS. This is only used in IBSS mode. This
1311  *      function is optional if the firmware/hardware takes full care of
1312  *      TSF synchronization.
1313  *
1314  * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1315  *      This is needed only for IBSS mode and the result of this function is
1316  *      used to determine whether to reply to Probe Requests.
1317  *
1318  * @ampdu_action: Perform a certain A-MPDU action
1319  *      The RA/TID combination determines the destination and TID we want
1320  *      the ampdu action to be performed for. The action is defined through
1321  *      ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1322  *      is the first frame we expect to perform the action on. notice
1323  *      that TX/RX_STOP can pass NULL for this parameter.
1324  */
1325 struct ieee80211_ops {
1326         int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1327         int (*start)(struct ieee80211_hw *hw);
1328         void (*stop)(struct ieee80211_hw *hw);
1329         int (*add_interface)(struct ieee80211_hw *hw,
1330                              struct ieee80211_if_init_conf *conf);
1331         void (*remove_interface)(struct ieee80211_hw *hw,
1332                                  struct ieee80211_if_init_conf *conf);
1333         int (*config)(struct ieee80211_hw *hw, u32 changed);
1334         int (*config_interface)(struct ieee80211_hw *hw,
1335                                 struct ieee80211_vif *vif,
1336                                 struct ieee80211_if_conf *conf);
1337         void (*bss_info_changed)(struct ieee80211_hw *hw,
1338                                  struct ieee80211_vif *vif,
1339                                  struct ieee80211_bss_conf *info,
1340                                  u32 changed);
1341         void (*configure_filter)(struct ieee80211_hw *hw,
1342                                  unsigned int changed_flags,
1343                                  unsigned int *total_flags,
1344                                  int mc_count, struct dev_addr_list *mc_list);
1345         int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1346                        bool set);
1347         int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1348                        struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1349                        struct ieee80211_key_conf *key);
1350         void (*update_tkip_key)(struct ieee80211_hw *hw,
1351                         struct ieee80211_key_conf *conf, const u8 *address,
1352                         u32 iv32, u16 *phase1key);
1353         int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1354         int (*get_stats)(struct ieee80211_hw *hw,
1355                          struct ieee80211_low_level_stats *stats);
1356         void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1357                              u32 *iv32, u16 *iv16);
1358         int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1359         void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1360                         enum sta_notify_cmd, struct ieee80211_sta *sta);
1361         int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1362                        const struct ieee80211_tx_queue_params *params);
1363         int (*get_tx_stats)(struct ieee80211_hw *hw,
1364                             struct ieee80211_tx_queue_stats *stats);
1365         u64 (*get_tsf)(struct ieee80211_hw *hw);
1366         void (*reset_tsf)(struct ieee80211_hw *hw);
1367         int (*tx_last_beacon)(struct ieee80211_hw *hw);
1368         int (*ampdu_action)(struct ieee80211_hw *hw,
1369                             enum ieee80211_ampdu_mlme_action action,
1370                             struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1371 };
1372
1373 /**
1374  * ieee80211_alloc_hw -  Allocate a new hardware device
1375  *
1376  * This must be called once for each hardware device. The returned pointer
1377  * must be used to refer to this device when calling other functions.
1378  * mac80211 allocates a private data area for the driver pointed to by
1379  * @priv in &struct ieee80211_hw, the size of this area is given as
1380  * @priv_data_len.
1381  *
1382  * @priv_data_len: length of private data
1383  * @ops: callbacks for this device
1384  */
1385 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1386                                         const struct ieee80211_ops *ops);
1387
1388 /**
1389  * ieee80211_register_hw - Register hardware device
1390  *
1391  * You must call this function before any other functions in
1392  * mac80211. Note that before a hardware can be registered, you
1393  * need to fill the contained wiphy's information.
1394  *
1395  * @hw: the device to register as returned by ieee80211_alloc_hw()
1396  */
1397 int ieee80211_register_hw(struct ieee80211_hw *hw);
1398
1399 #ifdef CONFIG_MAC80211_LEDS
1400 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1401 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1402 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1403 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1404 #endif
1405 /**
1406  * ieee80211_get_tx_led_name - get name of TX LED
1407  *
1408  * mac80211 creates a transmit LED trigger for each wireless hardware
1409  * that can be used to drive LEDs if your driver registers a LED device.
1410  * This function returns the name (or %NULL if not configured for LEDs)
1411  * of the trigger so you can automatically link the LED device.
1412  *
1413  * @hw: the hardware to get the LED trigger name for
1414  */
1415 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1416 {
1417 #ifdef CONFIG_MAC80211_LEDS
1418         return __ieee80211_get_tx_led_name(hw);
1419 #else
1420         return NULL;
1421 #endif
1422 }
1423
1424 /**
1425  * ieee80211_get_rx_led_name - get name of RX LED
1426  *
1427  * mac80211 creates a receive LED trigger for each wireless hardware
1428  * that can be used to drive LEDs if your driver registers a LED device.
1429  * This function returns the name (or %NULL if not configured for LEDs)
1430  * of the trigger so you can automatically link the LED device.
1431  *
1432  * @hw: the hardware to get the LED trigger name for
1433  */
1434 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1435 {
1436 #ifdef CONFIG_MAC80211_LEDS
1437         return __ieee80211_get_rx_led_name(hw);
1438 #else
1439         return NULL;
1440 #endif
1441 }
1442
1443 /**
1444  * ieee80211_get_assoc_led_name - get name of association LED
1445  *
1446  * mac80211 creates a association LED trigger for each wireless hardware
1447  * that can be used to drive LEDs if your driver registers a LED device.
1448  * This function returns the name (or %NULL if not configured for LEDs)
1449  * of the trigger so you can automatically link the LED device.
1450  *
1451  * @hw: the hardware to get the LED trigger name for
1452  */
1453 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1454 {
1455 #ifdef CONFIG_MAC80211_LEDS
1456         return __ieee80211_get_assoc_led_name(hw);
1457 #else
1458         return NULL;
1459 #endif
1460 }
1461
1462 /**
1463  * ieee80211_get_radio_led_name - get name of radio LED
1464  *
1465  * mac80211 creates a radio change LED trigger for each wireless hardware
1466  * that can be used to drive LEDs if your driver registers a LED device.
1467  * This function returns the name (or %NULL if not configured for LEDs)
1468  * of the trigger so you can automatically link the LED device.
1469  *
1470  * @hw: the hardware to get the LED trigger name for
1471  */
1472 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1473 {
1474 #ifdef CONFIG_MAC80211_LEDS
1475         return __ieee80211_get_radio_led_name(hw);
1476 #else
1477         return NULL;
1478 #endif
1479 }
1480
1481 /**
1482  * ieee80211_unregister_hw - Unregister a hardware device
1483  *
1484  * This function instructs mac80211 to free allocated resources
1485  * and unregister netdevices from the networking subsystem.
1486  *
1487  * @hw: the hardware to unregister
1488  */
1489 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1490
1491 /**
1492  * ieee80211_free_hw - free hardware descriptor
1493  *
1494  * This function frees everything that was allocated, including the
1495  * private data for the driver. You must call ieee80211_unregister_hw()
1496  * before calling this function.
1497  *
1498  * @hw: the hardware to free
1499  */
1500 void ieee80211_free_hw(struct ieee80211_hw *hw);
1501
1502 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1503 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1504                     struct ieee80211_rx_status *status);
1505
1506 /**
1507  * ieee80211_rx - receive frame
1508  *
1509  * Use this function to hand received frames to mac80211. The receive
1510  * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1511  * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1512  *
1513  * This function may not be called in IRQ context. Calls to this function
1514  * for a single hardware must be synchronized against each other. Calls
1515  * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1516  * single hardware.
1517  *
1518  * @hw: the hardware this frame came in on
1519  * @skb: the buffer to receive, owned by mac80211 after this call
1520  * @status: status of this frame; the status pointer need not be valid
1521  *      after this function returns
1522  */
1523 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1524                                 struct ieee80211_rx_status *status)
1525 {
1526         __ieee80211_rx(hw, skb, status);
1527 }
1528
1529 /**
1530  * ieee80211_rx_irqsafe - receive frame
1531  *
1532  * Like ieee80211_rx() but can be called in IRQ context
1533  * (internally defers to a tasklet.)
1534  *
1535  * Calls to this function and ieee80211_rx() may not be mixed for a
1536  * single hardware.
1537  *
1538  * @hw: the hardware this frame came in on
1539  * @skb: the buffer to receive, owned by mac80211 after this call
1540  * @status: status of this frame; the status pointer need not be valid
1541  *      after this function returns and is not freed by mac80211,
1542  *      it is recommended that it points to a stack area
1543  */
1544 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1545                           struct sk_buff *skb,
1546                           struct ieee80211_rx_status *status);
1547
1548 /**
1549  * ieee80211_tx_status - transmit status callback
1550  *
1551  * Call this function for all transmitted frames after they have been
1552  * transmitted. It is permissible to not call this function for
1553  * multicast frames but this can affect statistics.
1554  *
1555  * This function may not be called in IRQ context. Calls to this function
1556  * for a single hardware must be synchronized against each other. Calls
1557  * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1558  * for a single hardware.
1559  *
1560  * @hw: the hardware the frame was transmitted by
1561  * @skb: the frame that was transmitted, owned by mac80211 after this call
1562  */
1563 void ieee80211_tx_status(struct ieee80211_hw *hw,
1564                          struct sk_buff *skb);
1565
1566 /**
1567  * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1568  *
1569  * Like ieee80211_tx_status() but can be called in IRQ context
1570  * (internally defers to a tasklet.)
1571  *
1572  * Calls to this function and ieee80211_tx_status() may not be mixed for a
1573  * single hardware.
1574  *
1575  * @hw: the hardware the frame was transmitted by
1576  * @skb: the frame that was transmitted, owned by mac80211 after this call
1577  */
1578 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1579                                  struct sk_buff *skb);
1580
1581 /**
1582  * ieee80211_beacon_get - beacon generation function
1583  * @hw: pointer obtained from ieee80211_alloc_hw().
1584  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1585  *
1586  * If the beacon frames are generated by the host system (i.e., not in
1587  * hardware/firmware), the low-level driver uses this function to receive
1588  * the next beacon frame from the 802.11 code. The low-level is responsible
1589  * for calling this function before beacon data is needed (e.g., based on
1590  * hardware interrupt). Returned skb is used only once and low-level driver
1591  * is responsible for freeing it.
1592  */
1593 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1594                                      struct ieee80211_vif *vif);
1595
1596 /**
1597  * ieee80211_rts_get - RTS frame generation function
1598  * @hw: pointer obtained from ieee80211_alloc_hw().
1599  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1600  * @frame: pointer to the frame that is going to be protected by the RTS.
1601  * @frame_len: the frame length (in octets).
1602  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1603  * @rts: The buffer where to store the RTS frame.
1604  *
1605  * If the RTS frames are generated by the host system (i.e., not in
1606  * hardware/firmware), the low-level driver uses this function to receive
1607  * the next RTS frame from the 802.11 code. The low-level is responsible
1608  * for calling this function before and RTS frame is needed.
1609  */
1610 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1611                        const void *frame, size_t frame_len,
1612                        const struct ieee80211_tx_info *frame_txctl,
1613                        struct ieee80211_rts *rts);
1614
1615 /**
1616  * ieee80211_rts_duration - Get the duration field for an RTS frame
1617  * @hw: pointer obtained from ieee80211_alloc_hw().
1618  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1619  * @frame_len: the length of the frame that is going to be protected by the RTS.
1620  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1621  *
1622  * If the RTS is generated in firmware, but the host system must provide
1623  * the duration field, the low-level driver uses this function to receive
1624  * the duration field value in little-endian byteorder.
1625  */
1626 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1627                               struct ieee80211_vif *vif, size_t frame_len,
1628                               const struct ieee80211_tx_info *frame_txctl);
1629
1630 /**
1631  * ieee80211_ctstoself_get - CTS-to-self frame generation function
1632  * @hw: pointer obtained from ieee80211_alloc_hw().
1633  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1634  * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1635  * @frame_len: the frame length (in octets).
1636  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1637  * @cts: The buffer where to store the CTS-to-self frame.
1638  *
1639  * If the CTS-to-self frames are generated by the host system (i.e., not in
1640  * hardware/firmware), the low-level driver uses this function to receive
1641  * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1642  * for calling this function before and CTS-to-self frame is needed.
1643  */
1644 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1645                              struct ieee80211_vif *vif,
1646                              const void *frame, size_t frame_len,
1647                              const struct ieee80211_tx_info *frame_txctl,
1648                              struct ieee80211_cts *cts);
1649
1650 /**
1651  * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1652  * @hw: pointer obtained from ieee80211_alloc_hw().
1653  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1654  * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1655  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1656  *
1657  * If the CTS-to-self is generated in firmware, but the host system must provide
1658  * the duration field, the low-level driver uses this function to receive
1659  * the duration field value in little-endian byteorder.
1660  */
1661 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1662                                     struct ieee80211_vif *vif,
1663                                     size_t frame_len,
1664                                     const struct ieee80211_tx_info *frame_txctl);
1665
1666 /**
1667  * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1668  * @hw: pointer obtained from ieee80211_alloc_hw().
1669  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1670  * @frame_len: the length of the frame.
1671  * @rate: the rate at which the frame is going to be transmitted.
1672  *
1673  * Calculate the duration field of some generic frame, given its
1674  * length and transmission rate (in 100kbps).
1675  */
1676 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1677                                         struct ieee80211_vif *vif,
1678                                         size_t frame_len,
1679                                         struct ieee80211_rate *rate);
1680
1681 /**
1682  * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1683  * @hw: pointer as obtained from ieee80211_alloc_hw().
1684  * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1685  *
1686  * Function for accessing buffered broadcast and multicast frames. If
1687  * hardware/firmware does not implement buffering of broadcast/multicast
1688  * frames when power saving is used, 802.11 code buffers them in the host
1689  * memory. The low-level driver uses this function to fetch next buffered
1690  * frame. In most cases, this is used when generating beacon frame. This
1691  * function returns a pointer to the next buffered skb or NULL if no more
1692  * buffered frames are available.
1693  *
1694  * Note: buffered frames are returned only after DTIM beacon frame was
1695  * generated with ieee80211_beacon_get() and the low-level driver must thus
1696  * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1697  * NULL if the previous generated beacon was not DTIM, so the low-level driver
1698  * does not need to check for DTIM beacons separately and should be able to
1699  * use common code for all beacons.
1700  */
1701 struct sk_buff *
1702 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1703
1704 /**
1705  * ieee80211_get_hdrlen_from_skb - get header length from data
1706  *
1707  * Given an skb with a raw 802.11 header at the data pointer this function
1708  * returns the 802.11 header length in bytes (not including encryption
1709  * headers). If the data in the sk_buff is too short to contain a valid 802.11
1710  * header the function returns 0.
1711  *
1712  * @skb: the frame
1713  */
1714 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1715
1716 /**
1717  * ieee80211_hdrlen - get header length in bytes from frame control
1718  * @fc: frame control field in little-endian format
1719  */
1720 unsigned int ieee80211_hdrlen(__le16 fc);
1721
1722 /**
1723  * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1724  *
1725  * This function computes a TKIP rc4 key for an skb. It computes
1726  * a phase 1 key if needed (iv16 wraps around). This function is to
1727  * be used by drivers which can do HW encryption but need to compute
1728  * to phase 1/2 key in SW.
1729  *
1730  * @keyconf: the parameter passed with the set key
1731  * @skb: the skb for which the key is needed
1732  * @type: TBD
1733  * @key: a buffer to which the key will be written
1734  */
1735 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1736                                 struct sk_buff *skb,
1737                                 enum ieee80211_tkip_key_type type, u8 *key);
1738 /**
1739  * ieee80211_wake_queue - wake specific queue
1740  * @hw: pointer as obtained from ieee80211_alloc_hw().
1741  * @queue: queue number (counted from zero).
1742  *
1743  * Drivers should use this function instead of netif_wake_queue.
1744  */
1745 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1746
1747 /**
1748  * ieee80211_stop_queue - stop specific queue
1749  * @hw: pointer as obtained from ieee80211_alloc_hw().
1750  * @queue: queue number (counted from zero).
1751  *
1752  * Drivers should use this function instead of netif_stop_queue.
1753  */
1754 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1755
1756 /**
1757  * ieee80211_queue_stopped - test status of the queue
1758  * @hw: pointer as obtained from ieee80211_alloc_hw().
1759  * @queue: queue number (counted from zero).
1760  *
1761  * Drivers should use this function instead of netif_stop_queue.
1762  */
1763
1764 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1765
1766 /**
1767  * ieee80211_stop_queues - stop all queues
1768  * @hw: pointer as obtained from ieee80211_alloc_hw().
1769  *
1770  * Drivers should use this function instead of netif_stop_queue.
1771  */
1772 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1773
1774 /**
1775  * ieee80211_wake_queues - wake all queues
1776  * @hw: pointer as obtained from ieee80211_alloc_hw().
1777  *
1778  * Drivers should use this function instead of netif_wake_queue.
1779  */
1780 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1781
1782 /**
1783  * ieee80211_scan_completed - completed hardware scan
1784  *
1785  * When hardware scan offload is used (i.e. the hw_scan() callback is
1786  * assigned) this function needs to be called by the driver to notify
1787  * mac80211 that the scan finished.
1788  *
1789  * @hw: the hardware that finished the scan
1790  */
1791 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1792
1793 /**
1794  * ieee80211_iterate_active_interfaces - iterate active interfaces
1795  *
1796  * This function iterates over the interfaces associated with a given
1797  * hardware that are currently active and calls the callback for them.
1798  * This function allows the iterator function to sleep, when the iterator
1799  * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1800  * be used.
1801  *
1802  * @hw: the hardware struct of which the interfaces should be iterated over
1803  * @iterator: the iterator function to call
1804  * @data: first argument of the iterator function
1805  */
1806 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1807                                          void (*iterator)(void *data, u8 *mac,
1808                                                 struct ieee80211_vif *vif),
1809                                          void *data);
1810
1811 /**
1812  * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1813  *
1814  * This function iterates over the interfaces associated with a given
1815  * hardware that are currently active and calls the callback for them.
1816  * This function requires the iterator callback function to be atomic,
1817  * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1818  *
1819  * @hw: the hardware struct of which the interfaces should be iterated over
1820  * @iterator: the iterator function to call, cannot sleep
1821  * @data: first argument of the iterator function
1822  */
1823 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1824                                                 void (*iterator)(void *data,
1825                                                     u8 *mac,
1826                                                     struct ieee80211_vif *vif),
1827                                                 void *data);
1828
1829 /**
1830  * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1831  * @hw: pointer as obtained from ieee80211_alloc_hw().
1832  * @ra: receiver address of the BA session recipient
1833  * @tid: the TID to BA on.
1834  *
1835  * Return: success if addBA request was sent, failure otherwise
1836  *
1837  * Although mac80211/low level driver/user space application can estimate
1838  * the need to start aggregation on a certain RA/TID, the session level
1839  * will be managed by the mac80211.
1840  */
1841 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1842
1843 /**
1844  * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1845  * @hw: pointer as obtained from ieee80211_alloc_hw().
1846  * @ra: receiver address of the BA session recipient.
1847  * @tid: the TID to BA on.
1848  *
1849  * This function must be called by low level driver once it has
1850  * finished with preparations for the BA session.
1851  */
1852 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1853
1854 /**
1855  * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1856  * @hw: pointer as obtained from ieee80211_alloc_hw().
1857  * @ra: receiver address of the BA session recipient.
1858  * @tid: the TID to BA on.
1859  *
1860  * This function must be called by low level driver once it has
1861  * finished with preparations for the BA session.
1862  * This version of the function is IRQ-safe.
1863  */
1864 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1865                                       u16 tid);
1866
1867 /**
1868  * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1869  * @hw: pointer as obtained from ieee80211_alloc_hw().
1870  * @ra: receiver address of the BA session recipient
1871  * @tid: the TID to stop BA.
1872  * @initiator: if indicates initiator DELBA frame will be sent.
1873  *
1874  * Return: error if no sta with matching da found, success otherwise
1875  *
1876  * Although mac80211/low level driver/user space application can estimate
1877  * the need to stop aggregation on a certain RA/TID, the session level
1878  * will be managed by the mac80211.
1879  */
1880 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1881                                  u8 *ra, u16 tid,
1882                                  enum ieee80211_back_parties initiator);
1883
1884 /**
1885  * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1886  * @hw: pointer as obtained from ieee80211_alloc_hw().
1887  * @ra: receiver address of the BA session recipient.
1888  * @tid: the desired TID to BA on.
1889  *
1890  * This function must be called by low level driver once it has
1891  * finished with preparations for the BA session tear down.
1892  */
1893 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1894
1895 /**
1896  * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1897  * @hw: pointer as obtained from ieee80211_alloc_hw().
1898  * @ra: receiver address of the BA session recipient.
1899  * @tid: the desired TID to BA on.
1900  *
1901  * This function must be called by low level driver once it has
1902  * finished with preparations for the BA session tear down.
1903  * This version of the function is IRQ-safe.
1904  */
1905 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1906                                      u16 tid);
1907
1908 /**
1909  * ieee80211_find_sta - find a station
1910  *
1911  * @hw: pointer as obtained from ieee80211_alloc_hw()
1912  * @addr: station's address
1913  *
1914  * This function must be called under RCU lock and the
1915  * resulting pointer is only valid under RCU lock as well.
1916  */
1917 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
1918                                          const u8 *addr);
1919
1920
1921 /* Rate control API */
1922
1923 /**
1924  * struct ieee80211_tx_rate_control - rate control information for/from RC algo
1925  *
1926  * @hw: The hardware the algorithm is invoked for.
1927  * @sband: The band this frame is being transmitted on.
1928  * @bss_conf: the current BSS configuration
1929  * @reported_rate: The rate control algorithm can fill this in to indicate
1930  *      which rate should be reported to userspace as the current rate and
1931  *      used for rate calculations in the mesh network.
1932  * @rts: whether RTS will be used for this frame because it is longer than the
1933  *      RTS threshold
1934  * @short_preamble: whether mac80211 will request short-preamble transmission
1935  *      if the selected rate supports it
1936  * @max_rate_idx: user-requested maximum rate (not MCS for now)
1937  * @skb: the skb that will be transmitted, the control information in it needs
1938  *      to be filled in
1939  */
1940 struct ieee80211_tx_rate_control {
1941         struct ieee80211_hw *hw;
1942         struct ieee80211_supported_band *sband;
1943         struct ieee80211_bss_conf *bss_conf;
1944         struct sk_buff *skb;
1945         struct ieee80211_tx_rate reported_rate;
1946         bool rts, short_preamble;
1947         u8 max_rate_idx;
1948 };
1949
1950 struct rate_control_ops {
1951         struct module *module;
1952         const char *name;
1953         void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
1954         void (*free)(void *priv);
1955
1956         void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
1957         void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
1958                           struct ieee80211_sta *sta, void *priv_sta);
1959         void (*free_sta)(void *priv, struct ieee80211_sta *sta,
1960                          void *priv_sta);
1961
1962         void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
1963                           struct ieee80211_sta *sta, void *priv_sta,
1964                           struct sk_buff *skb);
1965         void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
1966                          struct ieee80211_tx_rate_control *txrc);
1967
1968         void (*add_sta_debugfs)(void *priv, void *priv_sta,
1969                                 struct dentry *dir);
1970         void (*remove_sta_debugfs)(void *priv, void *priv_sta);
1971 };
1972
1973 static inline int rate_supported(struct ieee80211_sta *sta,
1974                                  enum ieee80211_band band,
1975                                  int index)
1976 {
1977         return (sta == NULL || sta->supp_rates[band] & BIT(index));
1978 }
1979
1980 static inline s8
1981 rate_lowest_index(struct ieee80211_supported_band *sband,
1982                   struct ieee80211_sta *sta)
1983 {
1984         int i;
1985
1986         for (i = 0; i < sband->n_bitrates; i++)
1987                 if (rate_supported(sta, sband->band, i))
1988                         return i;
1989
1990         /* warn when we cannot find a rate. */
1991         WARN_ON(1);
1992
1993         return 0;
1994 }
1995
1996
1997 int ieee80211_rate_control_register(struct rate_control_ops *ops);
1998 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
1999
2000 static inline bool
2001 conf_is_ht20(struct ieee80211_conf *conf)
2002 {
2003         return conf->channel_type == NL80211_CHAN_HT20;
2004 }
2005
2006 static inline bool
2007 conf_is_ht40_minus(struct ieee80211_conf *conf)
2008 {
2009         return conf->channel_type == NL80211_CHAN_HT40MINUS;
2010 }
2011
2012 static inline bool
2013 conf_is_ht40_plus(struct ieee80211_conf *conf)
2014 {
2015         return conf->channel_type == NL80211_CHAN_HT40PLUS;
2016 }
2017
2018 static inline bool
2019 conf_is_ht40(struct ieee80211_conf *conf)
2020 {
2021         return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2022 }
2023
2024 static inline bool
2025 conf_is_ht(struct ieee80211_conf *conf)
2026 {
2027         return conf->channel_type != NL80211_CHAN_NO_HT;
2028 }
2029
2030 #endif /* MAC80211_H */