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