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