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