mac80211: reset probe_send_count also in HW_CONNECTION_MONITOR case
[firefly-linux-kernel-4.4.55.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/bug.h>
17 #include <linux/kernel.h>
18 #include <linux/if_ether.h>
19 #include <linux/skbuff.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 struct device;
91
92 /**
93  * enum ieee80211_max_queues - maximum number of queues
94  *
95  * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96  * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
97  */
98 enum ieee80211_max_queues {
99         IEEE80211_MAX_QUEUES =          16,
100         IEEE80211_MAX_QUEUE_MAP =       BIT(IEEE80211_MAX_QUEUES) - 1,
101 };
102
103 #define IEEE80211_INVAL_HW_QUEUE        0xff
104
105 /**
106  * enum ieee80211_ac_numbers - AC numbers as used in mac80211
107  * @IEEE80211_AC_VO: voice
108  * @IEEE80211_AC_VI: video
109  * @IEEE80211_AC_BE: best effort
110  * @IEEE80211_AC_BK: background
111  */
112 enum ieee80211_ac_numbers {
113         IEEE80211_AC_VO         = 0,
114         IEEE80211_AC_VI         = 1,
115         IEEE80211_AC_BE         = 2,
116         IEEE80211_AC_BK         = 3,
117 };
118 #define IEEE80211_NUM_ACS       4
119
120 /**
121  * struct ieee80211_tx_queue_params - transmit queue configuration
122  *
123  * The information provided in this structure is required for QoS
124  * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
125  *
126  * @aifs: arbitration interframe space [0..255]
127  * @cw_min: minimum contention window [a value of the form
128  *      2^n-1 in the range 1..32767]
129  * @cw_max: maximum contention window [like @cw_min]
130  * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
131  * @acm: is mandatory admission control required for the access category
132  * @uapsd: is U-APSD mode enabled for the queue
133  */
134 struct ieee80211_tx_queue_params {
135         u16 txop;
136         u16 cw_min;
137         u16 cw_max;
138         u8 aifs;
139         bool acm;
140         bool uapsd;
141 };
142
143 struct ieee80211_low_level_stats {
144         unsigned int dot11ACKFailureCount;
145         unsigned int dot11RTSFailureCount;
146         unsigned int dot11FCSErrorCount;
147         unsigned int dot11RTSSuccessCount;
148 };
149
150 /**
151  * enum ieee80211_chanctx_change - change flag for channel context
152  * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
153  * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
154  * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
155  * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
156  *      this is used only with channel switching with CSA
157  * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
158  */
159 enum ieee80211_chanctx_change {
160         IEEE80211_CHANCTX_CHANGE_WIDTH          = BIT(0),
161         IEEE80211_CHANCTX_CHANGE_RX_CHAINS      = BIT(1),
162         IEEE80211_CHANCTX_CHANGE_RADAR          = BIT(2),
163         IEEE80211_CHANCTX_CHANGE_CHANNEL        = BIT(3),
164         IEEE80211_CHANCTX_CHANGE_MIN_WIDTH      = BIT(4),
165 };
166
167 /**
168  * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
169  *
170  * This is the driver-visible part. The ieee80211_chanctx
171  * that contains it is visible in mac80211 only.
172  *
173  * @def: the channel definition
174  * @min_def: the minimum channel definition currently required.
175  * @rx_chains_static: The number of RX chains that must always be
176  *      active on the channel to receive MIMO transmissions
177  * @rx_chains_dynamic: The number of RX chains that must be enabled
178  *      after RTS/CTS handshake to receive SMPS MIMO transmissions;
179  *      this will always be >= @rx_chains_static.
180  * @radar_enabled: whether radar detection is enabled on this channel.
181  * @drv_priv: data area for driver use, will always be aligned to
182  *      sizeof(void *), size is determined in hw information.
183  */
184 struct ieee80211_chanctx_conf {
185         struct cfg80211_chan_def def;
186         struct cfg80211_chan_def min_def;
187
188         u8 rx_chains_static, rx_chains_dynamic;
189
190         bool radar_enabled;
191
192         u8 drv_priv[0] __aligned(sizeof(void *));
193 };
194
195 /**
196  * enum ieee80211_bss_change - BSS change notification flags
197  *
198  * These flags are used with the bss_info_changed() callback
199  * to indicate which BSS parameter changed.
200  *
201  * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
202  *      also implies a change in the AID.
203  * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
204  * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
205  * @BSS_CHANGED_ERP_SLOT: slot timing changed
206  * @BSS_CHANGED_HT: 802.11n parameters changed
207  * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
208  * @BSS_CHANGED_BEACON_INT: Beacon interval changed
209  * @BSS_CHANGED_BSSID: BSSID changed, for whatever
210  *      reason (IBSS and managed mode)
211  * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
212  *      new beacon (beaconing modes)
213  * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
214  *      enabled/disabled (beaconing modes)
215  * @BSS_CHANGED_CQM: Connection quality monitor config changed
216  * @BSS_CHANGED_IBSS: IBSS join status changed
217  * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
218  * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
219  *      that it is only ever disabled for station mode.
220  * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
221  * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
222  * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
223  * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
224  * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
225  * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
226  *      changed (currently only in P2P client mode, GO mode will be later)
227  * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
228  *      currently dtim_period only is under consideration.
229  * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
230  *      note that this is only called when it changes after the channel
231  *      context had been assigned.
232  */
233 enum ieee80211_bss_change {
234         BSS_CHANGED_ASSOC               = 1<<0,
235         BSS_CHANGED_ERP_CTS_PROT        = 1<<1,
236         BSS_CHANGED_ERP_PREAMBLE        = 1<<2,
237         BSS_CHANGED_ERP_SLOT            = 1<<3,
238         BSS_CHANGED_HT                  = 1<<4,
239         BSS_CHANGED_BASIC_RATES         = 1<<5,
240         BSS_CHANGED_BEACON_INT          = 1<<6,
241         BSS_CHANGED_BSSID               = 1<<7,
242         BSS_CHANGED_BEACON              = 1<<8,
243         BSS_CHANGED_BEACON_ENABLED      = 1<<9,
244         BSS_CHANGED_CQM                 = 1<<10,
245         BSS_CHANGED_IBSS                = 1<<11,
246         BSS_CHANGED_ARP_FILTER          = 1<<12,
247         BSS_CHANGED_QOS                 = 1<<13,
248         BSS_CHANGED_IDLE                = 1<<14,
249         BSS_CHANGED_SSID                = 1<<15,
250         BSS_CHANGED_AP_PROBE_RESP       = 1<<16,
251         BSS_CHANGED_PS                  = 1<<17,
252         BSS_CHANGED_TXPOWER             = 1<<18,
253         BSS_CHANGED_P2P_PS              = 1<<19,
254         BSS_CHANGED_BEACON_INFO         = 1<<20,
255         BSS_CHANGED_BANDWIDTH           = 1<<21,
256
257         /* when adding here, make sure to change ieee80211_reconfig */
258 };
259
260 /*
261  * The maximum number of IPv4 addresses listed for ARP filtering. If the number
262  * of addresses for an interface increase beyond this value, hardware ARP
263  * filtering will be disabled.
264  */
265 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
266
267 /**
268  * enum ieee80211_rssi_event - RSSI threshold event
269  * An indicator for when RSSI goes below/above a certain threshold.
270  * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
271  * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
272  */
273 enum ieee80211_rssi_event {
274         RSSI_EVENT_HIGH,
275         RSSI_EVENT_LOW,
276 };
277
278 /**
279  * struct ieee80211_bss_conf - holds the BSS's changing parameters
280  *
281  * This structure keeps information about a BSS (and an association
282  * to that BSS) that can change during the lifetime of the BSS.
283  *
284  * @assoc: association status
285  * @ibss_joined: indicates whether this station is part of an IBSS
286  *      or not
287  * @ibss_creator: indicates if a new IBSS network is being created
288  * @aid: association ID number, valid only when @assoc is true
289  * @use_cts_prot: use CTS protection
290  * @use_short_preamble: use 802.11b short preamble;
291  *      if the hardware cannot handle this it must set the
292  *      IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
293  * @use_short_slot: use short slot time (only relevant for ERP);
294  *      if the hardware cannot handle this it must set the
295  *      IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
296  * @dtim_period: num of beacons before the next DTIM, for beaconing,
297  *      valid in station mode only if after the driver was notified
298  *      with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
299  * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
300  *      as it may have been received during scanning long ago). If the
301  *      HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
302  *      only come from a beacon, but might not become valid until after
303  *      association when a beacon is received (which is notified with the
304  *      %BSS_CHANGED_DTIM flag.)
305  * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
306  *      the driver/device can use this to calculate synchronisation
307  *      (see @sync_tsf)
308  * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
309  *      is requested, see @sync_tsf/@sync_device_ts.
310  * @beacon_int: beacon interval
311  * @assoc_capability: capabilities taken from assoc resp
312  * @basic_rates: bitmap of basic rates, each bit stands for an
313  *      index into the rate table configured by the driver in
314  *      the current band.
315  * @beacon_rate: associated AP's beacon TX rate
316  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
317  * @bssid: The BSSID for this BSS
318  * @enable_beacon: whether beaconing should be enabled or not
319  * @chandef: Channel definition for this BSS -- the hardware might be
320  *      configured a higher bandwidth than this BSS uses, for example.
321  * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
322  *      This field is only valid when the channel type is one of the HT types.
323  * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
324  *      implies disabled
325  * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
326  * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
327  *      may filter ARP queries targeted for other addresses than listed here.
328  *      The driver must allow ARP queries targeted for all address listed here
329  *      to pass through. An empty list implies no ARP queries need to pass.
330  * @arp_addr_cnt: Number of addresses currently on the list. Note that this
331  *      may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
332  *      array size), it's up to the driver what to do in that case.
333  * @qos: This is a QoS-enabled BSS.
334  * @idle: This interface is idle. There's also a global idle flag in the
335  *      hardware config which may be more appropriate depending on what
336  *      your driver/device needs to do.
337  * @ps: power-save mode (STA only). This flag is NOT affected by
338  *      offchannel/dynamic_ps operations.
339  * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
340  * @ssid_len: Length of SSID given in @ssid.
341  * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
342  * @txpower: TX power in dBm
343  * @p2p_noa_attr: P2P NoA attribute for P2P powersave
344  */
345 struct ieee80211_bss_conf {
346         const u8 *bssid;
347         /* association related data */
348         bool assoc, ibss_joined;
349         bool ibss_creator;
350         u16 aid;
351         /* erp related data */
352         bool use_cts_prot;
353         bool use_short_preamble;
354         bool use_short_slot;
355         bool enable_beacon;
356         u8 dtim_period;
357         u16 beacon_int;
358         u16 assoc_capability;
359         u64 sync_tsf;
360         u32 sync_device_ts;
361         u8 sync_dtim_count;
362         u32 basic_rates;
363         struct ieee80211_rate *beacon_rate;
364         int mcast_rate[IEEE80211_NUM_BANDS];
365         u16 ht_operation_mode;
366         s32 cqm_rssi_thold;
367         u32 cqm_rssi_hyst;
368         struct cfg80211_chan_def chandef;
369         __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
370         int arp_addr_cnt;
371         bool qos;
372         bool idle;
373         bool ps;
374         u8 ssid[IEEE80211_MAX_SSID_LEN];
375         size_t ssid_len;
376         bool hidden_ssid;
377         int txpower;
378         struct ieee80211_p2p_noa_attr p2p_noa_attr;
379 };
380
381 /**
382  * enum mac80211_tx_info_flags - flags to describe transmission information/status
383  *
384  * These flags are used with the @flags member of &ieee80211_tx_info.
385  *
386  * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
387  * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
388  *      number to this frame, taking care of not overwriting the fragment
389  *      number and increasing the sequence number only when the
390  *      IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
391  *      assign sequence numbers to QoS-data frames but cannot do so correctly
392  *      for non-QoS-data and management frames because beacons need them from
393  *      that counter as well and mac80211 cannot guarantee proper sequencing.
394  *      If this flag is set, the driver should instruct the hardware to
395  *      assign a sequence number to the frame or assign one itself. Cf. IEEE
396  *      802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
397  *      beacons and always be clear for frames without a sequence number field.
398  * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
399  * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
400  *      station
401  * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
402  * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
403  * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
404  * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
405  * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
406  *      because the destination STA was in powersave mode. Note that to
407  *      avoid race conditions, the filter must be set by the hardware or
408  *      firmware upon receiving a frame that indicates that the station
409  *      went to sleep (must be done on device to filter frames already on
410  *      the queue) and may only be unset after mac80211 gives the OK for
411  *      that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
412  *      since only then is it guaranteed that no more frames are in the
413  *      hardware queue.
414  * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
415  * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
416  *      is for the whole aggregation.
417  * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
418  *      so consider using block ack request (BAR).
419  * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
420  *      set by rate control algorithms to indicate probe rate, will
421  *      be cleared for fragmented frames (except on the last fragment)
422  * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
423  *      that a frame can be transmitted while the queues are stopped for
424  *      off-channel operation.
425  * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
426  *      used to indicate that a pending frame requires TX processing before
427  *      it can be sent out.
428  * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
429  *      used to indicate that a frame was already retried due to PS
430  * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
431  *      used to indicate frame should not be encrypted
432  * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
433  *      frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
434  *      be sent although the station is in powersave mode.
435  * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
436  *      transmit function after the current frame, this can be used
437  *      by drivers to kick the DMA queue only if unset or when the
438  *      queue gets full.
439  * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
440  *      after TX status because the destination was asleep, it must not
441  *      be modified again (no seqno assignment, crypto, etc.)
442  * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
443  *      code for connection establishment, this indicates that its status
444  *      should kick the MLME state machine.
445  * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
446  *      MLME command (internal to mac80211 to figure out whether to send TX
447  *      status to user space)
448  * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
449  * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
450  *      frame and selects the maximum number of streams that it can use.
451  * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
452  *      the off-channel channel when a remain-on-channel offload is done
453  *      in hardware -- normal packets still flow and are expected to be
454  *      handled properly by the device.
455  * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
456  *      testing. It will be sent out with incorrect Michael MIC key to allow
457  *      TKIP countermeasures to be tested.
458  * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
459  *      This flag is actually used for management frame especially for P2P
460  *      frames not being sent at CCK rate in 2GHz band.
461  * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
462  *      when its status is reported the service period ends. For frames in
463  *      an SP that mac80211 transmits, it is already set; for driver frames
464  *      the driver may set this flag. It is also used to do the same for
465  *      PS-Poll responses.
466  * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
467  *      This flag is used to send nullfunc frame at minimum rate when
468  *      the nullfunc is used for connection monitoring purpose.
469  * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
470  *      would be fragmented by size (this is optional, only used for
471  *      monitor injection).
472  * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
473  *      frame (PS-Poll or uAPSD).
474  *
475  * Note: If you have to add new flags to the enumeration, then don't
476  *       forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
477  */
478 enum mac80211_tx_info_flags {
479         IEEE80211_TX_CTL_REQ_TX_STATUS          = BIT(0),
480         IEEE80211_TX_CTL_ASSIGN_SEQ             = BIT(1),
481         IEEE80211_TX_CTL_NO_ACK                 = BIT(2),
482         IEEE80211_TX_CTL_CLEAR_PS_FILT          = BIT(3),
483         IEEE80211_TX_CTL_FIRST_FRAGMENT         = BIT(4),
484         IEEE80211_TX_CTL_SEND_AFTER_DTIM        = BIT(5),
485         IEEE80211_TX_CTL_AMPDU                  = BIT(6),
486         IEEE80211_TX_CTL_INJECTED               = BIT(7),
487         IEEE80211_TX_STAT_TX_FILTERED           = BIT(8),
488         IEEE80211_TX_STAT_ACK                   = BIT(9),
489         IEEE80211_TX_STAT_AMPDU                 = BIT(10),
490         IEEE80211_TX_STAT_AMPDU_NO_BACK         = BIT(11),
491         IEEE80211_TX_CTL_RATE_CTRL_PROBE        = BIT(12),
492         IEEE80211_TX_INTFL_OFFCHAN_TX_OK        = BIT(13),
493         IEEE80211_TX_INTFL_NEED_TXPROCESSING    = BIT(14),
494         IEEE80211_TX_INTFL_RETRIED              = BIT(15),
495         IEEE80211_TX_INTFL_DONT_ENCRYPT         = BIT(16),
496         IEEE80211_TX_CTL_NO_PS_BUFFER           = BIT(17),
497         IEEE80211_TX_CTL_MORE_FRAMES            = BIT(18),
498         IEEE80211_TX_INTFL_RETRANSMISSION       = BIT(19),
499         IEEE80211_TX_INTFL_MLME_CONN_TX         = BIT(20),
500         IEEE80211_TX_INTFL_NL80211_FRAME_TX     = BIT(21),
501         IEEE80211_TX_CTL_LDPC                   = BIT(22),
502         IEEE80211_TX_CTL_STBC                   = BIT(23) | BIT(24),
503         IEEE80211_TX_CTL_TX_OFFCHAN             = BIT(25),
504         IEEE80211_TX_INTFL_TKIP_MIC_FAILURE     = BIT(26),
505         IEEE80211_TX_CTL_NO_CCK_RATE            = BIT(27),
506         IEEE80211_TX_STATUS_EOSP                = BIT(28),
507         IEEE80211_TX_CTL_USE_MINRATE            = BIT(29),
508         IEEE80211_TX_CTL_DONTFRAG               = BIT(30),
509         IEEE80211_TX_CTL_PS_RESPONSE            = BIT(31),
510 };
511
512 #define IEEE80211_TX_CTL_STBC_SHIFT             23
513
514 /**
515  * enum mac80211_tx_control_flags - flags to describe transmit control
516  *
517  * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
518  *      protocol frame (e.g. EAP)
519  *
520  * These flags are used in tx_info->control.flags.
521  */
522 enum mac80211_tx_control_flags {
523         IEEE80211_TX_CTRL_PORT_CTRL_PROTO       = BIT(0),
524 };
525
526 /*
527  * This definition is used as a mask to clear all temporary flags, which are
528  * set by the tx handlers for each transmission attempt by the mac80211 stack.
529  */
530 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK |               \
531         IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT |    \
532         IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU |           \
533         IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK |               \
534         IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK |           \
535         IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER |    \
536         IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |                \
537         IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
538
539 /**
540  * enum mac80211_rate_control_flags - per-rate flags set by the
541  *      Rate Control algorithm.
542  *
543  * These flags are set by the Rate control algorithm for each rate during tx,
544  * in the @flags member of struct ieee80211_tx_rate.
545  *
546  * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
547  * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
548  *      This is set if the current BSS requires ERP protection.
549  * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
550  * @IEEE80211_TX_RC_MCS: HT rate.
551  * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
552  *      into a higher 4 bits (Nss) and lower 4 bits (MCS number)
553  * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
554  *      Greenfield mode.
555  * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
556  * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
557  * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
558  *      (80+80 isn't supported yet)
559  * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
560  *      adjacent 20 MHz channels, if the current channel type is
561  *      NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
562  * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
563  */
564 enum mac80211_rate_control_flags {
565         IEEE80211_TX_RC_USE_RTS_CTS             = BIT(0),
566         IEEE80211_TX_RC_USE_CTS_PROTECT         = BIT(1),
567         IEEE80211_TX_RC_USE_SHORT_PREAMBLE      = BIT(2),
568
569         /* rate index is an HT/VHT MCS instead of an index */
570         IEEE80211_TX_RC_MCS                     = BIT(3),
571         IEEE80211_TX_RC_GREEN_FIELD             = BIT(4),
572         IEEE80211_TX_RC_40_MHZ_WIDTH            = BIT(5),
573         IEEE80211_TX_RC_DUP_DATA                = BIT(6),
574         IEEE80211_TX_RC_SHORT_GI                = BIT(7),
575         IEEE80211_TX_RC_VHT_MCS                 = BIT(8),
576         IEEE80211_TX_RC_80_MHZ_WIDTH            = BIT(9),
577         IEEE80211_TX_RC_160_MHZ_WIDTH           = BIT(10),
578 };
579
580
581 /* there are 40 bytes if you don't need the rateset to be kept */
582 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
583
584 /* if you do need the rateset, then you have less space */
585 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
586
587 /* maximum number of rate stages */
588 #define IEEE80211_TX_MAX_RATES  4
589
590 /* maximum number of rate table entries */
591 #define IEEE80211_TX_RATE_TABLE_SIZE    4
592
593 /**
594  * struct ieee80211_tx_rate - rate selection/status
595  *
596  * @idx: rate index to attempt to send with
597  * @flags: rate control flags (&enum mac80211_rate_control_flags)
598  * @count: number of tries in this rate before going to the next rate
599  *
600  * A value of -1 for @idx indicates an invalid rate and, if used
601  * in an array of retry rates, that no more rates should be tried.
602  *
603  * When used for transmit status reporting, the driver should
604  * always report the rate along with the flags it used.
605  *
606  * &struct ieee80211_tx_info contains an array of these structs
607  * in the control information, and it will be filled by the rate
608  * control algorithm according to what should be sent. For example,
609  * if this array contains, in the format { <idx>, <count> } the
610  * information
611  *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
612  * then this means that the frame should be transmitted
613  * up to twice at rate 3, up to twice at rate 2, and up to four
614  * times at rate 1 if it doesn't get acknowledged. Say it gets
615  * acknowledged by the peer after the fifth attempt, the status
616  * information should then contain
617  *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
618  * since it was transmitted twice at rate 3, twice at rate 2
619  * and once at rate 1 after which we received an acknowledgement.
620  */
621 struct ieee80211_tx_rate {
622         s8 idx;
623         u16 count:5,
624             flags:11;
625 } __packed;
626
627 #define IEEE80211_MAX_TX_RETRY          31
628
629 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
630                                           u8 mcs, u8 nss)
631 {
632         WARN_ON(mcs & ~0xF);
633         WARN_ON((nss - 1) & ~0x7);
634         rate->idx = ((nss - 1) << 4) | mcs;
635 }
636
637 static inline u8
638 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
639 {
640         return rate->idx & 0xF;
641 }
642
643 static inline u8
644 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
645 {
646         return (rate->idx >> 4) + 1;
647 }
648
649 /**
650  * struct ieee80211_tx_info - skb transmit information
651  *
652  * This structure is placed in skb->cb for three uses:
653  *  (1) mac80211 TX control - mac80211 tells the driver what to do
654  *  (2) driver internal use (if applicable)
655  *  (3) TX status information - driver tells mac80211 what happened
656  *
657  * @flags: transmit info flags, defined above
658  * @band: the band to transmit on (use for checking for races)
659  * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
660  * @ack_frame_id: internal frame ID for TX status, used internally
661  * @control: union for control data
662  * @status: union for status data
663  * @driver_data: array of driver_data pointers
664  * @ampdu_ack_len: number of acked aggregated frames.
665  *      relevant only if IEEE80211_TX_STAT_AMPDU was set.
666  * @ampdu_len: number of aggregated frames.
667  *      relevant only if IEEE80211_TX_STAT_AMPDU was set.
668  * @ack_signal: signal strength of the ACK frame
669  */
670 struct ieee80211_tx_info {
671         /* common information */
672         u32 flags;
673         u8 band;
674
675         u8 hw_queue;
676
677         u16 ack_frame_id;
678
679         union {
680                 struct {
681                         union {
682                                 /* rate control */
683                                 struct {
684                                         struct ieee80211_tx_rate rates[
685                                                 IEEE80211_TX_MAX_RATES];
686                                         s8 rts_cts_rate_idx;
687                                         u8 use_rts:1;
688                                         u8 use_cts_prot:1;
689                                         u8 short_preamble:1;
690                                         u8 skip_table:1;
691                                         /* 2 bytes free */
692                                 };
693                                 /* only needed before rate control */
694                                 unsigned long jiffies;
695                         };
696                         /* NB: vif can be NULL for injected frames */
697                         struct ieee80211_vif *vif;
698                         struct ieee80211_key_conf *hw_key;
699                         u32 flags;
700                         /* 4 bytes free */
701                 } control;
702                 struct {
703                         struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
704                         int ack_signal;
705                         u8 ampdu_ack_len;
706                         u8 ampdu_len;
707                         u8 antenna;
708                         /* 21 bytes free */
709                 } status;
710                 struct {
711                         struct ieee80211_tx_rate driver_rates[
712                                 IEEE80211_TX_MAX_RATES];
713                         u8 pad[4];
714
715                         void *rate_driver_data[
716                                 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
717                 };
718                 void *driver_data[
719                         IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
720         };
721 };
722
723 /**
724  * struct ieee80211_sched_scan_ies - scheduled scan IEs
725  *
726  * This structure is used to pass the appropriate IEs to be used in scheduled
727  * scans for all bands.  It contains both the IEs passed from the userspace
728  * and the ones generated by mac80211.
729  *
730  * @ie: array with the IEs for each supported band
731  * @len: array with the total length of the IEs for each band
732  */
733 struct ieee80211_sched_scan_ies {
734         u8 *ie[IEEE80211_NUM_BANDS];
735         size_t len[IEEE80211_NUM_BANDS];
736 };
737
738 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
739 {
740         return (struct ieee80211_tx_info *)skb->cb;
741 }
742
743 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
744 {
745         return (struct ieee80211_rx_status *)skb->cb;
746 }
747
748 /**
749  * ieee80211_tx_info_clear_status - clear TX status
750  *
751  * @info: The &struct ieee80211_tx_info to be cleared.
752  *
753  * When the driver passes an skb back to mac80211, it must report
754  * a number of things in TX status. This function clears everything
755  * in the TX status but the rate control information (it does clear
756  * the count since you need to fill that in anyway).
757  *
758  * NOTE: You can only use this function if you do NOT use
759  *       info->driver_data! Use info->rate_driver_data
760  *       instead if you need only the less space that allows.
761  */
762 static inline void
763 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
764 {
765         int i;
766
767         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
768                      offsetof(struct ieee80211_tx_info, control.rates));
769         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
770                      offsetof(struct ieee80211_tx_info, driver_rates));
771         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
772         /* clear the rate counts */
773         for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
774                 info->status.rates[i].count = 0;
775
776         BUILD_BUG_ON(
777             offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
778         memset(&info->status.ampdu_ack_len, 0,
779                sizeof(struct ieee80211_tx_info) -
780                offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
781 }
782
783
784 /**
785  * enum mac80211_rx_flags - receive flags
786  *
787  * These flags are used with the @flag member of &struct ieee80211_rx_status.
788  * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
789  *      Use together with %RX_FLAG_MMIC_STRIPPED.
790  * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
791  * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
792  *      verification has been done by the hardware.
793  * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
794  *      If this flag is set, the stack cannot do any replay detection
795  *      hence the driver or hardware will have to do that.
796  * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
797  *      the frame.
798  * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
799  *      the frame.
800  * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
801  *      field) is valid and contains the time the first symbol of the MPDU
802  *      was received. This is useful in monitor mode and for proper IBSS
803  *      merging.
804  * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
805  *      field) is valid and contains the time the last symbol of the MPDU
806  *      (including FCS) was received.
807  * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
808  * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
809  * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
810  * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
811  * @RX_FLAG_SHORT_GI: Short guard interval was used
812  * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
813  *      Valid only for data frames (mainly A-MPDU)
814  * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
815  *      the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
816  *      to hw.radiotap_mcs_details to advertise that fact
817  * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
818  *      number (@ampdu_reference) must be populated and be a distinct number for
819  *      each A-MPDU
820  * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
821  * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
822  *      monitoring purposes only
823  * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
824  *      subframes of a single A-MPDU
825  * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
826  * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
827  *      on this subframe
828  * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
829  *      is stored in the @ampdu_delimiter_crc field)
830  * @RX_FLAG_LDPC: LDPC was used
831  * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
832  * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
833  * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
834  * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
835  *      subframes instead of a one huge frame for performance reasons.
836  *      All, but the last MSDU from an A-MSDU should have this flag set. E.g.
837  *      if an A-MSDU has 3 frames, the first 2 must have the flag set, while
838  *      the 3rd (last) one must not have this flag set. The flag is used to
839  *      deal with retransmission/duplication recovery properly since A-MSDU
840  *      subframes share the same sequence number. Reported subframes can be
841  *      either regular MSDU or singly A-MSDUs. Subframes must not be
842  *      interleaved with other frames.
843  */
844 enum mac80211_rx_flags {
845         RX_FLAG_MMIC_ERROR              = BIT(0),
846         RX_FLAG_DECRYPTED               = BIT(1),
847         RX_FLAG_MMIC_STRIPPED           = BIT(3),
848         RX_FLAG_IV_STRIPPED             = BIT(4),
849         RX_FLAG_FAILED_FCS_CRC          = BIT(5),
850         RX_FLAG_FAILED_PLCP_CRC         = BIT(6),
851         RX_FLAG_MACTIME_START           = BIT(7),
852         RX_FLAG_SHORTPRE                = BIT(8),
853         RX_FLAG_HT                      = BIT(9),
854         RX_FLAG_40MHZ                   = BIT(10),
855         RX_FLAG_SHORT_GI                = BIT(11),
856         RX_FLAG_NO_SIGNAL_VAL           = BIT(12),
857         RX_FLAG_HT_GF                   = BIT(13),
858         RX_FLAG_AMPDU_DETAILS           = BIT(14),
859         RX_FLAG_AMPDU_REPORT_ZEROLEN    = BIT(15),
860         RX_FLAG_AMPDU_IS_ZEROLEN        = BIT(16),
861         RX_FLAG_AMPDU_LAST_KNOWN        = BIT(17),
862         RX_FLAG_AMPDU_IS_LAST           = BIT(18),
863         RX_FLAG_AMPDU_DELIM_CRC_ERROR   = BIT(19),
864         RX_FLAG_AMPDU_DELIM_CRC_KNOWN   = BIT(20),
865         RX_FLAG_MACTIME_END             = BIT(21),
866         RX_FLAG_VHT                     = BIT(22),
867         RX_FLAG_LDPC                    = BIT(23),
868         RX_FLAG_STBC_MASK               = BIT(26) | BIT(27),
869         RX_FLAG_10MHZ                   = BIT(28),
870         RX_FLAG_5MHZ                    = BIT(29),
871         RX_FLAG_AMSDU_MORE              = BIT(30),
872 };
873
874 #define RX_FLAG_STBC_SHIFT              26
875
876 /**
877  * enum mac80211_rx_vht_flags - receive VHT flags
878  *
879  * These flags are used with the @vht_flag member of
880  *      &struct ieee80211_rx_status.
881  * @RX_VHT_FLAG_80MHZ: 80 MHz was used
882  * @RX_VHT_FLAG_80P80MHZ: 80+80 MHz was used
883  * @RX_VHT_FLAG_160MHZ: 160 MHz was used
884  */
885 enum mac80211_rx_vht_flags {
886         RX_VHT_FLAG_80MHZ               = BIT(0),
887         RX_VHT_FLAG_80P80MHZ            = BIT(1),
888         RX_VHT_FLAG_160MHZ              = BIT(2),
889 };
890
891 /**
892  * struct ieee80211_rx_status - receive status
893  *
894  * The low-level driver should provide this information (the subset
895  * supported by hardware) to the 802.11 code with each received
896  * frame, in the skb's control buffer (cb).
897  *
898  * @mactime: value in microseconds of the 64-bit Time Synchronization Function
899  *      (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
900  * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
901  *      it but can store it and pass it back to the driver for synchronisation
902  * @band: the active band when this frame was received
903  * @freq: frequency the radio was tuned to when receiving this frame, in MHz
904  * @signal: signal strength when receiving this frame, either in dBm, in dB or
905  *      unspecified depending on the hardware capabilities flags
906  *      @IEEE80211_HW_SIGNAL_*
907  * @chains: bitmask of receive chains for which separate signal strength
908  *      values were filled.
909  * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
910  *      support dB or unspecified units)
911  * @antenna: antenna used
912  * @rate_idx: index of data rate into band's supported rates or MCS index if
913  *      HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
914  * @vht_nss: number of streams (VHT only)
915  * @flag: %RX_FLAG_*
916  * @vht_flag: %RX_VHT_FLAG_*
917  * @rx_flags: internal RX flags for mac80211
918  * @ampdu_reference: A-MPDU reference number, must be a different value for
919  *      each A-MPDU but the same for each subframe within one A-MPDU
920  * @ampdu_delimiter_crc: A-MPDU delimiter CRC
921  */
922 struct ieee80211_rx_status {
923         u64 mactime;
924         u32 device_timestamp;
925         u32 ampdu_reference;
926         u32 flag;
927         u16 freq;
928         u8 vht_flag;
929         u8 rate_idx;
930         u8 vht_nss;
931         u8 rx_flags;
932         u8 band;
933         u8 antenna;
934         s8 signal;
935         u8 chains;
936         s8 chain_signal[IEEE80211_MAX_CHAINS];
937         u8 ampdu_delimiter_crc;
938 };
939
940 /**
941  * enum ieee80211_conf_flags - configuration flags
942  *
943  * Flags to define PHY configuration options
944  *
945  * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
946  *      to determine for example whether to calculate timestamps for packets
947  *      or not, do not use instead of filter flags!
948  * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
949  *      This is the power save mode defined by IEEE 802.11-2007 section 11.2,
950  *      meaning that the hardware still wakes up for beacons, is able to
951  *      transmit frames and receive the possible acknowledgment frames.
952  *      Not to be confused with hardware specific wakeup/sleep states,
953  *      driver is responsible for that. See the section "Powersave support"
954  *      for more.
955  * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
956  *      the driver should be prepared to handle configuration requests but
957  *      may turn the device off as much as possible. Typically, this flag will
958  *      be set when an interface is set UP but not associated or scanning, but
959  *      it can also be unset in that case when monitor interfaces are active.
960  * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
961  *      operating channel.
962  */
963 enum ieee80211_conf_flags {
964         IEEE80211_CONF_MONITOR          = (1<<0),
965         IEEE80211_CONF_PS               = (1<<1),
966         IEEE80211_CONF_IDLE             = (1<<2),
967         IEEE80211_CONF_OFFCHANNEL       = (1<<3),
968 };
969
970
971 /**
972  * enum ieee80211_conf_changed - denotes which configuration changed
973  *
974  * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
975  * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
976  * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
977  * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
978  * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
979  * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
980  * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
981  * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
982  *      Note that this is only valid if channel contexts are not used,
983  *      otherwise each channel context has the number of chains listed.
984  */
985 enum ieee80211_conf_changed {
986         IEEE80211_CONF_CHANGE_SMPS              = BIT(1),
987         IEEE80211_CONF_CHANGE_LISTEN_INTERVAL   = BIT(2),
988         IEEE80211_CONF_CHANGE_MONITOR           = BIT(3),
989         IEEE80211_CONF_CHANGE_PS                = BIT(4),
990         IEEE80211_CONF_CHANGE_POWER             = BIT(5),
991         IEEE80211_CONF_CHANGE_CHANNEL           = BIT(6),
992         IEEE80211_CONF_CHANGE_RETRY_LIMITS      = BIT(7),
993         IEEE80211_CONF_CHANGE_IDLE              = BIT(8),
994 };
995
996 /**
997  * enum ieee80211_smps_mode - spatial multiplexing power save mode
998  *
999  * @IEEE80211_SMPS_AUTOMATIC: automatic
1000  * @IEEE80211_SMPS_OFF: off
1001  * @IEEE80211_SMPS_STATIC: static
1002  * @IEEE80211_SMPS_DYNAMIC: dynamic
1003  * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1004  */
1005 enum ieee80211_smps_mode {
1006         IEEE80211_SMPS_AUTOMATIC,
1007         IEEE80211_SMPS_OFF,
1008         IEEE80211_SMPS_STATIC,
1009         IEEE80211_SMPS_DYNAMIC,
1010
1011         /* keep last */
1012         IEEE80211_SMPS_NUM_MODES,
1013 };
1014
1015 /**
1016  * struct ieee80211_conf - configuration of the device
1017  *
1018  * This struct indicates how the driver shall configure the hardware.
1019  *
1020  * @flags: configuration flags defined above
1021  *
1022  * @listen_interval: listen interval in units of beacon interval
1023  * @max_sleep_period: the maximum number of beacon intervals to sleep for
1024  *      before checking the beacon for a TIM bit (managed mode only); this
1025  *      value will be only achievable between DTIM frames, the hardware
1026  *      needs to check for the multicast traffic bit in DTIM beacons.
1027  *      This variable is valid only when the CONF_PS flag is set.
1028  * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1029  *      in power saving. Power saving will not be enabled until a beacon
1030  *      has been received and the DTIM period is known.
1031  * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1032  *      powersave documentation below. This variable is valid only when
1033  *      the CONF_PS flag is set.
1034  *
1035  * @power_level: requested transmit power (in dBm), backward compatibility
1036  *      value only that is set to the minimum of all interfaces
1037  *
1038  * @chandef: the channel definition to tune to
1039  * @radar_enabled: whether radar detection is enabled
1040  *
1041  * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1042  *      (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1043  *      but actually means the number of transmissions not the number of retries
1044  * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1045  *      frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1046  *      number of transmissions not the number of retries
1047  *
1048  * @smps_mode: spatial multiplexing powersave mode; note that
1049  *      %IEEE80211_SMPS_STATIC is used when the device is not
1050  *      configured for an HT channel.
1051  *      Note that this is only valid if channel contexts are not used,
1052  *      otherwise each channel context has the number of chains listed.
1053  */
1054 struct ieee80211_conf {
1055         u32 flags;
1056         int power_level, dynamic_ps_timeout;
1057         int max_sleep_period;
1058
1059         u16 listen_interval;
1060         u8 ps_dtim_period;
1061
1062         u8 long_frame_max_tx_count, short_frame_max_tx_count;
1063
1064         struct cfg80211_chan_def chandef;
1065         bool radar_enabled;
1066         enum ieee80211_smps_mode smps_mode;
1067 };
1068
1069 /**
1070  * struct ieee80211_channel_switch - holds the channel switch data
1071  *
1072  * The information provided in this structure is required for channel switch
1073  * operation.
1074  *
1075  * @timestamp: value in microseconds of the 64-bit Time Synchronization
1076  *      Function (TSF) timer when the frame containing the channel switch
1077  *      announcement was received. This is simply the rx.mactime parameter
1078  *      the driver passed into mac80211.
1079  * @block_tx: Indicates whether transmission must be blocked before the
1080  *      scheduled channel switch, as indicated by the AP.
1081  * @chandef: the new channel to switch to
1082  * @count: the number of TBTT's until the channel switch event
1083  */
1084 struct ieee80211_channel_switch {
1085         u64 timestamp;
1086         bool block_tx;
1087         struct cfg80211_chan_def chandef;
1088         u8 count;
1089 };
1090
1091 /**
1092  * enum ieee80211_vif_flags - virtual interface flags
1093  *
1094  * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1095  *      on this virtual interface to avoid unnecessary CPU wakeups
1096  * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1097  *      monitoring on this virtual interface -- i.e. it can monitor
1098  *      connection quality related parameters, such as the RSSI level and
1099  *      provide notifications if configured trigger levels are reached.
1100  */
1101 enum ieee80211_vif_flags {
1102         IEEE80211_VIF_BEACON_FILTER             = BIT(0),
1103         IEEE80211_VIF_SUPPORTS_CQM_RSSI         = BIT(1),
1104 };
1105
1106 /**
1107  * struct ieee80211_vif - per-interface data
1108  *
1109  * Data in this structure is continually present for driver
1110  * use during the life of a virtual interface.
1111  *
1112  * @type: type of this virtual interface
1113  * @bss_conf: BSS configuration for this interface, either our own
1114  *      or the BSS we're associated to
1115  * @addr: address of this interface
1116  * @p2p: indicates whether this AP or STA interface is a p2p
1117  *      interface, i.e. a GO or p2p-sta respectively
1118  * @csa_active: marks whether a channel switch is going on
1119  * @driver_flags: flags/capabilities the driver has for this interface,
1120  *      these need to be set (or cleared) when the interface is added
1121  *      or, if supported by the driver, the interface type is changed
1122  *      at runtime, mac80211 will never touch this field
1123  * @hw_queue: hardware queue for each AC
1124  * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1125  * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1126  *      when it is not assigned. This pointer is RCU-protected due to the TX
1127  *      path needing to access it; even though the netdev carrier will always
1128  *      be off when it is %NULL there can still be races and packets could be
1129  *      processed after it switches back to %NULL.
1130  * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1131  *      interface debug files. Note that it will be NULL for the virtual
1132  *      monitor interface (if that is requested.)
1133  * @drv_priv: data area for driver use, will always be aligned to
1134  *      sizeof(void *).
1135  */
1136 struct ieee80211_vif {
1137         enum nl80211_iftype type;
1138         struct ieee80211_bss_conf bss_conf;
1139         u8 addr[ETH_ALEN];
1140         bool p2p;
1141         bool csa_active;
1142
1143         u8 cab_queue;
1144         u8 hw_queue[IEEE80211_NUM_ACS];
1145
1146         struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1147
1148         u32 driver_flags;
1149
1150 #ifdef CONFIG_MAC80211_DEBUGFS
1151         struct dentry *debugfs_dir;
1152 #endif
1153
1154         /* must be last */
1155         u8 drv_priv[0] __aligned(sizeof(void *));
1156 };
1157
1158 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1159 {
1160 #ifdef CONFIG_MAC80211_MESH
1161         return vif->type == NL80211_IFTYPE_MESH_POINT;
1162 #endif
1163         return false;
1164 }
1165
1166 /**
1167  * wdev_to_ieee80211_vif - return a vif struct from a wdev
1168  * @wdev: the wdev to get the vif for
1169  *
1170  * This can be used by mac80211 drivers with direct cfg80211 APIs
1171  * (like the vendor commands) that get a wdev.
1172  *
1173  * Note that this function may return %NULL if the given wdev isn't
1174  * associated with a vif that the driver knows about (e.g. monitor
1175  * or AP_VLAN interfaces.)
1176  */
1177 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1178
1179 /**
1180  * enum ieee80211_key_flags - key flags
1181  *
1182  * These flags are used for communication about keys between the driver
1183  * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1184  *
1185  * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1186  *      driver to indicate that it requires IV generation for this
1187  *      particular key.
1188  * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1189  *      the driver for a TKIP key if it requires Michael MIC
1190  *      generation in software.
1191  * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1192  *      that the key is pairwise rather then a shared key.
1193  * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1194  *      CCMP key if it requires CCMP encryption of management frames (MFP) to
1195  *      be done in software.
1196  * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1197  *      if space should be prepared for the IV, but the IV
1198  *      itself should not be generated. Do not set together with
1199  *      @IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1200  * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1201  *      management frames. The flag can help drivers that have a hardware
1202  *      crypto implementation that doesn't deal with management frames
1203  *      properly by allowing them to not upload the keys to hardware and
1204  *      fall back to software crypto. Note that this flag deals only with
1205  *      RX, if your crypto engine can't deal with TX you can also set the
1206  *      %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1207  */
1208 enum ieee80211_key_flags {
1209         IEEE80211_KEY_FLAG_GENERATE_IV  = 1<<1,
1210         IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
1211         IEEE80211_KEY_FLAG_PAIRWISE     = 1<<3,
1212         IEEE80211_KEY_FLAG_SW_MGMT_TX   = 1<<4,
1213         IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
1214         IEEE80211_KEY_FLAG_RX_MGMT      = 1<<6,
1215 };
1216
1217 /**
1218  * struct ieee80211_key_conf - key information
1219  *
1220  * This key information is given by mac80211 to the driver by
1221  * the set_key() callback in &struct ieee80211_ops.
1222  *
1223  * @hw_key_idx: To be set by the driver, this is the key index the driver
1224  *      wants to be given when a frame is transmitted and needs to be
1225  *      encrypted in hardware.
1226  * @cipher: The key's cipher suite selector.
1227  * @flags: key flags, see &enum ieee80211_key_flags.
1228  * @keyidx: the key index (0-3)
1229  * @keylen: key material length
1230  * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1231  *      data block:
1232  *      - Temporal Encryption Key (128 bits)
1233  *      - Temporal Authenticator Tx MIC Key (64 bits)
1234  *      - Temporal Authenticator Rx MIC Key (64 bits)
1235  * @icv_len: The ICV length for this key type
1236  * @iv_len: The IV length for this key type
1237  */
1238 struct ieee80211_key_conf {
1239         u32 cipher;
1240         u8 icv_len;
1241         u8 iv_len;
1242         u8 hw_key_idx;
1243         u8 flags;
1244         s8 keyidx;
1245         u8 keylen;
1246         u8 key[0];
1247 };
1248
1249 /**
1250  * struct ieee80211_cipher_scheme - cipher scheme
1251  *
1252  * This structure contains a cipher scheme information defining
1253  * the secure packet crypto handling.
1254  *
1255  * @cipher: a cipher suite selector
1256  * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1257  * @hdr_len: a length of a security header used the cipher
1258  * @pn_len: a length of a packet number in the security header
1259  * @pn_off: an offset of pn from the beginning of the security header
1260  * @key_idx_off: an offset of key index byte in the security header
1261  * @key_idx_mask: a bit mask of key_idx bits
1262  * @key_idx_shift: a bit shift needed to get key_idx
1263  *     key_idx value calculation:
1264  *      (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1265  * @mic_len: a mic length in bytes
1266  */
1267 struct ieee80211_cipher_scheme {
1268         u32 cipher;
1269         u16 iftype;
1270         u8 hdr_len;
1271         u8 pn_len;
1272         u8 pn_off;
1273         u8 key_idx_off;
1274         u8 key_idx_mask;
1275         u8 key_idx_shift;
1276         u8 mic_len;
1277 };
1278
1279 /**
1280  * enum set_key_cmd - key command
1281  *
1282  * Used with the set_key() callback in &struct ieee80211_ops, this
1283  * indicates whether a key is being removed or added.
1284  *
1285  * @SET_KEY: a key is set
1286  * @DISABLE_KEY: a key must be disabled
1287  */
1288 enum set_key_cmd {
1289         SET_KEY, DISABLE_KEY,
1290 };
1291
1292 /**
1293  * enum ieee80211_sta_state - station state
1294  *
1295  * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1296  *      this is a special state for add/remove transitions
1297  * @IEEE80211_STA_NONE: station exists without special state
1298  * @IEEE80211_STA_AUTH: station is authenticated
1299  * @IEEE80211_STA_ASSOC: station is associated
1300  * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1301  */
1302 enum ieee80211_sta_state {
1303         /* NOTE: These need to be ordered correctly! */
1304         IEEE80211_STA_NOTEXIST,
1305         IEEE80211_STA_NONE,
1306         IEEE80211_STA_AUTH,
1307         IEEE80211_STA_ASSOC,
1308         IEEE80211_STA_AUTHORIZED,
1309 };
1310
1311 /**
1312  * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1313  * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1314  * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1315  * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1316  * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1317  *      (including 80+80 MHz)
1318  *
1319  * Implementation note: 20 must be zero to be initialized
1320  *      correctly, the values must be sorted.
1321  */
1322 enum ieee80211_sta_rx_bandwidth {
1323         IEEE80211_STA_RX_BW_20 = 0,
1324         IEEE80211_STA_RX_BW_40,
1325         IEEE80211_STA_RX_BW_80,
1326         IEEE80211_STA_RX_BW_160,
1327 };
1328
1329 /**
1330  * struct ieee80211_sta_rates - station rate selection table
1331  *
1332  * @rcu_head: RCU head used for freeing the table on update
1333  * @rate: transmit rates/flags to be used by default.
1334  *      Overriding entries per-packet is possible by using cb tx control.
1335  */
1336 struct ieee80211_sta_rates {
1337         struct rcu_head rcu_head;
1338         struct {
1339                 s8 idx;
1340                 u8 count;
1341                 u8 count_cts;
1342                 u8 count_rts;
1343                 u16 flags;
1344         } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1345 };
1346
1347 /**
1348  * struct ieee80211_sta - station table entry
1349  *
1350  * A station table entry represents a station we are possibly
1351  * communicating with. Since stations are RCU-managed in
1352  * mac80211, any ieee80211_sta pointer you get access to must
1353  * either be protected by rcu_read_lock() explicitly or implicitly,
1354  * or you must take good care to not use such a pointer after a
1355  * call to your sta_remove callback that removed it.
1356  *
1357  * @addr: MAC address
1358  * @aid: AID we assigned to the station if we're an AP
1359  * @supp_rates: Bitmap of supported rates (per band)
1360  * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1361  * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1362  * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1363  * @drv_priv: data area for driver use, will always be aligned to
1364  *      sizeof(void *), size is determined in hw information.
1365  * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1366  *      if wme is supported.
1367  * @max_sp: max Service Period. Only valid if wme is supported.
1368  * @bandwidth: current bandwidth the station can receive with
1369  * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1370  *      station can receive at the moment, changed by operating mode
1371  *      notifications and capabilities. The value is only valid after
1372  *      the station moves to associated state.
1373  * @smps_mode: current SMPS mode (off, static or dynamic)
1374  * @rates: rate control selection table
1375  */
1376 struct ieee80211_sta {
1377         u32 supp_rates[IEEE80211_NUM_BANDS];
1378         u8 addr[ETH_ALEN];
1379         u16 aid;
1380         struct ieee80211_sta_ht_cap ht_cap;
1381         struct ieee80211_sta_vht_cap vht_cap;
1382         bool wme;
1383         u8 uapsd_queues;
1384         u8 max_sp;
1385         u8 rx_nss;
1386         enum ieee80211_sta_rx_bandwidth bandwidth;
1387         enum ieee80211_smps_mode smps_mode;
1388         struct ieee80211_sta_rates __rcu *rates;
1389
1390         /* must be last */
1391         u8 drv_priv[0] __aligned(sizeof(void *));
1392 };
1393
1394 /**
1395  * enum sta_notify_cmd - sta notify command
1396  *
1397  * Used with the sta_notify() callback in &struct ieee80211_ops, this
1398  * indicates if an associated station made a power state transition.
1399  *
1400  * @STA_NOTIFY_SLEEP: a station is now sleeping
1401  * @STA_NOTIFY_AWAKE: a sleeping station woke up
1402  */
1403 enum sta_notify_cmd {
1404         STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1405 };
1406
1407 /**
1408  * struct ieee80211_tx_control - TX control data
1409  *
1410  * @sta: station table entry, this sta pointer may be NULL and
1411  *      it is not allowed to copy the pointer, due to RCU.
1412  */
1413 struct ieee80211_tx_control {
1414         struct ieee80211_sta *sta;
1415 };
1416
1417 /**
1418  * enum ieee80211_hw_flags - hardware flags
1419  *
1420  * These flags are used to indicate hardware capabilities to
1421  * the stack. Generally, flags here should have their meaning
1422  * done in a way that the simplest hardware doesn't need setting
1423  * any particular flags. There are some exceptions to this rule,
1424  * however, so you are advised to review these flags carefully.
1425  *
1426  * @IEEE80211_HW_HAS_RATE_CONTROL:
1427  *      The hardware or firmware includes rate control, and cannot be
1428  *      controlled by the stack. As such, no rate control algorithm
1429  *      should be instantiated, and the TX rate reported to userspace
1430  *      will be taken from the TX status instead of the rate control
1431  *      algorithm.
1432  *      Note that this requires that the driver implement a number of
1433  *      callbacks so it has the correct information, it needs to have
1434  *      the @set_rts_threshold callback and must look at the BSS config
1435  *      @use_cts_prot for G/N protection, @use_short_slot for slot
1436  *      timing in 2.4 GHz and @use_short_preamble for preambles for
1437  *      CCK frames.
1438  *
1439  * @IEEE80211_HW_RX_INCLUDES_FCS:
1440  *      Indicates that received frames passed to the stack include
1441  *      the FCS at the end.
1442  *
1443  * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1444  *      Some wireless LAN chipsets buffer broadcast/multicast frames
1445  *      for power saving stations in the hardware/firmware and others
1446  *      rely on the host system for such buffering. This option is used
1447  *      to configure the IEEE 802.11 upper layer to buffer broadcast and
1448  *      multicast frames when there are power saving stations so that
1449  *      the driver can fetch them with ieee80211_get_buffered_bc().
1450  *
1451  * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1452  *      Hardware is not capable of short slot operation on the 2.4 GHz band.
1453  *
1454  * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1455  *      Hardware is not capable of receiving frames with short preamble on
1456  *      the 2.4 GHz band.
1457  *
1458  * @IEEE80211_HW_SIGNAL_UNSPEC:
1459  *      Hardware can provide signal values but we don't know its units. We
1460  *      expect values between 0 and @max_signal.
1461  *      If possible please provide dB or dBm instead.
1462  *
1463  * @IEEE80211_HW_SIGNAL_DBM:
1464  *      Hardware gives signal values in dBm, decibel difference from
1465  *      one milliwatt. This is the preferred method since it is standardized
1466  *      between different devices. @max_signal does not need to be set.
1467  *
1468  * @IEEE80211_HW_SPECTRUM_MGMT:
1469  *      Hardware supports spectrum management defined in 802.11h
1470  *      Measurement, Channel Switch, Quieting, TPC
1471  *
1472  * @IEEE80211_HW_AMPDU_AGGREGATION:
1473  *      Hardware supports 11n A-MPDU aggregation.
1474  *
1475  * @IEEE80211_HW_SUPPORTS_PS:
1476  *      Hardware has power save support (i.e. can go to sleep).
1477  *
1478  * @IEEE80211_HW_PS_NULLFUNC_STACK:
1479  *      Hardware requires nullfunc frame handling in stack, implies
1480  *      stack support for dynamic PS.
1481  *
1482  * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1483  *      Hardware has support for dynamic PS.
1484  *
1485  * @IEEE80211_HW_MFP_CAPABLE:
1486  *      Hardware supports management frame protection (MFP, IEEE 802.11w).
1487  *
1488  * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1489  *      Hardware supports static spatial multiplexing powersave,
1490  *      ie. can turn off all but one chain even on HT connections
1491  *      that should be using more chains.
1492  *
1493  * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1494  *      Hardware supports dynamic spatial multiplexing powersave,
1495  *      ie. can turn off all but one chain and then wake the rest
1496  *      up as required after, for example, rts/cts handshake.
1497  *
1498  * @IEEE80211_HW_SUPPORTS_UAPSD:
1499  *      Hardware supports Unscheduled Automatic Power Save Delivery
1500  *      (U-APSD) in managed mode. The mode is configured with
1501  *      conf_tx() operation.
1502  *
1503  * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1504  *      Hardware can provide ack status reports of Tx frames to
1505  *      the stack.
1506  *
1507  * @IEEE80211_HW_CONNECTION_MONITOR:
1508  *      The hardware performs its own connection monitoring, including
1509  *      periodic keep-alives to the AP and probing the AP on beacon loss.
1510  *
1511  * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1512  *      This device needs to get data from beacon before association (i.e.
1513  *      dtim_period).
1514  *
1515  * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1516  *      per-station GTKs as used by IBSS RSN or during fast transition. If
1517  *      the device doesn't support per-station GTKs, but can be asked not
1518  *      to decrypt group addressed frames, then IBSS RSN support is still
1519  *      possible but software crypto will be used. Advertise the wiphy flag
1520  *      only in that case.
1521  *
1522  * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1523  *      autonomously manages the PS status of connected stations. When
1524  *      this flag is set mac80211 will not trigger PS mode for connected
1525  *      stations based on the PM bit of incoming frames.
1526  *      Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1527  *      the PS mode of connected stations.
1528  *
1529  * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1530  *      setup strictly in HW. mac80211 should not attempt to do this in
1531  *      software.
1532  *
1533  * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1534  *      a virtual monitor interface when monitor interfaces are the only
1535  *      active interfaces.
1536  *
1537  * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1538  *      queue mapping in order to use different queues (not just one per AC)
1539  *      for different virtual interfaces. See the doc section on HW queue
1540  *      control for more details.
1541  *
1542  * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1543  *      selection table provided by the rate control algorithm.
1544  *
1545  * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1546  *      P2P Interface. This will be honoured even if more than one interface
1547  *      is supported.
1548  *
1549  * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1550  *      only, to allow getting TBTT of a DTIM beacon.
1551  *
1552  * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1553  *      and can cope with CCK rates in an aggregation session (e.g. by not
1554  *      using aggregation for such frames.)
1555  *
1556  * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1557  *      for a single active channel while using channel contexts. When support
1558  *      is not enabled the default action is to disconnect when getting the
1559  *      CSA frame.
1560  */
1561 enum ieee80211_hw_flags {
1562         IEEE80211_HW_HAS_RATE_CONTROL                   = 1<<0,
1563         IEEE80211_HW_RX_INCLUDES_FCS                    = 1<<1,
1564         IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING        = 1<<2,
1565         IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE          = 1<<3,
1566         IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE      = 1<<4,
1567         IEEE80211_HW_SIGNAL_UNSPEC                      = 1<<5,
1568         IEEE80211_HW_SIGNAL_DBM                         = 1<<6,
1569         IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC             = 1<<7,
1570         IEEE80211_HW_SPECTRUM_MGMT                      = 1<<8,
1571         IEEE80211_HW_AMPDU_AGGREGATION                  = 1<<9,
1572         IEEE80211_HW_SUPPORTS_PS                        = 1<<10,
1573         IEEE80211_HW_PS_NULLFUNC_STACK                  = 1<<11,
1574         IEEE80211_HW_SUPPORTS_DYNAMIC_PS                = 1<<12,
1575         IEEE80211_HW_MFP_CAPABLE                        = 1<<13,
1576         IEEE80211_HW_WANT_MONITOR_VIF                   = 1<<14,
1577         IEEE80211_HW_SUPPORTS_STATIC_SMPS               = 1<<15,
1578         IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS              = 1<<16,
1579         IEEE80211_HW_SUPPORTS_UAPSD                     = 1<<17,
1580         IEEE80211_HW_REPORTS_TX_ACK_STATUS              = 1<<18,
1581         IEEE80211_HW_CONNECTION_MONITOR                 = 1<<19,
1582         IEEE80211_HW_QUEUE_CONTROL                      = 1<<20,
1583         IEEE80211_HW_SUPPORTS_PER_STA_GTK               = 1<<21,
1584         IEEE80211_HW_AP_LINK_PS                         = 1<<22,
1585         IEEE80211_HW_TX_AMPDU_SETUP_IN_HW               = 1<<23,
1586         IEEE80211_HW_SUPPORTS_RC_TABLE                  = 1<<24,
1587         IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF              = 1<<25,
1588         IEEE80211_HW_TIMING_BEACON_ONLY                 = 1<<26,
1589         IEEE80211_HW_SUPPORTS_HT_CCK_RATES              = 1<<27,
1590         IEEE80211_HW_CHANCTX_STA_CSA                    = 1<<28,
1591 };
1592
1593 /**
1594  * struct ieee80211_hw - hardware information and state
1595  *
1596  * This structure contains the configuration and hardware
1597  * information for an 802.11 PHY.
1598  *
1599  * @wiphy: This points to the &struct wiphy allocated for this
1600  *      802.11 PHY. You must fill in the @perm_addr and @dev
1601  *      members of this structure using SET_IEEE80211_DEV()
1602  *      and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1603  *      bands (with channels, bitrates) are registered here.
1604  *
1605  * @conf: &struct ieee80211_conf, device configuration, don't use.
1606  *
1607  * @priv: pointer to private area that was allocated for driver use
1608  *      along with this structure.
1609  *
1610  * @flags: hardware flags, see &enum ieee80211_hw_flags.
1611  *
1612  * @extra_tx_headroom: headroom to reserve in each transmit skb
1613  *      for use by the driver (e.g. for transmit headers.)
1614  *
1615  * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
1616  *      Can be used by drivers to add extra IEs.
1617  *
1618  * @max_signal: Maximum value for signal (rssi) in RX information, used
1619  *      only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1620  *
1621  * @max_listen_interval: max listen interval in units of beacon interval
1622  *      that HW supports
1623  *
1624  * @queues: number of available hardware transmit queues for
1625  *      data packets. WMM/QoS requires at least four, these
1626  *      queues need to have configurable access parameters.
1627  *
1628  * @rate_control_algorithm: rate control algorithm for this hardware.
1629  *      If unset (NULL), the default algorithm will be used. Must be
1630  *      set before calling ieee80211_register_hw().
1631  *
1632  * @vif_data_size: size (in bytes) of the drv_priv data area
1633  *      within &struct ieee80211_vif.
1634  * @sta_data_size: size (in bytes) of the drv_priv data area
1635  *      within &struct ieee80211_sta.
1636  * @chanctx_data_size: size (in bytes) of the drv_priv data area
1637  *      within &struct ieee80211_chanctx_conf.
1638  *
1639  * @max_rates: maximum number of alternate rate retry stages the hw
1640  *      can handle.
1641  * @max_report_rates: maximum number of alternate rate retry stages
1642  *      the hw can report back.
1643  * @max_rate_tries: maximum number of tries for each stage
1644  *
1645  * @napi_weight: weight used for NAPI polling.  You must specify an
1646  *      appropriate value here if a napi_poll operation is provided
1647  *      by your driver.
1648  *
1649  * @max_rx_aggregation_subframes: maximum buffer size (number of
1650  *      sub-frames) to be used for A-MPDU block ack receiver
1651  *      aggregation.
1652  *      This is only relevant if the device has restrictions on the
1653  *      number of subframes, if it relies on mac80211 to do reordering
1654  *      it shouldn't be set.
1655  *
1656  * @max_tx_aggregation_subframes: maximum number of subframes in an
1657  *      aggregate an HT driver will transmit, used by the peer as a
1658  *      hint to size its reorder buffer.
1659  *
1660  * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
1661  *      (if %IEEE80211_HW_QUEUE_CONTROL is set)
1662  *
1663  * @radiotap_mcs_details: lists which MCS information can the HW
1664  *      reports, by default it is set to _MCS, _GI and _BW but doesn't
1665  *      include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
1666  *      adding _BW is supported today.
1667  *
1668  * @radiotap_vht_details: lists which VHT MCS information the HW reports,
1669  *      the default is _GI | _BANDWIDTH.
1670  *      Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
1671  *
1672  * @netdev_features: netdev features to be set in each netdev created
1673  *      from this HW. Note only HW checksum features are currently
1674  *      compatible with mac80211. Other feature bits will be rejected.
1675  *
1676  * @uapsd_queues: This bitmap is included in (re)association frame to indicate
1677  *      for each access category if it is uAPSD trigger-enabled and delivery-
1678  *      enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
1679  *      Each bit corresponds to different AC. Value '1' in specific bit means
1680  *      that corresponding AC is both trigger- and delivery-enabled. '0' means
1681  *      neither enabled.
1682  *
1683  * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
1684  *      deliver to a WMM STA during any Service Period triggered by the WMM STA.
1685  *      Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
1686  *
1687  * @n_cipher_schemes: a size of an array of cipher schemes definitions.
1688  * @cipher_schemes: a pointer to an array of cipher scheme definitions
1689  *      supported by HW.
1690  */
1691 struct ieee80211_hw {
1692         struct ieee80211_conf conf;
1693         struct wiphy *wiphy;
1694         const char *rate_control_algorithm;
1695         void *priv;
1696         u32 flags;
1697         unsigned int extra_tx_headroom;
1698         unsigned int extra_beacon_tailroom;
1699         int vif_data_size;
1700         int sta_data_size;
1701         int chanctx_data_size;
1702         int napi_weight;
1703         u16 queues;
1704         u16 max_listen_interval;
1705         s8 max_signal;
1706         u8 max_rates;
1707         u8 max_report_rates;
1708         u8 max_rate_tries;
1709         u8 max_rx_aggregation_subframes;
1710         u8 max_tx_aggregation_subframes;
1711         u8 offchannel_tx_hw_queue;
1712         u8 radiotap_mcs_details;
1713         u16 radiotap_vht_details;
1714         netdev_features_t netdev_features;
1715         u8 uapsd_queues;
1716         u8 uapsd_max_sp_len;
1717         u8 n_cipher_schemes;
1718         const struct ieee80211_cipher_scheme *cipher_schemes;
1719 };
1720
1721 /**
1722  * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1723  *
1724  * @wiphy: the &struct wiphy which we want to query
1725  *
1726  * mac80211 drivers can use this to get to their respective
1727  * &struct ieee80211_hw. Drivers wishing to get to their own private
1728  * structure can then access it via hw->priv. Note that mac802111 drivers should
1729  * not use wiphy_priv() to try to get their private driver structure as this
1730  * is already used internally by mac80211.
1731  *
1732  * Return: The mac80211 driver hw struct of @wiphy.
1733  */
1734 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1735
1736 /**
1737  * SET_IEEE80211_DEV - set device for 802.11 hardware
1738  *
1739  * @hw: the &struct ieee80211_hw to set the device for
1740  * @dev: the &struct device of this 802.11 device
1741  */
1742 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1743 {
1744         set_wiphy_dev(hw->wiphy, dev);
1745 }
1746
1747 /**
1748  * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1749  *
1750  * @hw: the &struct ieee80211_hw to set the MAC address for
1751  * @addr: the address to set
1752  */
1753 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1754 {
1755         memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1756 }
1757
1758 static inline struct ieee80211_rate *
1759 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1760                       const struct ieee80211_tx_info *c)
1761 {
1762         if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
1763                 return NULL;
1764         return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1765 }
1766
1767 static inline struct ieee80211_rate *
1768 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1769                            const struct ieee80211_tx_info *c)
1770 {
1771         if (c->control.rts_cts_rate_idx < 0)
1772                 return NULL;
1773         return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1774 }
1775
1776 static inline struct ieee80211_rate *
1777 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1778                              const struct ieee80211_tx_info *c, int idx)
1779 {
1780         if (c->control.rates[idx + 1].idx < 0)
1781                 return NULL;
1782         return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1783 }
1784
1785 /**
1786  * ieee80211_free_txskb - free TX skb
1787  * @hw: the hardware
1788  * @skb: the skb
1789  *
1790  * Free a transmit skb. Use this funtion when some failure
1791  * to transmit happened and thus status cannot be reported.
1792  */
1793 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
1794
1795 /**
1796  * DOC: Hardware crypto acceleration
1797  *
1798  * mac80211 is capable of taking advantage of many hardware
1799  * acceleration designs for encryption and decryption operations.
1800  *
1801  * The set_key() callback in the &struct ieee80211_ops for a given
1802  * device is called to enable hardware acceleration of encryption and
1803  * decryption. The callback takes a @sta parameter that will be NULL
1804  * for default keys or keys used for transmission only, or point to
1805  * the station information for the peer for individual keys.
1806  * Multiple transmission keys with the same key index may be used when
1807  * VLANs are configured for an access point.
1808  *
1809  * When transmitting, the TX control data will use the @hw_key_idx
1810  * selected by the driver by modifying the &struct ieee80211_key_conf
1811  * pointed to by the @key parameter to the set_key() function.
1812  *
1813  * The set_key() call for the %SET_KEY command should return 0 if
1814  * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1815  * added; if you return 0 then hw_key_idx must be assigned to the
1816  * hardware key index, you are free to use the full u8 range.
1817  *
1818  * When the cmd is %DISABLE_KEY then it must succeed.
1819  *
1820  * Note that it is permissible to not decrypt a frame even if a key
1821  * for it has been uploaded to hardware, the stack will not make any
1822  * decision based on whether a key has been uploaded or not but rather
1823  * based on the receive flags.
1824  *
1825  * The &struct ieee80211_key_conf structure pointed to by the @key
1826  * parameter is guaranteed to be valid until another call to set_key()
1827  * removes it, but it can only be used as a cookie to differentiate
1828  * keys.
1829  *
1830  * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1831  * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1832  * handler.
1833  * The update_tkip_key() call updates the driver with the new phase 1 key.
1834  * This happens every time the iv16 wraps around (every 65536 packets). The
1835  * set_key() call will happen only once for each key (unless the AP did
1836  * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1837  * provided by update_tkip_key only. The trigger that makes mac80211 call this
1838  * handler is software decryption with wrap around of iv16.
1839  *
1840  * The set_default_unicast_key() call updates the default WEP key index
1841  * configured to the hardware for WEP encryption type. This is required
1842  * for devices that support offload of data packets (e.g. ARP responses).
1843  */
1844
1845 /**
1846  * DOC: Powersave support
1847  *
1848  * mac80211 has support for various powersave implementations.
1849  *
1850  * First, it can support hardware that handles all powersaving by itself,
1851  * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1852  * flag. In that case, it will be told about the desired powersave mode
1853  * with the %IEEE80211_CONF_PS flag depending on the association status.
1854  * The hardware must take care of sending nullfunc frames when necessary,
1855  * i.e. when entering and leaving powersave mode. The hardware is required
1856  * to look at the AID in beacons and signal to the AP that it woke up when
1857  * it finds traffic directed to it.
1858  *
1859  * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1860  * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1861  * with hardware wakeup and sleep states. Driver is responsible for waking
1862  * up the hardware before issuing commands to the hardware and putting it
1863  * back to sleep at appropriate times.
1864  *
1865  * When PS is enabled, hardware needs to wakeup for beacons and receive the
1866  * buffered multicast/broadcast frames after the beacon. Also it must be
1867  * possible to send frames and receive the acknowledment frame.
1868  *
1869  * Other hardware designs cannot send nullfunc frames by themselves and also
1870  * need software support for parsing the TIM bitmap. This is also supported
1871  * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1872  * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1873  * required to pass up beacons. The hardware is still required to handle
1874  * waking up for multicast traffic; if it cannot the driver must handle that
1875  * as best as it can, mac80211 is too slow to do that.
1876  *
1877  * Dynamic powersave is an extension to normal powersave in which the
1878  * hardware stays awake for a user-specified period of time after sending a
1879  * frame so that reply frames need not be buffered and therefore delayed to
1880  * the next wakeup. It's compromise of getting good enough latency when
1881  * there's data traffic and still saving significantly power in idle
1882  * periods.
1883  *
1884  * Dynamic powersave is simply supported by mac80211 enabling and disabling
1885  * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1886  * flag and mac80211 will handle everything automatically. Additionally,
1887  * hardware having support for the dynamic PS feature may set the
1888  * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1889  * dynamic PS mode itself. The driver needs to look at the
1890  * @dynamic_ps_timeout hardware configuration value and use it that value
1891  * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1892  * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1893  * enabled whenever user has enabled powersave.
1894  *
1895  * Driver informs U-APSD client support by enabling
1896  * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1897  * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1898  * Nullfunc frames and stay awake until the service period has ended. To
1899  * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1900  * from that AC are transmitted with powersave enabled.
1901  *
1902  * Note: U-APSD client mode is not yet supported with
1903  * %IEEE80211_HW_PS_NULLFUNC_STACK.
1904  */
1905
1906 /**
1907  * DOC: Beacon filter support
1908  *
1909  * Some hardware have beacon filter support to reduce host cpu wakeups
1910  * which will reduce system power consumption. It usually works so that
1911  * the firmware creates a checksum of the beacon but omits all constantly
1912  * changing elements (TSF, TIM etc). Whenever the checksum changes the
1913  * beacon is forwarded to the host, otherwise it will be just dropped. That
1914  * way the host will only receive beacons where some relevant information
1915  * (for example ERP protection or WMM settings) have changed.
1916  *
1917  * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
1918  * interface capability. The driver needs to enable beacon filter support
1919  * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1920  * power save is enabled, the stack will not check for beacon loss and the
1921  * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1922  *
1923  * The time (or number of beacons missed) until the firmware notifies the
1924  * driver of a beacon loss event (which in turn causes the driver to call
1925  * ieee80211_beacon_loss()) should be configurable and will be controlled
1926  * by mac80211 and the roaming algorithm in the future.
1927  *
1928  * Since there may be constantly changing information elements that nothing
1929  * in the software stack cares about, we will, in the future, have mac80211
1930  * tell the driver which information elements are interesting in the sense
1931  * that we want to see changes in them. This will include
1932  *  - a list of information element IDs
1933  *  - a list of OUIs for the vendor information element
1934  *
1935  * Ideally, the hardware would filter out any beacons without changes in the
1936  * requested elements, but if it cannot support that it may, at the expense
1937  * of some efficiency, filter out only a subset. For example, if the device
1938  * doesn't support checking for OUIs it should pass up all changes in all
1939  * vendor information elements.
1940  *
1941  * Note that change, for the sake of simplification, also includes information
1942  * elements appearing or disappearing from the beacon.
1943  *
1944  * Some hardware supports an "ignore list" instead, just make sure nothing
1945  * that was requested is on the ignore list, and include commonly changing
1946  * information element IDs in the ignore list, for example 11 (BSS load) and
1947  * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1948  * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1949  * it could also include some currently unused IDs.
1950  *
1951  *
1952  * In addition to these capabilities, hardware should support notifying the
1953  * host of changes in the beacon RSSI. This is relevant to implement roaming
1954  * when no traffic is flowing (when traffic is flowing we see the RSSI of
1955  * the received data packets). This can consist in notifying the host when
1956  * the RSSI changes significantly or when it drops below or rises above
1957  * configurable thresholds. In the future these thresholds will also be
1958  * configured by mac80211 (which gets them from userspace) to implement
1959  * them as the roaming algorithm requires.
1960  *
1961  * If the hardware cannot implement this, the driver should ask it to
1962  * periodically pass beacon frames to the host so that software can do the
1963  * signal strength threshold checking.
1964  */
1965
1966 /**
1967  * DOC: Spatial multiplexing power save
1968  *
1969  * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1970  * power in an 802.11n implementation. For details on the mechanism
1971  * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1972  * "11.2.3 SM power save".
1973  *
1974  * The mac80211 implementation is capable of sending action frames
1975  * to update the AP about the station's SMPS mode, and will instruct
1976  * the driver to enter the specific mode. It will also announce the
1977  * requested SMPS mode during the association handshake. Hardware
1978  * support for this feature is required, and can be indicated by
1979  * hardware flags.
1980  *
1981  * The default mode will be "automatic", which nl80211/cfg80211
1982  * defines to be dynamic SMPS in (regular) powersave, and SMPS
1983  * turned off otherwise.
1984  *
1985  * To support this feature, the driver must set the appropriate
1986  * hardware support flags, and handle the SMPS flag to the config()
1987  * operation. It will then with this mechanism be instructed to
1988  * enter the requested SMPS mode while associated to an HT AP.
1989  */
1990
1991 /**
1992  * DOC: Frame filtering
1993  *
1994  * mac80211 requires to see many management frames for proper
1995  * operation, and users may want to see many more frames when
1996  * in monitor mode. However, for best CPU usage and power consumption,
1997  * having as few frames as possible percolate through the stack is
1998  * desirable. Hence, the hardware should filter as much as possible.
1999  *
2000  * To achieve this, mac80211 uses filter flags (see below) to tell
2001  * the driver's configure_filter() function which frames should be
2002  * passed to mac80211 and which should be filtered out.
2003  *
2004  * Before configure_filter() is invoked, the prepare_multicast()
2005  * callback is invoked with the parameters @mc_count and @mc_list
2006  * for the combined multicast address list of all virtual interfaces.
2007  * It's use is optional, and it returns a u64 that is passed to
2008  * configure_filter(). Additionally, configure_filter() has the
2009  * arguments @changed_flags telling which flags were changed and
2010  * @total_flags with the new flag states.
2011  *
2012  * If your device has no multicast address filters your driver will
2013  * need to check both the %FIF_ALLMULTI flag and the @mc_count
2014  * parameter to see whether multicast frames should be accepted
2015  * or dropped.
2016  *
2017  * All unsupported flags in @total_flags must be cleared.
2018  * Hardware does not support a flag if it is incapable of _passing_
2019  * the frame to the stack. Otherwise the driver must ignore
2020  * the flag, but not clear it.
2021  * You must _only_ clear the flag (announce no support for the
2022  * flag to mac80211) if you are not able to pass the packet type
2023  * to the stack (so the hardware always filters it).
2024  * So for example, you should clear @FIF_CONTROL, if your hardware
2025  * always filters control frames. If your hardware always passes
2026  * control frames to the kernel and is incapable of filtering them,
2027  * you do _not_ clear the @FIF_CONTROL flag.
2028  * This rule applies to all other FIF flags as well.
2029  */
2030
2031 /**
2032  * DOC: AP support for powersaving clients
2033  *
2034  * In order to implement AP and P2P GO modes, mac80211 has support for
2035  * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2036  * There currently is no support for sAPSD.
2037  *
2038  * There is one assumption that mac80211 makes, namely that a client
2039  * will not poll with PS-Poll and trigger with uAPSD at the same time.
2040  * Both are supported, and both can be used by the same client, but
2041  * they can't be used concurrently by the same client. This simplifies
2042  * the driver code.
2043  *
2044  * The first thing to keep in mind is that there is a flag for complete
2045  * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2046  * mac80211 expects the driver to handle most of the state machine for
2047  * powersaving clients and will ignore the PM bit in incoming frames.
2048  * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2049  * stations' powersave transitions. In this mode, mac80211 also doesn't
2050  * handle PS-Poll/uAPSD.
2051  *
2052  * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2053  * PM bit in incoming frames for client powersave transitions. When a
2054  * station goes to sleep, we will stop transmitting to it. There is,
2055  * however, a race condition: a station might go to sleep while there is
2056  * data buffered on hardware queues. If the device has support for this
2057  * it will reject frames, and the driver should give the frames back to
2058  * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2059  * cause mac80211 to retry the frame when the station wakes up. The
2060  * driver is also notified of powersave transitions by calling its
2061  * @sta_notify callback.
2062  *
2063  * When the station is asleep, it has three choices: it can wake up,
2064  * it can PS-Poll, or it can possibly start a uAPSD service period.
2065  * Waking up is implemented by simply transmitting all buffered (and
2066  * filtered) frames to the station. This is the easiest case. When
2067  * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2068  * will inform the driver of this with the @allow_buffered_frames
2069  * callback; this callback is optional. mac80211 will then transmit
2070  * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2071  * on each frame. The last frame in the service period (or the only
2072  * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2073  * indicate that it ends the service period; as this frame must have
2074  * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2075  * When TX status is reported for this frame, the service period is
2076  * marked has having ended and a new one can be started by the peer.
2077  *
2078  * Additionally, non-bufferable MMPDUs can also be transmitted by
2079  * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2080  *
2081  * Another race condition can happen on some devices like iwlwifi
2082  * when there are frames queued for the station and it wakes up
2083  * or polls; the frames that are already queued could end up being
2084  * transmitted first instead, causing reordering and/or wrong
2085  * processing of the EOSP. The cause is that allowing frames to be
2086  * transmitted to a certain station is out-of-band communication to
2087  * the device. To allow this problem to be solved, the driver can
2088  * call ieee80211_sta_block_awake() if frames are buffered when it
2089  * is notified that the station went to sleep. When all these frames
2090  * have been filtered (see above), it must call the function again
2091  * to indicate that the station is no longer blocked.
2092  *
2093  * If the driver buffers frames in the driver for aggregation in any
2094  * way, it must use the ieee80211_sta_set_buffered() call when it is
2095  * notified of the station going to sleep to inform mac80211 of any
2096  * TIDs that have frames buffered. Note that when a station wakes up
2097  * this information is reset (hence the requirement to call it when
2098  * informed of the station going to sleep). Then, when a service
2099  * period starts for any reason, @release_buffered_frames is called
2100  * with the number of frames to be released and which TIDs they are
2101  * to come from. In this case, the driver is responsible for setting
2102  * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2103  * to help the @more_data paramter is passed to tell the driver if
2104  * there is more data on other TIDs -- the TIDs to release frames
2105  * from are ignored since mac80211 doesn't know how many frames the
2106  * buffers for those TIDs contain.
2107  *
2108  * If the driver also implement GO mode, where absence periods may
2109  * shorten service periods (or abort PS-Poll responses), it must
2110  * filter those response frames except in the case of frames that
2111  * are buffered in the driver -- those must remain buffered to avoid
2112  * reordering. Because it is possible that no frames are released
2113  * in this case, the driver must call ieee80211_sta_eosp()
2114  * to indicate to mac80211 that the service period ended anyway.
2115  *
2116  * Finally, if frames from multiple TIDs are released from mac80211
2117  * but the driver might reorder them, it must clear & set the flags
2118  * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2119  * and also take care of the EOSP and MORE_DATA bits in the frame.
2120  * The driver may also use ieee80211_sta_eosp() in this case.
2121  *
2122  * Note that if the driver ever buffers frames other than QoS-data
2123  * frames, it must take care to never send a non-QoS-data frame as
2124  * the last frame in a service period, adding a QoS-nulldata frame
2125  * after a non-QoS-data frame if needed.
2126  */
2127
2128 /**
2129  * DOC: HW queue control
2130  *
2131  * Before HW queue control was introduced, mac80211 only had a single static
2132  * assignment of per-interface AC software queues to hardware queues. This
2133  * was problematic for a few reasons:
2134  * 1) off-channel transmissions might get stuck behind other frames
2135  * 2) multiple virtual interfaces couldn't be handled correctly
2136  * 3) after-DTIM frames could get stuck behind other frames
2137  *
2138  * To solve this, hardware typically uses multiple different queues for all
2139  * the different usages, and this needs to be propagated into mac80211 so it
2140  * won't have the same problem with the software queues.
2141  *
2142  * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2143  * flag that tells it that the driver implements its own queue control. To do
2144  * so, the driver will set up the various queues in each &struct ieee80211_vif
2145  * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2146  * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2147  * if necessary will queue the frame on the right software queue that mirrors
2148  * the hardware queue.
2149  * Additionally, the driver has to then use these HW queue IDs for the queue
2150  * management functions (ieee80211_stop_queue() et al.)
2151  *
2152  * The driver is free to set up the queue mappings as needed, multiple virtual
2153  * interfaces may map to the same hardware queues if needed. The setup has to
2154  * happen during add_interface or change_interface callbacks. For example, a
2155  * driver supporting station+station and station+AP modes might decide to have
2156  * 10 hardware queues to handle different scenarios:
2157  *
2158  * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2159  * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2160  * after-DTIM queue for AP:   8
2161  * off-channel queue:         9
2162  *
2163  * It would then set up the hardware like this:
2164  *   hw.offchannel_tx_hw_queue = 9
2165  *
2166  * and the first virtual interface that is added as follows:
2167  *   vif.hw_queue[IEEE80211_AC_VO] = 0
2168  *   vif.hw_queue[IEEE80211_AC_VI] = 1
2169  *   vif.hw_queue[IEEE80211_AC_BE] = 2
2170  *   vif.hw_queue[IEEE80211_AC_BK] = 3
2171  *   vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2172  * and the second virtual interface with 4-7.
2173  *
2174  * If queue 6 gets full, for example, mac80211 would only stop the second
2175  * virtual interface's BE queue since virtual interface queues are per AC.
2176  *
2177  * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2178  * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2179  * queue could potentially be shared since mac80211 will look at cab_queue when
2180  * a queue is stopped/woken even if the interface is not in AP mode.
2181  */
2182
2183 /**
2184  * enum ieee80211_filter_flags - hardware filter flags
2185  *
2186  * These flags determine what the filter in hardware should be
2187  * programmed to let through and what should not be passed to the
2188  * stack. It is always safe to pass more frames than requested,
2189  * but this has negative impact on power consumption.
2190  *
2191  * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
2192  *      think of the BSS as your network segment and then this corresponds
2193  *      to the regular ethernet device promiscuous mode.
2194  *
2195  * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2196  *      by the user or if the hardware is not capable of filtering by
2197  *      multicast address.
2198  *
2199  * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2200  *      %RX_FLAG_FAILED_FCS_CRC for them)
2201  *
2202  * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2203  *      the %RX_FLAG_FAILED_PLCP_CRC for them
2204  *
2205  * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2206  *      to the hardware that it should not filter beacons or probe responses
2207  *      by BSSID. Filtering them can greatly reduce the amount of processing
2208  *      mac80211 needs to do and the amount of CPU wakeups, so you should
2209  *      honour this flag if possible.
2210  *
2211  * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
2212  *      is not set then only those addressed to this station.
2213  *
2214  * @FIF_OTHER_BSS: pass frames destined to other BSSes
2215  *
2216  * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
2217  *      those addressed to this station.
2218  *
2219  * @FIF_PROBE_REQ: pass probe request frames
2220  */
2221 enum ieee80211_filter_flags {
2222         FIF_PROMISC_IN_BSS      = 1<<0,
2223         FIF_ALLMULTI            = 1<<1,
2224         FIF_FCSFAIL             = 1<<2,
2225         FIF_PLCPFAIL            = 1<<3,
2226         FIF_BCN_PRBRESP_PROMISC = 1<<4,
2227         FIF_CONTROL             = 1<<5,
2228         FIF_OTHER_BSS           = 1<<6,
2229         FIF_PSPOLL              = 1<<7,
2230         FIF_PROBE_REQ           = 1<<8,
2231 };
2232
2233 /**
2234  * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2235  *
2236  * These flags are used with the ampdu_action() callback in
2237  * &struct ieee80211_ops to indicate which action is needed.
2238  *
2239  * Note that drivers MUST be able to deal with a TX aggregation
2240  * session being stopped even before they OK'ed starting it by
2241  * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2242  * might receive the addBA frame and send a delBA right away!
2243  *
2244  * @IEEE80211_AMPDU_RX_START: start RX aggregation
2245  * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2246  * @IEEE80211_AMPDU_TX_START: start TX aggregation
2247  * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2248  * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2249  *      queued packets, now unaggregated. After all packets are transmitted the
2250  *      driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2251  * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2252  *      called when the station is removed. There's no need or reason to call
2253  *      ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2254  *      session is gone and removes the station.
2255  * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2256  *      but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2257  *      now the connection is dropped and the station will be removed. Drivers
2258  *      should clean up and drop remaining packets when this is called.
2259  */
2260 enum ieee80211_ampdu_mlme_action {
2261         IEEE80211_AMPDU_RX_START,
2262         IEEE80211_AMPDU_RX_STOP,
2263         IEEE80211_AMPDU_TX_START,
2264         IEEE80211_AMPDU_TX_STOP_CONT,
2265         IEEE80211_AMPDU_TX_STOP_FLUSH,
2266         IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2267         IEEE80211_AMPDU_TX_OPERATIONAL,
2268 };
2269
2270 /**
2271  * enum ieee80211_frame_release_type - frame release reason
2272  * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2273  * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2274  *      frame received on trigger-enabled AC
2275  */
2276 enum ieee80211_frame_release_type {
2277         IEEE80211_FRAME_RELEASE_PSPOLL,
2278         IEEE80211_FRAME_RELEASE_UAPSD,
2279 };
2280
2281 /**
2282  * enum ieee80211_rate_control_changed - flags to indicate what changed
2283  *
2284  * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2285  *      to this station changed. The actual bandwidth is in the station
2286  *      information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2287  *      flag changes, for HT and VHT the bandwidth field changes.
2288  * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2289  * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2290  *      changed (in IBSS mode) due to discovering more information about
2291  *      the peer.
2292  * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2293  *      by the peer
2294  */
2295 enum ieee80211_rate_control_changed {
2296         IEEE80211_RC_BW_CHANGED         = BIT(0),
2297         IEEE80211_RC_SMPS_CHANGED       = BIT(1),
2298         IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2299         IEEE80211_RC_NSS_CHANGED        = BIT(3),
2300 };
2301
2302 /**
2303  * enum ieee80211_roc_type - remain on channel type
2304  *
2305  * With the support for multi channel contexts and multi channel operations,
2306  * remain on channel operations might be limited/deferred/aborted by other
2307  * flows/operations which have higher priority (and vise versa).
2308  * Specifying the ROC type can be used by devices to prioritize the ROC
2309  * operations compared to other operations/flows.
2310  *
2311  * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2312  * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2313  *      for sending managment frames offchannel.
2314  */
2315 enum ieee80211_roc_type {
2316         IEEE80211_ROC_TYPE_NORMAL = 0,
2317         IEEE80211_ROC_TYPE_MGMT_TX,
2318 };
2319
2320 /**
2321  * struct ieee80211_ops - callbacks from mac80211 to the driver
2322  *
2323  * This structure contains various callbacks that the driver may
2324  * handle or, in some cases, must handle, for example to configure
2325  * the hardware to a new channel or to transmit a frame.
2326  *
2327  * @tx: Handler that 802.11 module calls for each transmitted frame.
2328  *      skb contains the buffer starting from the IEEE 802.11 header.
2329  *      The low-level driver should send the frame out based on
2330  *      configuration in the TX control data. This handler should,
2331  *      preferably, never fail and stop queues appropriately.
2332  *      Must be atomic.
2333  *
2334  * @start: Called before the first netdevice attached to the hardware
2335  *      is enabled. This should turn on the hardware and must turn on
2336  *      frame reception (for possibly enabled monitor interfaces.)
2337  *      Returns negative error codes, these may be seen in userspace,
2338  *      or zero.
2339  *      When the device is started it should not have a MAC address
2340  *      to avoid acknowledging frames before a non-monitor device
2341  *      is added.
2342  *      Must be implemented and can sleep.
2343  *
2344  * @stop: Called after last netdevice attached to the hardware
2345  *      is disabled. This should turn off the hardware (at least
2346  *      it must turn off frame reception.)
2347  *      May be called right after add_interface if that rejects
2348  *      an interface. If you added any work onto the mac80211 workqueue
2349  *      you should ensure to cancel it on this callback.
2350  *      Must be implemented and can sleep.
2351  *
2352  * @suspend: Suspend the device; mac80211 itself will quiesce before and
2353  *      stop transmitting and doing any other configuration, and then
2354  *      ask the device to suspend. This is only invoked when WoWLAN is
2355  *      configured, otherwise the device is deconfigured completely and
2356  *      reconfigured at resume time.
2357  *      The driver may also impose special conditions under which it
2358  *      wants to use the "normal" suspend (deconfigure), say if it only
2359  *      supports WoWLAN when the device is associated. In this case, it
2360  *      must return 1 from this function.
2361  *
2362  * @resume: If WoWLAN was configured, this indicates that mac80211 is
2363  *      now resuming its operation, after this the device must be fully
2364  *      functional again. If this returns an error, the only way out is
2365  *      to also unregister the device. If it returns 1, then mac80211
2366  *      will also go through the regular complete restart on resume.
2367  *
2368  * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2369  *      modified. The reason is that device_set_wakeup_enable() is
2370  *      supposed to be called when the configuration changes, not only
2371  *      in suspend().
2372  *
2373  * @add_interface: Called when a netdevice attached to the hardware is
2374  *      enabled. Because it is not called for monitor mode devices, @start
2375  *      and @stop must be implemented.
2376  *      The driver should perform any initialization it needs before
2377  *      the device can be enabled. The initial configuration for the
2378  *      interface is given in the conf parameter.
2379  *      The callback may refuse to add an interface by returning a
2380  *      negative error code (which will be seen in userspace.)
2381  *      Must be implemented and can sleep.
2382  *
2383  * @change_interface: Called when a netdevice changes type. This callback
2384  *      is optional, but only if it is supported can interface types be
2385  *      switched while the interface is UP. The callback may sleep.
2386  *      Note that while an interface is being switched, it will not be
2387  *      found by the interface iteration callbacks.
2388  *
2389  * @remove_interface: Notifies a driver that an interface is going down.
2390  *      The @stop callback is called after this if it is the last interface
2391  *      and no monitor interfaces are present.
2392  *      When all interfaces are removed, the MAC address in the hardware
2393  *      must be cleared so the device no longer acknowledges packets,
2394  *      the mac_addr member of the conf structure is, however, set to the
2395  *      MAC address of the device going away.
2396  *      Hence, this callback must be implemented. It can sleep.
2397  *
2398  * @config: Handler for configuration requests. IEEE 802.11 code calls this
2399  *      function to change hardware configuration, e.g., channel.
2400  *      This function should never fail but returns a negative error code
2401  *      if it does. The callback can sleep.
2402  *
2403  * @bss_info_changed: Handler for configuration requests related to BSS
2404  *      parameters that may vary during BSS's lifespan, and may affect low
2405  *      level driver (e.g. assoc/disassoc status, erp parameters).
2406  *      This function should not be used if no BSS has been set, unless
2407  *      for association indication. The @changed parameter indicates which
2408  *      of the bss parameters has changed when a call is made. The callback
2409  *      can sleep.
2410  *
2411  * @prepare_multicast: Prepare for multicast filter configuration.
2412  *      This callback is optional, and its return value is passed
2413  *      to configure_filter(). This callback must be atomic.
2414  *
2415  * @configure_filter: Configure the device's RX filter.
2416  *      See the section "Frame filtering" for more information.
2417  *      This callback must be implemented and can sleep.
2418  *
2419  * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2420  *      must be set or cleared for a given STA. Must be atomic.
2421  *
2422  * @set_key: See the section "Hardware crypto acceleration"
2423  *      This callback is only called between add_interface and
2424  *      remove_interface calls, i.e. while the given virtual interface
2425  *      is enabled.
2426  *      Returns a negative error code if the key can't be added.
2427  *      The callback can sleep.
2428  *
2429  * @update_tkip_key: See the section "Hardware crypto acceleration"
2430  *      This callback will be called in the context of Rx. Called for drivers
2431  *      which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2432  *      The callback must be atomic.
2433  *
2434  * @set_rekey_data: If the device supports GTK rekeying, for example while the
2435  *      host is suspended, it can assign this callback to retrieve the data
2436  *      necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2437  *      After rekeying was done it should (for example during resume) notify
2438  *      userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2439  *
2440  * @set_default_unicast_key: Set the default (unicast) key index, useful for
2441  *      WEP when the device sends data packets autonomously, e.g. for ARP
2442  *      offloading. The index can be 0-3, or -1 for unsetting it.
2443  *
2444  * @hw_scan: Ask the hardware to service the scan request, no need to start
2445  *      the scan state machine in stack. The scan must honour the channel
2446  *      configuration done by the regulatory agent in the wiphy's
2447  *      registered bands. The hardware (or the driver) needs to make sure
2448  *      that power save is disabled.
2449  *      The @req ie/ie_len members are rewritten by mac80211 to contain the
2450  *      entire IEs after the SSID, so that drivers need not look at these
2451  *      at all but just send them after the SSID -- mac80211 includes the
2452  *      (extended) supported rates and HT information (where applicable).
2453  *      When the scan finishes, ieee80211_scan_completed() must be called;
2454  *      note that it also must be called when the scan cannot finish due to
2455  *      any error unless this callback returned a negative error code.
2456  *      The callback can sleep.
2457  *
2458  * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2459  *      The driver should ask the hardware to cancel the scan (if possible),
2460  *      but the scan will be completed only after the driver will call
2461  *      ieee80211_scan_completed().
2462  *      This callback is needed for wowlan, to prevent enqueueing a new
2463  *      scan_work after the low-level driver was already suspended.
2464  *      The callback can sleep.
2465  *
2466  * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2467  *      specific intervals.  The driver must call the
2468  *      ieee80211_sched_scan_results() function whenever it finds results.
2469  *      This process will continue until sched_scan_stop is called.
2470  *
2471  * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2472  *
2473  * @sw_scan_start: Notifier function that is called just before a software scan
2474  *      is started. Can be NULL, if the driver doesn't need this notification.
2475  *      The callback can sleep.
2476  *
2477  * @sw_scan_complete: Notifier function that is called just after a
2478  *      software scan finished. Can be NULL, if the driver doesn't need
2479  *      this notification.
2480  *      The callback can sleep.
2481  *
2482  * @get_stats: Return low-level statistics.
2483  *      Returns zero if statistics are available.
2484  *      The callback can sleep.
2485  *
2486  * @get_tkip_seq: If your device implements TKIP encryption in hardware this
2487  *      callback should be provided to read the TKIP transmit IVs (both IV32
2488  *      and IV16) for the given key from hardware.
2489  *      The callback must be atomic.
2490  *
2491  * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
2492  *      if the device does fragmentation by itself; if this callback is
2493  *      implemented then the stack will not do fragmentation.
2494  *      The callback can sleep.
2495  *
2496  * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
2497  *      The callback can sleep.
2498  *
2499  * @sta_add: Notifies low level driver about addition of an associated station,
2500  *      AP, IBSS/WDS/mesh peer etc. This callback can sleep.
2501  *
2502  * @sta_remove: Notifies low level driver about removal of an associated
2503  *      station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
2504  *      returns it isn't safe to use the pointer, not even RCU protected;
2505  *      no RCU grace period is guaranteed between returning here and freeing
2506  *      the station. See @sta_pre_rcu_remove if needed.
2507  *      This callback can sleep.
2508  *
2509  * @sta_add_debugfs: Drivers can use this callback to add debugfs files
2510  *      when a station is added to mac80211's station list. This callback
2511  *      and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
2512  *      conditional. This callback can sleep.
2513  *
2514  * @sta_remove_debugfs: Remove the debugfs files which were added using
2515  *      @sta_add_debugfs. This callback can sleep.
2516  *
2517  * @sta_notify: Notifies low level driver about power state transition of an
2518  *      associated station, AP,  IBSS/WDS/mesh peer etc. For a VIF operating
2519  *      in AP mode, this callback will not be called when the flag
2520  *      %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
2521  *
2522  * @sta_state: Notifies low level driver about state transition of a
2523  *      station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
2524  *      This callback is mutually exclusive with @sta_add/@sta_remove.
2525  *      It must not fail for down transitions but may fail for transitions
2526  *      up the list of states. Also note that after the callback returns it
2527  *      isn't safe to use the pointer, not even RCU protected - no RCU grace
2528  *      period is guaranteed between returning here and freeing the station.
2529  *      See @sta_pre_rcu_remove if needed.
2530  *      The callback can sleep.
2531  *
2532  * @sta_pre_rcu_remove: Notify driver about station removal before RCU
2533  *      synchronisation. This is useful if a driver needs to have station
2534  *      pointers protected using RCU, it can then use this call to clear
2535  *      the pointers instead of waiting for an RCU grace period to elapse
2536  *      in @sta_state.
2537  *      The callback can sleep.
2538  *
2539  * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
2540  *      used to transmit to the station. The changes are advertised with bits
2541  *      from &enum ieee80211_rate_control_changed and the values are reflected
2542  *      in the station data. This callback should only be used when the driver
2543  *      uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
2544  *      otherwise the rate control algorithm is notified directly.
2545  *      Must be atomic.
2546  *
2547  * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
2548  *      bursting) for a hardware TX queue.
2549  *      Returns a negative error code on failure.
2550  *      The callback can sleep.
2551  *
2552  * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
2553  *      this is only used for IBSS mode BSSID merging and debugging. Is not a
2554  *      required function.
2555  *      The callback can sleep.
2556  *
2557  * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
2558  *      Currently, this is only used for IBSS mode debugging. Is not a
2559  *      required function.
2560  *      The callback can sleep.
2561  *
2562  * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
2563  *      with other STAs in the IBSS. This is only used in IBSS mode. This
2564  *      function is optional if the firmware/hardware takes full care of
2565  *      TSF synchronization.
2566  *      The callback can sleep.
2567  *
2568  * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
2569  *      This is needed only for IBSS mode and the result of this function is
2570  *      used to determine whether to reply to Probe Requests.
2571  *      Returns non-zero if this device sent the last beacon.
2572  *      The callback can sleep.
2573  *
2574  * @ampdu_action: Perform a certain A-MPDU action
2575  *      The RA/TID combination determines the destination and TID we want
2576  *      the ampdu action to be performed for. The action is defined through
2577  *      ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
2578  *      is the first frame we expect to perform the action on. Notice
2579  *      that TX/RX_STOP can pass NULL for this parameter.
2580  *      The @buf_size parameter is only valid when the action is set to
2581  *      %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
2582  *      buffer size (number of subframes) for this session -- the driver
2583  *      may neither send aggregates containing more subframes than this
2584  *      nor send aggregates in a way that lost frames would exceed the
2585  *      buffer size. If just limiting the aggregate size, this would be
2586  *      possible with a buf_size of 8:
2587  *       - TX: 1.....7
2588  *       - RX:  2....7 (lost frame #1)
2589  *       - TX:        8..1...
2590  *      which is invalid since #1 was now re-transmitted well past the
2591  *      buffer size of 8. Correct ways to retransmit #1 would be:
2592  *       - TX:       1 or 18 or 81
2593  *      Even "189" would be wrong since 1 could be lost again.
2594  *
2595  *      Returns a negative error code on failure.
2596  *      The callback can sleep.
2597  *
2598  * @get_survey: Return per-channel survey information
2599  *
2600  * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
2601  *      need to set wiphy->rfkill_poll to %true before registration,
2602  *      and need to call wiphy_rfkill_set_hw_state() in the callback.
2603  *      The callback can sleep.
2604  *
2605  * @set_coverage_class: Set slot time for given coverage class as specified
2606  *      in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2607  *      accordingly. This callback is not required and may sleep.
2608  *
2609  * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
2610  *      be %NULL. The callback can sleep.
2611  * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2612  *
2613  * @flush: Flush all pending frames from the hardware queue, making sure
2614  *      that the hardware queues are empty. The @queues parameter is a bitmap
2615  *      of queues to flush, which is useful if different virtual interfaces
2616  *      use different hardware queues; it may also indicate all queues.
2617  *      If the parameter @drop is set to %true, pending frames may be dropped.
2618  *      The callback can sleep.
2619  *
2620  * @channel_switch: Drivers that need (or want) to offload the channel
2621  *      switch operation for CSAs received from the AP may implement this
2622  *      callback. They must then call ieee80211_chswitch_done() to indicate
2623  *      completion of the channel switch.
2624  *
2625  * @napi_poll: Poll Rx queue for incoming data frames.
2626  *
2627  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2628  *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2629  *      reject TX/RX mask combinations they cannot support by returning -EINVAL
2630  *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2631  *
2632  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2633  *
2634  * @remain_on_channel: Starts an off-channel period on the given channel, must
2635  *      call back to ieee80211_ready_on_channel() when on that channel. Note
2636  *      that normal channel traffic is not stopped as this is intended for hw
2637  *      offload. Frames to transmit on the off-channel channel are transmitted
2638  *      normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2639  *      duration (which will always be non-zero) expires, the driver must call
2640  *      ieee80211_remain_on_channel_expired().
2641  *      Note that this callback may be called while the device is in IDLE and
2642  *      must be accepted in this case.
2643  *      This callback may sleep.
2644  * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2645  *      aborted before it expires. This callback may sleep.
2646  *
2647  * @set_ringparam: Set tx and rx ring sizes.
2648  *
2649  * @get_ringparam: Get tx and rx ring current and maximum sizes.
2650  *
2651  * @tx_frames_pending: Check if there is any pending frame in the hardware
2652  *      queues before entering power save.
2653  *
2654  * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2655  *      when transmitting a frame. Currently only legacy rates are handled.
2656  *      The callback can sleep.
2657  * @rssi_callback: Notify driver when the average RSSI goes above/below
2658  *      thresholds that were registered previously. The callback can sleep.
2659  *
2660  * @release_buffered_frames: Release buffered frames according to the given
2661  *      parameters. In the case where the driver buffers some frames for
2662  *      sleeping stations mac80211 will use this callback to tell the driver
2663  *      to release some frames, either for PS-poll or uAPSD.
2664  *      Note that if the @more_data paramter is %false the driver must check
2665  *      if there are more frames on the given TIDs, and if there are more than
2666  *      the frames being released then it must still set the more-data bit in
2667  *      the frame. If the @more_data parameter is %true, then of course the
2668  *      more-data bit must always be set.
2669  *      The @tids parameter tells the driver which TIDs to release frames
2670  *      from, for PS-poll it will always have only a single bit set.
2671  *      In the case this is used for a PS-poll initiated release, the
2672  *      @num_frames parameter will always be 1 so code can be shared. In
2673  *      this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2674  *      on the TX status (and must report TX status) so that the PS-poll
2675  *      period is properly ended. This is used to avoid sending multiple
2676  *      responses for a retried PS-poll frame.
2677  *      In the case this is used for uAPSD, the @num_frames parameter may be
2678  *      bigger than one, but the driver may send fewer frames (it must send
2679  *      at least one, however). In this case it is also responsible for
2680  *      setting the EOSP flag in the QoS header of the frames. Also, when the
2681  *      service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2682  *      on the last frame in the SP. Alternatively, it may call the function
2683  *      ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
2684  *      This callback must be atomic.
2685  * @allow_buffered_frames: Prepare device to allow the given number of frames
2686  *      to go out to the given station. The frames will be sent by mac80211
2687  *      via the usual TX path after this call. The TX information for frames
2688  *      released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
2689  *      and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2690  *      frames from multiple TIDs are released and the driver might reorder
2691  *      them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2692  *      on the last frame and clear it on all others and also handle the EOSP
2693  *      bit in the QoS header correctly. Alternatively, it can also call the
2694  *      ieee80211_sta_eosp() function.
2695  *      The @tids parameter is a bitmap and tells the driver which TIDs the
2696  *      frames will be on; it will at most have two bits set.
2697  *      This callback must be atomic.
2698  *
2699  * @get_et_sset_count:  Ethtool API to get string-set count.
2700  *
2701  * @get_et_stats:  Ethtool API to get a set of u64 stats.
2702  *
2703  * @get_et_strings:  Ethtool API to get a set of strings to describe stats
2704  *      and perhaps other supported types of ethtool data-sets.
2705  *
2706  * @get_rssi: Get current signal strength in dBm, the function is optional
2707  *      and can sleep.
2708  *
2709  * @mgd_prepare_tx: Prepare for transmitting a management frame for association
2710  *      before associated. In multi-channel scenarios, a virtual interface is
2711  *      bound to a channel before it is associated, but as it isn't associated
2712  *      yet it need not necessarily be given airtime, in particular since any
2713  *      transmission to a P2P GO needs to be synchronized against the GO's
2714  *      powersave state. mac80211 will call this function before transmitting a
2715  *      management frame prior to having successfully associated to allow the
2716  *      driver to give it channel time for the transmission, to get a response
2717  *      and to be able to synchronize with the GO.
2718  *      The callback will be called before each transmission and upon return
2719  *      mac80211 will transmit the frame right away.
2720  *      The callback is optional and can (should!) sleep.
2721  *
2722  * @add_chanctx: Notifies device driver about new channel context creation.
2723  * @remove_chanctx: Notifies device driver about channel context destruction.
2724  * @change_chanctx: Notifies device driver about channel context changes that
2725  *      may happen when combining different virtual interfaces on the same
2726  *      channel context with different settings
2727  * @assign_vif_chanctx: Notifies device driver about channel context being bound
2728  *      to vif. Possible use is for hw queue remapping.
2729  * @unassign_vif_chanctx: Notifies device driver about channel context being
2730  *      unbound from vif.
2731  * @start_ap: Start operation on the AP interface, this is called after all the
2732  *      information in bss_conf is set and beacon can be retrieved. A channel
2733  *      context is bound before this is called. Note that if the driver uses
2734  *      software scan or ROC, this (and @stop_ap) isn't called when the AP is
2735  *      just "paused" for scanning/ROC, which is indicated by the beacon being
2736  *      disabled/enabled via @bss_info_changed.
2737  * @stop_ap: Stop operation on the AP interface.
2738  *
2739  * @restart_complete: Called after a call to ieee80211_restart_hw(), when the
2740  *      reconfiguration has completed. This can help the driver implement the
2741  *      reconfiguration step. Also called when reconfiguring because the
2742  *      driver's resume function returned 1, as this is just like an "inline"
2743  *      hardware restart. This callback may sleep.
2744  *
2745  * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
2746  *      Currently, this is only called for managed or P2P client interfaces.
2747  *      This callback is optional; it must not sleep.
2748  *
2749  * @channel_switch_beacon: Starts a channel switch to a new channel.
2750  *      Beacons are modified to include CSA or ECSA IEs before calling this
2751  *      function. The corresponding count fields in these IEs must be
2752  *      decremented, and when they reach 1 the driver must call
2753  *      ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
2754  *      get the csa counter decremented by mac80211, but must check if it is
2755  *      1 using ieee80211_csa_is_complete() after the beacon has been
2756  *      transmitted and then call ieee80211_csa_finish().
2757  *      If the CSA count starts as zero or 1, this function will not be called,
2758  *      since there won't be any time to beacon before the switch anyway.
2759  *
2760  * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
2761  *      information in bss_conf is set up and the beacon can be retrieved. A
2762  *      channel context is bound before this is called.
2763  * @leave_ibss: Leave the IBSS again.
2764  */
2765 struct ieee80211_ops {
2766         void (*tx)(struct ieee80211_hw *hw,
2767                    struct ieee80211_tx_control *control,
2768                    struct sk_buff *skb);
2769         int (*start)(struct ieee80211_hw *hw);
2770         void (*stop)(struct ieee80211_hw *hw);
2771 #ifdef CONFIG_PM
2772         int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2773         int (*resume)(struct ieee80211_hw *hw);
2774         void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
2775 #endif
2776         int (*add_interface)(struct ieee80211_hw *hw,
2777                              struct ieee80211_vif *vif);
2778         int (*change_interface)(struct ieee80211_hw *hw,
2779                                 struct ieee80211_vif *vif,
2780                                 enum nl80211_iftype new_type, bool p2p);
2781         void (*remove_interface)(struct ieee80211_hw *hw,
2782                                  struct ieee80211_vif *vif);
2783         int (*config)(struct ieee80211_hw *hw, u32 changed);
2784         void (*bss_info_changed)(struct ieee80211_hw *hw,
2785                                  struct ieee80211_vif *vif,
2786                                  struct ieee80211_bss_conf *info,
2787                                  u32 changed);
2788
2789         int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2790         void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2791
2792         u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2793                                  struct netdev_hw_addr_list *mc_list);
2794         void (*configure_filter)(struct ieee80211_hw *hw,
2795                                  unsigned int changed_flags,
2796                                  unsigned int *total_flags,
2797                                  u64 multicast);
2798         int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2799                        bool set);
2800         int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2801                        struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2802                        struct ieee80211_key_conf *key);
2803         void (*update_tkip_key)(struct ieee80211_hw *hw,
2804                                 struct ieee80211_vif *vif,
2805                                 struct ieee80211_key_conf *conf,
2806                                 struct ieee80211_sta *sta,
2807                                 u32 iv32, u16 *phase1key);
2808         void (*set_rekey_data)(struct ieee80211_hw *hw,
2809                                struct ieee80211_vif *vif,
2810                                struct cfg80211_gtk_rekey_data *data);
2811         void (*set_default_unicast_key)(struct ieee80211_hw *hw,
2812                                         struct ieee80211_vif *vif, int idx);
2813         int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2814                        struct cfg80211_scan_request *req);
2815         void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2816                                struct ieee80211_vif *vif);
2817         int (*sched_scan_start)(struct ieee80211_hw *hw,
2818                                 struct ieee80211_vif *vif,
2819                                 struct cfg80211_sched_scan_request *req,
2820                                 struct ieee80211_sched_scan_ies *ies);
2821         void (*sched_scan_stop)(struct ieee80211_hw *hw,
2822                                struct ieee80211_vif *vif);
2823         void (*sw_scan_start)(struct ieee80211_hw *hw);
2824         void (*sw_scan_complete)(struct ieee80211_hw *hw);
2825         int (*get_stats)(struct ieee80211_hw *hw,
2826                          struct ieee80211_low_level_stats *stats);
2827         void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2828                              u32 *iv32, u16 *iv16);
2829         int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2830         int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2831         int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2832                        struct ieee80211_sta *sta);
2833         int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2834                           struct ieee80211_sta *sta);
2835 #ifdef CONFIG_MAC80211_DEBUGFS
2836         void (*sta_add_debugfs)(struct ieee80211_hw *hw,
2837                                 struct ieee80211_vif *vif,
2838                                 struct ieee80211_sta *sta,
2839                                 struct dentry *dir);
2840         void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
2841                                    struct ieee80211_vif *vif,
2842                                    struct ieee80211_sta *sta,
2843                                    struct dentry *dir);
2844 #endif
2845         void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2846                         enum sta_notify_cmd, struct ieee80211_sta *sta);
2847         int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2848                          struct ieee80211_sta *sta,
2849                          enum ieee80211_sta_state old_state,
2850                          enum ieee80211_sta_state new_state);
2851         void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
2852                                    struct ieee80211_vif *vif,
2853                                    struct ieee80211_sta *sta);
2854         void (*sta_rc_update)(struct ieee80211_hw *hw,
2855                               struct ieee80211_vif *vif,
2856                               struct ieee80211_sta *sta,
2857                               u32 changed);
2858         int (*conf_tx)(struct ieee80211_hw *hw,
2859                        struct ieee80211_vif *vif, u16 ac,
2860                        const struct ieee80211_tx_queue_params *params);
2861         u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2862         void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2863                         u64 tsf);
2864         void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2865         int (*tx_last_beacon)(struct ieee80211_hw *hw);
2866         int (*ampdu_action)(struct ieee80211_hw *hw,
2867                             struct ieee80211_vif *vif,
2868                             enum ieee80211_ampdu_mlme_action action,
2869                             struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2870                             u8 buf_size);
2871         int (*get_survey)(struct ieee80211_hw *hw, int idx,
2872                 struct survey_info *survey);
2873         void (*rfkill_poll)(struct ieee80211_hw *hw);
2874         void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2875 #ifdef CONFIG_NL80211_TESTMODE
2876         int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2877                             void *data, int len);
2878         int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2879                              struct netlink_callback *cb,
2880                              void *data, int len);
2881 #endif
2882         void (*flush)(struct ieee80211_hw *hw, u32 queues, bool drop);
2883         void (*channel_switch)(struct ieee80211_hw *hw,
2884                                struct ieee80211_channel_switch *ch_switch);
2885         int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2886         int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2887         int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2888
2889         int (*remain_on_channel)(struct ieee80211_hw *hw,
2890                                  struct ieee80211_vif *vif,
2891                                  struct ieee80211_channel *chan,
2892                                  int duration,
2893                                  enum ieee80211_roc_type type);
2894         int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2895         int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2896         void (*get_ringparam)(struct ieee80211_hw *hw,
2897                               u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2898         bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2899         int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2900                                 const struct cfg80211_bitrate_mask *mask);
2901         void (*rssi_callback)(struct ieee80211_hw *hw,
2902                               struct ieee80211_vif *vif,
2903                               enum ieee80211_rssi_event rssi_event);
2904
2905         void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2906                                       struct ieee80211_sta *sta,
2907                                       u16 tids, int num_frames,
2908                                       enum ieee80211_frame_release_type reason,
2909                                       bool more_data);
2910         void (*release_buffered_frames)(struct ieee80211_hw *hw,
2911                                         struct ieee80211_sta *sta,
2912                                         u16 tids, int num_frames,
2913                                         enum ieee80211_frame_release_type reason,
2914                                         bool more_data);
2915
2916         int     (*get_et_sset_count)(struct ieee80211_hw *hw,
2917                                      struct ieee80211_vif *vif, int sset);
2918         void    (*get_et_stats)(struct ieee80211_hw *hw,
2919                                 struct ieee80211_vif *vif,
2920                                 struct ethtool_stats *stats, u64 *data);
2921         void    (*get_et_strings)(struct ieee80211_hw *hw,
2922                                   struct ieee80211_vif *vif,
2923                                   u32 sset, u8 *data);
2924         int     (*get_rssi)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2925                             struct ieee80211_sta *sta, s8 *rssi_dbm);
2926
2927         void    (*mgd_prepare_tx)(struct ieee80211_hw *hw,
2928                                   struct ieee80211_vif *vif);
2929
2930         int (*add_chanctx)(struct ieee80211_hw *hw,
2931                            struct ieee80211_chanctx_conf *ctx);
2932         void (*remove_chanctx)(struct ieee80211_hw *hw,
2933                                struct ieee80211_chanctx_conf *ctx);
2934         void (*change_chanctx)(struct ieee80211_hw *hw,
2935                                struct ieee80211_chanctx_conf *ctx,
2936                                u32 changed);
2937         int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
2938                                   struct ieee80211_vif *vif,
2939                                   struct ieee80211_chanctx_conf *ctx);
2940         void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
2941                                      struct ieee80211_vif *vif,
2942                                      struct ieee80211_chanctx_conf *ctx);
2943
2944         void (*restart_complete)(struct ieee80211_hw *hw);
2945
2946 #if IS_ENABLED(CONFIG_IPV6)
2947         void (*ipv6_addr_change)(struct ieee80211_hw *hw,
2948                                  struct ieee80211_vif *vif,
2949                                  struct inet6_dev *idev);
2950 #endif
2951         void (*channel_switch_beacon)(struct ieee80211_hw *hw,
2952                                       struct ieee80211_vif *vif,
2953                                       struct cfg80211_chan_def *chandef);
2954
2955         int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2956         void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2957 };
2958
2959 /**
2960  * ieee80211_alloc_hw -  Allocate a new hardware device
2961  *
2962  * This must be called once for each hardware device. The returned pointer
2963  * must be used to refer to this device when calling other functions.
2964  * mac80211 allocates a private data area for the driver pointed to by
2965  * @priv in &struct ieee80211_hw, the size of this area is given as
2966  * @priv_data_len.
2967  *
2968  * @priv_data_len: length of private data
2969  * @ops: callbacks for this device
2970  *
2971  * Return: A pointer to the new hardware device, or %NULL on error.
2972  */
2973 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2974                                         const struct ieee80211_ops *ops);
2975
2976 /**
2977  * ieee80211_register_hw - Register hardware device
2978  *
2979  * You must call this function before any other functions in
2980  * mac80211. Note that before a hardware can be registered, you
2981  * need to fill the contained wiphy's information.
2982  *
2983  * @hw: the device to register as returned by ieee80211_alloc_hw()
2984  *
2985  * Return: 0 on success. An error code otherwise.
2986  */
2987 int ieee80211_register_hw(struct ieee80211_hw *hw);
2988
2989 /**
2990  * struct ieee80211_tpt_blink - throughput blink description
2991  * @throughput: throughput in Kbit/sec
2992  * @blink_time: blink time in milliseconds
2993  *      (full cycle, ie. one off + one on period)
2994  */
2995 struct ieee80211_tpt_blink {
2996         int throughput;
2997         int blink_time;
2998 };
2999
3000 /**
3001  * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3002  * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3003  * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3004  * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3005  *      interface is connected in some way, including being an AP
3006  */
3007 enum ieee80211_tpt_led_trigger_flags {
3008         IEEE80211_TPT_LEDTRIG_FL_RADIO          = BIT(0),
3009         IEEE80211_TPT_LEDTRIG_FL_WORK           = BIT(1),
3010         IEEE80211_TPT_LEDTRIG_FL_CONNECTED      = BIT(2),
3011 };
3012
3013 #ifdef CONFIG_MAC80211_LEDS
3014 char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3015 char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3016 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3017 char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3018 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3019                                          unsigned int flags,
3020                                          const struct ieee80211_tpt_blink *blink_table,
3021                                          unsigned int blink_table_len);
3022 #endif
3023 /**
3024  * ieee80211_get_tx_led_name - get name of TX LED
3025  *
3026  * mac80211 creates a transmit LED trigger for each wireless hardware
3027  * that can be used to drive LEDs if your driver registers a LED device.
3028  * This function returns the name (or %NULL if not configured for LEDs)
3029  * of the trigger so you can automatically link the LED device.
3030  *
3031  * @hw: the hardware to get the LED trigger name for
3032  *
3033  * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3034  */
3035 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3036 {
3037 #ifdef CONFIG_MAC80211_LEDS
3038         return __ieee80211_get_tx_led_name(hw);
3039 #else
3040         return NULL;
3041 #endif
3042 }
3043
3044 /**
3045  * ieee80211_get_rx_led_name - get name of RX LED
3046  *
3047  * mac80211 creates a receive LED trigger for each wireless hardware
3048  * that can be used to drive LEDs if your driver registers a LED device.
3049  * This function returns the name (or %NULL if not configured for LEDs)
3050  * of the trigger so you can automatically link the LED device.
3051  *
3052  * @hw: the hardware to get the LED trigger name for
3053  *
3054  * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3055  */
3056 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3057 {
3058 #ifdef CONFIG_MAC80211_LEDS
3059         return __ieee80211_get_rx_led_name(hw);
3060 #else
3061         return NULL;
3062 #endif
3063 }
3064
3065 /**
3066  * ieee80211_get_assoc_led_name - get name of association LED
3067  *
3068  * mac80211 creates a association LED trigger for each wireless hardware
3069  * that can be used to drive LEDs if your driver registers a LED device.
3070  * This function returns the name (or %NULL if not configured for LEDs)
3071  * of the trigger so you can automatically link the LED device.
3072  *
3073  * @hw: the hardware to get the LED trigger name for
3074  *
3075  * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3076  */
3077 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3078 {
3079 #ifdef CONFIG_MAC80211_LEDS
3080         return __ieee80211_get_assoc_led_name(hw);
3081 #else
3082         return NULL;
3083 #endif
3084 }
3085
3086 /**
3087  * ieee80211_get_radio_led_name - get name of radio LED
3088  *
3089  * mac80211 creates a radio change LED trigger for each wireless hardware
3090  * that can be used to drive LEDs if your driver registers a LED device.
3091  * This function returns the name (or %NULL if not configured for LEDs)
3092  * of the trigger so you can automatically link the LED device.
3093  *
3094  * @hw: the hardware to get the LED trigger name for
3095  *
3096  * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3097  */
3098 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3099 {
3100 #ifdef CONFIG_MAC80211_LEDS
3101         return __ieee80211_get_radio_led_name(hw);
3102 #else
3103         return NULL;
3104 #endif
3105 }
3106
3107 /**
3108  * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3109  * @hw: the hardware to create the trigger for
3110  * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3111  * @blink_table: the blink table -- needs to be ordered by throughput
3112  * @blink_table_len: size of the blink table
3113  *
3114  * Return: %NULL (in case of error, or if no LED triggers are
3115  * configured) or the name of the new trigger.
3116  *
3117  * Note: This function must be called before ieee80211_register_hw().
3118  */
3119 static inline char *
3120 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3121                                  const struct ieee80211_tpt_blink *blink_table,
3122                                  unsigned int blink_table_len)
3123 {
3124 #ifdef CONFIG_MAC80211_LEDS
3125         return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3126                                                   blink_table_len);
3127 #else
3128         return NULL;
3129 #endif
3130 }
3131
3132 /**
3133  * ieee80211_unregister_hw - Unregister a hardware device
3134  *
3135  * This function instructs mac80211 to free allocated resources
3136  * and unregister netdevices from the networking subsystem.
3137  *
3138  * @hw: the hardware to unregister
3139  */
3140 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3141
3142 /**
3143  * ieee80211_free_hw - free hardware descriptor
3144  *
3145  * This function frees everything that was allocated, including the
3146  * private data for the driver. You must call ieee80211_unregister_hw()
3147  * before calling this function.
3148  *
3149  * @hw: the hardware to free
3150  */
3151 void ieee80211_free_hw(struct ieee80211_hw *hw);
3152
3153 /**
3154  * ieee80211_restart_hw - restart hardware completely
3155  *
3156  * Call this function when the hardware was restarted for some reason
3157  * (hardware error, ...) and the driver is unable to restore its state
3158  * by itself. mac80211 assumes that at this point the driver/hardware
3159  * is completely uninitialised and stopped, it starts the process by
3160  * calling the ->start() operation. The driver will need to reset all
3161  * internal state that it has prior to calling this function.
3162  *
3163  * @hw: the hardware to restart
3164  */
3165 void ieee80211_restart_hw(struct ieee80211_hw *hw);
3166
3167 /** ieee80211_napi_schedule - schedule NAPI poll
3168  *
3169  * Use this function to schedule NAPI polling on a device.
3170  *
3171  * @hw: the hardware to start polling
3172  */
3173 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
3174
3175 /** ieee80211_napi_complete - complete NAPI polling
3176  *
3177  * Use this function to finish NAPI polling on a device.
3178  *
3179  * @hw: the hardware to stop polling
3180  */
3181 void ieee80211_napi_complete(struct ieee80211_hw *hw);
3182
3183 /**
3184  * ieee80211_rx - receive frame
3185  *
3186  * Use this function to hand received frames to mac80211. The receive
3187  * buffer in @skb must start with an IEEE 802.11 header. In case of a
3188  * paged @skb is used, the driver is recommended to put the ieee80211
3189  * header of the frame on the linear part of the @skb to avoid memory
3190  * allocation and/or memcpy by the stack.
3191  *
3192  * This function may not be called in IRQ context. Calls to this function
3193  * for a single hardware must be synchronized against each other. Calls to
3194  * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3195  * mixed for a single hardware. Must not run concurrently with
3196  * ieee80211_tx_status() or ieee80211_tx_status_ni().
3197  *
3198  * In process context use instead ieee80211_rx_ni().
3199  *
3200  * @hw: the hardware this frame came in on
3201  * @skb: the buffer to receive, owned by mac80211 after this call
3202  */
3203 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
3204
3205 /**
3206  * ieee80211_rx_irqsafe - receive frame
3207  *
3208  * Like ieee80211_rx() but can be called in IRQ context
3209  * (internally defers to a tasklet.)
3210  *
3211  * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3212  * be mixed for a single hardware.Must not run concurrently with
3213  * ieee80211_tx_status() or ieee80211_tx_status_ni().
3214  *
3215  * @hw: the hardware this frame came in on
3216  * @skb: the buffer to receive, owned by mac80211 after this call
3217  */
3218 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3219
3220 /**
3221  * ieee80211_rx_ni - receive frame (in process context)
3222  *
3223  * Like ieee80211_rx() but can be called in process context
3224  * (internally disables bottom halves).
3225  *
3226  * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3227  * not be mixed for a single hardware. Must not run concurrently with
3228  * ieee80211_tx_status() or ieee80211_tx_status_ni().
3229  *
3230  * @hw: the hardware this frame came in on
3231  * @skb: the buffer to receive, owned by mac80211 after this call
3232  */
3233 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3234                                    struct sk_buff *skb)
3235 {
3236         local_bh_disable();
3237         ieee80211_rx(hw, skb);
3238         local_bh_enable();
3239 }
3240
3241 /**
3242  * ieee80211_sta_ps_transition - PS transition for connected sta
3243  *
3244  * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3245  * flag set, use this function to inform mac80211 about a connected station
3246  * entering/leaving PS mode.
3247  *
3248  * This function may not be called in IRQ context or with softirqs enabled.
3249  *
3250  * Calls to this function for a single hardware must be synchronized against
3251  * each other.
3252  *
3253  * @sta: currently connected sta
3254  * @start: start or stop PS
3255  *
3256  * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3257  */
3258 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3259
3260 /**
3261  * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3262  *                                  (in process context)
3263  *
3264  * Like ieee80211_sta_ps_transition() but can be called in process context
3265  * (internally disables bottom halves). Concurrent call restriction still
3266  * applies.
3267  *
3268  * @sta: currently connected sta
3269  * @start: start or stop PS
3270  *
3271  * Return: Like ieee80211_sta_ps_transition().
3272  */
3273 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3274                                                   bool start)
3275 {
3276         int ret;
3277
3278         local_bh_disable();
3279         ret = ieee80211_sta_ps_transition(sta, start);
3280         local_bh_enable();
3281
3282         return ret;
3283 }
3284
3285 /*
3286  * The TX headroom reserved by mac80211 for its own tx_status functions.
3287  * This is enough for the radiotap header.
3288  */
3289 #define IEEE80211_TX_STATUS_HEADROOM    14
3290
3291 /**
3292  * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3293  * @sta: &struct ieee80211_sta pointer for the sleeping station
3294  * @tid: the TID that has buffered frames
3295  * @buffered: indicates whether or not frames are buffered for this TID
3296  *
3297  * If a driver buffers frames for a powersave station instead of passing
3298  * them back to mac80211 for retransmission, the station may still need
3299  * to be told that there are buffered frames via the TIM bit.
3300  *
3301  * This function informs mac80211 whether or not there are frames that are
3302  * buffered in the driver for a given TID; mac80211 can then use this data
3303  * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3304  * call! Beware of the locking!)
3305  *
3306  * If all frames are released to the station (due to PS-poll or uAPSD)
3307  * then the driver needs to inform mac80211 that there no longer are
3308  * frames buffered. However, when the station wakes up mac80211 assumes
3309  * that all buffered frames will be transmitted and clears this data,
3310  * drivers need to make sure they inform mac80211 about all buffered
3311  * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3312  *
3313  * Note that technically mac80211 only needs to know this per AC, not per
3314  * TID, but since driver buffering will inevitably happen per TID (since
3315  * it is related to aggregation) it is easier to make mac80211 map the
3316  * TID to the AC as required instead of keeping track in all drivers that
3317  * use this API.
3318  */
3319 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3320                                 u8 tid, bool buffered);
3321
3322 /**
3323  * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3324  *
3325  * Call this function in a driver with per-packet rate selection support
3326  * to combine the rate info in the packet tx info with the most recent
3327  * rate selection table for the station entry.
3328  *
3329  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3330  * @sta: the receiver station to which this packet is sent.
3331  * @skb: the frame to be transmitted.
3332  * @dest: buffer for extracted rate/retry information
3333  * @max_rates: maximum number of rates to fetch
3334  */
3335 void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
3336                             struct ieee80211_sta *sta,
3337                             struct sk_buff *skb,
3338                             struct ieee80211_tx_rate *dest,
3339                             int max_rates);
3340
3341 /**
3342  * ieee80211_tx_status - transmit status callback
3343  *
3344  * Call this function for all transmitted frames after they have been
3345  * transmitted. It is permissible to not call this function for
3346  * multicast frames but this can affect statistics.
3347  *
3348  * This function may not be called in IRQ context. Calls to this function
3349  * for a single hardware must be synchronized against each other. Calls
3350  * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
3351  * may not be mixed for a single hardware. Must not run concurrently with
3352  * ieee80211_rx() or ieee80211_rx_ni().
3353  *
3354  * @hw: the hardware the frame was transmitted by
3355  * @skb: the frame that was transmitted, owned by mac80211 after this call
3356  */
3357 void ieee80211_tx_status(struct ieee80211_hw *hw,
3358                          struct sk_buff *skb);
3359
3360 /**
3361  * ieee80211_tx_status_ni - transmit status callback (in process context)
3362  *
3363  * Like ieee80211_tx_status() but can be called in process context.
3364  *
3365  * Calls to this function, ieee80211_tx_status() and
3366  * ieee80211_tx_status_irqsafe() may not be mixed
3367  * for a single hardware.
3368  *
3369  * @hw: the hardware the frame was transmitted by
3370  * @skb: the frame that was transmitted, owned by mac80211 after this call
3371  */
3372 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
3373                                           struct sk_buff *skb)
3374 {
3375         local_bh_disable();
3376         ieee80211_tx_status(hw, skb);
3377         local_bh_enable();
3378 }
3379
3380 /**
3381  * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
3382  *
3383  * Like ieee80211_tx_status() but can be called in IRQ context
3384  * (internally defers to a tasklet.)
3385  *
3386  * Calls to this function, ieee80211_tx_status() and
3387  * ieee80211_tx_status_ni() may not be mixed for a single hardware.
3388  *
3389  * @hw: the hardware the frame was transmitted by
3390  * @skb: the frame that was transmitted, owned by mac80211 after this call
3391  */
3392 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
3393                                  struct sk_buff *skb);
3394
3395 /**
3396  * ieee80211_report_low_ack - report non-responding station
3397  *
3398  * When operating in AP-mode, call this function to report a non-responding
3399  * connected STA.
3400  *
3401  * @sta: the non-responding connected sta
3402  * @num_packets: number of packets sent to @sta without a response
3403  */
3404 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
3405
3406 /**
3407  * ieee80211_beacon_get_tim - beacon generation function
3408  * @hw: pointer obtained from ieee80211_alloc_hw().
3409  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3410  * @tim_offset: pointer to variable that will receive the TIM IE offset.
3411  *      Set to 0 if invalid (in non-AP modes).
3412  * @tim_length: pointer to variable that will receive the TIM IE length,
3413  *      (including the ID and length bytes!).
3414  *      Set to 0 if invalid (in non-AP modes).
3415  *
3416  * If the driver implements beaconing modes, it must use this function to
3417  * obtain the beacon frame/template.
3418  *
3419  * If the beacon frames are generated by the host system (i.e., not in
3420  * hardware/firmware), the driver uses this function to get each beacon
3421  * frame from mac80211 -- it is responsible for calling this function
3422  * before the beacon is needed (e.g. based on hardware interrupt).
3423  *
3424  * If the beacon frames are generated by the device, then the driver
3425  * must use the returned beacon as the template and change the TIM IE
3426  * according to the current DTIM parameters/TIM bitmap.
3427  *
3428  * The driver is responsible for freeing the returned skb.
3429  *
3430  * Return: The beacon template. %NULL on error.
3431  */
3432 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
3433                                          struct ieee80211_vif *vif,
3434                                          u16 *tim_offset, u16 *tim_length);
3435
3436 /**
3437  * ieee80211_beacon_get - beacon generation function
3438  * @hw: pointer obtained from ieee80211_alloc_hw().
3439  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3440  *
3441  * See ieee80211_beacon_get_tim().
3442  *
3443  * Return: See ieee80211_beacon_get_tim().
3444  */
3445 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
3446                                                    struct ieee80211_vif *vif)
3447 {
3448         return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
3449 }
3450
3451 /**
3452  * ieee80211_csa_finish - notify mac80211 about channel switch
3453  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3454  *
3455  * After a channel switch announcement was scheduled and the counter in this
3456  * announcement hits 1, this function must be called by the driver to
3457  * notify mac80211 that the channel can be changed.
3458  */
3459 void ieee80211_csa_finish(struct ieee80211_vif *vif);
3460
3461 /**
3462  * ieee80211_csa_is_complete - find out if counters reached 1
3463  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3464  *
3465  * This function returns whether the channel switch counters reached zero.
3466  */
3467 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
3468
3469
3470 /**
3471  * ieee80211_proberesp_get - retrieve a Probe Response template
3472  * @hw: pointer obtained from ieee80211_alloc_hw().
3473  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3474  *
3475  * Creates a Probe Response template which can, for example, be uploaded to
3476  * hardware. The destination address should be set by the caller.
3477  *
3478  * Can only be called in AP mode.
3479  *
3480  * Return: The Probe Response template. %NULL on error.
3481  */
3482 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
3483                                         struct ieee80211_vif *vif);
3484
3485 /**
3486  * ieee80211_pspoll_get - retrieve a PS Poll template
3487  * @hw: pointer obtained from ieee80211_alloc_hw().
3488  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3489  *
3490  * Creates a PS Poll a template which can, for example, uploaded to
3491  * hardware. The template must be updated after association so that correct
3492  * AID, BSSID and MAC address is used.
3493  *
3494  * Note: Caller (or hardware) is responsible for setting the
3495  * &IEEE80211_FCTL_PM bit.
3496  *
3497  * Return: The PS Poll template. %NULL on error.
3498  */
3499 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
3500                                      struct ieee80211_vif *vif);
3501
3502 /**
3503  * ieee80211_nullfunc_get - retrieve a nullfunc template
3504  * @hw: pointer obtained from ieee80211_alloc_hw().
3505  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3506  *
3507  * Creates a Nullfunc template which can, for example, uploaded to
3508  * hardware. The template must be updated after association so that correct
3509  * BSSID and address is used.
3510  *
3511  * Note: Caller (or hardware) is responsible for setting the
3512  * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
3513  *
3514  * Return: The nullfunc template. %NULL on error.
3515  */
3516 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
3517                                        struct ieee80211_vif *vif);
3518
3519 /**
3520  * ieee80211_probereq_get - retrieve a Probe Request template
3521  * @hw: pointer obtained from ieee80211_alloc_hw().
3522  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3523  * @ssid: SSID buffer
3524  * @ssid_len: length of SSID
3525  * @tailroom: tailroom to reserve at end of SKB for IEs
3526  *
3527  * Creates a Probe Request template which can, for example, be uploaded to
3528  * hardware.
3529  *
3530  * Return: The Probe Request template. %NULL on error.
3531  */
3532 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
3533                                        struct ieee80211_vif *vif,
3534                                        const u8 *ssid, size_t ssid_len,
3535                                        size_t tailroom);
3536
3537 /**
3538  * ieee80211_rts_get - RTS frame generation function
3539  * @hw: pointer obtained from ieee80211_alloc_hw().
3540  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3541  * @frame: pointer to the frame that is going to be protected by the RTS.
3542  * @frame_len: the frame length (in octets).
3543  * @frame_txctl: &struct ieee80211_tx_info of the frame.
3544  * @rts: The buffer where to store the RTS frame.
3545  *
3546  * If the RTS frames are generated by the host system (i.e., not in
3547  * hardware/firmware), the low-level driver uses this function to receive
3548  * the next RTS frame from the 802.11 code. The low-level is responsible
3549  * for calling this function before and RTS frame is needed.
3550  */
3551 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3552                        const void *frame, size_t frame_len,
3553                        const struct ieee80211_tx_info *frame_txctl,
3554                        struct ieee80211_rts *rts);
3555
3556 /**
3557  * ieee80211_rts_duration - Get the duration field for an RTS frame
3558  * @hw: pointer obtained from ieee80211_alloc_hw().
3559  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3560  * @frame_len: the length of the frame that is going to be protected by the RTS.
3561  * @frame_txctl: &struct ieee80211_tx_info of the frame.
3562  *
3563  * If the RTS is generated in firmware, but the host system must provide
3564  * the duration field, the low-level driver uses this function to receive
3565  * the duration field value in little-endian byteorder.
3566  *
3567  * Return: The duration.
3568  */
3569 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
3570                               struct ieee80211_vif *vif, size_t frame_len,
3571                               const struct ieee80211_tx_info *frame_txctl);
3572
3573 /**
3574  * ieee80211_ctstoself_get - CTS-to-self frame generation function
3575  * @hw: pointer obtained from ieee80211_alloc_hw().
3576  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3577  * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
3578  * @frame_len: the frame length (in octets).
3579  * @frame_txctl: &struct ieee80211_tx_info of the frame.
3580  * @cts: The buffer where to store the CTS-to-self frame.
3581  *
3582  * If the CTS-to-self frames are generated by the host system (i.e., not in
3583  * hardware/firmware), the low-level driver uses this function to receive
3584  * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
3585  * for calling this function before and CTS-to-self frame is needed.
3586  */
3587 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
3588                              struct ieee80211_vif *vif,
3589                              const void *frame, size_t frame_len,
3590                              const struct ieee80211_tx_info *frame_txctl,
3591                              struct ieee80211_cts *cts);
3592
3593 /**
3594  * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
3595  * @hw: pointer obtained from ieee80211_alloc_hw().
3596  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3597  * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
3598  * @frame_txctl: &struct ieee80211_tx_info of the frame.
3599  *
3600  * If the CTS-to-self is generated in firmware, but the host system must provide
3601  * the duration field, the low-level driver uses this function to receive
3602  * the duration field value in little-endian byteorder.
3603  *
3604  * Return: The duration.
3605  */
3606 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
3607                                     struct ieee80211_vif *vif,
3608                                     size_t frame_len,
3609                                     const struct ieee80211_tx_info *frame_txctl);
3610
3611 /**
3612  * ieee80211_generic_frame_duration - Calculate the duration field for a frame
3613  * @hw: pointer obtained from ieee80211_alloc_hw().
3614  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3615  * @band: the band to calculate the frame duration on
3616  * @frame_len: the length of the frame.
3617  * @rate: the rate at which the frame is going to be transmitted.
3618  *
3619  * Calculate the duration field of some generic frame, given its
3620  * length and transmission rate (in 100kbps).
3621  *
3622  * Return: The duration.
3623  */
3624 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
3625                                         struct ieee80211_vif *vif,
3626                                         enum ieee80211_band band,
3627                                         size_t frame_len,
3628                                         struct ieee80211_rate *rate);
3629
3630 /**
3631  * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
3632  * @hw: pointer as obtained from ieee80211_alloc_hw().
3633  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3634  *
3635  * Function for accessing buffered broadcast and multicast frames. If
3636  * hardware/firmware does not implement buffering of broadcast/multicast
3637  * frames when power saving is used, 802.11 code buffers them in the host
3638  * memory. The low-level driver uses this function to fetch next buffered
3639  * frame. In most cases, this is used when generating beacon frame.
3640  *
3641  * Return: A pointer to the next buffered skb or NULL if no more buffered
3642  * frames are available.
3643  *
3644  * Note: buffered frames are returned only after DTIM beacon frame was
3645  * generated with ieee80211_beacon_get() and the low-level driver must thus
3646  * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
3647  * NULL if the previous generated beacon was not DTIM, so the low-level driver
3648  * does not need to check for DTIM beacons separately and should be able to
3649  * use common code for all beacons.
3650  */
3651 struct sk_buff *
3652 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3653
3654 /**
3655  * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
3656  *
3657  * This function returns the TKIP phase 1 key for the given IV32.
3658  *
3659  * @keyconf: the parameter passed with the set key
3660  * @iv32: IV32 to get the P1K for
3661  * @p1k: a buffer to which the key will be written, as 5 u16 values
3662  */
3663 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
3664                                u32 iv32, u16 *p1k);
3665
3666 /**
3667  * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
3668  *
3669  * This function returns the TKIP phase 1 key for the IV32 taken
3670  * from the given packet.
3671  *
3672  * @keyconf: the parameter passed with the set key
3673  * @skb: the packet to take the IV32 value from that will be encrypted
3674  *      with this P1K
3675  * @p1k: a buffer to which the key will be written, as 5 u16 values
3676  */
3677 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
3678                                           struct sk_buff *skb, u16 *p1k)
3679 {
3680         struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
3681         const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
3682         u32 iv32 = get_unaligned_le32(&data[4]);
3683
3684         ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
3685 }
3686
3687 /**
3688  * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
3689  *
3690  * This function returns the TKIP phase 1 key for the given IV32
3691  * and transmitter address.
3692  *
3693  * @keyconf: the parameter passed with the set key
3694  * @ta: TA that will be used with the key
3695  * @iv32: IV32 to get the P1K for
3696  * @p1k: a buffer to which the key will be written, as 5 u16 values
3697  */
3698 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
3699                                const u8 *ta, u32 iv32, u16 *p1k);
3700
3701 /**
3702  * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
3703  *
3704  * This function computes the TKIP RC4 key for the IV values
3705  * in the packet.
3706  *
3707  * @keyconf: the parameter passed with the set key
3708  * @skb: the packet to take the IV32/IV16 values from that will be
3709  *      encrypted with this key
3710  * @p2k: a buffer to which the key will be written, 16 bytes
3711  */
3712 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
3713                             struct sk_buff *skb, u8 *p2k);
3714
3715 /**
3716  * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys
3717  *
3718  * This function computes the two AES-CMAC sub-keys, based on the
3719  * previously installed master key.
3720  *
3721  * @keyconf: the parameter passed with the set key
3722  * @k1: a buffer to be filled with the 1st sub-key
3723  * @k2: a buffer to be filled with the 2nd sub-key
3724  */
3725 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf,
3726                                         u8 *k1, u8 *k2);
3727
3728 /**
3729  * struct ieee80211_key_seq - key sequence counter
3730  *
3731  * @tkip: TKIP data, containing IV32 and IV16 in host byte order
3732  * @ccmp: PN data, most significant byte first (big endian,
3733  *      reverse order than in packet)
3734  * @aes_cmac: PN data, most significant byte first (big endian,
3735  *      reverse order than in packet)
3736  */
3737 struct ieee80211_key_seq {
3738         union {
3739                 struct {
3740                         u32 iv32;
3741                         u16 iv16;
3742                 } tkip;
3743                 struct {
3744                         u8 pn[6];
3745                 } ccmp;
3746                 struct {
3747                         u8 pn[6];
3748                 } aes_cmac;
3749         };
3750 };
3751
3752 /**
3753  * ieee80211_get_key_tx_seq - get key TX sequence counter
3754  *
3755  * @keyconf: the parameter passed with the set key
3756  * @seq: buffer to receive the sequence data
3757  *
3758  * This function allows a driver to retrieve the current TX IV/PN
3759  * for the given key. It must not be called if IV generation is
3760  * offloaded to the device.
3761  *
3762  * Note that this function may only be called when no TX processing
3763  * can be done concurrently, for example when queues are stopped
3764  * and the stop has been synchronized.
3765  */
3766 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
3767                               struct ieee80211_key_seq *seq);
3768
3769 /**
3770  * ieee80211_get_key_rx_seq - get key RX sequence counter
3771  *
3772  * @keyconf: the parameter passed with the set key
3773  * @tid: The TID, or -1 for the management frame value (CCMP only);
3774  *      the value on TID 0 is also used for non-QoS frames. For
3775  *      CMAC, only TID 0 is valid.
3776  * @seq: buffer to receive the sequence data
3777  *
3778  * This function allows a driver to retrieve the current RX IV/PNs
3779  * for the given key. It must not be called if IV checking is done
3780  * by the device and not by mac80211.
3781  *
3782  * Note that this function may only be called when no RX processing
3783  * can be done concurrently.
3784  */
3785 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
3786                               int tid, struct ieee80211_key_seq *seq);
3787
3788 /**
3789  * ieee80211_set_key_tx_seq - set key TX sequence counter
3790  *
3791  * @keyconf: the parameter passed with the set key
3792  * @seq: new sequence data
3793  *
3794  * This function allows a driver to set the current TX IV/PNs for the
3795  * given key. This is useful when resuming from WoWLAN sleep and the
3796  * device may have transmitted frames using the PTK, e.g. replies to
3797  * ARP requests.
3798  *
3799  * Note that this function may only be called when no TX processing
3800  * can be done concurrently.
3801  */
3802 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf,
3803                               struct ieee80211_key_seq *seq);
3804
3805 /**
3806  * ieee80211_set_key_rx_seq - set key RX sequence counter
3807  *
3808  * @keyconf: the parameter passed with the set key
3809  * @tid: The TID, or -1 for the management frame value (CCMP only);
3810  *      the value on TID 0 is also used for non-QoS frames. For
3811  *      CMAC, only TID 0 is valid.
3812  * @seq: new sequence data
3813  *
3814  * This function allows a driver to set the current RX IV/PNs for the
3815  * given key. This is useful when resuming from WoWLAN sleep and GTK
3816  * rekey may have been done while suspended. It should not be called
3817  * if IV checking is done by the device and not by mac80211.
3818  *
3819  * Note that this function may only be called when no RX processing
3820  * can be done concurrently.
3821  */
3822 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
3823                               int tid, struct ieee80211_key_seq *seq);
3824
3825 /**
3826  * ieee80211_remove_key - remove the given key
3827  * @keyconf: the parameter passed with the set key
3828  *
3829  * Remove the given key. If the key was uploaded to the hardware at the
3830  * time this function is called, it is not deleted in the hardware but
3831  * instead assumed to have been removed already.
3832  *
3833  * Note that due to locking considerations this function can (currently)
3834  * only be called during key iteration (ieee80211_iter_keys().)
3835  */
3836 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
3837
3838 /**
3839  * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
3840  * @vif: the virtual interface to add the key on
3841  * @keyconf: new key data
3842  *
3843  * When GTK rekeying was done while the system was suspended, (a) new
3844  * key(s) will be available. These will be needed by mac80211 for proper
3845  * RX processing, so this function allows setting them.
3846  *
3847  * The function returns the newly allocated key structure, which will
3848  * have similar contents to the passed key configuration but point to
3849  * mac80211-owned memory. In case of errors, the function returns an
3850  * ERR_PTR(), use IS_ERR() etc.
3851  *
3852  * Note that this function assumes the key isn't added to hardware
3853  * acceleration, so no TX will be done with the key. Since it's a GTK
3854  * on managed (station) networks, this is true anyway. If the driver
3855  * calls this function from the resume callback and subsequently uses
3856  * the return code 1 to reconfigure the device, this key will be part
3857  * of the reconfiguration.
3858  *
3859  * Note that the driver should also call ieee80211_set_key_rx_seq()
3860  * for the new key for each TID to set up sequence counters properly.
3861  *
3862  * IMPORTANT: If this replaces a key that is present in the hardware,
3863  * then it will attempt to remove it during this call. In many cases
3864  * this isn't what you want, so call ieee80211_remove_key() first for
3865  * the key that's being replaced.
3866  */
3867 struct ieee80211_key_conf *
3868 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
3869                         struct ieee80211_key_conf *keyconf);
3870
3871 /**
3872  * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
3873  * @vif: virtual interface the rekeying was done on
3874  * @bssid: The BSSID of the AP, for checking association
3875  * @replay_ctr: the new replay counter after GTK rekeying
3876  * @gfp: allocation flags
3877  */
3878 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
3879                                 const u8 *replay_ctr, gfp_t gfp);
3880
3881 /**
3882  * ieee80211_wake_queue - wake specific queue
3883  * @hw: pointer as obtained from ieee80211_alloc_hw().
3884  * @queue: queue number (counted from zero).
3885  *
3886  * Drivers should use this function instead of netif_wake_queue.
3887  */
3888 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
3889
3890 /**
3891  * ieee80211_stop_queue - stop specific queue
3892  * @hw: pointer as obtained from ieee80211_alloc_hw().
3893  * @queue: queue number (counted from zero).
3894  *
3895  * Drivers should use this function instead of netif_stop_queue.
3896  */
3897 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
3898
3899 /**
3900  * ieee80211_queue_stopped - test status of the queue
3901  * @hw: pointer as obtained from ieee80211_alloc_hw().
3902  * @queue: queue number (counted from zero).
3903  *
3904  * Drivers should use this function instead of netif_stop_queue.
3905  *
3906  * Return: %true if the queue is stopped. %false otherwise.
3907  */
3908
3909 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
3910
3911 /**
3912  * ieee80211_stop_queues - stop all queues
3913  * @hw: pointer as obtained from ieee80211_alloc_hw().
3914  *
3915  * Drivers should use this function instead of netif_stop_queue.
3916  */
3917 void ieee80211_stop_queues(struct ieee80211_hw *hw);
3918
3919 /**
3920  * ieee80211_wake_queues - wake all queues
3921  * @hw: pointer as obtained from ieee80211_alloc_hw().
3922  *
3923  * Drivers should use this function instead of netif_wake_queue.
3924  */
3925 void ieee80211_wake_queues(struct ieee80211_hw *hw);
3926
3927 /**
3928  * ieee80211_scan_completed - completed hardware scan
3929  *
3930  * When hardware scan offload is used (i.e. the hw_scan() callback is
3931  * assigned) this function needs to be called by the driver to notify
3932  * mac80211 that the scan finished. This function can be called from
3933  * any context, including hardirq context.
3934  *
3935  * @hw: the hardware that finished the scan
3936  * @aborted: set to true if scan was aborted
3937  */
3938 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3939
3940 /**
3941  * ieee80211_sched_scan_results - got results from scheduled scan
3942  *
3943  * When a scheduled scan is running, this function needs to be called by the
3944  * driver whenever there are new scan results available.
3945  *
3946  * @hw: the hardware that is performing scheduled scans
3947  */
3948 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3949
3950 /**
3951  * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3952  *
3953  * When a scheduled scan is running, this function can be called by
3954  * the driver if it needs to stop the scan to perform another task.
3955  * Usual scenarios are drivers that cannot continue the scheduled scan
3956  * while associating, for instance.
3957  *
3958  * @hw: the hardware that is performing scheduled scans
3959  */
3960 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3961
3962 /**
3963  * enum ieee80211_interface_iteration_flags - interface iteration flags
3964  * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
3965  *      been added to the driver; However, note that during hardware
3966  *      reconfiguration (after restart_hw) it will iterate over a new
3967  *      interface and over all the existing interfaces even if they
3968  *      haven't been re-added to the driver yet.
3969  * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
3970  *      interfaces, even if they haven't been re-added to the driver yet.
3971  */
3972 enum ieee80211_interface_iteration_flags {
3973         IEEE80211_IFACE_ITER_NORMAL     = 0,
3974         IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
3975 };
3976
3977 /**
3978  * ieee80211_iterate_active_interfaces - iterate active interfaces
3979  *
3980  * This function iterates over the interfaces associated with a given
3981  * hardware that are currently active and calls the callback for them.
3982  * This function allows the iterator function to sleep, when the iterator
3983  * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3984  * be used.
3985  * Does not iterate over a new interface during add_interface().
3986  *
3987  * @hw: the hardware struct of which the interfaces should be iterated over
3988  * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
3989  * @iterator: the iterator function to call
3990  * @data: first argument of the iterator function
3991  */
3992 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3993                                          u32 iter_flags,
3994                                          void (*iterator)(void *data, u8 *mac,
3995                                                 struct ieee80211_vif *vif),
3996                                          void *data);
3997
3998 /**
3999  * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4000  *
4001  * This function iterates over the interfaces associated with a given
4002  * hardware that are currently active and calls the callback for them.
4003  * This function requires the iterator callback function to be atomic,
4004  * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4005  * Does not iterate over a new interface during add_interface().
4006  *
4007  * @hw: the hardware struct of which the interfaces should be iterated over
4008  * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4009  * @iterator: the iterator function to call, cannot sleep
4010  * @data: first argument of the iterator function
4011  */
4012 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4013                                                 u32 iter_flags,
4014                                                 void (*iterator)(void *data,
4015                                                     u8 *mac,
4016                                                     struct ieee80211_vif *vif),
4017                                                 void *data);
4018
4019 /**
4020  * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4021  *
4022  * This function iterates over the interfaces associated with a given
4023  * hardware that are currently active and calls the callback for them.
4024  * This version can only be used while holding the RTNL.
4025  *
4026  * @hw: the hardware struct of which the interfaces should be iterated over
4027  * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4028  * @iterator: the iterator function to call, cannot sleep
4029  * @data: first argument of the iterator function
4030  */
4031 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4032                                               u32 iter_flags,
4033                                               void (*iterator)(void *data,
4034                                                 u8 *mac,
4035                                                 struct ieee80211_vif *vif),
4036                                               void *data);
4037
4038 /**
4039  * ieee80211_queue_work - add work onto the mac80211 workqueue
4040  *
4041  * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4042  * This helper ensures drivers are not queueing work when they should not be.
4043  *
4044  * @hw: the hardware struct for the interface we are adding work for
4045  * @work: the work we want to add onto the mac80211 workqueue
4046  */
4047 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4048
4049 /**
4050  * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4051  *
4052  * Drivers and mac80211 use this to queue delayed work onto the mac80211
4053  * workqueue.
4054  *
4055  * @hw: the hardware struct for the interface we are adding work for
4056  * @dwork: delayable work to queue onto the mac80211 workqueue
4057  * @delay: number of jiffies to wait before queueing
4058  */
4059 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4060                                   struct delayed_work *dwork,
4061                                   unsigned long delay);
4062
4063 /**
4064  * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4065  * @sta: the station for which to start a BA session
4066  * @tid: the TID to BA on.
4067  * @timeout: session timeout value (in TUs)
4068  *
4069  * Return: success if addBA request was sent, failure otherwise
4070  *
4071  * Although mac80211/low level driver/user space application can estimate
4072  * the need to start aggregation on a certain RA/TID, the session level
4073  * will be managed by the mac80211.
4074  */
4075 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4076                                   u16 timeout);
4077
4078 /**
4079  * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4080  * @vif: &struct ieee80211_vif pointer from the add_interface callback
4081  * @ra: receiver address of the BA session recipient.
4082  * @tid: the TID to BA on.
4083  *
4084  * This function must be called by low level driver once it has
4085  * finished with preparations for the BA session. It can be called
4086  * from any context.
4087  */
4088 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4089                                       u16 tid);
4090
4091 /**
4092  * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4093  * @sta: the station whose BA session to stop
4094  * @tid: the TID to stop BA.
4095  *
4096  * Return: negative error if the TID is invalid, or no aggregation active
4097  *
4098  * Although mac80211/low level driver/user space application can estimate
4099  * the need to stop aggregation on a certain RA/TID, the session level
4100  * will be managed by the mac80211.
4101  */
4102 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4103
4104 /**
4105  * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4106  * @vif: &struct ieee80211_vif pointer from the add_interface callback
4107  * @ra: receiver address of the BA session recipient.
4108  * @tid: the desired TID to BA on.
4109  *
4110  * This function must be called by low level driver once it has
4111  * finished with preparations for the BA session tear down. It
4112  * can be called from any context.
4113  */
4114 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4115                                      u16 tid);
4116
4117 /**
4118  * ieee80211_find_sta - find a station
4119  *
4120  * @vif: virtual interface to look for station on
4121  * @addr: station's address
4122  *
4123  * Return: The station, if found. %NULL otherwise.
4124  *
4125  * Note: This function must be called under RCU lock and the
4126  * resulting pointer is only valid under RCU lock as well.
4127  */
4128 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4129                                          const u8 *addr);
4130
4131 /**
4132  * ieee80211_find_sta_by_ifaddr - find a station on hardware
4133  *
4134  * @hw: pointer as obtained from ieee80211_alloc_hw()
4135  * @addr: remote station's address
4136  * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4137  *
4138  * Return: The station, if found. %NULL otherwise.
4139  *
4140  * Note: This function must be called under RCU lock and the
4141  * resulting pointer is only valid under RCU lock as well.
4142  *
4143  * NOTE: You may pass NULL for localaddr, but then you will just get
4144  *      the first STA that matches the remote address 'addr'.
4145  *      We can have multiple STA associated with multiple
4146  *      logical stations (e.g. consider a station connecting to another
4147  *      BSSID on the same AP hardware without disconnecting first).
4148  *      In this case, the result of this method with localaddr NULL
4149  *      is not reliable.
4150  *
4151  * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4152  */
4153 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4154                                                const u8 *addr,
4155                                                const u8 *localaddr);
4156
4157 /**
4158  * ieee80211_sta_block_awake - block station from waking up
4159  * @hw: the hardware
4160  * @pubsta: the station
4161  * @block: whether to block or unblock
4162  *
4163  * Some devices require that all frames that are on the queues
4164  * for a specific station that went to sleep are flushed before
4165  * a poll response or frames after the station woke up can be
4166  * delivered to that it. Note that such frames must be rejected
4167  * by the driver as filtered, with the appropriate status flag.
4168  *
4169  * This function allows implementing this mode in a race-free
4170  * manner.
4171  *
4172  * To do this, a driver must keep track of the number of frames
4173  * still enqueued for a specific station. If this number is not
4174  * zero when the station goes to sleep, the driver must call
4175  * this function to force mac80211 to consider the station to
4176  * be asleep regardless of the station's actual state. Once the
4177  * number of outstanding frames reaches zero, the driver must
4178  * call this function again to unblock the station. That will
4179  * cause mac80211 to be able to send ps-poll responses, and if
4180  * the station queried in the meantime then frames will also
4181  * be sent out as a result of this. Additionally, the driver
4182  * will be notified that the station woke up some time after
4183  * it is unblocked, regardless of whether the station actually
4184  * woke up while blocked or not.
4185  */
4186 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4187                                struct ieee80211_sta *pubsta, bool block);
4188
4189 /**
4190  * ieee80211_sta_eosp - notify mac80211 about end of SP
4191  * @pubsta: the station
4192  *
4193  * When a device transmits frames in a way that it can't tell
4194  * mac80211 in the TX status about the EOSP, it must clear the
4195  * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4196  * This applies for PS-Poll as well as uAPSD.
4197  *
4198  * Note that just like with _tx_status() and _rx() drivers must
4199  * not mix calls to irqsafe/non-irqsafe versions, this function
4200  * must not be mixed with those either. Use the all irqsafe, or
4201  * all non-irqsafe, don't mix!
4202  *
4203  * NB: the _irqsafe version of this function doesn't exist, no
4204  *     driver needs it right now. Don't call this function if
4205  *     you'd need the _irqsafe version, look at the git history
4206  *     and restore the _irqsafe version!
4207  */
4208 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4209
4210 /**
4211  * ieee80211_iter_keys - iterate keys programmed into the device
4212  * @hw: pointer obtained from ieee80211_alloc_hw()
4213  * @vif: virtual interface to iterate, may be %NULL for all
4214  * @iter: iterator function that will be called for each key
4215  * @iter_data: custom data to pass to the iterator function
4216  *
4217  * This function can be used to iterate all the keys known to
4218  * mac80211, even those that weren't previously programmed into
4219  * the device. This is intended for use in WoWLAN if the device
4220  * needs reprogramming of the keys during suspend. Note that due
4221  * to locking reasons, it is also only safe to call this at few
4222  * spots since it must hold the RTNL and be able to sleep.
4223  *
4224  * The order in which the keys are iterated matches the order
4225  * in which they were originally installed and handed to the
4226  * set_key callback.
4227  */
4228 void ieee80211_iter_keys(struct ieee80211_hw *hw,
4229                          struct ieee80211_vif *vif,
4230                          void (*iter)(struct ieee80211_hw *hw,
4231                                       struct ieee80211_vif *vif,
4232                                       struct ieee80211_sta *sta,
4233                                       struct ieee80211_key_conf *key,
4234                                       void *data),
4235                          void *iter_data);
4236
4237 /**
4238  * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
4239  * @hw: pointre obtained from ieee80211_alloc_hw().
4240  * @iter: iterator function
4241  * @iter_data: data passed to iterator function
4242  *
4243  * Iterate all active channel contexts. This function is atomic and
4244  * doesn't acquire any locks internally that might be held in other
4245  * places while calling into the driver.
4246  *
4247  * The iterator will not find a context that's being added (during
4248  * the driver callback to add it) but will find it while it's being
4249  * removed.
4250  *
4251  * Note that during hardware restart, all contexts that existed
4252  * before the restart are considered already present so will be
4253  * found while iterating, whether they've been re-added already
4254  * or not.
4255  */
4256 void ieee80211_iter_chan_contexts_atomic(
4257         struct ieee80211_hw *hw,
4258         void (*iter)(struct ieee80211_hw *hw,
4259                      struct ieee80211_chanctx_conf *chanctx_conf,
4260                      void *data),
4261         void *iter_data);
4262
4263 /**
4264  * ieee80211_ap_probereq_get - retrieve a Probe Request template
4265  * @hw: pointer obtained from ieee80211_alloc_hw().
4266  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4267  *
4268  * Creates a Probe Request template which can, for example, be uploaded to
4269  * hardware. The template is filled with bssid, ssid and supported rate
4270  * information. This function must only be called from within the
4271  * .bss_info_changed callback function and only in managed mode. The function
4272  * is only useful when the interface is associated, otherwise it will return
4273  * %NULL.
4274  *
4275  * Return: The Probe Request template. %NULL on error.
4276  */
4277 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
4278                                           struct ieee80211_vif *vif);
4279
4280 /**
4281  * ieee80211_beacon_loss - inform hardware does not receive beacons
4282  *
4283  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4284  *
4285  * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
4286  * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
4287  * hardware is not receiving beacons with this function.
4288  */
4289 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
4290
4291 /**
4292  * ieee80211_connection_loss - inform hardware has lost connection to the AP
4293  *
4294  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4295  *
4296  * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
4297  * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
4298  * needs to inform if the connection to the AP has been lost.
4299  * The function may also be called if the connection needs to be terminated
4300  * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
4301  *
4302  * This function will cause immediate change to disassociated state,
4303  * without connection recovery attempts.
4304  */
4305 void ieee80211_connection_loss(struct ieee80211_vif *vif);
4306
4307 /**
4308  * ieee80211_resume_disconnect - disconnect from AP after resume
4309  *
4310  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4311  *
4312  * Instructs mac80211 to disconnect from the AP after resume.
4313  * Drivers can use this after WoWLAN if they know that the
4314  * connection cannot be kept up, for example because keys were
4315  * used while the device was asleep but the replay counters or
4316  * similar cannot be retrieved from the device during resume.
4317  *
4318  * Note that due to implementation issues, if the driver uses
4319  * the reconfiguration functionality during resume the interface
4320  * will still be added as associated first during resume and then
4321  * disconnect normally later.
4322  *
4323  * This function can only be called from the resume callback and
4324  * the driver must not be holding any of its own locks while it
4325  * calls this function, or at least not any locks it needs in the
4326  * key configuration paths (if it supports HW crypto).
4327  */
4328 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
4329
4330 /**
4331  * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
4332  *      rssi threshold triggered
4333  *
4334  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4335  * @rssi_event: the RSSI trigger event type
4336  * @gfp: context flags
4337  *
4338  * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
4339  * monitoring is configured with an rssi threshold, the driver will inform
4340  * whenever the rssi level reaches the threshold.
4341  */
4342 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
4343                                enum nl80211_cqm_rssi_threshold_event rssi_event,
4344                                gfp_t gfp);
4345
4346 /**
4347  * ieee80211_radar_detected - inform that a radar was detected
4348  *
4349  * @hw: pointer as obtained from ieee80211_alloc_hw()
4350  */
4351 void ieee80211_radar_detected(struct ieee80211_hw *hw);
4352
4353 /**
4354  * ieee80211_chswitch_done - Complete channel switch process
4355  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4356  * @success: make the channel switch successful or not
4357  *
4358  * Complete the channel switch post-process: set the new operational channel
4359  * and wake up the suspended queues.
4360  */
4361 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
4362
4363 /**
4364  * ieee80211_request_smps - request SM PS transition
4365  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4366  * @smps_mode: new SM PS mode
4367  *
4368  * This allows the driver to request an SM PS transition in managed
4369  * mode. This is useful when the driver has more information than
4370  * the stack about possible interference, for example by bluetooth.
4371  */
4372 void ieee80211_request_smps(struct ieee80211_vif *vif,
4373                             enum ieee80211_smps_mode smps_mode);
4374
4375 /**
4376  * ieee80211_ready_on_channel - notification of remain-on-channel start
4377  * @hw: pointer as obtained from ieee80211_alloc_hw()
4378  */
4379 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
4380
4381 /**
4382  * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
4383  * @hw: pointer as obtained from ieee80211_alloc_hw()
4384  */
4385 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
4386
4387 /**
4388  * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
4389  *
4390  * in order not to harm the system performance and user experience, the device
4391  * may request not to allow any rx ba session and tear down existing rx ba
4392  * sessions based on system constraints such as periodic BT activity that needs
4393  * to limit wlan activity (eg.sco or a2dp)."
4394  * in such cases, the intention is to limit the duration of the rx ppdu and
4395  * therefore prevent the peer device to use a-mpdu aggregation.
4396  *
4397  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4398  * @ba_rx_bitmap: Bit map of open rx ba per tid
4399  * @addr: & to bssid mac address
4400  */
4401 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
4402                                   const u8 *addr);
4403
4404 /**
4405  * ieee80211_send_bar - send a BlockAckReq frame
4406  *
4407  * can be used to flush pending frames from the peer's aggregation reorder
4408  * buffer.
4409  *
4410  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4411  * @ra: the peer's destination address
4412  * @tid: the TID of the aggregation session
4413  * @ssn: the new starting sequence number for the receiver
4414  */
4415 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
4416
4417 /* Rate control API */
4418
4419 /**
4420  * struct ieee80211_tx_rate_control - rate control information for/from RC algo
4421  *
4422  * @hw: The hardware the algorithm is invoked for.
4423  * @sband: The band this frame is being transmitted on.
4424  * @bss_conf: the current BSS configuration
4425  * @skb: the skb that will be transmitted, the control information in it needs
4426  *      to be filled in
4427  * @reported_rate: The rate control algorithm can fill this in to indicate
4428  *      which rate should be reported to userspace as the current rate and
4429  *      used for rate calculations in the mesh network.
4430  * @rts: whether RTS will be used for this frame because it is longer than the
4431  *      RTS threshold
4432  * @short_preamble: whether mac80211 will request short-preamble transmission
4433  *      if the selected rate supports it
4434  * @max_rate_idx: user-requested maximum (legacy) rate
4435  *      (deprecated; this will be removed once drivers get updated to use
4436  *      rate_idx_mask)
4437  * @rate_idx_mask: user-requested (legacy) rate mask
4438  * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
4439  * @bss: whether this frame is sent out in AP or IBSS mode
4440  */
4441 struct ieee80211_tx_rate_control {
4442         struct ieee80211_hw *hw;
4443         struct ieee80211_supported_band *sband;
4444         struct ieee80211_bss_conf *bss_conf;
4445         struct sk_buff *skb;
4446         struct ieee80211_tx_rate reported_rate;
4447         bool rts, short_preamble;
4448         u8 max_rate_idx;
4449         u32 rate_idx_mask;
4450         u8 *rate_idx_mcs_mask;
4451         bool bss;
4452 };
4453
4454 struct rate_control_ops {
4455         const char *name;
4456         void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
4457         void (*free)(void *priv);
4458
4459         void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
4460         void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
4461                           struct cfg80211_chan_def *chandef,
4462                           struct ieee80211_sta *sta, void *priv_sta);
4463         void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
4464                             struct cfg80211_chan_def *chandef,
4465                             struct ieee80211_sta *sta, void *priv_sta,
4466                             u32 changed);
4467         void (*free_sta)(void *priv, struct ieee80211_sta *sta,
4468                          void *priv_sta);
4469
4470         void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
4471                           struct ieee80211_sta *sta, void *priv_sta,
4472                           struct sk_buff *skb);
4473         void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
4474                          struct ieee80211_tx_rate_control *txrc);
4475
4476         void (*add_sta_debugfs)(void *priv, void *priv_sta,
4477                                 struct dentry *dir);
4478         void (*remove_sta_debugfs)(void *priv, void *priv_sta);
4479 };
4480
4481 static inline int rate_supported(struct ieee80211_sta *sta,
4482                                  enum ieee80211_band band,
4483                                  int index)
4484 {
4485         return (sta == NULL || sta->supp_rates[band] & BIT(index));
4486 }
4487
4488 /**
4489  * rate_control_send_low - helper for drivers for management/no-ack frames
4490  *
4491  * Rate control algorithms that agree to use the lowest rate to
4492  * send management frames and NO_ACK data with the respective hw
4493  * retries should use this in the beginning of their mac80211 get_rate
4494  * callback. If true is returned the rate control can simply return.
4495  * If false is returned we guarantee that sta and sta and priv_sta is
4496  * not null.
4497  *
4498  * Rate control algorithms wishing to do more intelligent selection of
4499  * rate for multicast/broadcast frames may choose to not use this.
4500  *
4501  * @sta: &struct ieee80211_sta pointer to the target destination. Note
4502  *      that this may be null.
4503  * @priv_sta: private rate control structure. This may be null.
4504  * @txrc: rate control information we sholud populate for mac80211.
4505  */
4506 bool rate_control_send_low(struct ieee80211_sta *sta,
4507                            void *priv_sta,
4508                            struct ieee80211_tx_rate_control *txrc);
4509
4510
4511 static inline s8
4512 rate_lowest_index(struct ieee80211_supported_band *sband,
4513                   struct ieee80211_sta *sta)
4514 {
4515         int i;
4516
4517         for (i = 0; i < sband->n_bitrates; i++)
4518                 if (rate_supported(sta, sband->band, i))
4519                         return i;
4520
4521         /* warn when we cannot find a rate. */
4522         WARN_ON_ONCE(1);
4523
4524         /* and return 0 (the lowest index) */
4525         return 0;
4526 }
4527
4528 static inline
4529 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
4530                               struct ieee80211_sta *sta)
4531 {
4532         unsigned int i;
4533
4534         for (i = 0; i < sband->n_bitrates; i++)
4535                 if (rate_supported(sta, sband->band, i))
4536                         return true;
4537         return false;
4538 }
4539
4540 /**
4541  * rate_control_set_rates - pass the sta rate selection to mac80211/driver
4542  *
4543  * When not doing a rate control probe to test rates, rate control should pass
4544  * its rate selection to mac80211. If the driver supports receiving a station
4545  * rate table, it will use it to ensure that frames are always sent based on
4546  * the most recent rate control module decision.
4547  *
4548  * @hw: pointer as obtained from ieee80211_alloc_hw()
4549  * @pubsta: &struct ieee80211_sta pointer to the target destination.
4550  * @rates: new tx rate set to be used for this station.
4551  */
4552 int rate_control_set_rates(struct ieee80211_hw *hw,
4553                            struct ieee80211_sta *pubsta,
4554                            struct ieee80211_sta_rates *rates);
4555
4556 int ieee80211_rate_control_register(const struct rate_control_ops *ops);
4557 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
4558
4559 static inline bool
4560 conf_is_ht20(struct ieee80211_conf *conf)
4561 {
4562         return conf->chandef.width == NL80211_CHAN_WIDTH_20;
4563 }
4564
4565 static inline bool
4566 conf_is_ht40_minus(struct ieee80211_conf *conf)
4567 {
4568         return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4569                conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
4570 }
4571
4572 static inline bool
4573 conf_is_ht40_plus(struct ieee80211_conf *conf)
4574 {
4575         return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
4576                conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
4577 }
4578
4579 static inline bool
4580 conf_is_ht40(struct ieee80211_conf *conf)
4581 {
4582         return conf->chandef.width == NL80211_CHAN_WIDTH_40;
4583 }
4584
4585 static inline bool
4586 conf_is_ht(struct ieee80211_conf *conf)
4587 {
4588         return conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT;
4589 }
4590
4591 static inline enum nl80211_iftype
4592 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
4593 {
4594         if (p2p) {
4595                 switch (type) {
4596                 case NL80211_IFTYPE_STATION:
4597                         return NL80211_IFTYPE_P2P_CLIENT;
4598                 case NL80211_IFTYPE_AP:
4599                         return NL80211_IFTYPE_P2P_GO;
4600                 default:
4601                         break;
4602                 }
4603         }
4604         return type;
4605 }
4606
4607 static inline enum nl80211_iftype
4608 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
4609 {
4610         return ieee80211_iftype_p2p(vif->type, vif->p2p);
4611 }
4612
4613 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
4614                                    int rssi_min_thold,
4615                                    int rssi_max_thold);
4616
4617 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
4618
4619 /**
4620  * ieee80211_ave_rssi - report the average RSSI for the specified interface
4621  *
4622  * @vif: the specified virtual interface
4623  *
4624  * Note: This function assumes that the given vif is valid.
4625  *
4626  * Return: The average RSSI value for the requested interface, or 0 if not
4627  * applicable.
4628  */
4629 int ieee80211_ave_rssi(struct ieee80211_vif *vif);
4630
4631 /**
4632  * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
4633  * @vif: virtual interface
4634  * @wakeup: wakeup reason(s)
4635  * @gfp: allocation flags
4636  *
4637  * See cfg80211_report_wowlan_wakeup().
4638  */
4639 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
4640                                     struct cfg80211_wowlan_wakeup *wakeup,
4641                                     gfp_t gfp);
4642
4643 /**
4644  * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
4645  * @hw: pointer as obtained from ieee80211_alloc_hw()
4646  * @vif: virtual interface
4647  * @skb: frame to be sent from within the driver
4648  * @band: the band to transmit on
4649  * @sta: optional pointer to get the station to send the frame to
4650  *
4651  * Note: must be called under RCU lock
4652  */
4653 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
4654                               struct ieee80211_vif *vif, struct sk_buff *skb,
4655                               int band, struct ieee80211_sta **sta);
4656
4657 /**
4658  * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
4659  *
4660  * @next_tsf: TSF timestamp of the next absent state change
4661  * @has_next_tsf: next absent state change event pending
4662  *
4663  * @absent: descriptor bitmask, set if GO is currently absent
4664  *
4665  * private:
4666  *
4667  * @count: count fields from the NoA descriptors
4668  * @desc: adjusted data from the NoA
4669  */
4670 struct ieee80211_noa_data {
4671         u32 next_tsf;
4672         bool has_next_tsf;
4673
4674         u8 absent;
4675
4676         u8 count[IEEE80211_P2P_NOA_DESC_MAX];
4677         struct {
4678                 u32 start;
4679                 u32 duration;
4680                 u32 interval;
4681         } desc[IEEE80211_P2P_NOA_DESC_MAX];
4682 };
4683
4684 /**
4685  * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
4686  *
4687  * @attr: P2P NoA IE
4688  * @data: NoA tracking data
4689  * @tsf: current TSF timestamp
4690  *
4691  * Return: number of successfully parsed descriptors
4692  */
4693 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
4694                             struct ieee80211_noa_data *data, u32 tsf);
4695
4696 /**
4697  * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
4698  *
4699  * @data: NoA tracking data
4700  * @tsf: current TSF timestamp
4701  */
4702 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
4703
4704 #endif /* MAC80211_H */