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