mac80211: fix mac80211.h documentation warnings
[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/cfg80211.h>
23
24 /**
25  * DOC: Introduction
26  *
27  * mac80211 is the Linux stack for 802.11 hardware that implements
28  * only partial functionality in hard- or firmware. This document
29  * defines the interface between mac80211 and low-level hardware
30  * drivers.
31  */
32
33 /**
34  * DOC: Calling mac80211 from interrupts
35  *
36  * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37  * called in hardware interrupt context. The low-level driver must not call any
38  * other functions in hardware interrupt context. If there is a need for such
39  * call, the low-level driver should first ACK the interrupt and perform the
40  * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
41  * tasklet function.
42  *
43  * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44  *       use the non-IRQ-safe functions!
45  */
46
47 /**
48  * DOC: Warning
49  *
50  * If you're reading this document and not the header file itself, it will
51  * be incomplete because not all documentation has been converted yet.
52  */
53
54 /**
55  * DOC: Frame format
56  *
57  * As a general rule, when frames are passed between mac80211 and the driver,
58  * they start with the IEEE 802.11 header and include the same octets that are
59  * sent over the air except for the FCS which should be calculated by the
60  * hardware.
61  *
62  * There are, however, various exceptions to this rule for advanced features:
63  *
64  * The first exception is for hardware encryption and decryption offload
65  * where the IV/ICV may or may not be generated in hardware.
66  *
67  * Secondly, when the hardware handles fragmentation, the frame handed to
68  * the driver from mac80211 is the MSDU, not the MPDU.
69  *
70  * Finally, for received frames, the driver is able to indicate that it has
71  * filled a radiotap header and put that in front of the frame; if it does
72  * not do so then mac80211 may add this under certain circumstances.
73  */
74
75 /**
76  * DOC: mac80211 workqueue
77  *
78  * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79  * The workqueue is a single threaded workqueue and can only be accessed by
80  * helpers for sanity checking. Drivers must ensure all work added onto the
81  * mac80211 workqueue should be cancelled on the driver stop() callback.
82  *
83  * mac80211 will flushed the workqueue upon interface removal and during
84  * suspend.
85  *
86  * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
87  *
88  */
89
90 /**
91  * enum ieee80211_max_queues - maximum number of queues
92  *
93  * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
94  */
95 enum ieee80211_max_queues {
96         IEEE80211_MAX_QUEUES =          4,
97 };
98
99 /**
100  * struct ieee80211_tx_queue_params - transmit queue configuration
101  *
102  * The information provided in this structure is required for QoS
103  * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
104  *
105  * @aifs: arbitration interframe space [0..255]
106  * @cw_min: minimum contention window [a value of the form
107  *      2^n-1 in the range 1..32767]
108  * @cw_max: maximum contention window [like @cw_min]
109  * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
110  * @uapsd: is U-APSD mode enabled for the queue
111  */
112 struct ieee80211_tx_queue_params {
113         u16 txop;
114         u16 cw_min;
115         u16 cw_max;
116         u8 aifs;
117         bool uapsd;
118 };
119
120 /**
121  * struct ieee80211_tx_queue_stats - transmit queue statistics
122  *
123  * @len: number of packets in queue
124  * @limit: queue length limit
125  * @count: number of frames sent
126  */
127 struct ieee80211_tx_queue_stats {
128         unsigned int len;
129         unsigned int limit;
130         unsigned int count;
131 };
132
133 struct ieee80211_low_level_stats {
134         unsigned int dot11ACKFailureCount;
135         unsigned int dot11RTSFailureCount;
136         unsigned int dot11FCSErrorCount;
137         unsigned int dot11RTSSuccessCount;
138 };
139
140 /**
141  * enum ieee80211_bss_change - BSS change notification flags
142  *
143  * These flags are used with the bss_info_changed() callback
144  * to indicate which BSS parameter changed.
145  *
146  * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
147  *      also implies a change in the AID.
148  * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
149  * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
150  * @BSS_CHANGED_ERP_SLOT: slot timing changed
151  * @BSS_CHANGED_HT: 802.11n parameters changed
152  * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
153  * @BSS_CHANGED_BEACON_INT: Beacon interval changed
154  * @BSS_CHANGED_BSSID: BSSID changed, for whatever
155  *      reason (IBSS and managed mode)
156  * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
157  *      new beacon (beaconing modes)
158  * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
159  *      enabled/disabled (beaconing modes)
160  */
161 enum ieee80211_bss_change {
162         BSS_CHANGED_ASSOC               = 1<<0,
163         BSS_CHANGED_ERP_CTS_PROT        = 1<<1,
164         BSS_CHANGED_ERP_PREAMBLE        = 1<<2,
165         BSS_CHANGED_ERP_SLOT            = 1<<3,
166         BSS_CHANGED_HT                  = 1<<4,
167         BSS_CHANGED_BASIC_RATES         = 1<<5,
168         BSS_CHANGED_BEACON_INT          = 1<<6,
169         BSS_CHANGED_BSSID               = 1<<7,
170         BSS_CHANGED_BEACON              = 1<<8,
171         BSS_CHANGED_BEACON_ENABLED      = 1<<9,
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  * @basic_rates: bitmap of basic rates, each bit stands for an
194  *      index into the rate table configured by the driver in
195  *      the current band.
196  * @bssid: The BSSID for this BSS
197  * @enable_beacon: whether beaconing should be enabled or not
198  * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
199  *      This field is only valid when the channel type is one of the HT types.
200  */
201 struct ieee80211_bss_conf {
202         const u8 *bssid;
203         /* association related data */
204         bool assoc;
205         u16 aid;
206         /* erp related data */
207         bool use_cts_prot;
208         bool use_short_preamble;
209         bool use_short_slot;
210         bool enable_beacon;
211         u8 dtim_period;
212         u16 beacon_int;
213         u16 assoc_capability;
214         u64 timestamp;
215         u32 basic_rates;
216         u16 ht_operation_mode;
217 };
218
219 /**
220  * enum mac80211_tx_control_flags - flags to describe transmission information/status
221  *
222  * These flags are used with the @flags member of &ieee80211_tx_info.
223  *
224  * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
225  * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
226  *      number to this frame, taking care of not overwriting the fragment
227  *      number and increasing the sequence number only when the
228  *      IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
229  *      assign sequence numbers to QoS-data frames but cannot do so correctly
230  *      for non-QoS-data and management frames because beacons need them from
231  *      that counter as well and mac80211 cannot guarantee proper sequencing.
232  *      If this flag is set, the driver should instruct the hardware to
233  *      assign a sequence number to the frame or assign one itself. Cf. IEEE
234  *      802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
235  *      beacons and always be clear for frames without a sequence number field.
236  * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
237  * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
238  *      station
239  * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
240  * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
241  * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
242  * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
243  * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
244  *      because the destination STA was in powersave mode. Note that to
245  *      avoid race conditions, the filter must be set by the hardware or
246  *      firmware upon receiving a frame that indicates that the station
247  *      went to sleep (must be done on device to filter frames already on
248  *      the queue) and may only be unset after mac80211 gives the OK for
249  *      that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
250  *      since only then is it guaranteed that no more frames are in the
251  *      hardware queue.
252  * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
253  * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
254  *      is for the whole aggregation.
255  * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
256  *      so consider using block ack request (BAR).
257  * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
258  *      set by rate control algorithms to indicate probe rate, will
259  *      be cleared for fragmented frames (except on the last fragment)
260  * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
261  *      used to indicate that a pending frame requires TX processing before
262  *      it can be sent out.
263  * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
264  *      used to indicate that a frame was already retried due to PS
265  * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
266  *      used to indicate frame should not be encrypted
267  * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
268  *      This frame is a response to a PS-poll frame and should be sent
269  *      although the station is in powersave mode.
270  * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
271  *      transmit function after the current frame, this can be used
272  *      by drivers to kick the DMA queue only if unset or when the
273  *      queue gets full.
274  */
275 enum mac80211_tx_control_flags {
276         IEEE80211_TX_CTL_REQ_TX_STATUS          = BIT(0),
277         IEEE80211_TX_CTL_ASSIGN_SEQ             = BIT(1),
278         IEEE80211_TX_CTL_NO_ACK                 = BIT(2),
279         IEEE80211_TX_CTL_CLEAR_PS_FILT          = BIT(3),
280         IEEE80211_TX_CTL_FIRST_FRAGMENT         = BIT(4),
281         IEEE80211_TX_CTL_SEND_AFTER_DTIM        = BIT(5),
282         IEEE80211_TX_CTL_AMPDU                  = BIT(6),
283         IEEE80211_TX_CTL_INJECTED               = BIT(7),
284         IEEE80211_TX_STAT_TX_FILTERED           = BIT(8),
285         IEEE80211_TX_STAT_ACK                   = BIT(9),
286         IEEE80211_TX_STAT_AMPDU                 = BIT(10),
287         IEEE80211_TX_STAT_AMPDU_NO_BACK         = BIT(11),
288         IEEE80211_TX_CTL_RATE_CTRL_PROBE        = BIT(12),
289         IEEE80211_TX_INTFL_NEED_TXPROCESSING    = BIT(14),
290         IEEE80211_TX_INTFL_RETRIED              = BIT(15),
291         IEEE80211_TX_INTFL_DONT_ENCRYPT         = BIT(16),
292         IEEE80211_TX_CTL_PSPOLL_RESPONSE        = BIT(17),
293         IEEE80211_TX_CTL_MORE_FRAMES            = BIT(18),
294 };
295
296 /**
297  * enum mac80211_rate_control_flags - per-rate flags set by the
298  *      Rate Control algorithm.
299  *
300  * These flags are set by the Rate control algorithm for each rate during tx,
301  * in the @flags member of struct ieee80211_tx_rate.
302  *
303  * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
304  * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
305  *      This is set if the current BSS requires ERP protection.
306  * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
307  * @IEEE80211_TX_RC_MCS: HT rate.
308  * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
309  *      Greenfield mode.
310  * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
311  * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
312  *      adjacent 20 MHz channels, if the current channel type is
313  *      NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
314  * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
315  */
316 enum mac80211_rate_control_flags {
317         IEEE80211_TX_RC_USE_RTS_CTS             = BIT(0),
318         IEEE80211_TX_RC_USE_CTS_PROTECT         = BIT(1),
319         IEEE80211_TX_RC_USE_SHORT_PREAMBLE      = BIT(2),
320
321         /* rate index is an MCS rate number instead of an index */
322         IEEE80211_TX_RC_MCS                     = BIT(3),
323         IEEE80211_TX_RC_GREEN_FIELD             = BIT(4),
324         IEEE80211_TX_RC_40_MHZ_WIDTH            = BIT(5),
325         IEEE80211_TX_RC_DUP_DATA                = BIT(6),
326         IEEE80211_TX_RC_SHORT_GI                = BIT(7),
327 };
328
329
330 /* there are 40 bytes if you don't need the rateset to be kept */
331 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
332
333 /* if you do need the rateset, then you have less space */
334 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
335
336 /* maximum number of rate stages */
337 #define IEEE80211_TX_MAX_RATES  5
338
339 /**
340  * struct ieee80211_tx_rate - rate selection/status
341  *
342  * @idx: rate index to attempt to send with
343  * @flags: rate control flags (&enum mac80211_rate_control_flags)
344  * @count: number of tries in this rate before going to the next rate
345  *
346  * A value of -1 for @idx indicates an invalid rate and, if used
347  * in an array of retry rates, that no more rates should be tried.
348  *
349  * When used for transmit status reporting, the driver should
350  * always report the rate along with the flags it used.
351  *
352  * &struct ieee80211_tx_info contains an array of these structs
353  * in the control information, and it will be filled by the rate
354  * control algorithm according to what should be sent. For example,
355  * if this array contains, in the format { <idx>, <count> } the
356  * information
357  *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
358  * then this means that the frame should be transmitted
359  * up to twice at rate 3, up to twice at rate 2, and up to four
360  * times at rate 1 if it doesn't get acknowledged. Say it gets
361  * acknowledged by the peer after the fifth attempt, the status
362  * information should then contain
363  *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
364  * since it was transmitted twice at rate 3, twice at rate 2
365  * and once at rate 1 after which we received an acknowledgement.
366  */
367 struct ieee80211_tx_rate {
368         s8 idx;
369         u8 count;
370         u8 flags;
371 } __attribute__((packed));
372
373 /**
374  * struct ieee80211_tx_info - skb transmit information
375  *
376  * This structure is placed in skb->cb for three uses:
377  *  (1) mac80211 TX control - mac80211 tells the driver what to do
378  *  (2) driver internal use (if applicable)
379  *  (3) TX status information - driver tells mac80211 what happened
380  *
381  * The TX control's sta pointer is only valid during the ->tx call,
382  * it may be NULL.
383  *
384  * @flags: transmit info flags, defined above
385  * @band: the band to transmit on (use for checking for races)
386  * @antenna_sel_tx: antenna to use, 0 for automatic diversity
387  * @pad: padding, ignore
388  * @control: union for control data
389  * @status: union for status data
390  * @driver_data: array of driver_data pointers
391  * @ampdu_ack_len: number of acked aggregated frames.
392  *      relevant only if IEEE80211_TX_STATUS_AMPDU was set.
393  * @ampdu_ack_map: block ack bit map for the aggregation.
394  *      relevant only if IEEE80211_TX_STATUS_AMPDU was set.
395  * @ampdu_len: number of aggregated frames.
396  *      relevant only if IEEE80211_TX_STATUS_AMPDU was set.
397  * @ack_signal: signal strength of the ACK frame
398  */
399 struct ieee80211_tx_info {
400         /* common information */
401         u32 flags;
402         u8 band;
403
404         u8 antenna_sel_tx;
405
406         /* 2 byte hole */
407         u8 pad[2];
408
409         union {
410                 struct {
411                         union {
412                                 /* rate control */
413                                 struct {
414                                         struct ieee80211_tx_rate rates[
415                                                 IEEE80211_TX_MAX_RATES];
416                                         s8 rts_cts_rate_idx;
417                                 };
418                                 /* only needed before rate control */
419                                 unsigned long jiffies;
420                         };
421                         /* NB: vif can be NULL for injected frames */
422                         struct ieee80211_vif *vif;
423                         struct ieee80211_key_conf *hw_key;
424                         struct ieee80211_sta *sta;
425                 } control;
426                 struct {
427                         struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
428                         u8 ampdu_ack_len;
429                         u64 ampdu_ack_map;
430                         int ack_signal;
431                         u8 ampdu_len;
432                         /* 7 bytes free */
433                 } status;
434                 struct {
435                         struct ieee80211_tx_rate driver_rates[
436                                 IEEE80211_TX_MAX_RATES];
437                         void *rate_driver_data[
438                                 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
439                 };
440                 void *driver_data[
441                         IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
442         };
443 };
444
445 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
446 {
447         return (struct ieee80211_tx_info *)skb->cb;
448 }
449
450 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
451 {
452         return (struct ieee80211_rx_status *)skb->cb;
453 }
454
455 /**
456  * ieee80211_tx_info_clear_status - clear TX status
457  *
458  * @info: The &struct ieee80211_tx_info to be cleared.
459  *
460  * When the driver passes an skb back to mac80211, it must report
461  * a number of things in TX status. This function clears everything
462  * in the TX status but the rate control information (it does clear
463  * the count since you need to fill that in anyway).
464  *
465  * NOTE: You can only use this function if you do NOT use
466  *       info->driver_data! Use info->rate_driver_data
467  *       instead if you need only the less space that allows.
468  */
469 static inline void
470 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
471 {
472         int i;
473
474         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
475                      offsetof(struct ieee80211_tx_info, control.rates));
476         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
477                      offsetof(struct ieee80211_tx_info, driver_rates));
478         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
479         /* clear the rate counts */
480         for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
481                 info->status.rates[i].count = 0;
482
483         BUILD_BUG_ON(
484             offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
485         memset(&info->status.ampdu_ack_len, 0,
486                sizeof(struct ieee80211_tx_info) -
487                offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
488 }
489
490
491 /**
492  * enum mac80211_rx_flags - receive flags
493  *
494  * These flags are used with the @flag member of &struct ieee80211_rx_status.
495  * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
496  *      Use together with %RX_FLAG_MMIC_STRIPPED.
497  * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
498  * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
499  *      verification has been done by the hardware.
500  * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
501  *      If this flag is set, the stack cannot do any replay detection
502  *      hence the driver or hardware will have to do that.
503  * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
504  *      the frame.
505  * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
506  *      the frame.
507  * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
508  *      is valid. This is useful in monitor mode and necessary for beacon frames
509  *      to enable IBSS merging.
510  * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
511  * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
512  * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
513  * @RX_FLAG_SHORT_GI: Short guard interval was used
514  * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
515  *      on cooked monitor to avoid double-reporting it for multiple
516  *      virtual interfaces
517  */
518 enum mac80211_rx_flags {
519         RX_FLAG_MMIC_ERROR      = 1<<0,
520         RX_FLAG_DECRYPTED       = 1<<1,
521         RX_FLAG_MMIC_STRIPPED   = 1<<3,
522         RX_FLAG_IV_STRIPPED     = 1<<4,
523         RX_FLAG_FAILED_FCS_CRC  = 1<<5,
524         RX_FLAG_FAILED_PLCP_CRC = 1<<6,
525         RX_FLAG_TSFT            = 1<<7,
526         RX_FLAG_SHORTPRE        = 1<<8,
527         RX_FLAG_HT              = 1<<9,
528         RX_FLAG_40MHZ           = 1<<10,
529         RX_FLAG_SHORT_GI        = 1<<11,
530         RX_FLAG_INTERNAL_CMTR   = 1<<12,
531 };
532
533 /**
534  * struct ieee80211_rx_status - receive status
535  *
536  * The low-level driver should provide this information (the subset
537  * supported by hardware) to the 802.11 code with each received
538  * frame, in the skb's control buffer (cb).
539  *
540  * @mactime: value in microseconds of the 64-bit Time Synchronization Function
541  *      (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
542  * @band: the active band when this frame was received
543  * @freq: frequency the radio was tuned to when receiving this frame, in MHz
544  * @signal: signal strength when receiving this frame, either in dBm, in dB or
545  *      unspecified depending on the hardware capabilities flags
546  *      @IEEE80211_HW_SIGNAL_*
547  * @noise: noise when receiving this frame, in dBm.
548  * @antenna: antenna used
549  * @rate_idx: index of data rate into band's supported rates or MCS index if
550  *      HT rates are use (RX_FLAG_HT)
551  * @flag: %RX_FLAG_*
552  */
553 struct ieee80211_rx_status {
554         u64 mactime;
555         enum ieee80211_band band;
556         int freq;
557         int signal;
558         int noise;
559         int antenna;
560         int rate_idx;
561         int flag;
562 };
563
564 /**
565  * enum ieee80211_conf_flags - configuration flags
566  *
567  * Flags to define PHY configuration options
568  *
569  * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
570  *      to determine for example whether to calculate timestamps for packets
571  *      or not, do not use instead of filter flags!
572  * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only)
573  * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
574  *      the driver should be prepared to handle configuration requests but
575  *      may turn the device off as much as possible. Typically, this flag will
576  *      be set when an interface is set UP but not associated or scanning, but
577  *      it can also be unset in that case when monitor interfaces are active.
578  */
579 enum ieee80211_conf_flags {
580         IEEE80211_CONF_MONITOR          = (1<<0),
581         IEEE80211_CONF_PS               = (1<<1),
582         IEEE80211_CONF_IDLE             = (1<<2),
583 };
584
585
586 /**
587  * enum ieee80211_conf_changed - denotes which configuration changed
588  *
589  * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
590  * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
591  * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
592  * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
593  * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
594  * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
595  * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
596  * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
597  */
598 enum ieee80211_conf_changed {
599         IEEE80211_CONF_CHANGE_SMPS              = BIT(1),
600         IEEE80211_CONF_CHANGE_LISTEN_INTERVAL   = BIT(2),
601         IEEE80211_CONF_CHANGE_MONITOR           = BIT(3),
602         IEEE80211_CONF_CHANGE_PS                = BIT(4),
603         IEEE80211_CONF_CHANGE_POWER             = BIT(5),
604         IEEE80211_CONF_CHANGE_CHANNEL           = BIT(6),
605         IEEE80211_CONF_CHANGE_RETRY_LIMITS      = BIT(7),
606         IEEE80211_CONF_CHANGE_IDLE              = BIT(8),
607 };
608
609 /**
610  * enum ieee80211_smps_mode - spatial multiplexing power save mode
611  *
612  * @IEEE80211_SMPS_AUTOMATIC: automatic
613  * @IEEE80211_SMPS_OFF: off
614  * @IEEE80211_SMPS_STATIC: static
615  * @IEEE80211_SMPS_DYNAMIC: dynamic
616  * @IEEE80211_SMPS_NUM_MODES: internal, don't use
617  */
618 enum ieee80211_smps_mode {
619         IEEE80211_SMPS_AUTOMATIC,
620         IEEE80211_SMPS_OFF,
621         IEEE80211_SMPS_STATIC,
622         IEEE80211_SMPS_DYNAMIC,
623
624         /* keep last */
625         IEEE80211_SMPS_NUM_MODES,
626 };
627
628 /**
629  * struct ieee80211_conf - configuration of the device
630  *
631  * This struct indicates how the driver shall configure the hardware.
632  *
633  * @flags: configuration flags defined above
634  *
635  * @listen_interval: listen interval in units of beacon interval
636  * @max_sleep_period: the maximum number of beacon intervals to sleep for
637  *      before checking the beacon for a TIM bit (managed mode only); this
638  *      value will be only achievable between DTIM frames, the hardware
639  *      needs to check for the multicast traffic bit in DTIM beacons.
640  *      This variable is valid only when the CONF_PS flag is set.
641  * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
642  *      powersave documentation below. This variable is valid only when
643  *      the CONF_PS flag is set.
644  *
645  * @power_level: requested transmit power (in dBm)
646  *
647  * @channel: the channel to tune to
648  * @channel_type: the channel (HT) type
649  *
650  * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
651  *    (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
652  *    but actually means the number of transmissions not the number of retries
653  * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
654  *    frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
655  *    number of transmissions not the number of retries
656  *
657  * @smps_mode: spatial multiplexing powersave mode; note that
658  *      %IEEE80211_SMPS_STATIC is used when the device is not
659  *      configured for an HT channel
660  */
661 struct ieee80211_conf {
662         u32 flags;
663         int power_level, dynamic_ps_timeout;
664         int max_sleep_period;
665
666         u16 listen_interval;
667
668         u8 long_frame_max_tx_count, short_frame_max_tx_count;
669
670         struct ieee80211_channel *channel;
671         enum nl80211_channel_type channel_type;
672         enum ieee80211_smps_mode smps_mode;
673 };
674
675 /**
676  * struct ieee80211_vif - per-interface data
677  *
678  * Data in this structure is continually present for driver
679  * use during the life of a virtual interface.
680  *
681  * @type: type of this virtual interface
682  * @bss_conf: BSS configuration for this interface, either our own
683  *      or the BSS we're associated to
684  * @addr: address of this interface
685  * @drv_priv: data area for driver use, will always be aligned to
686  *      sizeof(void *).
687  */
688 struct ieee80211_vif {
689         enum nl80211_iftype type;
690         struct ieee80211_bss_conf bss_conf;
691         u8 addr[ETH_ALEN];
692         /* must be last */
693         u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
694 };
695
696 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
697 {
698 #ifdef CONFIG_MAC80211_MESH
699         return vif->type == NL80211_IFTYPE_MESH_POINT;
700 #endif
701         return false;
702 }
703
704 /**
705  * enum ieee80211_key_alg - key algorithm
706  * @ALG_WEP: WEP40 or WEP104
707  * @ALG_TKIP: TKIP
708  * @ALG_CCMP: CCMP (AES)
709  * @ALG_AES_CMAC: AES-128-CMAC
710  */
711 enum ieee80211_key_alg {
712         ALG_WEP,
713         ALG_TKIP,
714         ALG_CCMP,
715         ALG_AES_CMAC,
716 };
717
718 /**
719  * enum ieee80211_key_flags - key flags
720  *
721  * These flags are used for communication about keys between the driver
722  * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
723  *
724  * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
725  *      that the STA this key will be used with could be using QoS.
726  * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
727  *      driver to indicate that it requires IV generation for this
728  *      particular key.
729  * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
730  *      the driver for a TKIP key if it requires Michael MIC
731  *      generation in software.
732  * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
733  *      that the key is pairwise rather then a shared key.
734  * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
735  *      CCMP key if it requires CCMP encryption of management frames (MFP) to
736  *      be done in software.
737  */
738 enum ieee80211_key_flags {
739         IEEE80211_KEY_FLAG_WMM_STA      = 1<<0,
740         IEEE80211_KEY_FLAG_GENERATE_IV  = 1<<1,
741         IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
742         IEEE80211_KEY_FLAG_PAIRWISE     = 1<<3,
743         IEEE80211_KEY_FLAG_SW_MGMT      = 1<<4,
744 };
745
746 /**
747  * struct ieee80211_key_conf - key information
748  *
749  * This key information is given by mac80211 to the driver by
750  * the set_key() callback in &struct ieee80211_ops.
751  *
752  * @hw_key_idx: To be set by the driver, this is the key index the driver
753  *      wants to be given when a frame is transmitted and needs to be
754  *      encrypted in hardware.
755  * @alg: The key algorithm.
756  * @flags: key flags, see &enum ieee80211_key_flags.
757  * @keyidx: the key index (0-3)
758  * @keylen: key material length
759  * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
760  *      data block:
761  *      - Temporal Encryption Key (128 bits)
762  *      - Temporal Authenticator Tx MIC Key (64 bits)
763  *      - Temporal Authenticator Rx MIC Key (64 bits)
764  * @icv_len: The ICV length for this key type
765  * @iv_len: The IV length for this key type
766  */
767 struct ieee80211_key_conf {
768         enum ieee80211_key_alg alg;
769         u8 icv_len;
770         u8 iv_len;
771         u8 hw_key_idx;
772         u8 flags;
773         s8 keyidx;
774         u8 keylen;
775         u8 key[0];
776 };
777
778 /**
779  * enum set_key_cmd - key command
780  *
781  * Used with the set_key() callback in &struct ieee80211_ops, this
782  * indicates whether a key is being removed or added.
783  *
784  * @SET_KEY: a key is set
785  * @DISABLE_KEY: a key must be disabled
786  */
787 enum set_key_cmd {
788         SET_KEY, DISABLE_KEY,
789 };
790
791 /**
792  * struct ieee80211_sta - station table entry
793  *
794  * A station table entry represents a station we are possibly
795  * communicating with. Since stations are RCU-managed in
796  * mac80211, any ieee80211_sta pointer you get access to must
797  * either be protected by rcu_read_lock() explicitly or implicitly,
798  * or you must take good care to not use such a pointer after a
799  * call to your sta_notify callback that removed it.
800  *
801  * @addr: MAC address
802  * @aid: AID we assigned to the station if we're an AP
803  * @supp_rates: Bitmap of supported rates (per band)
804  * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
805  * @drv_priv: data area for driver use, will always be aligned to
806  *      sizeof(void *), size is determined in hw information.
807  */
808 struct ieee80211_sta {
809         u32 supp_rates[IEEE80211_NUM_BANDS];
810         u8 addr[ETH_ALEN];
811         u16 aid;
812         struct ieee80211_sta_ht_cap ht_cap;
813
814         /* must be last */
815         u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
816 };
817
818 /**
819  * enum sta_notify_cmd - sta notify command
820  *
821  * Used with the sta_notify() callback in &struct ieee80211_ops, this
822  * indicates addition and removal of a station to station table,
823  * or if a associated station made a power state transition.
824  *
825  * @STA_NOTIFY_ADD: a station was added to the station table
826  * @STA_NOTIFY_REMOVE: a station being removed from the station table
827  * @STA_NOTIFY_SLEEP: a station is now sleeping
828  * @STA_NOTIFY_AWAKE: a sleeping station woke up
829  */
830 enum sta_notify_cmd {
831         STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
832         STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
833 };
834
835 /**
836  * enum ieee80211_tkip_key_type - get tkip key
837  *
838  * Used by drivers which need to get a tkip key for skb. Some drivers need a
839  * phase 1 key, others need a phase 2 key. A single function allows the driver
840  * to get the key, this enum indicates what type of key is required.
841  *
842  * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
843  * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
844  */
845 enum ieee80211_tkip_key_type {
846         IEEE80211_TKIP_P1_KEY,
847         IEEE80211_TKIP_P2_KEY,
848 };
849
850 /**
851  * enum ieee80211_hw_flags - hardware flags
852  *
853  * These flags are used to indicate hardware capabilities to
854  * the stack. Generally, flags here should have their meaning
855  * done in a way that the simplest hardware doesn't need setting
856  * any particular flags. There are some exceptions to this rule,
857  * however, so you are advised to review these flags carefully.
858  *
859  * @IEEE80211_HW_HAS_RATE_CONTROL:
860  *      The hardware or firmware includes rate control, and cannot be
861  *      controlled by the stack. As such, no rate control algorithm
862  *      should be instantiated, and the TX rate reported to userspace
863  *      will be taken from the TX status instead of the rate control
864  *      algorithm.
865  *      Note that this requires that the driver implement a number of
866  *      callbacks so it has the correct information, it needs to have
867  *      the @set_rts_threshold callback and must look at the BSS config
868  *      @use_cts_prot for G/N protection, @use_short_slot for slot
869  *      timing in 2.4 GHz and @use_short_preamble for preambles for
870  *      CCK frames.
871  *
872  * @IEEE80211_HW_RX_INCLUDES_FCS:
873  *      Indicates that received frames passed to the stack include
874  *      the FCS at the end.
875  *
876  * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
877  *      Some wireless LAN chipsets buffer broadcast/multicast frames
878  *      for power saving stations in the hardware/firmware and others
879  *      rely on the host system for such buffering. This option is used
880  *      to configure the IEEE 802.11 upper layer to buffer broadcast and
881  *      multicast frames when there are power saving stations so that
882  *      the driver can fetch them with ieee80211_get_buffered_bc().
883  *
884  * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
885  *      Hardware is not capable of short slot operation on the 2.4 GHz band.
886  *
887  * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
888  *      Hardware is not capable of receiving frames with short preamble on
889  *      the 2.4 GHz band.
890  *
891  * @IEEE80211_HW_SIGNAL_UNSPEC:
892  *      Hardware can provide signal values but we don't know its units. We
893  *      expect values between 0 and @max_signal.
894  *      If possible please provide dB or dBm instead.
895  *
896  * @IEEE80211_HW_SIGNAL_DBM:
897  *      Hardware gives signal values in dBm, decibel difference from
898  *      one milliwatt. This is the preferred method since it is standardized
899  *      between different devices. @max_signal does not need to be set.
900  *
901  * @IEEE80211_HW_NOISE_DBM:
902  *      Hardware can provide noise (radio interference) values in units dBm,
903  *      decibel difference from one milliwatt.
904  *
905  * @IEEE80211_HW_SPECTRUM_MGMT:
906  *      Hardware supports spectrum management defined in 802.11h
907  *      Measurement, Channel Switch, Quieting, TPC
908  *
909  * @IEEE80211_HW_AMPDU_AGGREGATION:
910  *      Hardware supports 11n A-MPDU aggregation.
911  *
912  * @IEEE80211_HW_SUPPORTS_PS:
913  *      Hardware has power save support (i.e. can go to sleep).
914  *
915  * @IEEE80211_HW_PS_NULLFUNC_STACK:
916  *      Hardware requires nullfunc frame handling in stack, implies
917  *      stack support for dynamic PS.
918  *
919  * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
920  *      Hardware has support for dynamic PS.
921  *
922  * @IEEE80211_HW_MFP_CAPABLE:
923  *      Hardware supports management frame protection (MFP, IEEE 802.11w).
924  *
925  * @IEEE80211_HW_BEACON_FILTER:
926  *      Hardware supports dropping of irrelevant beacon frames to
927  *      avoid waking up cpu.
928  *
929  * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
930  *      Hardware supports static spatial multiplexing powersave,
931  *      ie. can turn off all but one chain even on HT connections
932  *      that should be using more chains.
933  *
934  * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
935  *      Hardware supports dynamic spatial multiplexing powersave,
936  *      ie. can turn off all but one chain and then wake the rest
937  *      up as required after, for example, rts/cts handshake.
938  *
939  * @IEEE80211_HW_SUPPORTS_UAPSD:
940  *      Hardware supports Unscheduled Automatic Power Save Delivery
941  *      (U-APSD) in managed mode. The mode is configured with
942  *      conf_tx() operation.
943  */
944 enum ieee80211_hw_flags {
945         IEEE80211_HW_HAS_RATE_CONTROL                   = 1<<0,
946         IEEE80211_HW_RX_INCLUDES_FCS                    = 1<<1,
947         IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING        = 1<<2,
948         IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE          = 1<<3,
949         IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE      = 1<<4,
950         IEEE80211_HW_SIGNAL_UNSPEC                      = 1<<5,
951         IEEE80211_HW_SIGNAL_DBM                         = 1<<6,
952         IEEE80211_HW_NOISE_DBM                          = 1<<7,
953         IEEE80211_HW_SPECTRUM_MGMT                      = 1<<8,
954         IEEE80211_HW_AMPDU_AGGREGATION                  = 1<<9,
955         IEEE80211_HW_SUPPORTS_PS                        = 1<<10,
956         IEEE80211_HW_PS_NULLFUNC_STACK                  = 1<<11,
957         IEEE80211_HW_SUPPORTS_DYNAMIC_PS                = 1<<12,
958         IEEE80211_HW_MFP_CAPABLE                        = 1<<13,
959         IEEE80211_HW_BEACON_FILTER                      = 1<<14,
960         IEEE80211_HW_SUPPORTS_STATIC_SMPS               = 1<<15,
961         IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS              = 1<<16,
962         IEEE80211_HW_SUPPORTS_UAPSD                     = 1<<17,
963 };
964
965 /**
966  * struct ieee80211_hw - hardware information and state
967  *
968  * This structure contains the configuration and hardware
969  * information for an 802.11 PHY.
970  *
971  * @wiphy: This points to the &struct wiphy allocated for this
972  *      802.11 PHY. You must fill in the @perm_addr and @dev
973  *      members of this structure using SET_IEEE80211_DEV()
974  *      and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
975  *      bands (with channels, bitrates) are registered here.
976  *
977  * @conf: &struct ieee80211_conf, device configuration, don't use.
978  *
979  * @priv: pointer to private area that was allocated for driver use
980  *      along with this structure.
981  *
982  * @flags: hardware flags, see &enum ieee80211_hw_flags.
983  *
984  * @extra_tx_headroom: headroom to reserve in each transmit skb
985  *      for use by the driver (e.g. for transmit headers.)
986  *
987  * @channel_change_time: time (in microseconds) it takes to change channels.
988  *
989  * @max_signal: Maximum value for signal (rssi) in RX information, used
990  *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
991  *
992  * @max_listen_interval: max listen interval in units of beacon interval
993  *     that HW supports
994  *
995  * @queues: number of available hardware transmit queues for
996  *      data packets. WMM/QoS requires at least four, these
997  *      queues need to have configurable access parameters.
998  *
999  * @rate_control_algorithm: rate control algorithm for this hardware.
1000  *      If unset (NULL), the default algorithm will be used. Must be
1001  *      set before calling ieee80211_register_hw().
1002  *
1003  * @vif_data_size: size (in bytes) of the drv_priv data area
1004  *      within &struct ieee80211_vif.
1005  * @sta_data_size: size (in bytes) of the drv_priv data area
1006  *      within &struct ieee80211_sta.
1007  *
1008  * @max_rates: maximum number of alternate rate retry stages
1009  * @max_rate_tries: maximum number of tries for each stage
1010  */
1011 struct ieee80211_hw {
1012         struct ieee80211_conf conf;
1013         struct wiphy *wiphy;
1014         const char *rate_control_algorithm;
1015         void *priv;
1016         u32 flags;
1017         unsigned int extra_tx_headroom;
1018         int channel_change_time;
1019         int vif_data_size;
1020         int sta_data_size;
1021         u16 queues;
1022         u16 max_listen_interval;
1023         s8 max_signal;
1024         u8 max_rates;
1025         u8 max_rate_tries;
1026 };
1027
1028 /**
1029  * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1030  *
1031  * @wiphy: the &struct wiphy which we want to query
1032  *
1033  * mac80211 drivers can use this to get to their respective
1034  * &struct ieee80211_hw. Drivers wishing to get to their own private
1035  * structure can then access it via hw->priv. Note that mac802111 drivers should
1036  * not use wiphy_priv() to try to get their private driver structure as this
1037  * is already used internally by mac80211.
1038  */
1039 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1040
1041 /**
1042  * SET_IEEE80211_DEV - set device for 802.11 hardware
1043  *
1044  * @hw: the &struct ieee80211_hw to set the device for
1045  * @dev: the &struct device of this 802.11 device
1046  */
1047 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1048 {
1049         set_wiphy_dev(hw->wiphy, dev);
1050 }
1051
1052 /**
1053  * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1054  *
1055  * @hw: the &struct ieee80211_hw to set the MAC address for
1056  * @addr: the address to set
1057  */
1058 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1059 {
1060         memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1061 }
1062
1063 static inline struct ieee80211_rate *
1064 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1065                       const struct ieee80211_tx_info *c)
1066 {
1067         if (WARN_ON(c->control.rates[0].idx < 0))
1068                 return NULL;
1069         return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1070 }
1071
1072 static inline struct ieee80211_rate *
1073 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1074                            const struct ieee80211_tx_info *c)
1075 {
1076         if (c->control.rts_cts_rate_idx < 0)
1077                 return NULL;
1078         return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1079 }
1080
1081 static inline struct ieee80211_rate *
1082 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1083                              const struct ieee80211_tx_info *c, int idx)
1084 {
1085         if (c->control.rates[idx + 1].idx < 0)
1086                 return NULL;
1087         return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1088 }
1089
1090 /**
1091  * DOC: Hardware crypto acceleration
1092  *
1093  * mac80211 is capable of taking advantage of many hardware
1094  * acceleration designs for encryption and decryption operations.
1095  *
1096  * The set_key() callback in the &struct ieee80211_ops for a given
1097  * device is called to enable hardware acceleration of encryption and
1098  * decryption. The callback takes a @sta parameter that will be NULL
1099  * for default keys or keys used for transmission only, or point to
1100  * the station information for the peer for individual keys.
1101  * Multiple transmission keys with the same key index may be used when
1102  * VLANs are configured for an access point.
1103  *
1104  * When transmitting, the TX control data will use the @hw_key_idx
1105  * selected by the driver by modifying the &struct ieee80211_key_conf
1106  * pointed to by the @key parameter to the set_key() function.
1107  *
1108  * The set_key() call for the %SET_KEY command should return 0 if
1109  * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1110  * added; if you return 0 then hw_key_idx must be assigned to the
1111  * hardware key index, you are free to use the full u8 range.
1112  *
1113  * When the cmd is %DISABLE_KEY then it must succeed.
1114  *
1115  * Note that it is permissible to not decrypt a frame even if a key
1116  * for it has been uploaded to hardware, the stack will not make any
1117  * decision based on whether a key has been uploaded or not but rather
1118  * based on the receive flags.
1119  *
1120  * The &struct ieee80211_key_conf structure pointed to by the @key
1121  * parameter is guaranteed to be valid until another call to set_key()
1122  * removes it, but it can only be used as a cookie to differentiate
1123  * keys.
1124  *
1125  * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1126  * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1127  * handler.
1128  * The update_tkip_key() call updates the driver with the new phase 1 key.
1129  * This happens everytime the iv16 wraps around (every 65536 packets). The
1130  * set_key() call will happen only once for each key (unless the AP did
1131  * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1132  * provided by update_tkip_key only. The trigger that makes mac80211 call this
1133  * handler is software decryption with wrap around of iv16.
1134  */
1135
1136 /**
1137  * DOC: Powersave support
1138  *
1139  * mac80211 has support for various powersave implementations.
1140  *
1141  * First, it can support hardware that handles all powersaving by
1142  * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1143  * hardware flag. In that case, it will be told about the desired
1144  * powersave mode depending on the association status, and the driver
1145  * must take care of sending nullfunc frames when necessary, i.e. when
1146  * entering and leaving powersave mode. The driver is required to look at
1147  * the AID in beacons and signal to the AP that it woke up when it finds
1148  * traffic directed to it. This mode supports dynamic PS by simply
1149  * enabling/disabling PS.
1150  *
1151  * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1152  * flag to indicate that it can support dynamic PS mode itself (see below).
1153  *
1154  * Other hardware designs cannot send nullfunc frames by themselves and also
1155  * need software support for parsing the TIM bitmap. This is also supported
1156  * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1157  * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1158  * required to pass up beacons. The hardware is still required to handle
1159  * waking up for multicast traffic; if it cannot the driver must handle that
1160  * as best as it can, mac80211 is too slow.
1161  *
1162  * Dynamic powersave mode is an extension to normal powersave mode in which
1163  * the hardware stays awake for a user-specified period of time after sending
1164  * a frame so that reply frames need not be buffered and therefore delayed
1165  * to the next wakeup. This can either be supported by hardware, in which case
1166  * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1167  * value, or by the stack if all nullfunc handling is in the stack.
1168  */
1169
1170 /**
1171  * DOC: Beacon filter support
1172  *
1173  * Some hardware have beacon filter support to reduce host cpu wakeups
1174  * which will reduce system power consumption. It usuallly works so that
1175  * the firmware creates a checksum of the beacon but omits all constantly
1176  * changing elements (TSF, TIM etc). Whenever the checksum changes the
1177  * beacon is forwarded to the host, otherwise it will be just dropped. That
1178  * way the host will only receive beacons where some relevant information
1179  * (for example ERP protection or WMM settings) have changed.
1180  *
1181  * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1182  * hardware capability. The driver needs to enable beacon filter support
1183  * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1184  * power save is enabled, the stack will not check for beacon loss and the
1185  * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1186  *
1187  * The time (or number of beacons missed) until the firmware notifies the
1188  * driver of a beacon loss event (which in turn causes the driver to call
1189  * ieee80211_beacon_loss()) should be configurable and will be controlled
1190  * by mac80211 and the roaming algorithm in the future.
1191  *
1192  * Since there may be constantly changing information elements that nothing
1193  * in the software stack cares about, we will, in the future, have mac80211
1194  * tell the driver which information elements are interesting in the sense
1195  * that we want to see changes in them. This will include
1196  *  - a list of information element IDs
1197  *  - a list of OUIs for the vendor information element
1198  *
1199  * Ideally, the hardware would filter out any beacons without changes in the
1200  * requested elements, but if it cannot support that it may, at the expense
1201  * of some efficiency, filter out only a subset. For example, if the device
1202  * doesn't support checking for OUIs it should pass up all changes in all
1203  * vendor information elements.
1204  *
1205  * Note that change, for the sake of simplification, also includes information
1206  * elements appearing or disappearing from the beacon.
1207  *
1208  * Some hardware supports an "ignore list" instead, just make sure nothing
1209  * that was requested is on the ignore list, and include commonly changing
1210  * information element IDs in the ignore list, for example 11 (BSS load) and
1211  * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1212  * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1213  * it could also include some currently unused IDs.
1214  *
1215  *
1216  * In addition to these capabilities, hardware should support notifying the
1217  * host of changes in the beacon RSSI. This is relevant to implement roaming
1218  * when no traffic is flowing (when traffic is flowing we see the RSSI of
1219  * the received data packets). This can consist in notifying the host when
1220  * the RSSI changes significantly or when it drops below or rises above
1221  * configurable thresholds. In the future these thresholds will also be
1222  * configured by mac80211 (which gets them from userspace) to implement
1223  * them as the roaming algorithm requires.
1224  *
1225  * If the hardware cannot implement this, the driver should ask it to
1226  * periodically pass beacon frames to the host so that software can do the
1227  * signal strength threshold checking.
1228  */
1229
1230 /**
1231  * DOC: Spatial multiplexing power save
1232  *
1233  * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1234  * power in an 802.11n implementation. For details on the mechanism
1235  * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1236  * "11.2.3 SM power save".
1237  *
1238  * The mac80211 implementation is capable of sending action frames
1239  * to update the AP about the station's SMPS mode, and will instruct
1240  * the driver to enter the specific mode. It will also announce the
1241  * requested SMPS mode during the association handshake. Hardware
1242  * support for this feature is required, and can be indicated by
1243  * hardware flags.
1244  *
1245  * The default mode will be "automatic", which nl80211/cfg80211
1246  * defines to be dynamic SMPS in (regular) powersave, and SMPS
1247  * turned off otherwise.
1248  *
1249  * To support this feature, the driver must set the appropriate
1250  * hardware support flags, and handle the SMPS flag to the config()
1251  * operation. It will then with this mechanism be instructed to
1252  * enter the requested SMPS mode while associated to an HT AP.
1253  */
1254
1255 /**
1256  * DOC: Frame filtering
1257  *
1258  * mac80211 requires to see many management frames for proper
1259  * operation, and users may want to see many more frames when
1260  * in monitor mode. However, for best CPU usage and power consumption,
1261  * having as few frames as possible percolate through the stack is
1262  * desirable. Hence, the hardware should filter as much as possible.
1263  *
1264  * To achieve this, mac80211 uses filter flags (see below) to tell
1265  * the driver's configure_filter() function which frames should be
1266  * passed to mac80211 and which should be filtered out.
1267  *
1268  * Before configure_filter() is invoked, the prepare_multicast()
1269  * callback is invoked with the parameters @mc_count and @mc_list
1270  * for the combined multicast address list of all virtual interfaces.
1271  * It's use is optional, and it returns a u64 that is passed to
1272  * configure_filter(). Additionally, configure_filter() has the
1273  * arguments @changed_flags telling which flags were changed and
1274  * @total_flags with the new flag states.
1275  *
1276  * If your device has no multicast address filters your driver will
1277  * need to check both the %FIF_ALLMULTI flag and the @mc_count
1278  * parameter to see whether multicast frames should be accepted
1279  * or dropped.
1280  *
1281  * All unsupported flags in @total_flags must be cleared.
1282  * Hardware does not support a flag if it is incapable of _passing_
1283  * the frame to the stack. Otherwise the driver must ignore
1284  * the flag, but not clear it.
1285  * You must _only_ clear the flag (announce no support for the
1286  * flag to mac80211) if you are not able to pass the packet type
1287  * to the stack (so the hardware always filters it).
1288  * So for example, you should clear @FIF_CONTROL, if your hardware
1289  * always filters control frames. If your hardware always passes
1290  * control frames to the kernel and is incapable of filtering them,
1291  * you do _not_ clear the @FIF_CONTROL flag.
1292  * This rule applies to all other FIF flags as well.
1293  */
1294
1295 /**
1296  * enum ieee80211_filter_flags - hardware filter flags
1297  *
1298  * These flags determine what the filter in hardware should be
1299  * programmed to let through and what should not be passed to the
1300  * stack. It is always safe to pass more frames than requested,
1301  * but this has negative impact on power consumption.
1302  *
1303  * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1304  *      think of the BSS as your network segment and then this corresponds
1305  *      to the regular ethernet device promiscuous mode.
1306  *
1307  * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1308  *      by the user or if the hardware is not capable of filtering by
1309  *      multicast address.
1310  *
1311  * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1312  *      %RX_FLAG_FAILED_FCS_CRC for them)
1313  *
1314  * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1315  *      the %RX_FLAG_FAILED_PLCP_CRC for them
1316  *
1317  * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1318  *      to the hardware that it should not filter beacons or probe responses
1319  *      by BSSID. Filtering them can greatly reduce the amount of processing
1320  *      mac80211 needs to do and the amount of CPU wakeups, so you should
1321  *      honour this flag if possible.
1322  *
1323  * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1324  *  is not set then only those addressed to this station.
1325  *
1326  * @FIF_OTHER_BSS: pass frames destined to other BSSes
1327  *
1328  * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS  is not set then only
1329  *  those addressed to this station.
1330  */
1331 enum ieee80211_filter_flags {
1332         FIF_PROMISC_IN_BSS      = 1<<0,
1333         FIF_ALLMULTI            = 1<<1,
1334         FIF_FCSFAIL             = 1<<2,
1335         FIF_PLCPFAIL            = 1<<3,
1336         FIF_BCN_PRBRESP_PROMISC = 1<<4,
1337         FIF_CONTROL             = 1<<5,
1338         FIF_OTHER_BSS           = 1<<6,
1339         FIF_PSPOLL              = 1<<7,
1340 };
1341
1342 /**
1343  * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1344  *
1345  * These flags are used with the ampdu_action() callback in
1346  * &struct ieee80211_ops to indicate which action is needed.
1347  *
1348  * Note that drivers MUST be able to deal with a TX aggregation
1349  * session being stopped even before they OK'ed starting it by
1350  * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1351  * might receive the addBA frame and send a delBA right away!
1352  *
1353  * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1354  * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1355  * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1356  * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1357  * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1358  */
1359 enum ieee80211_ampdu_mlme_action {
1360         IEEE80211_AMPDU_RX_START,
1361         IEEE80211_AMPDU_RX_STOP,
1362         IEEE80211_AMPDU_TX_START,
1363         IEEE80211_AMPDU_TX_STOP,
1364         IEEE80211_AMPDU_TX_OPERATIONAL,
1365 };
1366
1367 /**
1368  * struct ieee80211_ops - callbacks from mac80211 to the driver
1369  *
1370  * This structure contains various callbacks that the driver may
1371  * handle or, in some cases, must handle, for example to configure
1372  * the hardware to a new channel or to transmit a frame.
1373  *
1374  * @tx: Handler that 802.11 module calls for each transmitted frame.
1375  *      skb contains the buffer starting from the IEEE 802.11 header.
1376  *      The low-level driver should send the frame out based on
1377  *      configuration in the TX control data. This handler should,
1378  *      preferably, never fail and stop queues appropriately, more
1379  *      importantly, however, it must never fail for A-MPDU-queues.
1380  *      This function should return NETDEV_TX_OK except in very
1381  *      limited cases.
1382  *      Must be implemented and atomic.
1383  *
1384  * @start: Called before the first netdevice attached to the hardware
1385  *      is enabled. This should turn on the hardware and must turn on
1386  *      frame reception (for possibly enabled monitor interfaces.)
1387  *      Returns negative error codes, these may be seen in userspace,
1388  *      or zero.
1389  *      When the device is started it should not have a MAC address
1390  *      to avoid acknowledging frames before a non-monitor device
1391  *      is added.
1392  *      Must be implemented and can sleep.
1393  *
1394  * @stop: Called after last netdevice attached to the hardware
1395  *      is disabled. This should turn off the hardware (at least
1396  *      it must turn off frame reception.)
1397  *      May be called right after add_interface if that rejects
1398  *      an interface. If you added any work onto the mac80211 workqueue
1399  *      you should ensure to cancel it on this callback.
1400  *      Must be implemented and can sleep.
1401  *
1402  * @add_interface: Called when a netdevice attached to the hardware is
1403  *      enabled. Because it is not called for monitor mode devices, @start
1404  *      and @stop must be implemented.
1405  *      The driver should perform any initialization it needs before
1406  *      the device can be enabled. The initial configuration for the
1407  *      interface is given in the conf parameter.
1408  *      The callback may refuse to add an interface by returning a
1409  *      negative error code (which will be seen in userspace.)
1410  *      Must be implemented and can sleep.
1411  *
1412  * @remove_interface: Notifies a driver that an interface is going down.
1413  *      The @stop callback is called after this if it is the last interface
1414  *      and no monitor interfaces are present.
1415  *      When all interfaces are removed, the MAC address in the hardware
1416  *      must be cleared so the device no longer acknowledges packets,
1417  *      the mac_addr member of the conf structure is, however, set to the
1418  *      MAC address of the device going away.
1419  *      Hence, this callback must be implemented. It can sleep.
1420  *
1421  * @config: Handler for configuration requests. IEEE 802.11 code calls this
1422  *      function to change hardware configuration, e.g., channel.
1423  *      This function should never fail but returns a negative error code
1424  *      if it does. The callback can sleep.
1425  *
1426  * @bss_info_changed: Handler for configuration requests related to BSS
1427  *      parameters that may vary during BSS's lifespan, and may affect low
1428  *      level driver (e.g. assoc/disassoc status, erp parameters).
1429  *      This function should not be used if no BSS has been set, unless
1430  *      for association indication. The @changed parameter indicates which
1431  *      of the bss parameters has changed when a call is made. The callback
1432  *      can sleep.
1433  *
1434  * @prepare_multicast: Prepare for multicast filter configuration.
1435  *      This callback is optional, and its return value is passed
1436  *      to configure_filter(). This callback must be atomic.
1437  *
1438  * @configure_filter: Configure the device's RX filter.
1439  *      See the section "Frame filtering" for more information.
1440  *      This callback must be implemented and can sleep.
1441  *
1442  * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1443  *      must be set or cleared for a given STA. Must be atomic.
1444  *
1445  * @set_key: See the section "Hardware crypto acceleration"
1446  *      This callback is only called between add_interface and
1447  *      remove_interface calls, i.e. while the given virtual interface
1448  *      is enabled.
1449  *      Returns a negative error code if the key can't be added.
1450  *      The callback can sleep.
1451  *
1452  * @update_tkip_key: See the section "Hardware crypto acceleration"
1453  *      This callback will be called in the context of Rx. Called for drivers
1454  *      which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1455  *      The callback can sleep.
1456  *
1457  * @hw_scan: Ask the hardware to service the scan request, no need to start
1458  *      the scan state machine in stack. The scan must honour the channel
1459  *      configuration done by the regulatory agent in the wiphy's
1460  *      registered bands. The hardware (or the driver) needs to make sure
1461  *      that power save is disabled.
1462  *      The @req ie/ie_len members are rewritten by mac80211 to contain the
1463  *      entire IEs after the SSID, so that drivers need not look at these
1464  *      at all but just send them after the SSID -- mac80211 includes the
1465  *      (extended) supported rates and HT information (where applicable).
1466  *      When the scan finishes, ieee80211_scan_completed() must be called;
1467  *      note that it also must be called when the scan cannot finish due to
1468  *      any error unless this callback returned a negative error code.
1469  *      The callback can sleep.
1470  *
1471  * @sw_scan_start: Notifier function that is called just before a software scan
1472  *      is started. Can be NULL, if the driver doesn't need this notification.
1473  *      The callback can sleep.
1474  *
1475  * @sw_scan_complete: Notifier function that is called just after a
1476  *      software scan finished. Can be NULL, if the driver doesn't need
1477  *      this notification.
1478  *      The callback can sleep.
1479  *
1480  * @get_stats: Return low-level statistics.
1481  *      Returns zero if statistics are available.
1482  *      The callback can sleep.
1483  *
1484  * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1485  *      callback should be provided to read the TKIP transmit IVs (both IV32
1486  *      and IV16) for the given key from hardware.
1487  *      The callback must be atomic.
1488  *
1489  * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1490  *      The callback can sleep.
1491  *
1492  * @sta_notify: Notifies low level driver about addition, removal or power
1493  *      state transition of an associated station, AP,  IBSS/WDS/mesh peer etc.
1494  *      Must be atomic.
1495  *
1496  * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1497  *      bursting) for a hardware TX queue.
1498  *      Returns a negative error code on failure.
1499  *      The callback can sleep.
1500  *
1501  * @get_tx_stats: Get statistics of the current TX queue status. This is used
1502  *      to get number of currently queued packets (queue length), maximum queue
1503  *      size (limit), and total number of packets sent using each TX queue
1504  *      (count). The 'stats' pointer points to an array that has hw->queues
1505  *      items.
1506  *      The callback must be atomic.
1507  *
1508  * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1509  *      this is only used for IBSS mode BSSID merging and debugging. Is not a
1510  *      required function.
1511  *      The callback can sleep.
1512  *
1513  * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1514  *      Currently, this is only used for IBSS mode debugging. Is not a
1515  *      required function.
1516  *      The callback can sleep.
1517  *
1518  * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1519  *      with other STAs in the IBSS. This is only used in IBSS mode. This
1520  *      function is optional if the firmware/hardware takes full care of
1521  *      TSF synchronization.
1522  *      The callback can sleep.
1523  *
1524  * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1525  *      This is needed only for IBSS mode and the result of this function is
1526  *      used to determine whether to reply to Probe Requests.
1527  *      Returns non-zero if this device sent the last beacon.
1528  *      The callback can sleep.
1529  *
1530  * @ampdu_action: Perform a certain A-MPDU action
1531  *      The RA/TID combination determines the destination and TID we want
1532  *      the ampdu action to be performed for. The action is defined through
1533  *      ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1534  *      is the first frame we expect to perform the action on. Notice
1535  *      that TX/RX_STOP can pass NULL for this parameter.
1536  *      Returns a negative error code on failure.
1537  *      The callback must be atomic.
1538  *
1539  * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1540  *      need to set wiphy->rfkill_poll to %true before registration,
1541  *      and need to call wiphy_rfkill_set_hw_state() in the callback.
1542  *      The callback can sleep.
1543  *
1544  * @set_coverage_class: Set slot time for given coverage class as specified
1545  *      in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1546  *      accordingly. This callback is not required and may sleep.
1547  *
1548  * @testmode_cmd: Implement a cfg80211 test mode command.
1549  *      The callback can sleep.
1550  *
1551  * @flush: Flush all pending frames from the hardware queue, making sure
1552  *      that the hardware queues are empty. If the parameter @drop is set
1553  *      to %true, pending frames may be dropped. The callback can sleep.
1554  */
1555 struct ieee80211_ops {
1556         int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1557         int (*start)(struct ieee80211_hw *hw);
1558         void (*stop)(struct ieee80211_hw *hw);
1559         int (*add_interface)(struct ieee80211_hw *hw,
1560                              struct ieee80211_vif *vif);
1561         void (*remove_interface)(struct ieee80211_hw *hw,
1562                                  struct ieee80211_vif *vif);
1563         int (*config)(struct ieee80211_hw *hw, u32 changed);
1564         void (*bss_info_changed)(struct ieee80211_hw *hw,
1565                                  struct ieee80211_vif *vif,
1566                                  struct ieee80211_bss_conf *info,
1567                                  u32 changed);
1568         u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1569                                  int mc_count, struct dev_addr_list *mc_list);
1570         void (*configure_filter)(struct ieee80211_hw *hw,
1571                                  unsigned int changed_flags,
1572                                  unsigned int *total_flags,
1573                                  u64 multicast);
1574         int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1575                        bool set);
1576         int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1577                        struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1578                        struct ieee80211_key_conf *key);
1579         void (*update_tkip_key)(struct ieee80211_hw *hw,
1580                         struct ieee80211_key_conf *conf, const u8 *address,
1581                         u32 iv32, u16 *phase1key);
1582         int (*hw_scan)(struct ieee80211_hw *hw,
1583                        struct cfg80211_scan_request *req);
1584         void (*sw_scan_start)(struct ieee80211_hw *hw);
1585         void (*sw_scan_complete)(struct ieee80211_hw *hw);
1586         int (*get_stats)(struct ieee80211_hw *hw,
1587                          struct ieee80211_low_level_stats *stats);
1588         void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1589                              u32 *iv32, u16 *iv16);
1590         int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1591         void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1592                         enum sta_notify_cmd, struct ieee80211_sta *sta);
1593         int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1594                        const struct ieee80211_tx_queue_params *params);
1595         int (*get_tx_stats)(struct ieee80211_hw *hw,
1596                             struct ieee80211_tx_queue_stats *stats);
1597         u64 (*get_tsf)(struct ieee80211_hw *hw);
1598         void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1599         void (*reset_tsf)(struct ieee80211_hw *hw);
1600         int (*tx_last_beacon)(struct ieee80211_hw *hw);
1601         int (*ampdu_action)(struct ieee80211_hw *hw,
1602                             struct ieee80211_vif *vif,
1603                             enum ieee80211_ampdu_mlme_action action,
1604                             struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1605
1606         void (*rfkill_poll)(struct ieee80211_hw *hw);
1607         void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
1608 #ifdef CONFIG_NL80211_TESTMODE
1609         int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1610 #endif
1611         void (*flush)(struct ieee80211_hw *hw, bool drop);
1612 };
1613
1614 /**
1615  * ieee80211_alloc_hw -  Allocate a new hardware device
1616  *
1617  * This must be called once for each hardware device. The returned pointer
1618  * must be used to refer to this device when calling other functions.
1619  * mac80211 allocates a private data area for the driver pointed to by
1620  * @priv in &struct ieee80211_hw, the size of this area is given as
1621  * @priv_data_len.
1622  *
1623  * @priv_data_len: length of private data
1624  * @ops: callbacks for this device
1625  */
1626 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1627                                         const struct ieee80211_ops *ops);
1628
1629 /**
1630  * ieee80211_register_hw - Register hardware device
1631  *
1632  * You must call this function before any other functions in
1633  * mac80211. Note that before a hardware can be registered, you
1634  * need to fill the contained wiphy's information.
1635  *
1636  * @hw: the device to register as returned by ieee80211_alloc_hw()
1637  */
1638 int ieee80211_register_hw(struct ieee80211_hw *hw);
1639
1640 #ifdef CONFIG_MAC80211_LEDS
1641 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1642 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1643 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1644 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1645 #endif
1646 /**
1647  * ieee80211_get_tx_led_name - get name of TX LED
1648  *
1649  * mac80211 creates a transmit LED trigger for each wireless hardware
1650  * that can be used to drive LEDs if your driver registers a LED device.
1651  * This function returns the name (or %NULL if not configured for LEDs)
1652  * of the trigger so you can automatically link the LED device.
1653  *
1654  * @hw: the hardware to get the LED trigger name for
1655  */
1656 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1657 {
1658 #ifdef CONFIG_MAC80211_LEDS
1659         return __ieee80211_get_tx_led_name(hw);
1660 #else
1661         return NULL;
1662 #endif
1663 }
1664
1665 /**
1666  * ieee80211_get_rx_led_name - get name of RX LED
1667  *
1668  * mac80211 creates a receive LED trigger for each wireless hardware
1669  * that can be used to drive LEDs if your driver registers a LED device.
1670  * This function returns the name (or %NULL if not configured for LEDs)
1671  * of the trigger so you can automatically link the LED device.
1672  *
1673  * @hw: the hardware to get the LED trigger name for
1674  */
1675 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1676 {
1677 #ifdef CONFIG_MAC80211_LEDS
1678         return __ieee80211_get_rx_led_name(hw);
1679 #else
1680         return NULL;
1681 #endif
1682 }
1683
1684 /**
1685  * ieee80211_get_assoc_led_name - get name of association LED
1686  *
1687  * mac80211 creates a association LED trigger for each wireless hardware
1688  * that can be used to drive LEDs if your driver registers a LED device.
1689  * This function returns the name (or %NULL if not configured for LEDs)
1690  * of the trigger so you can automatically link the LED device.
1691  *
1692  * @hw: the hardware to get the LED trigger name for
1693  */
1694 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1695 {
1696 #ifdef CONFIG_MAC80211_LEDS
1697         return __ieee80211_get_assoc_led_name(hw);
1698 #else
1699         return NULL;
1700 #endif
1701 }
1702
1703 /**
1704  * ieee80211_get_radio_led_name - get name of radio LED
1705  *
1706  * mac80211 creates a radio change LED trigger for each wireless hardware
1707  * that can be used to drive LEDs if your driver registers a LED device.
1708  * This function returns the name (or %NULL if not configured for LEDs)
1709  * of the trigger so you can automatically link the LED device.
1710  *
1711  * @hw: the hardware to get the LED trigger name for
1712  */
1713 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1714 {
1715 #ifdef CONFIG_MAC80211_LEDS
1716         return __ieee80211_get_radio_led_name(hw);
1717 #else
1718         return NULL;
1719 #endif
1720 }
1721
1722 /**
1723  * ieee80211_unregister_hw - Unregister a hardware device
1724  *
1725  * This function instructs mac80211 to free allocated resources
1726  * and unregister netdevices from the networking subsystem.
1727  *
1728  * @hw: the hardware to unregister
1729  */
1730 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1731
1732 /**
1733  * ieee80211_free_hw - free hardware descriptor
1734  *
1735  * This function frees everything that was allocated, including the
1736  * private data for the driver. You must call ieee80211_unregister_hw()
1737  * before calling this function.
1738  *
1739  * @hw: the hardware to free
1740  */
1741 void ieee80211_free_hw(struct ieee80211_hw *hw);
1742
1743 /**
1744  * ieee80211_restart_hw - restart hardware completely
1745  *
1746  * Call this function when the hardware was restarted for some reason
1747  * (hardware error, ...) and the driver is unable to restore its state
1748  * by itself. mac80211 assumes that at this point the driver/hardware
1749  * is completely uninitialised and stopped, it starts the process by
1750  * calling the ->start() operation. The driver will need to reset all
1751  * internal state that it has prior to calling this function.
1752  *
1753  * @hw: the hardware to restart
1754  */
1755 void ieee80211_restart_hw(struct ieee80211_hw *hw);
1756
1757 /**
1758  * ieee80211_rx - receive frame
1759  *
1760  * Use this function to hand received frames to mac80211. The receive
1761  * buffer in @skb must start with an IEEE 802.11 header.
1762  *
1763  * This function may not be called in IRQ context. Calls to this function
1764  * for a single hardware must be synchronized against each other. Calls to
1765  * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1766  * mixed for a single hardware.
1767  *
1768  * In process context use instead ieee80211_rx_ni().
1769  *
1770  * @hw: the hardware this frame came in on
1771  * @skb: the buffer to receive, owned by mac80211 after this call
1772  */
1773 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
1774
1775 /**
1776  * ieee80211_rx_irqsafe - receive frame
1777  *
1778  * Like ieee80211_rx() but can be called in IRQ context
1779  * (internally defers to a tasklet.)
1780  *
1781  * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1782  * be mixed for a single hardware.
1783  *
1784  * @hw: the hardware this frame came in on
1785  * @skb: the buffer to receive, owned by mac80211 after this call
1786  */
1787 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
1788
1789 /**
1790  * ieee80211_rx_ni - receive frame (in process context)
1791  *
1792  * Like ieee80211_rx() but can be called in process context
1793  * (internally disables bottom halves).
1794  *
1795  * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1796  * not be mixed for a single hardware.
1797  *
1798  * @hw: the hardware this frame came in on
1799  * @skb: the buffer to receive, owned by mac80211 after this call
1800  */
1801 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1802                                    struct sk_buff *skb)
1803 {
1804         local_bh_disable();
1805         ieee80211_rx(hw, skb);
1806         local_bh_enable();
1807 }
1808
1809 /*
1810  * The TX headroom reserved by mac80211 for its own tx_status functions.
1811  * This is enough for the radiotap header.
1812  */
1813 #define IEEE80211_TX_STATUS_HEADROOM    13
1814
1815 /**
1816  * ieee80211_tx_status - transmit status callback
1817  *
1818  * Call this function for all transmitted frames after they have been
1819  * transmitted. It is permissible to not call this function for
1820  * multicast frames but this can affect statistics.
1821  *
1822  * This function may not be called in IRQ context. Calls to this function
1823  * for a single hardware must be synchronized against each other. Calls
1824  * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1825  * for a single hardware.
1826  *
1827  * @hw: the hardware the frame was transmitted by
1828  * @skb: the frame that was transmitted, owned by mac80211 after this call
1829  */
1830 void ieee80211_tx_status(struct ieee80211_hw *hw,
1831                          struct sk_buff *skb);
1832
1833 /**
1834  * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1835  *
1836  * Like ieee80211_tx_status() but can be called in IRQ context
1837  * (internally defers to a tasklet.)
1838  *
1839  * Calls to this function and ieee80211_tx_status() may not be mixed for a
1840  * single hardware.
1841  *
1842  * @hw: the hardware the frame was transmitted by
1843  * @skb: the frame that was transmitted, owned by mac80211 after this call
1844  */
1845 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1846                                  struct sk_buff *skb);
1847
1848 /**
1849  * ieee80211_beacon_get_tim - beacon generation function
1850  * @hw: pointer obtained from ieee80211_alloc_hw().
1851  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1852  * @tim_offset: pointer to variable that will receive the TIM IE offset.
1853  *      Set to 0 if invalid (in non-AP modes).
1854  * @tim_length: pointer to variable that will receive the TIM IE length,
1855  *      (including the ID and length bytes!).
1856  *      Set to 0 if invalid (in non-AP modes).
1857  *
1858  * If the driver implements beaconing modes, it must use this function to
1859  * obtain the beacon frame/template.
1860  *
1861  * If the beacon frames are generated by the host system (i.e., not in
1862  * hardware/firmware), the driver uses this function to get each beacon
1863  * frame from mac80211 -- it is responsible for calling this function
1864  * before the beacon is needed (e.g. based on hardware interrupt).
1865  *
1866  * If the beacon frames are generated by the device, then the driver
1867  * must use the returned beacon as the template and change the TIM IE
1868  * according to the current DTIM parameters/TIM bitmap.
1869  *
1870  * The driver is responsible for freeing the returned skb.
1871  */
1872 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
1873                                          struct ieee80211_vif *vif,
1874                                          u16 *tim_offset, u16 *tim_length);
1875
1876 /**
1877  * ieee80211_beacon_get - beacon generation function
1878  * @hw: pointer obtained from ieee80211_alloc_hw().
1879  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1880  *
1881  * See ieee80211_beacon_get_tim().
1882  */
1883 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1884                                                    struct ieee80211_vif *vif)
1885 {
1886         return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
1887 }
1888
1889 /**
1890  * ieee80211_pspoll_get - retrieve a PS Poll template
1891  * @hw: pointer obtained from ieee80211_alloc_hw().
1892  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1893  *
1894  * Creates a PS Poll a template which can, for example, uploaded to
1895  * hardware. The template must be updated after association so that correct
1896  * AID, BSSID and MAC address is used.
1897  *
1898  * Note: Caller (or hardware) is responsible for setting the
1899  * &IEEE80211_FCTL_PM bit.
1900  */
1901 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
1902                                      struct ieee80211_vif *vif);
1903
1904 /**
1905  * ieee80211_nullfunc_get - retrieve a nullfunc template
1906  * @hw: pointer obtained from ieee80211_alloc_hw().
1907  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1908  *
1909  * Creates a Nullfunc template which can, for example, uploaded to
1910  * hardware. The template must be updated after association so that correct
1911  * BSSID and address is used.
1912  *
1913  * Note: Caller (or hardware) is responsible for setting the
1914  * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
1915  */
1916 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
1917                                        struct ieee80211_vif *vif);
1918
1919 /**
1920  * ieee80211_probereq_get - retrieve a Probe Request template
1921  * @hw: pointer obtained from ieee80211_alloc_hw().
1922  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1923  * @ssid: SSID buffer
1924  * @ssid_len: length of SSID
1925  * @ie: buffer containing all IEs except SSID for the template
1926  * @ie_len: length of the IE buffer
1927  *
1928  * Creates a Probe Request template which can, for example, be uploaded to
1929  * hardware.
1930  */
1931 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
1932                                        struct ieee80211_vif *vif,
1933                                        const u8 *ssid, size_t ssid_len,
1934                                        const u8 *ie, size_t ie_len);
1935
1936 /**
1937  * ieee80211_rts_get - RTS frame generation function
1938  * @hw: pointer obtained from ieee80211_alloc_hw().
1939  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1940  * @frame: pointer to the frame that is going to be protected by the RTS.
1941  * @frame_len: the frame length (in octets).
1942  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1943  * @rts: The buffer where to store the RTS frame.
1944  *
1945  * If the RTS frames are generated by the host system (i.e., not in
1946  * hardware/firmware), the low-level driver uses this function to receive
1947  * the next RTS frame from the 802.11 code. The low-level is responsible
1948  * for calling this function before and RTS frame is needed.
1949  */
1950 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1951                        const void *frame, size_t frame_len,
1952                        const struct ieee80211_tx_info *frame_txctl,
1953                        struct ieee80211_rts *rts);
1954
1955 /**
1956  * ieee80211_rts_duration - Get the duration field for an RTS frame
1957  * @hw: pointer obtained from ieee80211_alloc_hw().
1958  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1959  * @frame_len: the length of the frame that is going to be protected by the RTS.
1960  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1961  *
1962  * If the RTS is generated in firmware, but the host system must provide
1963  * the duration field, the low-level driver uses this function to receive
1964  * the duration field value in little-endian byteorder.
1965  */
1966 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1967                               struct ieee80211_vif *vif, size_t frame_len,
1968                               const struct ieee80211_tx_info *frame_txctl);
1969
1970 /**
1971  * ieee80211_ctstoself_get - CTS-to-self frame generation function
1972  * @hw: pointer obtained from ieee80211_alloc_hw().
1973  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1974  * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1975  * @frame_len: the frame length (in octets).
1976  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1977  * @cts: The buffer where to store the CTS-to-self frame.
1978  *
1979  * If the CTS-to-self frames are generated by the host system (i.e., not in
1980  * hardware/firmware), the low-level driver uses this function to receive
1981  * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1982  * for calling this function before and CTS-to-self frame is needed.
1983  */
1984 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1985                              struct ieee80211_vif *vif,
1986                              const void *frame, size_t frame_len,
1987                              const struct ieee80211_tx_info *frame_txctl,
1988                              struct ieee80211_cts *cts);
1989
1990 /**
1991  * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1992  * @hw: pointer obtained from ieee80211_alloc_hw().
1993  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1994  * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1995  * @frame_txctl: &struct ieee80211_tx_info of the frame.
1996  *
1997  * If the CTS-to-self is generated in firmware, but the host system must provide
1998  * the duration field, the low-level driver uses this function to receive
1999  * the duration field value in little-endian byteorder.
2000  */
2001 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2002                                     struct ieee80211_vif *vif,
2003                                     size_t frame_len,
2004                                     const struct ieee80211_tx_info *frame_txctl);
2005
2006 /**
2007  * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2008  * @hw: pointer obtained from ieee80211_alloc_hw().
2009  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2010  * @frame_len: the length of the frame.
2011  * @rate: the rate at which the frame is going to be transmitted.
2012  *
2013  * Calculate the duration field of some generic frame, given its
2014  * length and transmission rate (in 100kbps).
2015  */
2016 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2017                                         struct ieee80211_vif *vif,
2018                                         size_t frame_len,
2019                                         struct ieee80211_rate *rate);
2020
2021 /**
2022  * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2023  * @hw: pointer as obtained from ieee80211_alloc_hw().
2024  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2025  *
2026  * Function for accessing buffered broadcast and multicast frames. If
2027  * hardware/firmware does not implement buffering of broadcast/multicast
2028  * frames when power saving is used, 802.11 code buffers them in the host
2029  * memory. The low-level driver uses this function to fetch next buffered
2030  * frame. In most cases, this is used when generating beacon frame. This
2031  * function returns a pointer to the next buffered skb or NULL if no more
2032  * buffered frames are available.
2033  *
2034  * Note: buffered frames are returned only after DTIM beacon frame was
2035  * generated with ieee80211_beacon_get() and the low-level driver must thus
2036  * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2037  * NULL if the previous generated beacon was not DTIM, so the low-level driver
2038  * does not need to check for DTIM beacons separately and should be able to
2039  * use common code for all beacons.
2040  */
2041 struct sk_buff *
2042 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2043
2044 /**
2045  * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2046  *
2047  * This function computes a TKIP rc4 key for an skb. It computes
2048  * a phase 1 key if needed (iv16 wraps around). This function is to
2049  * be used by drivers which can do HW encryption but need to compute
2050  * to phase 1/2 key in SW.
2051  *
2052  * @keyconf: the parameter passed with the set key
2053  * @skb: the skb for which the key is needed
2054  * @type: TBD
2055  * @key: a buffer to which the key will be written
2056  */
2057 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2058                                 struct sk_buff *skb,
2059                                 enum ieee80211_tkip_key_type type, u8 *key);
2060 /**
2061  * ieee80211_wake_queue - wake specific queue
2062  * @hw: pointer as obtained from ieee80211_alloc_hw().
2063  * @queue: queue number (counted from zero).
2064  *
2065  * Drivers should use this function instead of netif_wake_queue.
2066  */
2067 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2068
2069 /**
2070  * ieee80211_stop_queue - stop specific queue
2071  * @hw: pointer as obtained from ieee80211_alloc_hw().
2072  * @queue: queue number (counted from zero).
2073  *
2074  * Drivers should use this function instead of netif_stop_queue.
2075  */
2076 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2077
2078 /**
2079  * ieee80211_queue_stopped - test status of the queue
2080  * @hw: pointer as obtained from ieee80211_alloc_hw().
2081  * @queue: queue number (counted from zero).
2082  *
2083  * Drivers should use this function instead of netif_stop_queue.
2084  */
2085
2086 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2087
2088 /**
2089  * ieee80211_stop_queues - stop all queues
2090  * @hw: pointer as obtained from ieee80211_alloc_hw().
2091  *
2092  * Drivers should use this function instead of netif_stop_queue.
2093  */
2094 void ieee80211_stop_queues(struct ieee80211_hw *hw);
2095
2096 /**
2097  * ieee80211_wake_queues - wake all queues
2098  * @hw: pointer as obtained from ieee80211_alloc_hw().
2099  *
2100  * Drivers should use this function instead of netif_wake_queue.
2101  */
2102 void ieee80211_wake_queues(struct ieee80211_hw *hw);
2103
2104 /**
2105  * ieee80211_scan_completed - completed hardware scan
2106  *
2107  * When hardware scan offload is used (i.e. the hw_scan() callback is
2108  * assigned) this function needs to be called by the driver to notify
2109  * mac80211 that the scan finished.
2110  *
2111  * @hw: the hardware that finished the scan
2112  * @aborted: set to true if scan was aborted
2113  */
2114 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2115
2116 /**
2117  * ieee80211_iterate_active_interfaces - iterate active interfaces
2118  *
2119  * This function iterates over the interfaces associated with a given
2120  * hardware that are currently active and calls the callback for them.
2121  * This function allows the iterator function to sleep, when the iterator
2122  * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2123  * be used.
2124  *
2125  * @hw: the hardware struct of which the interfaces should be iterated over
2126  * @iterator: the iterator function to call
2127  * @data: first argument of the iterator function
2128  */
2129 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2130                                          void (*iterator)(void *data, u8 *mac,
2131                                                 struct ieee80211_vif *vif),
2132                                          void *data);
2133
2134 /**
2135  * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2136  *
2137  * This function iterates over the interfaces associated with a given
2138  * hardware that are currently active and calls the callback for them.
2139  * This function requires the iterator callback function to be atomic,
2140  * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2141  *
2142  * @hw: the hardware struct of which the interfaces should be iterated over
2143  * @iterator: the iterator function to call, cannot sleep
2144  * @data: first argument of the iterator function
2145  */
2146 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2147                                                 void (*iterator)(void *data,
2148                                                     u8 *mac,
2149                                                     struct ieee80211_vif *vif),
2150                                                 void *data);
2151
2152 /**
2153  * ieee80211_queue_work - add work onto the mac80211 workqueue
2154  *
2155  * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2156  * This helper ensures drivers are not queueing work when they should not be.
2157  *
2158  * @hw: the hardware struct for the interface we are adding work for
2159  * @work: the work we want to add onto the mac80211 workqueue
2160  */
2161 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2162
2163 /**
2164  * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2165  *
2166  * Drivers and mac80211 use this to queue delayed work onto the mac80211
2167  * workqueue.
2168  *
2169  * @hw: the hardware struct for the interface we are adding work for
2170  * @dwork: delayable work to queue onto the mac80211 workqueue
2171  * @delay: number of jiffies to wait before queueing
2172  */
2173 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2174                                   struct delayed_work *dwork,
2175                                   unsigned long delay);
2176
2177 /**
2178  * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2179  * @sta: the station for which to start a BA session
2180  * @tid: the TID to BA on.
2181  *
2182  * Return: success if addBA request was sent, failure otherwise
2183  *
2184  * Although mac80211/low level driver/user space application can estimate
2185  * the need to start aggregation on a certain RA/TID, the session level
2186  * will be managed by the mac80211.
2187  */
2188 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2189
2190 /**
2191  * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
2192  * @vif: &struct ieee80211_vif pointer from the add_interface callback
2193  * @ra: receiver address of the BA session recipient.
2194  * @tid: the TID to BA on.
2195  *
2196  * This function must be called by low level driver once it has
2197  * finished with preparations for the BA session.
2198  */
2199 void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
2200
2201 /**
2202  * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2203  * @vif: &struct ieee80211_vif pointer from the add_interface callback
2204  * @ra: receiver address of the BA session recipient.
2205  * @tid: the TID to BA on.
2206  *
2207  * This function must be called by low level driver once it has
2208  * finished with preparations for the BA session.
2209  * This version of the function is IRQ-safe.
2210  */
2211 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2212                                       u16 tid);
2213
2214 /**
2215  * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2216  * @sta: the station whose BA session to stop
2217  * @tid: the TID to stop BA.
2218  * @initiator: if indicates initiator DELBA frame will be sent.
2219  *
2220  * Return: error if no sta with matching da found, success otherwise
2221  *
2222  * Although mac80211/low level driver/user space application can estimate
2223  * the need to stop aggregation on a certain RA/TID, the session level
2224  * will be managed by the mac80211.
2225  */
2226 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2227                                  enum ieee80211_back_parties initiator);
2228
2229 /**
2230  * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
2231  * @vif: &struct ieee80211_vif pointer from the add_interface callback
2232  * @ra: receiver address of the BA session recipient.
2233  * @tid: the desired TID to BA on.
2234  *
2235  * This function must be called by low level driver once it has
2236  * finished with preparations for the BA session tear down.
2237  */
2238 void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
2239
2240 /**
2241  * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2242  * @vif: &struct ieee80211_vif pointer from the add_interface callback
2243  * @ra: receiver address of the BA session recipient.
2244  * @tid: the desired TID to BA on.
2245  *
2246  * This function must be called by low level driver once it has
2247  * finished with preparations for the BA session tear down.
2248  * This version of the function is IRQ-safe.
2249  */
2250 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2251                                      u16 tid);
2252
2253 /**
2254  * ieee80211_find_sta - find a station
2255  *
2256  * @vif: virtual interface to look for station on
2257  * @addr: station's address
2258  *
2259  * This function must be called under RCU lock and the
2260  * resulting pointer is only valid under RCU lock as well.
2261  */
2262 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2263                                          const u8 *addr);
2264
2265 /**
2266  * ieee80211_find_sta_by_hw - find a station on hardware
2267  *
2268  * @hw: pointer as obtained from ieee80211_alloc_hw()
2269  * @addr: station's address
2270  *
2271  * This function must be called under RCU lock and the
2272  * resulting pointer is only valid under RCU lock as well.
2273  *
2274  * NOTE: This function should not be used! When mac80211 is converted
2275  *       internally to properly keep track of stations on multiple
2276  *       virtual interfaces, it will not always know which station to
2277  *       return here since a single address might be used by multiple
2278  *       logical stations (e.g. consider a station connecting to another
2279  *       BSSID on the same AP hardware without disconnecting first).
2280  *
2281  * DO NOT USE THIS FUNCTION.
2282  */
2283 struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2284                                                const u8 *addr);
2285
2286 /**
2287  * ieee80211_sta_block_awake - block station from waking up
2288  * @hw: the hardware
2289  * @pubsta: the station
2290  * @block: whether to block or unblock
2291  *
2292  * Some devices require that all frames that are on the queues
2293  * for a specific station that went to sleep are flushed before
2294  * a poll response or frames after the station woke up can be
2295  * delivered to that it. Note that such frames must be rejected
2296  * by the driver as filtered, with the appropriate status flag.
2297  *
2298  * This function allows implementing this mode in a race-free
2299  * manner.
2300  *
2301  * To do this, a driver must keep track of the number of frames
2302  * still enqueued for a specific station. If this number is not
2303  * zero when the station goes to sleep, the driver must call
2304  * this function to force mac80211 to consider the station to
2305  * be asleep regardless of the station's actual state. Once the
2306  * number of outstanding frames reaches zero, the driver must
2307  * call this function again to unblock the station. That will
2308  * cause mac80211 to be able to send ps-poll responses, and if
2309  * the station queried in the meantime then frames will also
2310  * be sent out as a result of this. Additionally, the driver
2311  * will be notified that the station woke up some time after
2312  * it is unblocked, regardless of whether the station actually
2313  * woke up while blocked or not.
2314  */
2315 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2316                                struct ieee80211_sta *pubsta, bool block);
2317
2318 /**
2319  * ieee80211_beacon_loss - inform hardware does not receive beacons
2320  *
2321  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2322  *
2323  * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2324  * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2325  * hardware is not receiving beacons with this function.
2326  */
2327 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2328
2329 /* Rate control API */
2330
2331 /**
2332  * enum rate_control_changed - flags to indicate which parameter changed
2333  *
2334  * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2335  *      changed, rate control algorithm can update its internal state if needed.
2336  */
2337 enum rate_control_changed {
2338         IEEE80211_RC_HT_CHANGED = BIT(0)
2339 };
2340
2341 /**
2342  * struct ieee80211_tx_rate_control - rate control information for/from RC algo
2343  *
2344  * @hw: The hardware the algorithm is invoked for.
2345  * @sband: The band this frame is being transmitted on.
2346  * @bss_conf: the current BSS configuration
2347  * @reported_rate: The rate control algorithm can fill this in to indicate
2348  *      which rate should be reported to userspace as the current rate and
2349  *      used for rate calculations in the mesh network.
2350  * @rts: whether RTS will be used for this frame because it is longer than the
2351  *      RTS threshold
2352  * @short_preamble: whether mac80211 will request short-preamble transmission
2353  *      if the selected rate supports it
2354  * @max_rate_idx: user-requested maximum rate (not MCS for now)
2355  *      (deprecated; this will be removed once drivers get updated to use
2356  *      rate_idx_mask)
2357  * @rate_idx_mask: user-requested rate mask (not MCS for now)
2358  * @skb: the skb that will be transmitted, the control information in it needs
2359  *      to be filled in
2360  * @ap: whether this frame is sent out in AP mode
2361  */
2362 struct ieee80211_tx_rate_control {
2363         struct ieee80211_hw *hw;
2364         struct ieee80211_supported_band *sband;
2365         struct ieee80211_bss_conf *bss_conf;
2366         struct sk_buff *skb;
2367         struct ieee80211_tx_rate reported_rate;
2368         bool rts, short_preamble;
2369         u8 max_rate_idx;
2370         u32 rate_idx_mask;
2371         bool ap;
2372 };
2373
2374 struct rate_control_ops {
2375         struct module *module;
2376         const char *name;
2377         void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2378         void (*free)(void *priv);
2379
2380         void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2381         void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2382                           struct ieee80211_sta *sta, void *priv_sta);
2383         void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2384                             struct ieee80211_sta *sta,
2385                             void *priv_sta, u32 changed);
2386         void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2387                          void *priv_sta);
2388
2389         void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2390                           struct ieee80211_sta *sta, void *priv_sta,
2391                           struct sk_buff *skb);
2392         void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2393                          struct ieee80211_tx_rate_control *txrc);
2394
2395         void (*add_sta_debugfs)(void *priv, void *priv_sta,
2396                                 struct dentry *dir);
2397         void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2398 };
2399
2400 static inline int rate_supported(struct ieee80211_sta *sta,
2401                                  enum ieee80211_band band,
2402                                  int index)
2403 {
2404         return (sta == NULL || sta->supp_rates[band] & BIT(index));
2405 }
2406
2407 /**
2408  * rate_control_send_low - helper for drivers for management/no-ack frames
2409  *
2410  * Rate control algorithms that agree to use the lowest rate to
2411  * send management frames and NO_ACK data with the respective hw
2412  * retries should use this in the beginning of their mac80211 get_rate
2413  * callback. If true is returned the rate control can simply return.
2414  * If false is returned we guarantee that sta and sta and priv_sta is
2415  * not null.
2416  *
2417  * Rate control algorithms wishing to do more intelligent selection of
2418  * rate for multicast/broadcast frames may choose to not use this.
2419  *
2420  * @sta: &struct ieee80211_sta pointer to the target destination. Note
2421  *      that this may be null.
2422  * @priv_sta: private rate control structure. This may be null.
2423  * @txrc: rate control information we sholud populate for mac80211.
2424  */
2425 bool rate_control_send_low(struct ieee80211_sta *sta,
2426                            void *priv_sta,
2427                            struct ieee80211_tx_rate_control *txrc);
2428
2429
2430 static inline s8
2431 rate_lowest_index(struct ieee80211_supported_band *sband,
2432                   struct ieee80211_sta *sta)
2433 {
2434         int i;
2435
2436         for (i = 0; i < sband->n_bitrates; i++)
2437                 if (rate_supported(sta, sband->band, i))
2438                         return i;
2439
2440         /* warn when we cannot find a rate. */
2441         WARN_ON(1);
2442
2443         return 0;
2444 }
2445
2446 static inline
2447 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2448                               struct ieee80211_sta *sta)
2449 {
2450         unsigned int i;
2451
2452         for (i = 0; i < sband->n_bitrates; i++)
2453                 if (rate_supported(sta, sband->band, i))
2454                         return true;
2455         return false;
2456 }
2457
2458 int ieee80211_rate_control_register(struct rate_control_ops *ops);
2459 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2460
2461 static inline bool
2462 conf_is_ht20(struct ieee80211_conf *conf)
2463 {
2464         return conf->channel_type == NL80211_CHAN_HT20;
2465 }
2466
2467 static inline bool
2468 conf_is_ht40_minus(struct ieee80211_conf *conf)
2469 {
2470         return conf->channel_type == NL80211_CHAN_HT40MINUS;
2471 }
2472
2473 static inline bool
2474 conf_is_ht40_plus(struct ieee80211_conf *conf)
2475 {
2476         return conf->channel_type == NL80211_CHAN_HT40PLUS;
2477 }
2478
2479 static inline bool
2480 conf_is_ht40(struct ieee80211_conf *conf)
2481 {
2482         return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2483 }
2484
2485 static inline bool
2486 conf_is_ht(struct ieee80211_conf *conf)
2487 {
2488         return conf->channel_type != NL80211_CHAN_NO_HT;
2489 }
2490
2491 #endif /* MAC80211_H */