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