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