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