blob: acf9eaf596410423f6da2e1ca3a5f042d60a647b [file] [log] [blame]
Jiri Bencf0706e82007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e82007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Jouni Malinen026331c2010-02-15 12:53:10 +02006 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e82007-05-05 11:45:53 -07007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/kernel.h>
17#include <linux/if_ether.h>
18#include <linux/skbuff.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070019#include <linux/device.h>
20#include <linux/ieee80211.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070021#include <net/cfg80211.h>
Johannes Berg42d98792011-07-07 18:58:01 +020022#include <asm/unaligned.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070023
Johannes Berg75a5f0c2007-09-18 17:29:20 -040024/**
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
Jiri Bencf0706e82007-05-05 11:45:53 -070037 * 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
Johannes Berg2485f712008-02-25 16:27:41 +010040 * 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
Randy Dunlap6ef307b2008-07-03 13:52:18 -070044 * use the non-IRQ-safe functions!
Jiri Bencf0706e82007-05-05 11:45:53 -070045 */
46
Johannes Berg75a5f0c2007-09-18 17:29:20 -040047/**
48 * DOC: Warning
Jiri Bencf0706e82007-05-05 11:45:53 -070049 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040050 * 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
Jiri Bencf0706e82007-05-05 11:45:53 -070056 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040057 * 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.
Jiri Bencf0706e82007-05-05 11:45:53 -070073 */
74
Ron Rindjunsky10816d42007-11-26 16:14:30 +020075/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040076 * 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/**
Johannes Berge100bb62008-04-30 18:51:21 +020091 * enum ieee80211_max_queues - maximum number of queues
92 *
93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berge100bb62008-04-30 18:51:21 +020094 */
95enum ieee80211_max_queues {
Johannes Berg51b38142009-03-12 11:16:48 +010096 IEEE80211_MAX_QUEUES = 4,
Johannes Berge100bb62008-04-30 18:51:21 +020097};
98
99/**
Johannes Berg4bce22b2010-11-16 11:49:58 -0800100 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
101 * @IEEE80211_AC_VO: voice
102 * @IEEE80211_AC_VI: video
103 * @IEEE80211_AC_BE: best effort
104 * @IEEE80211_AC_BK: background
105 */
106enum ieee80211_ac_numbers {
107 IEEE80211_AC_VO = 0,
108 IEEE80211_AC_VI = 1,
109 IEEE80211_AC_BE = 2,
110 IEEE80211_AC_BK = 3,
111};
Johannes Berg948d8872011-09-29 16:04:29 +0200112#define IEEE80211_NUM_ACS 4
Johannes Berg4bce22b2010-11-16 11:49:58 -0800113
114/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400115 * struct ieee80211_tx_queue_params - transmit queue configuration
116 *
117 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100118 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400119 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400120 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200121 * @cw_min: minimum contention window [a value of the form
122 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400123 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100124 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Kalle Valo9d173fc2010-01-14 13:09:14 +0200125 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400126 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700127struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200128 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100129 u16 cw_min;
130 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200131 u8 aifs;
Kalle Valoab133152010-01-12 10:42:31 +0200132 bool uapsd;
Jiri Bencf0706e82007-05-05 11:45:53 -0700133};
134
Jiri Bencf0706e82007-05-05 11:45:53 -0700135struct ieee80211_low_level_stats {
136 unsigned int dot11ACKFailureCount;
137 unsigned int dot11RTSFailureCount;
138 unsigned int dot11FCSErrorCount;
139 unsigned int dot11RTSSuccessCount;
140};
141
Johannes Berg471b3ef2007-12-28 14:32:58 +0100142/**
143 * enum ieee80211_bss_change - BSS change notification flags
144 *
145 * These flags are used with the bss_info_changed() callback
146 * to indicate which BSS parameter changed.
147 *
148 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
149 * also implies a change in the AID.
150 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
151 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300152 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700153 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200154 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200155 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200156 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
157 * reason (IBSS and managed mode)
158 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
159 * new beacon (beaconing modes)
160 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
161 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200162 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200163 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300164 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200165 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
166 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200167 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Arik Nemtsov78274932011-09-04 11:11:32 +0300168 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
Johannes Berg471b3ef2007-12-28 14:32:58 +0100169 */
170enum ieee80211_bss_change {
171 BSS_CHANGED_ASSOC = 1<<0,
172 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
173 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300174 BSS_CHANGED_ERP_SLOT = 1<<3,
Alexander Simona7ce1c92011-09-18 00:16:45 +0200175 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200176 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200177 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200178 BSS_CHANGED_BSSID = 1<<7,
179 BSS_CHANGED_BEACON = 1<<8,
180 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200181 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200182 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300183 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200184 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200185 BSS_CHANGED_IDLE = 1<<14,
Arik Nemtsov78274932011-09-04 11:11:32 +0300186 BSS_CHANGED_SSID = 1<<15,
Johannes Bergac8dd502010-05-05 09:44:02 +0200187
188 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100189};
190
Juuso Oikarinen68542962010-06-09 13:43:26 +0300191/*
192 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
193 * of addresses for an interface increase beyond this value, hardware ARP
194 * filtering will be disabled.
195 */
196#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
197
Johannes Berg471b3ef2007-12-28 14:32:58 +0100198/**
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -0700199 * enum ieee80211_rssi_event - RSSI threshold event
200 * An indicator for when RSSI goes below/above a certain threshold.
201 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
202 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
203 */
204enum ieee80211_rssi_event {
205 RSSI_EVENT_HIGH,
206 RSSI_EVENT_LOW,
207};
208
209/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100210 * struct ieee80211_bss_conf - holds the BSS's changing parameters
211 *
212 * This structure keeps information about a BSS (and an association
213 * to that BSS) that can change during the lifetime of the BSS.
214 *
215 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200216 * @ibss_joined: indicates whether this station is part of an IBSS
217 * or not
Johannes Berg471b3ef2007-12-28 14:32:58 +0100218 * @aid: association ID number, valid only when @assoc is true
219 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200220 * @use_short_preamble: use 802.11b short preamble;
221 * if the hardware cannot handle this it must set the
222 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
223 * @use_short_slot: use short slot time (only relevant for ERP);
224 * if the hardware cannot handle this it must set the
225 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100226 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Johannes Berge5b900d2010-07-29 16:08:55 +0200227 * valid in station mode only while @assoc is true and if also
228 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
229 * @ps_dtim_period)
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700230 * @timestamp: beacon timestamp
231 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800232 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200233 * @basic_rates: bitmap of basic rates, each bit stands for an
234 * index into the rate table configured by the driver in
235 * the current band.
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100236 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200237 * @bssid: The BSSID for this BSS
238 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg0aaffa92010-05-05 15:28:27 +0200239 * @channel_type: Channel type for this BSS -- the hardware might be
240 * configured for HT40+ while this BSS only uses no-HT, for
241 * example.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200242 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
243 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200244 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
245 * implies disabled
246 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300247 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
248 * may filter ARP queries targeted for other addresses than listed here.
249 * The driver must allow ARP queries targeted for all address listed here
250 * to pass through. An empty list implies no ARP queries need to pass.
251 * @arp_addr_cnt: Number of addresses currently on the list.
252 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
253 * filter ARP queries based on the @arp_addr_list, if disabled, the
254 * hardware must not perform any ARP filtering. Note, that the filter will
255 * be enabled also in promiscuous mode.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200256 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200257 * @idle: This interface is idle. There's also a global idle flag in the
258 * hardware config which may be more appropriate depending on what
259 * your driver/device needs to do.
Arik Nemtsov78274932011-09-04 11:11:32 +0300260 * @ssid: The SSID of the current vif. Only valid in AP-mode.
261 * @ssid_len: Length of SSID given in @ssid.
262 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100263 */
264struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200265 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100266 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200267 bool assoc, ibss_joined;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100268 u16 aid;
269 /* erp related data */
270 bool use_cts_prot;
271 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300272 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200273 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800274 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700275 u16 beacon_int;
276 u16 assoc_capability;
277 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100278 u32 basic_rates;
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100279 int mcast_rate[IEEE80211_NUM_BANDS];
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200280 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200281 s32 cqm_rssi_thold;
282 u32 cqm_rssi_hyst;
Johannes Berg0aaffa92010-05-05 15:28:27 +0200283 enum nl80211_channel_type channel_type;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300284 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
285 u8 arp_addr_cnt;
286 bool arp_filter_enabled;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200287 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200288 bool idle;
Arik Nemtsov78274932011-09-04 11:11:32 +0300289 u8 ssid[IEEE80211_MAX_SSID_LEN];
290 size_t ssid_len;
291 bool hidden_ssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100292};
293
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800294/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700295 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800296 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700297 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800298 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100299 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200300 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
301 * number to this frame, taking care of not overwriting the fragment
302 * number and increasing the sequence number only when the
303 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
304 * assign sequence numbers to QoS-data frames but cannot do so correctly
305 * for non-QoS-data and management frames because beacons need them from
306 * that counter as well and mac80211 cannot guarantee proper sequencing.
307 * If this flag is set, the driver should instruct the hardware to
308 * assign a sequence number to the frame or assign one itself. Cf. IEEE
309 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
310 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200311 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200312 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
313 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200314 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200315 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
316 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200317 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200318 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200319 * because the destination STA was in powersave mode. Note that to
320 * avoid race conditions, the filter must be set by the hardware or
321 * firmware upon receiving a frame that indicates that the station
322 * went to sleep (must be done on device to filter frames already on
323 * the queue) and may only be unset after mac80211 gives the OK for
324 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
325 * since only then is it guaranteed that no more frames are in the
326 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200327 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
328 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
329 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300330 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
331 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200332 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
333 * set by rate control algorithms to indicate probe rate, will
334 * be cleared for fragmented frames (except on the last fragment)
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100335 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
336 * used to indicate that a pending frame requires TX processing before
337 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200338 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
339 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200340 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
341 * used to indicate frame should not be encrypted
Johannes Berg3fa52052009-07-24 13:23:09 +0200342 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
343 * This frame is a response to a PS-poll frame and should be sent
344 * although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200345 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
346 * transmit function after the current frame, this can be used
347 * by drivers to kick the DMA queue only if unset or when the
348 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100349 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
350 * after TX status because the destination was asleep, it must not
351 * be modified again (no seqno assignment, crypto, etc.)
Felix Fietkau17ad3532010-01-31 21:56:25 +0100352 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
353 * has a radiotap header at skb->data.
Jouni Malinen026331c2010-02-15 12:53:10 +0200354 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
355 * MLME command (internal to mac80211 to figure out whether to send TX
356 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400357 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200358 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
359 * frame and selects the maximum number of streams that it can use.
Johannes Berg610dbc92011-01-06 22:36:44 +0100360 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
361 * the off-channel channel when a remain-on-channel offload is done
362 * in hardware -- normal packets still flow and are expected to be
363 * handled properly by the device.
Jouni Malinen681d1192011-02-03 18:35:19 +0200364 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
365 * testing. It will be sent out with incorrect Michael MIC key to allow
366 * TKIP countermeasures to be tested.
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530367 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
368 * This flag is actually used for management frame especially for P2P
369 * frames not being sent at CCK rate in 2GHz band.
Christian Lampartereb7d3062010-09-21 21:36:18 +0200370 *
371 * Note: If you have to add new flags to the enumeration, then don't
372 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800373 */
374enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200375 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200376 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
377 IEEE80211_TX_CTL_NO_ACK = BIT(2),
378 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
379 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
380 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
381 IEEE80211_TX_CTL_AMPDU = BIT(6),
382 IEEE80211_TX_CTL_INJECTED = BIT(7),
383 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
384 IEEE80211_TX_STAT_ACK = BIT(9),
385 IEEE80211_TX_STAT_AMPDU = BIT(10),
386 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
387 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100388 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200389 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200390 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200391 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200392 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100393 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Felix Fietkau17ad3532010-01-31 21:56:25 +0100394 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200395 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400396 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200397 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100398 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Jouni Malinen681d1192011-02-03 18:35:19 +0200399 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
Rajkumar Manoharanaad14ce2011-09-25 14:53:31 +0530400 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
Johannes Berge6a98542008-10-21 12:40:02 +0200401};
402
Johannes Bergabe37c42010-06-07 11:12:27 +0200403#define IEEE80211_TX_CTL_STBC_SHIFT 23
404
Christian Lampartereb7d3062010-09-21 21:36:18 +0200405/*
406 * This definition is used as a mask to clear all temporary flags, which are
407 * set by the tx handlers for each transmission attempt by the mac80211 stack.
408 */
409#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
410 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
411 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
412 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
413 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
414 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
415 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
416 IEEE80211_TX_CTL_STBC)
417
Sujith2134e7e2009-01-22 09:00:52 +0530418/**
419 * enum mac80211_rate_control_flags - per-rate flags set by the
420 * Rate Control algorithm.
421 *
422 * These flags are set by the Rate control algorithm for each rate during tx,
423 * in the @flags member of struct ieee80211_tx_rate.
424 *
425 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
426 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
427 * This is set if the current BSS requires ERP protection.
428 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
429 * @IEEE80211_TX_RC_MCS: HT rate.
430 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
431 * Greenfield mode.
432 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
433 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
434 * adjacent 20 MHz channels, if the current channel type is
435 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
436 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
437 */
Johannes Berge6a98542008-10-21 12:40:02 +0200438enum mac80211_rate_control_flags {
439 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
440 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
441 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
442
443 /* rate index is an MCS rate number instead of an index */
444 IEEE80211_TX_RC_MCS = BIT(3),
445 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
446 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
447 IEEE80211_TX_RC_DUP_DATA = BIT(6),
448 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800449};
450
Johannes Berge039fa42008-05-15 12:55:29 +0200451
Johannes Berge6a98542008-10-21 12:40:02 +0200452/* there are 40 bytes if you don't need the rateset to be kept */
453#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200454
Johannes Berge6a98542008-10-21 12:40:02 +0200455/* if you do need the rateset, then you have less space */
456#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
457
458/* maximum number of rate stages */
459#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200460
461/**
Johannes Berge6a98542008-10-21 12:40:02 +0200462 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200463 *
Johannes Berge6a98542008-10-21 12:40:02 +0200464 * @idx: rate index to attempt to send with
465 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200466 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200467 *
468 * A value of -1 for @idx indicates an invalid rate and, if used
469 * in an array of retry rates, that no more rates should be tried.
470 *
471 * When used for transmit status reporting, the driver should
472 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200473 *
474 * &struct ieee80211_tx_info contains an array of these structs
475 * in the control information, and it will be filled by the rate
476 * control algorithm according to what should be sent. For example,
477 * if this array contains, in the format { <idx>, <count> } the
478 * information
479 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
480 * then this means that the frame should be transmitted
481 * up to twice at rate 3, up to twice at rate 2, and up to four
482 * times at rate 1 if it doesn't get acknowledged. Say it gets
483 * acknowledged by the peer after the fifth attempt, the status
484 * information should then contain
485 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
486 * since it was transmitted twice at rate 3, twice at rate 2
487 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200488 */
Johannes Berge6a98542008-10-21 12:40:02 +0200489struct ieee80211_tx_rate {
490 s8 idx;
491 u8 count;
492 u8 flags;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000493} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200494
Johannes Berge039fa42008-05-15 12:55:29 +0200495/**
496 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200497 *
Johannes Berge039fa42008-05-15 12:55:29 +0200498 * This structure is placed in skb->cb for three uses:
499 * (1) mac80211 TX control - mac80211 tells the driver what to do
500 * (2) driver internal use (if applicable)
501 * (3) TX status information - driver tells mac80211 what happened
502 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200503 * The TX control's sta pointer is only valid during the ->tx call,
504 * it may be NULL.
505 *
Johannes Berge039fa42008-05-15 12:55:29 +0200506 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200507 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200508 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200509 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700510 * @control: union for control data
511 * @status: union for status data
512 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100513 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700514 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100515 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700516 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200517 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200518 */
Johannes Berge039fa42008-05-15 12:55:29 +0200519struct ieee80211_tx_info {
520 /* common information */
521 u32 flags;
522 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200523
Johannes Berge039fa42008-05-15 12:55:29 +0200524 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100525
Johannes Berge6a98542008-10-21 12:40:02 +0200526 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500527 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100528
Johannes Berge039fa42008-05-15 12:55:29 +0200529 union {
530 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200531 union {
532 /* rate control */
533 struct {
534 struct ieee80211_tx_rate rates[
535 IEEE80211_TX_MAX_RATES];
536 s8 rts_cts_rate_idx;
537 };
538 /* only needed before rate control */
539 unsigned long jiffies;
540 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200541 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200542 struct ieee80211_vif *vif;
543 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200544 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200545 } control;
546 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200547 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
548 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200549 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100550 u8 ampdu_len;
Johannes Berg095dfdb2010-05-26 17:19:25 +0200551 /* 15 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200552 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200553 struct {
554 struct ieee80211_tx_rate driver_rates[
555 IEEE80211_TX_MAX_RATES];
556 void *rate_driver_data[
557 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
558 };
559 void *driver_data[
560 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200561 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700562};
563
Luciano Coelho79f460c2011-05-11 17:09:36 +0300564/**
Randy Dunlapbdfbe802011-05-22 17:22:45 -0700565 * struct ieee80211_sched_scan_ies - scheduled scan IEs
Luciano Coelho79f460c2011-05-11 17:09:36 +0300566 *
567 * This structure is used to pass the appropriate IEs to be used in scheduled
568 * scans for all bands. It contains both the IEs passed from the userspace
569 * and the ones generated by mac80211.
570 *
571 * @ie: array with the IEs for each supported band
572 * @len: array with the total length of the IEs for each band
573 */
574struct ieee80211_sched_scan_ies {
575 u8 *ie[IEEE80211_NUM_BANDS];
576 size_t len[IEEE80211_NUM_BANDS];
577};
578
Johannes Berge039fa42008-05-15 12:55:29 +0200579static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
580{
581 return (struct ieee80211_tx_info *)skb->cb;
582}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400583
Johannes Bergf1d58c22009-06-17 13:13:00 +0200584static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
585{
586 return (struct ieee80211_rx_status *)skb->cb;
587}
588
Johannes Berge6a98542008-10-21 12:40:02 +0200589/**
590 * ieee80211_tx_info_clear_status - clear TX status
591 *
592 * @info: The &struct ieee80211_tx_info to be cleared.
593 *
594 * When the driver passes an skb back to mac80211, it must report
595 * a number of things in TX status. This function clears everything
596 * in the TX status but the rate control information (it does clear
597 * the count since you need to fill that in anyway).
598 *
599 * NOTE: You can only use this function if you do NOT use
600 * info->driver_data! Use info->rate_driver_data
601 * instead if you need only the less space that allows.
602 */
603static inline void
604ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
605{
606 int i;
607
608 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
609 offsetof(struct ieee80211_tx_info, control.rates));
610 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
611 offsetof(struct ieee80211_tx_info, driver_rates));
612 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
613 /* clear the rate counts */
614 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
615 info->status.rates[i].count = 0;
616
617 BUILD_BUG_ON(
618 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
619 memset(&info->status.ampdu_ack_len, 0,
620 sizeof(struct ieee80211_tx_info) -
621 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
622}
623
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400624
625/**
626 * enum mac80211_rx_flags - receive flags
627 *
628 * These flags are used with the @flag member of &struct ieee80211_rx_status.
629 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
630 * Use together with %RX_FLAG_MMIC_STRIPPED.
631 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400632 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
633 * verification has been done by the hardware.
634 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
635 * If this flag is set, the stack cannot do any replay detection
636 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400637 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
638 * the frame.
639 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
640 * the frame.
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100641 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
642 * field) is valid and contains the time the first symbol of the MPDU
643 * was received. This is useful in monitor mode and for proper IBSS
644 * merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200645 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200646 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
647 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
648 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400649 */
650enum mac80211_rx_flags {
651 RX_FLAG_MMIC_ERROR = 1<<0,
652 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400653 RX_FLAG_MMIC_STRIPPED = 1<<3,
654 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400655 RX_FLAG_FAILED_FCS_CRC = 1<<5,
656 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Berg6ebacbb2011-02-23 15:06:08 +0100657 RX_FLAG_MACTIME_MPDU = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200658 RX_FLAG_SHORTPRE = 1<<8,
659 RX_FLAG_HT = 1<<9,
660 RX_FLAG_40MHZ = 1<<10,
661 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400662};
663
664/**
665 * struct ieee80211_rx_status - receive status
666 *
667 * The low-level driver should provide this information (the subset
668 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200669 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200670 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900671 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
672 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100673 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400674 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200675 * @signal: signal strength when receiving this frame, either in dBm, in dB or
676 * unspecified depending on the hardware capabilities flags
677 * @IEEE80211_HW_SIGNAL_*
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400678 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200679 * @rate_idx: index of data rate into band's supported rates or MCS index if
680 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400681 * @flag: %RX_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200682 * @rx_flags: internal RX flags for mac80211
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400683 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700684struct ieee80211_rx_status {
685 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100686 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400687 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400688 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700689 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100690 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700691 int flag;
Johannes Berg554891e2010-09-24 12:38:25 +0200692 unsigned int rx_flags;
Jiri Bencf0706e82007-05-05 11:45:53 -0700693};
694
Johannes Berg6b301cd2007-09-18 17:29:20 -0400695/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400696 * enum ieee80211_conf_flags - configuration flags
697 *
698 * Flags to define PHY configuration options
699 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100700 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
701 * to determine for example whether to calculate timestamps for packets
702 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200703 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
704 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
705 * meaning that the hardware still wakes up for beacons, is able to
706 * transmit frames and receive the possible acknowledgment frames.
707 * Not to be confused with hardware specific wakeup/sleep states,
708 * driver is responsible for that. See the section "Powersave support"
709 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200710 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
711 * the driver should be prepared to handle configuration requests but
712 * may turn the device off as much as possible. Typically, this flag will
713 * be set when an interface is set UP but not associated or scanning, but
714 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +0200715 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
716 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400717 */
718enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100719 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200720 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200721 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +0200722 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400723};
Jiri Bencf0706e82007-05-05 11:45:53 -0700724
Johannes Berg7a5158e2008-10-08 10:59:33 +0200725
Jiri Bencf0706e82007-05-05 11:45:53 -0700726/**
Johannes Berge8975582008-10-09 12:18:51 +0200727 * enum ieee80211_conf_changed - denotes which configuration changed
728 *
Johannes Berge8975582008-10-09 12:18:51 +0200729 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100730 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200731 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200732 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100733 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200734 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200735 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100736 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berge8975582008-10-09 12:18:51 +0200737 */
738enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100739 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200740 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100741 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200742 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200743 IEEE80211_CONF_CHANGE_POWER = BIT(5),
744 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
745 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200746 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200747};
748
749/**
Johannes Berg0f782312009-12-01 13:37:02 +0100750 * enum ieee80211_smps_mode - spatial multiplexing power save mode
751 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200752 * @IEEE80211_SMPS_AUTOMATIC: automatic
753 * @IEEE80211_SMPS_OFF: off
754 * @IEEE80211_SMPS_STATIC: static
755 * @IEEE80211_SMPS_DYNAMIC: dynamic
756 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100757 */
758enum ieee80211_smps_mode {
759 IEEE80211_SMPS_AUTOMATIC,
760 IEEE80211_SMPS_OFF,
761 IEEE80211_SMPS_STATIC,
762 IEEE80211_SMPS_DYNAMIC,
763
764 /* keep last */
765 IEEE80211_SMPS_NUM_MODES,
766};
767
768/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700769 * struct ieee80211_conf - configuration of the device
770 *
771 * This struct indicates how the driver shall configure the hardware.
772 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200773 * @flags: configuration flags defined above
774 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800775 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200776 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200777 * before checking the beacon for a TIM bit (managed mode only); this
778 * value will be only achievable between DTIM frames, the hardware
779 * needs to check for the multicast traffic bit in DTIM beacons.
780 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100781 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
782 * in power saving. Power saving will not be enabled until a beacon
783 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200784 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
785 * powersave documentation below. This variable is valid only when
786 * the CONF_PS flag is set.
787 *
Johannes Berg8318d782008-01-24 19:38:38 +0100788 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200789 *
Johannes Berg8318d782008-01-24 19:38:38 +0100790 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100791 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200792 *
Johannes Berg9124b072008-10-14 19:17:54 +0200793 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
794 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
795 * but actually means the number of transmissions not the number of retries
796 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
797 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
798 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100799 *
800 * @smps_mode: spatial multiplexing powersave mode; note that
801 * %IEEE80211_SMPS_STATIC is used when the device is not
802 * configured for an HT channel
Jiri Bencf0706e82007-05-05 11:45:53 -0700803 */
804struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400805 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +0300806 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200807 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200808
Johannes Berge8975582008-10-09 12:18:51 +0200809 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +0100810 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +0200811
Johannes Berg9124b072008-10-14 19:17:54 +0200812 u8 long_frame_max_tx_count, short_frame_max_tx_count;
813
Johannes Berg8318d782008-01-24 19:38:38 +0100814 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100815 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100816 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -0700817};
818
819/**
Johannes Berg5ce6e432010-05-11 16:20:57 +0200820 * struct ieee80211_channel_switch - holds the channel switch data
821 *
822 * The information provided in this structure is required for channel switch
823 * operation.
824 *
825 * @timestamp: value in microseconds of the 64-bit Time Synchronization
826 * Function (TSF) timer when the frame containing the channel switch
827 * announcement was received. This is simply the rx.mactime parameter
828 * the driver passed into mac80211.
829 * @block_tx: Indicates whether transmission must be blocked before the
830 * scheduled channel switch, as indicated by the AP.
831 * @channel: the new channel to switch to
832 * @count: the number of TBTT's until the channel switch event
833 */
834struct ieee80211_channel_switch {
835 u64 timestamp;
836 bool block_tx;
837 struct ieee80211_channel *channel;
838 u8 count;
839};
840
841/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100842 * struct ieee80211_vif - per-interface data
843 *
844 * Data in this structure is continually present for driver
845 * use during the life of a virtual interface.
846 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100847 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200848 * @bss_conf: BSS configuration for this interface, either our own
849 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100850 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200851 * @p2p: indicates whether this AP or STA interface is a p2p
852 * interface, i.e. a GO or p2p-sta respectively
Johannes Berg32bfd352007-12-19 01:31:26 +0100853 * @drv_priv: data area for driver use, will always be aligned to
854 * sizeof(void *).
855 */
856struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200857 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200858 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100859 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200860 bool p2p;
Johannes Berg32bfd352007-12-19 01:31:26 +0100861 /* must be last */
862 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
863};
864
Johannes Berg902acc72008-02-23 15:17:19 +0100865static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
866{
867#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200868 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100869#endif
870 return false;
871}
872
Johannes Berg32bfd352007-12-19 01:31:26 +0100873/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400874 * enum ieee80211_key_flags - key flags
875 *
876 * These flags are used for communication about keys between the driver
877 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
878 *
879 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
880 * that the STA this key will be used with could be using QoS.
881 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
882 * driver to indicate that it requires IV generation for this
883 * particular key.
884 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
885 * the driver for a TKIP key if it requires Michael MIC
886 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200887 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
888 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200889 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
890 * CCMP key if it requires CCMP encryption of management frames (MFP) to
891 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400892 */
893enum ieee80211_key_flags {
894 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
895 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
896 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200897 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200898 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400899};
900
901/**
902 * struct ieee80211_key_conf - key information
903 *
904 * This key information is given by mac80211 to the driver by
905 * the set_key() callback in &struct ieee80211_ops.
906 *
907 * @hw_key_idx: To be set by the driver, this is the key index the driver
908 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400909 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +0200910 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400911 * @flags: key flags, see &enum ieee80211_key_flags.
912 * @keyidx: the key index (0-3)
913 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400914 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
915 * data block:
916 * - Temporal Encryption Key (128 bits)
917 * - Temporal Authenticator Tx MIC Key (64 bits)
918 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100919 * @icv_len: The ICV length for this key type
920 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400921 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700922struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +0200923 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +0200924 u8 icv_len;
925 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400926 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400927 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400928 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400929 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700930 u8 key[0];
931};
932
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400933/**
934 * enum set_key_cmd - key command
935 *
936 * Used with the set_key() callback in &struct ieee80211_ops, this
937 * indicates whether a key is being removed or added.
938 *
939 * @SET_KEY: a key is set
940 * @DISABLE_KEY: a key must be disabled
941 */
Johannes Bergea49c352007-09-18 17:29:21 -0400942enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400943 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400944};
Jiri Bencf0706e82007-05-05 11:45:53 -0700945
Tomas Winkler478f8d22007-09-30 13:52:37 +0200946/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200947 * struct ieee80211_sta - station table entry
948 *
949 * A station table entry represents a station we are possibly
950 * communicating with. Since stations are RCU-managed in
951 * mac80211, any ieee80211_sta pointer you get access to must
952 * either be protected by rcu_read_lock() explicitly or implicitly,
953 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +0100954 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +0200955 *
956 * @addr: MAC address
957 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200958 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200959 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Arik Nemtsov39df6002011-06-27 23:58:45 +0300960 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
Johannes Berg17741cd2008-09-11 00:02:02 +0200961 * @drv_priv: data area for driver use, will always be aligned to
962 * sizeof(void *), size is determined in hw information.
Eliad Peller910868d2011-09-11 09:46:55 +0300963 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
964 * if wme is supported.
965 * @max_sp: max Service Period. Only valid if wme is supported.
Johannes Berg17741cd2008-09-11 00:02:02 +0200966 */
967struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100968 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200969 u8 addr[ETH_ALEN];
970 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200971 struct ieee80211_sta_ht_cap ht_cap;
Arik Nemtsov39df6002011-06-27 23:58:45 +0300972 bool wme;
Eliad Peller9533b4a2011-08-23 14:37:47 +0300973 u8 uapsd_queues;
974 u8 max_sp;
Johannes Berg17741cd2008-09-11 00:02:02 +0200975
976 /* must be last */
977 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
978};
979
980/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200981 * enum sta_notify_cmd - sta notify command
982 *
983 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +0530984 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200985 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100986 * @STA_NOTIFY_SLEEP: a station is now sleeping
987 * @STA_NOTIFY_AWAKE: a sleeping station woke up
988 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100989enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100990 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
991};
992
993/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400994 * enum ieee80211_hw_flags - hardware flags
995 *
996 * These flags are used to indicate hardware capabilities to
997 * the stack. Generally, flags here should have their meaning
998 * done in a way that the simplest hardware doesn't need setting
999 * any particular flags. There are some exceptions to this rule,
1000 * however, so you are advised to review these flags carefully.
1001 *
Johannes Bergaf65cd962009-11-17 18:18:36 +01001002 * @IEEE80211_HW_HAS_RATE_CONTROL:
1003 * The hardware or firmware includes rate control, and cannot be
1004 * controlled by the stack. As such, no rate control algorithm
1005 * should be instantiated, and the TX rate reported to userspace
1006 * will be taken from the TX status instead of the rate control
1007 * algorithm.
1008 * Note that this requires that the driver implement a number of
1009 * callbacks so it has the correct information, it needs to have
1010 * the @set_rts_threshold callback and must look at the BSS config
1011 * @use_cts_prot for G/N protection, @use_short_slot for slot
1012 * timing in 2.4 GHz and @use_short_preamble for preambles for
1013 * CCK frames.
1014 *
Johannes Berg1bc08262007-09-18 17:29:15 -04001015 * @IEEE80211_HW_RX_INCLUDES_FCS:
1016 * Indicates that received frames passed to the stack include
1017 * the FCS at the end.
1018 *
1019 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1020 * Some wireless LAN chipsets buffer broadcast/multicast frames
1021 * for power saving stations in the hardware/firmware and others
1022 * rely on the host system for such buffering. This option is used
1023 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1024 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001025 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -04001026 *
Johannes Berg8318d782008-01-24 19:38:38 +01001027 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1028 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1029 *
1030 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1031 * Hardware is not capable of receiving frames with short preamble on
1032 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +02001033 *
1034 * @IEEE80211_HW_SIGNAL_UNSPEC:
1035 * Hardware can provide signal values but we don't know its units. We
1036 * expect values between 0 and @max_signal.
1037 * If possible please provide dB or dBm instead.
1038 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001039 * @IEEE80211_HW_SIGNAL_DBM:
1040 * Hardware gives signal values in dBm, decibel difference from
1041 * one milliwatt. This is the preferred method since it is standardized
1042 * between different devices. @max_signal does not need to be set.
1043 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03001044 * @IEEE80211_HW_SPECTRUM_MGMT:
1045 * Hardware supports spectrum management defined in 802.11h
1046 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05301047 *
1048 * @IEEE80211_HW_AMPDU_AGGREGATION:
1049 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02001050 *
Johannes Berg4be8c382009-01-07 18:28:20 +01001051 * @IEEE80211_HW_SUPPORTS_PS:
1052 * Hardware has power save support (i.e. can go to sleep).
1053 *
1054 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1055 * Hardware requires nullfunc frame handling in stack, implies
1056 * stack support for dynamic PS.
1057 *
1058 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1059 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001060 *
1061 * @IEEE80211_HW_MFP_CAPABLE:
1062 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001063 *
1064 * @IEEE80211_HW_BEACON_FILTER:
1065 * Hardware supports dropping of irrelevant beacon frames to
1066 * avoid waking up cpu.
Johannes Berg0f782312009-12-01 13:37:02 +01001067 *
1068 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1069 * Hardware supports static spatial multiplexing powersave,
1070 * ie. can turn off all but one chain even on HT connections
1071 * that should be using more chains.
1072 *
1073 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1074 * Hardware supports dynamic spatial multiplexing powersave,
1075 * ie. can turn off all but one chain and then wake the rest
1076 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001077 *
1078 * @IEEE80211_HW_SUPPORTS_UAPSD:
1079 * Hardware supports Unscheduled Automatic Power Save Delivery
1080 * (U-APSD) in managed mode. The mode is configured with
1081 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301082 *
1083 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1084 * Hardware can provide ack status reports of Tx frames to
1085 * the stack.
1086 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001087 * @IEEE80211_HW_CONNECTION_MONITOR:
1088 * The hardware performs its own connection monitoring, including
1089 * periodic keep-alives to the AP and probing the AP on beacon loss.
1090 * When this flag is set, signaling beacon-loss will cause an immediate
1091 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001092 *
1093 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1094 * Hardware can do connection quality monitoring - i.e. it can monitor
1095 * connection quality related parameters, such as the RSSI level and
1096 * provide notifications if configured trigger levels are reached.
1097 *
Johannes Berge5b900d2010-07-29 16:08:55 +02001098 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1099 * This device needs to know the DTIM period for the BSS before
1100 * associating.
Johannes Berge31b8212010-10-05 19:39:30 +02001101 *
1102 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1103 * per-station GTKs as used by IBSS RSN or during fast transition. If
1104 * the device doesn't support per-station GTKs, but can be asked not
1105 * to decrypt group addressed frames, then IBSS RSN support is still
1106 * possible but software crypto will be used. Advertise the wiphy flag
1107 * only in that case.
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001108 *
1109 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1110 * autonomously manages the PS status of connected stations. When
1111 * this flag is set mac80211 will not trigger PS mode for connected
1112 * stations based on the PM bit of incoming frames.
1113 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1114 * the PS mode of connected stations.
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001115 *
1116 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1117 * setup strictly in HW. mac80211 should not attempt to do this in
1118 * software.
Johannes Berg1bc08262007-09-18 17:29:15 -04001119 */
1120enum ieee80211_hw_flags {
Johannes Bergaf65cd962009-11-17 18:18:36 +01001121 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001122 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1123 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001124 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1125 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001126 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001127 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Johannes Berge5b900d2010-07-29 16:08:55 +02001128 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001129 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1130 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1131 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1132 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1133 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1134 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +02001135 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001136 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1137 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001138 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301139 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001140 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001141 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
Johannes Berge31b8212010-10-05 19:39:30 +02001142 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001143 IEEE80211_HW_AP_LINK_PS = 1<<22,
Arik Nemtsovedf6b782011-08-30 09:32:38 +03001144 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23,
Johannes Berg1bc08262007-09-18 17:29:15 -04001145};
1146
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001147/**
1148 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001149 *
1150 * This structure contains the configuration and hardware
1151 * information for an 802.11 PHY.
1152 *
1153 * @wiphy: This points to the &struct wiphy allocated for this
1154 * 802.11 PHY. You must fill in the @perm_addr and @dev
1155 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001156 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1157 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001158 *
1159 * @conf: &struct ieee80211_conf, device configuration, don't use.
1160 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001161 * @priv: pointer to private area that was allocated for driver use
1162 * along with this structure.
1163 *
1164 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1165 *
1166 * @extra_tx_headroom: headroom to reserve in each transmit skb
1167 * for use by the driver (e.g. for transmit headers.)
1168 *
1169 * @channel_change_time: time (in microseconds) it takes to change channels.
1170 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001171 * @max_signal: Maximum value for signal (rssi) in RX information, used
1172 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001173 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001174 * @max_listen_interval: max listen interval in units of beacon interval
1175 * that HW supports
1176 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001177 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001178 * data packets. WMM/QoS requires at least four, these
1179 * queues need to have configurable access parameters.
1180 *
Johannes Berg830f9032007-10-28 14:51:05 +01001181 * @rate_control_algorithm: rate control algorithm for this hardware.
1182 * If unset (NULL), the default algorithm will be used. Must be
1183 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001184 *
1185 * @vif_data_size: size (in bytes) of the drv_priv data area
1186 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001187 * @sta_data_size: size (in bytes) of the drv_priv data area
1188 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001189 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001190 * @max_rates: maximum number of alternate rate retry stages the hw
1191 * can handle.
1192 * @max_report_rates: maximum number of alternate rate retry stages
1193 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001194 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001195 *
1196 * @napi_weight: weight used for NAPI polling. You must specify an
1197 * appropriate value here if a napi_poll operation is provided
1198 * by your driver.
Randy Dunlap858022a2011-03-18 09:33:02 -07001199 *
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001200 * @max_rx_aggregation_subframes: maximum buffer size (number of
1201 * sub-frames) to be used for A-MPDU block ack receiver
1202 * aggregation.
1203 * This is only relevant if the device has restrictions on the
1204 * number of subframes, if it relies on mac80211 to do reordering
1205 * it shouldn't be set.
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001206 *
1207 * @max_tx_aggregation_subframes: maximum number of subframes in an
1208 * aggregate an HT driver will transmit, used by the peer as a
1209 * hint to size its reorder buffer.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001210 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001211struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07001212 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001213 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001214 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07001215 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001216 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -07001217 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -07001218 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001219 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001220 int sta_data_size;
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001221 int napi_weight;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001222 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001223 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07001224 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001225 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001226 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001227 u8 max_rate_tries;
Luciano Coelhodf6ba5d2011-01-12 15:26:30 +02001228 u8 max_rx_aggregation_subframes;
Johannes Berg5dd36bc2011-01-18 13:52:23 +01001229 u8 max_tx_aggregation_subframes;
Jiri Bencf0706e82007-05-05 11:45:53 -07001230};
1231
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001232/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001233 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1234 *
1235 * @wiphy: the &struct wiphy which we want to query
1236 *
1237 * mac80211 drivers can use this to get to their respective
1238 * &struct ieee80211_hw. Drivers wishing to get to their own private
1239 * structure can then access it via hw->priv. Note that mac802111 drivers should
1240 * not use wiphy_priv() to try to get their private driver structure as this
1241 * is already used internally by mac80211.
1242 */
1243struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1244
1245/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001246 * SET_IEEE80211_DEV - set device for 802.11 hardware
1247 *
1248 * @hw: the &struct ieee80211_hw to set the device for
1249 * @dev: the &struct device of this 802.11 device
1250 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001251static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1252{
1253 set_wiphy_dev(hw->wiphy, dev);
1254}
1255
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001256/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001257 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001258 *
1259 * @hw: the &struct ieee80211_hw to set the MAC address for
1260 * @addr: the address to set
1261 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001262static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1263{
1264 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1265}
1266
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001267static inline struct ieee80211_rate *
1268ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001269 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001270{
Johannes Berge6a98542008-10-21 12:40:02 +02001271 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001272 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001273 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001274}
1275
1276static inline struct ieee80211_rate *
1277ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001278 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001279{
Johannes Berge039fa42008-05-15 12:55:29 +02001280 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001281 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001282 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001283}
1284
1285static inline struct ieee80211_rate *
1286ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001287 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001288{
Johannes Berge6a98542008-10-21 12:40:02 +02001289 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001290 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001291 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001292}
1293
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001294/**
1295 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001296 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001297 * mac80211 is capable of taking advantage of many hardware
1298 * acceleration designs for encryption and decryption operations.
1299 *
1300 * The set_key() callback in the &struct ieee80211_ops for a given
1301 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001302 * decryption. The callback takes a @sta parameter that will be NULL
1303 * for default keys or keys used for transmission only, or point to
1304 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001305 * Multiple transmission keys with the same key index may be used when
1306 * VLANs are configured for an access point.
1307 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001308 * When transmitting, the TX control data will use the @hw_key_idx
1309 * selected by the driver by modifying the &struct ieee80211_key_conf
1310 * pointed to by the @key parameter to the set_key() function.
1311 *
1312 * The set_key() call for the %SET_KEY command should return 0 if
1313 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1314 * added; if you return 0 then hw_key_idx must be assigned to the
1315 * hardware key index, you are free to use the full u8 range.
1316 *
1317 * When the cmd is %DISABLE_KEY then it must succeed.
1318 *
1319 * Note that it is permissible to not decrypt a frame even if a key
1320 * for it has been uploaded to hardware, the stack will not make any
1321 * decision based on whether a key has been uploaded or not but rather
1322 * based on the receive flags.
1323 *
1324 * The &struct ieee80211_key_conf structure pointed to by the @key
1325 * parameter is guaranteed to be valid until another call to set_key()
1326 * removes it, but it can only be used as a cookie to differentiate
1327 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001328 *
1329 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1330 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1331 * handler.
1332 * The update_tkip_key() call updates the driver with the new phase 1 key.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001333 * This happens every time the iv16 wraps around (every 65536 packets). The
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001334 * set_key() call will happen only once for each key (unless the AP did
1335 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001336 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001337 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001338 */
Johannes Berg4150c572007-09-17 01:29:23 -04001339
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001340/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001341 * DOC: Powersave support
1342 *
1343 * mac80211 has support for various powersave implementations.
1344 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001345 * First, it can support hardware that handles all powersaving by itself,
1346 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1347 * flag. In that case, it will be told about the desired powersave mode
1348 * with the %IEEE80211_CONF_PS flag depending on the association status.
1349 * The hardware must take care of sending nullfunc frames when necessary,
1350 * i.e. when entering and leaving powersave mode. The hardware is required
1351 * to look at the AID in beacons and signal to the AP that it woke up when
1352 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001353 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001354 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1355 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1356 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001357 * up the hardware before issuing commands to the hardware and putting it
1358 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001359 *
1360 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1361 * buffered multicast/broadcast frames after the beacon. Also it must be
1362 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001363 *
1364 * Other hardware designs cannot send nullfunc frames by themselves and also
1365 * need software support for parsing the TIM bitmap. This is also supported
1366 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1367 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001368 * required to pass up beacons. The hardware is still required to handle
1369 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001370 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001371 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001372 * Dynamic powersave is an extension to normal powersave in which the
1373 * hardware stays awake for a user-specified period of time after sending a
1374 * frame so that reply frames need not be buffered and therefore delayed to
1375 * the next wakeup. It's compromise of getting good enough latency when
1376 * there's data traffic and still saving significantly power in idle
1377 * periods.
1378 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001379 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001380 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1381 * flag and mac80211 will handle everything automatically. Additionally,
1382 * hardware having support for the dynamic PS feature may set the
1383 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1384 * dynamic PS mode itself. The driver needs to look at the
1385 * @dynamic_ps_timeout hardware configuration value and use it that value
1386 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1387 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1388 * enabled whenever user has enabled powersave.
1389 *
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03001390 * Some hardware need to toggle a single shared antenna between WLAN and
1391 * Bluetooth to facilitate co-existence. These types of hardware set
1392 * limitations on the use of host controlled dynamic powersave whenever there
1393 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1394 * driver may request temporarily going into full power save, in order to
1395 * enable toggling the antenna between BT and WLAN. If the driver requests
1396 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1397 * temporarily set to zero until the driver re-enables dynamic powersave.
1398 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001399 * Driver informs U-APSD client support by enabling
1400 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1401 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1402 * Nullfunc frames and stay awake until the service period has ended. To
1403 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1404 * from that AC are transmitted with powersave enabled.
1405 *
1406 * Note: U-APSD client mode is not yet supported with
1407 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001408 */
1409
1410/**
Kalle Valo04de8382009-03-22 21:57:35 +02001411 * DOC: Beacon filter support
1412 *
1413 * Some hardware have beacon filter support to reduce host cpu wakeups
1414 * which will reduce system power consumption. It usuallly works so that
1415 * the firmware creates a checksum of the beacon but omits all constantly
1416 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1417 * beacon is forwarded to the host, otherwise it will be just dropped. That
1418 * way the host will only receive beacons where some relevant information
1419 * (for example ERP protection or WMM settings) have changed.
1420 *
Johannes Berg955394c2009-04-16 17:04:25 +02001421 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1422 * hardware capability. The driver needs to enable beacon filter support
1423 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1424 * power save is enabled, the stack will not check for beacon loss and the
1425 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1426 *
1427 * The time (or number of beacons missed) until the firmware notifies the
1428 * driver of a beacon loss event (which in turn causes the driver to call
1429 * ieee80211_beacon_loss()) should be configurable and will be controlled
1430 * by mac80211 and the roaming algorithm in the future.
1431 *
1432 * Since there may be constantly changing information elements that nothing
1433 * in the software stack cares about, we will, in the future, have mac80211
1434 * tell the driver which information elements are interesting in the sense
1435 * that we want to see changes in them. This will include
1436 * - a list of information element IDs
1437 * - a list of OUIs for the vendor information element
1438 *
1439 * Ideally, the hardware would filter out any beacons without changes in the
1440 * requested elements, but if it cannot support that it may, at the expense
1441 * of some efficiency, filter out only a subset. For example, if the device
1442 * doesn't support checking for OUIs it should pass up all changes in all
1443 * vendor information elements.
1444 *
1445 * Note that change, for the sake of simplification, also includes information
1446 * elements appearing or disappearing from the beacon.
1447 *
1448 * Some hardware supports an "ignore list" instead, just make sure nothing
1449 * that was requested is on the ignore list, and include commonly changing
1450 * information element IDs in the ignore list, for example 11 (BSS load) and
1451 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1452 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1453 * it could also include some currently unused IDs.
1454 *
1455 *
1456 * In addition to these capabilities, hardware should support notifying the
1457 * host of changes in the beacon RSSI. This is relevant to implement roaming
1458 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1459 * the received data packets). This can consist in notifying the host when
1460 * the RSSI changes significantly or when it drops below or rises above
1461 * configurable thresholds. In the future these thresholds will also be
1462 * configured by mac80211 (which gets them from userspace) to implement
1463 * them as the roaming algorithm requires.
1464 *
1465 * If the hardware cannot implement this, the driver should ask it to
1466 * periodically pass beacon frames to the host so that software can do the
1467 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001468 */
1469
1470/**
Johannes Berg0f782312009-12-01 13:37:02 +01001471 * DOC: Spatial multiplexing power save
1472 *
1473 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1474 * power in an 802.11n implementation. For details on the mechanism
1475 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1476 * "11.2.3 SM power save".
1477 *
1478 * The mac80211 implementation is capable of sending action frames
1479 * to update the AP about the station's SMPS mode, and will instruct
1480 * the driver to enter the specific mode. It will also announce the
1481 * requested SMPS mode during the association handshake. Hardware
1482 * support for this feature is required, and can be indicated by
1483 * hardware flags.
1484 *
1485 * The default mode will be "automatic", which nl80211/cfg80211
1486 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1487 * turned off otherwise.
1488 *
1489 * To support this feature, the driver must set the appropriate
1490 * hardware support flags, and handle the SMPS flag to the config()
1491 * operation. It will then with this mechanism be instructed to
1492 * enter the requested SMPS mode while associated to an HT AP.
1493 */
1494
1495/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001496 * DOC: Frame filtering
1497 *
1498 * mac80211 requires to see many management frames for proper
1499 * operation, and users may want to see many more frames when
1500 * in monitor mode. However, for best CPU usage and power consumption,
1501 * having as few frames as possible percolate through the stack is
1502 * desirable. Hence, the hardware should filter as much as possible.
1503 *
1504 * To achieve this, mac80211 uses filter flags (see below) to tell
1505 * the driver's configure_filter() function which frames should be
1506 * passed to mac80211 and which should be filtered out.
1507 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001508 * Before configure_filter() is invoked, the prepare_multicast()
1509 * callback is invoked with the parameters @mc_count and @mc_list
1510 * for the combined multicast address list of all virtual interfaces.
1511 * It's use is optional, and it returns a u64 that is passed to
1512 * configure_filter(). Additionally, configure_filter() has the
1513 * arguments @changed_flags telling which flags were changed and
1514 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001515 *
1516 * If your device has no multicast address filters your driver will
1517 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1518 * parameter to see whether multicast frames should be accepted
1519 * or dropped.
1520 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001521 * All unsupported flags in @total_flags must be cleared.
1522 * Hardware does not support a flag if it is incapable of _passing_
1523 * the frame to the stack. Otherwise the driver must ignore
1524 * the flag, but not clear it.
1525 * You must _only_ clear the flag (announce no support for the
1526 * flag to mac80211) if you are not able to pass the packet type
1527 * to the stack (so the hardware always filters it).
1528 * So for example, you should clear @FIF_CONTROL, if your hardware
1529 * always filters control frames. If your hardware always passes
1530 * control frames to the kernel and is incapable of filtering them,
1531 * you do _not_ clear the @FIF_CONTROL flag.
1532 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001533 */
1534
1535/**
1536 * enum ieee80211_filter_flags - hardware filter flags
1537 *
1538 * These flags determine what the filter in hardware should be
1539 * programmed to let through and what should not be passed to the
1540 * stack. It is always safe to pass more frames than requested,
1541 * but this has negative impact on power consumption.
1542 *
1543 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1544 * think of the BSS as your network segment and then this corresponds
1545 * to the regular ethernet device promiscuous mode.
1546 *
1547 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1548 * by the user or if the hardware is not capable of filtering by
1549 * multicast address.
1550 *
1551 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1552 * %RX_FLAG_FAILED_FCS_CRC for them)
1553 *
1554 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1555 * the %RX_FLAG_FAILED_PLCP_CRC for them
1556 *
1557 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1558 * to the hardware that it should not filter beacons or probe responses
1559 * by BSSID. Filtering them can greatly reduce the amount of processing
1560 * mac80211 needs to do and the amount of CPU wakeups, so you should
1561 * honour this flag if possible.
1562 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001563 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02001564 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001565 *
1566 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001567 *
Johannes Berg7be50862010-10-13 12:06:24 +02001568 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1569 * those addressed to this station.
1570 *
1571 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001572 */
1573enum ieee80211_filter_flags {
1574 FIF_PROMISC_IN_BSS = 1<<0,
1575 FIF_ALLMULTI = 1<<1,
1576 FIF_FCSFAIL = 1<<2,
1577 FIF_PLCPFAIL = 1<<3,
1578 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1579 FIF_CONTROL = 1<<5,
1580 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001581 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02001582 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001583};
1584
1585/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001586 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1587 *
1588 * These flags are used with the ampdu_action() callback in
1589 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001590 *
1591 * Note that drivers MUST be able to deal with a TX aggregation
1592 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02001593 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01001594 * might receive the addBA frame and send a delBA right away!
1595 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001596 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1597 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001598 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1599 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001600 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001601 */
1602enum ieee80211_ampdu_mlme_action {
1603 IEEE80211_AMPDU_RX_START,
1604 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001605 IEEE80211_AMPDU_TX_START,
1606 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001607 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001608};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001609
1610/**
Johannes Bergb2abb6e2011-07-19 10:39:53 +02001611 * enum ieee80211_tx_sync_type - TX sync type
1612 * @IEEE80211_TX_SYNC_AUTH: sync TX for authentication
1613 * (and possibly also before direct probe)
1614 * @IEEE80211_TX_SYNC_ASSOC: sync TX for association
1615 * @IEEE80211_TX_SYNC_ACTION: sync TX for action frame
1616 * (not implemented yet)
1617 */
1618enum ieee80211_tx_sync_type {
1619 IEEE80211_TX_SYNC_AUTH,
1620 IEEE80211_TX_SYNC_ASSOC,
1621 IEEE80211_TX_SYNC_ACTION,
1622};
1623
1624/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001625 * struct ieee80211_ops - callbacks from mac80211 to the driver
1626 *
1627 * This structure contains various callbacks that the driver may
1628 * handle or, in some cases, must handle, for example to configure
1629 * the hardware to a new channel or to transmit a frame.
1630 *
1631 * @tx: Handler that 802.11 module calls for each transmitted frame.
1632 * skb contains the buffer starting from the IEEE 802.11 header.
1633 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001634 * configuration in the TX control data. This handler should,
1635 * preferably, never fail and stop queues appropriately, more
1636 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001637 * This function should return NETDEV_TX_OK except in very
1638 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001639 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001640 *
1641 * @start: Called before the first netdevice attached to the hardware
1642 * is enabled. This should turn on the hardware and must turn on
1643 * frame reception (for possibly enabled monitor interfaces.)
1644 * Returns negative error codes, these may be seen in userspace,
1645 * or zero.
1646 * When the device is started it should not have a MAC address
1647 * to avoid acknowledging frames before a non-monitor device
1648 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001649 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001650 *
1651 * @stop: Called after last netdevice attached to the hardware
1652 * is disabled. This should turn off the hardware (at least
1653 * it must turn off frame reception.)
1654 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001655 * an interface. If you added any work onto the mac80211 workqueue
1656 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001657 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001658 *
Johannes Bergeecc4802011-05-04 15:37:29 +02001659 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1660 * stop transmitting and doing any other configuration, and then
1661 * ask the device to suspend. This is only invoked when WoWLAN is
1662 * configured, otherwise the device is deconfigured completely and
1663 * reconfigured at resume time.
Johannes Berg2b4562d2011-07-02 00:02:01 +02001664 * The driver may also impose special conditions under which it
1665 * wants to use the "normal" suspend (deconfigure), say if it only
1666 * supports WoWLAN when the device is associated. In this case, it
1667 * must return 1 from this function.
Johannes Bergeecc4802011-05-04 15:37:29 +02001668 *
1669 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1670 * now resuming its operation, after this the device must be fully
1671 * functional again. If this returns an error, the only way out is
1672 * to also unregister the device. If it returns 1, then mac80211
1673 * will also go through the regular complete restart on resume.
1674 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001675 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001676 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001677 * and @stop must be implemented.
1678 * The driver should perform any initialization it needs before
1679 * the device can be enabled. The initial configuration for the
1680 * interface is given in the conf parameter.
1681 * The callback may refuse to add an interface by returning a
1682 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001683 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001684 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02001685 * @change_interface: Called when a netdevice changes type. This callback
1686 * is optional, but only if it is supported can interface types be
1687 * switched while the interface is UP. The callback may sleep.
1688 * Note that while an interface is being switched, it will not be
1689 * found by the interface iteration callbacks.
1690 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001691 * @remove_interface: Notifies a driver that an interface is going down.
1692 * The @stop callback is called after this if it is the last interface
1693 * and no monitor interfaces are present.
1694 * When all interfaces are removed, the MAC address in the hardware
1695 * must be cleared so the device no longer acknowledges packets,
1696 * the mac_addr member of the conf structure is, however, set to the
1697 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001698 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001699 *
1700 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1701 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001702 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001703 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001704 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001705 * @bss_info_changed: Handler for configuration requests related to BSS
1706 * parameters that may vary during BSS's lifespan, and may affect low
1707 * level driver (e.g. assoc/disassoc status, erp parameters).
1708 * This function should not be used if no BSS has been set, unless
1709 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001710 * of the bss parameters has changed when a call is made. The callback
1711 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001712 *
Johannes Bergb2abb6e2011-07-19 10:39:53 +02001713 * @tx_sync: Called before a frame is sent to an AP/GO. In the GO case, the
1714 * driver should sync with the GO's powersaving so the device doesn't
1715 * transmit the frame while the GO is asleep. In the regular AP case
1716 * it may be used by drivers for devices implementing other restrictions
1717 * on talking to APs, e.g. due to regulatory enforcement or just HW
1718 * restrictions.
1719 * This function is called for every authentication, association and
1720 * action frame separately since applications might attempt to auth
1721 * with multiple APs before chosing one to associate to. If it returns
1722 * an error, the corresponding authentication, association or frame
1723 * transmission is aborted and reported as having failed. It is always
1724 * called after tuning to the correct channel.
1725 * The callback might be called multiple times before @finish_tx_sync
1726 * (but @finish_tx_sync will be called once for each) but in practice
1727 * this is unlikely to happen. It can also refuse in that case if the
1728 * driver cannot handle that situation.
1729 * This callback can sleep.
1730 * @finish_tx_sync: Called as a counterpart to @tx_sync, unless that returned
1731 * an error. This callback can sleep.
1732 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001733 * @prepare_multicast: Prepare for multicast filter configuration.
1734 * This callback is optional, and its return value is passed
1735 * to configure_filter(). This callback must be atomic.
1736 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001737 * @configure_filter: Configure the device's RX filter.
1738 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001739 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001740 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001741 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001742 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001743 *
1744 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001745 * This callback is only called between add_interface and
1746 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001747 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001748 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001749 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001750 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001751 * @update_tkip_key: See the section "Hardware crypto acceleration"
1752 * This callback will be called in the context of Rx. Called for drivers
1753 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02001754 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001755 *
Johannes Bergc68f4b82011-07-05 16:35:41 +02001756 * @set_rekey_data: If the device supports GTK rekeying, for example while the
1757 * host is suspended, it can assign this callback to retrieve the data
1758 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1759 * After rekeying was done it should (for example during resume) notify
1760 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1761 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001762 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001763 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001764 * configuration done by the regulatory agent in the wiphy's
1765 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001766 * that power save is disabled.
1767 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1768 * entire IEs after the SSID, so that drivers need not look at these
1769 * at all but just send them after the SSID -- mac80211 includes the
1770 * (extended) supported rates and HT information (where applicable).
1771 * When the scan finishes, ieee80211_scan_completed() must be called;
1772 * note that it also must be called when the scan cannot finish due to
1773 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001774 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001775 *
Eliad Pellerb8564392011-06-13 12:47:30 +03001776 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1777 * The driver should ask the hardware to cancel the scan (if possible),
1778 * but the scan will be completed only after the driver will call
1779 * ieee80211_scan_completed().
1780 * This callback is needed for wowlan, to prevent enqueueing a new
1781 * scan_work after the low-level driver was already suspended.
1782 * The callback can sleep.
1783 *
Luciano Coelho79f460c2011-05-11 17:09:36 +03001784 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1785 * specific intervals. The driver must call the
1786 * ieee80211_sched_scan_results() function whenever it finds results.
1787 * This process will continue until sched_scan_stop is called.
1788 *
1789 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1790 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001791 * @sw_scan_start: Notifier function that is called just before a software scan
1792 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001793 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001794 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001795 * @sw_scan_complete: Notifier function that is called just after a
1796 * software scan finished. Can be NULL, if the driver doesn't need
1797 * this notification.
1798 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001799 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001800 * @get_stats: Return low-level statistics.
1801 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001802 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001803 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001804 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1805 * callback should be provided to read the TKIP transmit IVs (both IV32
1806 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001807 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001808 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001809 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1810 * if the device does fragmentation by itself; if this callback is
1811 * implemented then the stack will not do fragmentation.
1812 * The callback can sleep.
1813 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001814 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001815 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001816 *
Johannes Berg34e89502010-02-03 13:59:58 +01001817 * @sta_add: Notifies low level driver about addition of an associated station,
1818 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1819 *
1820 * @sta_remove: Notifies low level driver about removal of an associated
1821 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1822 *
1823 * @sta_notify: Notifies low level driver about power state transition of an
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02001824 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1825 * in AP mode, this callback will not be called when the flag
1826 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001827 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001828 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001829 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001830 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001831 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001832 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001833 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001834 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001835 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001836 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001837 *
1838 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1839 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001840 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001841 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001842 *
1843 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1844 * with other STAs in the IBSS. This is only used in IBSS mode. This
1845 * function is optional if the firmware/hardware takes full care of
1846 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001847 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001848 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001849 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1850 * This is needed only for IBSS mode and the result of this function is
1851 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001852 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001853 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001854 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001855 * @ampdu_action: Perform a certain A-MPDU action
1856 * The RA/TID combination determines the destination and TID we want
1857 * the ampdu action to be performed for. The action is defined through
1858 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001859 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001860 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg0b01f032011-01-18 13:51:05 +01001861 * The @buf_size parameter is only valid when the action is set to
1862 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
Johannes Berg5312c3f2011-04-01 13:52:34 +02001863 * buffer size (number of subframes) for this session -- the driver
1864 * may neither send aggregates containing more subframes than this
1865 * nor send aggregates in a way that lost frames would exceed the
1866 * buffer size. If just limiting the aggregate size, this would be
1867 * possible with a buf_size of 8:
1868 * - TX: 1.....7
1869 * - RX: 2....7 (lost frame #1)
1870 * - TX: 8..1...
1871 * which is invalid since #1 was now re-transmitted well past the
1872 * buffer size of 8. Correct ways to retransmit #1 would be:
1873 * - TX: 1 or 18 or 81
1874 * Even "189" would be wrong since 1 could be lost again.
1875 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001876 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02001877 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001878 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07001879 * @get_survey: Return per-channel survey information
1880 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001881 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1882 * need to set wiphy->rfkill_poll to %true before registration,
1883 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001884 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02001885 *
Lukáš Turek310bc672009-12-21 22:50:48 +01001886 * @set_coverage_class: Set slot time for given coverage class as specified
1887 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1888 * accordingly. This callback is not required and may sleep.
1889 *
Johannes Bergaff89a92009-07-01 21:26:51 +02001890 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001891 * The callback can sleep.
Wey-Yi Guy71063f02011-05-20 09:05:54 -07001892 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01001893 *
1894 * @flush: Flush all pending frames from the hardware queue, making sure
1895 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01001896 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02001897 *
1898 * @channel_switch: Drivers that need (or want) to offload the channel
1899 * switch operation for CSAs received from the AP may implement this
1900 * callback. They must then call ieee80211_chswitch_done() to indicate
1901 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001902 *
1903 * @napi_poll: Poll Rx queue for incoming data frames.
Bruno Randolf79b1c462010-11-24 14:34:41 +09001904 *
1905 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1906 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1907 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1908 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1909 *
1910 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01001911 *
1912 * @remain_on_channel: Starts an off-channel period on the given channel, must
1913 * call back to ieee80211_ready_on_channel() when on that channel. Note
1914 * that normal channel traffic is not stopped as this is intended for hw
1915 * offload. Frames to transmit on the off-channel channel are transmitted
1916 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1917 * duration (which will always be non-zero) expires, the driver must call
1918 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1919 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1920 * aborted before it expires. This callback may sleep.
John W. Linville38c09152011-03-07 16:19:18 -05001921 *
1922 * @set_ringparam: Set tx and rx ring sizes.
1923 *
1924 * @get_ringparam: Get tx and rx ring current and maximum sizes.
Vivek Natarajane8306f92011-04-06 11:41:10 +05301925 *
1926 * @tx_frames_pending: Check if there is any pending frame in the hardware
1927 * queues before entering power save.
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05301928 *
1929 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
1930 * when transmitting a frame. Currently only legacy rates are handled.
1931 * The callback can sleep.
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07001932 * @rssi_callback: Notify driver when the average RSSI goes above/below
1933 * thresholds that were registered previously. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001934 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001935struct ieee80211_ops {
Johannes Berg7bb45682011-02-24 14:42:06 +01001936 void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001937 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001938 void (*stop)(struct ieee80211_hw *hw);
Johannes Bergeecc4802011-05-04 15:37:29 +02001939#ifdef CONFIG_PM
1940 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
1941 int (*resume)(struct ieee80211_hw *hw);
1942#endif
Jiri Bencf0706e82007-05-05 11:45:53 -07001943 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001944 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02001945 int (*change_interface)(struct ieee80211_hw *hw,
1946 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001947 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e82007-05-05 11:45:53 -07001948 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001949 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02001950 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001951 void (*bss_info_changed)(struct ieee80211_hw *hw,
1952 struct ieee80211_vif *vif,
1953 struct ieee80211_bss_conf *info,
1954 u32 changed);
Johannes Bergb2abb6e2011-07-19 10:39:53 +02001955
1956 int (*tx_sync)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1957 const u8 *bssid, enum ieee80211_tx_sync_type type);
1958 void (*finish_tx_sync)(struct ieee80211_hw *hw,
1959 struct ieee80211_vif *vif,
1960 const u8 *bssid,
1961 enum ieee80211_tx_sync_type type);
1962
Johannes Berg3ac64be2009-08-17 16:16:53 +02001963 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad32010-04-01 21:22:57 +00001964 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001965 void (*configure_filter)(struct ieee80211_hw *hw,
1966 unsigned int changed_flags,
1967 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001968 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001969 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1970 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001971 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001972 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001973 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001974 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01001975 struct ieee80211_vif *vif,
1976 struct ieee80211_key_conf *conf,
1977 struct ieee80211_sta *sta,
1978 u32 iv32, u16 *phase1key);
Johannes Bergc68f4b82011-07-05 16:35:41 +02001979 void (*set_rekey_data)(struct ieee80211_hw *hw,
1980 struct ieee80211_vif *vif,
1981 struct cfg80211_gtk_rekey_data *data);
Johannes Berga060bbf2010-04-27 11:59:34 +02001982 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01001983 struct cfg80211_scan_request *req);
Eliad Pellerb8564392011-06-13 12:47:30 +03001984 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
1985 struct ieee80211_vif *vif);
Luciano Coelho79f460c2011-05-11 17:09:36 +03001986 int (*sched_scan_start)(struct ieee80211_hw *hw,
1987 struct ieee80211_vif *vif,
1988 struct cfg80211_sched_scan_request *req,
1989 struct ieee80211_sched_scan_ies *ies);
1990 void (*sched_scan_stop)(struct ieee80211_hw *hw,
1991 struct ieee80211_vif *vif);
Michael Buesch80e775b2009-02-20 15:37:03 +01001992 void (*sw_scan_start)(struct ieee80211_hw *hw);
1993 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001994 int (*get_stats)(struct ieee80211_hw *hw,
1995 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001996 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1997 u32 *iv32, u16 *iv16);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001998 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07001999 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01002000 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2001 struct ieee80211_sta *sta);
2002 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2003 struct ieee80211_sta *sta);
Johannes Berg32bfd352007-12-19 01:31:26 +01002004 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002005 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02002006 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07002007 const struct ieee80211_tx_queue_params *params);
Eliad Peller37a41b42011-09-21 14:06:11 +03002008 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2009 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2010 u64 tsf);
2011 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002012 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002013 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01002014 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02002015 enum ieee80211_ampdu_mlme_action action,
Johannes Berg0b01f032011-01-18 13:51:05 +01002016 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2017 u8 buf_size);
Holger Schurig12897232010-04-19 10:23:57 +02002018 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2019 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002020 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01002021 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02002022#ifdef CONFIG_NL80211_TESTMODE
2023 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002024 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2025 struct netlink_callback *cb,
2026 void *data, int len);
Johannes Bergaff89a92009-07-01 21:26:51 +02002027#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01002028 void (*flush)(struct ieee80211_hw *hw, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02002029 void (*channel_switch)(struct ieee80211_hw *hw,
2030 struct ieee80211_channel_switch *ch_switch);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002031 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
Bruno Randolf15d96752010-11-10 12:50:56 +09002032 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2033 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01002034
2035 int (*remain_on_channel)(struct ieee80211_hw *hw,
2036 struct ieee80211_channel *chan,
2037 enum nl80211_channel_type channel_type,
2038 int duration);
2039 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
John W. Linville38c09152011-03-07 16:19:18 -05002040 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2041 void (*get_ringparam)(struct ieee80211_hw *hw,
2042 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
Vivek Natarajane8306f92011-04-06 11:41:10 +05302043 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
Sujith Manoharanbdbfd6b2011-04-27 16:56:51 +05302044 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2045 const struct cfg80211_bitrate_mask *mask);
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07002046 void (*rssi_callback)(struct ieee80211_hw *hw,
2047 enum ieee80211_rssi_event rssi_event);
Jiri Bencf0706e82007-05-05 11:45:53 -07002048};
2049
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002050/**
2051 * ieee80211_alloc_hw - Allocate a new hardware device
2052 *
2053 * This must be called once for each hardware device. The returned pointer
2054 * must be used to refer to this device when calling other functions.
2055 * mac80211 allocates a private data area for the driver pointed to by
2056 * @priv in &struct ieee80211_hw, the size of this area is given as
2057 * @priv_data_len.
2058 *
2059 * @priv_data_len: length of private data
2060 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07002061 */
2062struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2063 const struct ieee80211_ops *ops);
2064
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002065/**
2066 * ieee80211_register_hw - Register hardware device
2067 *
Johannes Bergdbbea672008-02-26 14:34:06 +01002068 * You must call this function before any other functions in
2069 * mac80211. Note that before a hardware can be registered, you
2070 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002071 *
2072 * @hw: the device to register as returned by ieee80211_alloc_hw()
2073 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002074int ieee80211_register_hw(struct ieee80211_hw *hw);
2075
Johannes Berge1e54062010-11-30 08:58:45 +01002076/**
2077 * struct ieee80211_tpt_blink - throughput blink description
2078 * @throughput: throughput in Kbit/sec
2079 * @blink_time: blink time in milliseconds
2080 * (full cycle, ie. one off + one on period)
2081 */
2082struct ieee80211_tpt_blink {
2083 int throughput;
2084 int blink_time;
2085};
2086
Johannes Berg67408c82010-11-30 08:59:23 +01002087/**
2088 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2089 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2090 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2091 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2092 * interface is connected in some way, including being an AP
2093 */
2094enum ieee80211_tpt_led_trigger_flags {
2095 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2096 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2097 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2098};
2099
Jiri Bencf0706e82007-05-05 11:45:53 -07002100#ifdef CONFIG_MAC80211_LEDS
2101extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2102extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02002103extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002104extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Johannes Berge1e54062010-11-30 08:58:45 +01002105extern char *__ieee80211_create_tpt_led_trigger(
Johannes Berg67408c82010-11-30 08:59:23 +01002106 struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01002107 const struct ieee80211_tpt_blink *blink_table,
2108 unsigned int blink_table_len);
Jiri Bencf0706e82007-05-05 11:45:53 -07002109#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002110/**
2111 * ieee80211_get_tx_led_name - get name of TX LED
2112 *
2113 * mac80211 creates a transmit LED trigger for each wireless hardware
2114 * that can be used to drive LEDs if your driver registers a LED device.
2115 * This function returns the name (or %NULL if not configured for LEDs)
2116 * of the trigger so you can automatically link the LED device.
2117 *
2118 * @hw: the hardware to get the LED trigger name for
2119 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002120static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2121{
2122#ifdef CONFIG_MAC80211_LEDS
2123 return __ieee80211_get_tx_led_name(hw);
2124#else
2125 return NULL;
2126#endif
2127}
2128
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002129/**
2130 * ieee80211_get_rx_led_name - get name of RX LED
2131 *
2132 * mac80211 creates a receive LED trigger for each wireless hardware
2133 * that can be used to drive LEDs if your driver registers a LED device.
2134 * This function returns the name (or %NULL if not configured for LEDs)
2135 * of the trigger so you can automatically link the LED device.
2136 *
2137 * @hw: the hardware to get the LED trigger name for
2138 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002139static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2140{
2141#ifdef CONFIG_MAC80211_LEDS
2142 return __ieee80211_get_rx_led_name(hw);
2143#else
2144 return NULL;
2145#endif
2146}
2147
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002148/**
2149 * ieee80211_get_assoc_led_name - get name of association LED
2150 *
2151 * mac80211 creates a association LED trigger for each wireless hardware
2152 * that can be used to drive LEDs if your driver registers a LED device.
2153 * This function returns the name (or %NULL if not configured for LEDs)
2154 * of the trigger so you can automatically link the LED device.
2155 *
2156 * @hw: the hardware to get the LED trigger name for
2157 */
Michael Buesch47f0c502007-09-27 15:10:44 +02002158static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2159{
2160#ifdef CONFIG_MAC80211_LEDS
2161 return __ieee80211_get_assoc_led_name(hw);
2162#else
2163 return NULL;
2164#endif
2165}
2166
Ivo van Doorncdcb0062008-01-07 19:45:24 +01002167/**
2168 * ieee80211_get_radio_led_name - get name of radio LED
2169 *
2170 * mac80211 creates a radio change LED trigger for each wireless hardware
2171 * that can be used to drive LEDs if your driver registers a LED device.
2172 * This function returns the name (or %NULL if not configured for LEDs)
2173 * of the trigger so you can automatically link the LED device.
2174 *
2175 * @hw: the hardware to get the LED trigger name for
2176 */
2177static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2178{
2179#ifdef CONFIG_MAC80211_LEDS
2180 return __ieee80211_get_radio_led_name(hw);
2181#else
2182 return NULL;
2183#endif
2184}
Michael Buesch47f0c502007-09-27 15:10:44 +02002185
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002186/**
Johannes Berge1e54062010-11-30 08:58:45 +01002187 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2188 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01002189 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01002190 * @blink_table: the blink table -- needs to be ordered by throughput
2191 * @blink_table_len: size of the blink table
2192 *
2193 * This function returns %NULL (in case of error, or if no LED
2194 * triggers are configured) or the name of the new trigger.
2195 * This function must be called before ieee80211_register_hw().
2196 */
2197static inline char *
Johannes Berg67408c82010-11-30 08:59:23 +01002198ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01002199 const struct ieee80211_tpt_blink *blink_table,
2200 unsigned int blink_table_len)
2201{
2202#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01002203 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01002204 blink_table_len);
2205#else
2206 return NULL;
2207#endif
2208}
2209
2210/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002211 * ieee80211_unregister_hw - Unregister a hardware device
2212 *
2213 * This function instructs mac80211 to free allocated resources
2214 * and unregister netdevices from the networking subsystem.
2215 *
2216 * @hw: the hardware to unregister
2217 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002218void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2219
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002220/**
2221 * ieee80211_free_hw - free hardware descriptor
2222 *
2223 * This function frees everything that was allocated, including the
2224 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002225 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002226 *
2227 * @hw: the hardware to free
2228 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002229void ieee80211_free_hw(struct ieee80211_hw *hw);
2230
Johannes Bergf2753dd2009-04-14 10:09:24 +02002231/**
2232 * ieee80211_restart_hw - restart hardware completely
2233 *
2234 * Call this function when the hardware was restarted for some reason
2235 * (hardware error, ...) and the driver is unable to restore its state
2236 * by itself. mac80211 assumes that at this point the driver/hardware
2237 * is completely uninitialised and stopped, it starts the process by
2238 * calling the ->start() operation. The driver will need to reset all
2239 * internal state that it has prior to calling this function.
2240 *
2241 * @hw: the hardware to restart
2242 */
2243void ieee80211_restart_hw(struct ieee80211_hw *hw);
2244
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002245/** ieee80211_napi_schedule - schedule NAPI poll
2246 *
2247 * Use this function to schedule NAPI polling on a device.
2248 *
2249 * @hw: the hardware to start polling
2250 */
2251void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2252
2253/** ieee80211_napi_complete - complete NAPI polling
2254 *
2255 * Use this function to finish NAPI polling on a device.
2256 *
2257 * @hw: the hardware to stop polling
2258 */
2259void ieee80211_napi_complete(struct ieee80211_hw *hw);
2260
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002261/**
2262 * ieee80211_rx - receive frame
2263 *
2264 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08002265 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2266 * paged @skb is used, the driver is recommended to put the ieee80211
2267 * header of the frame on the linear part of the @skb to avoid memory
2268 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002269 *
Johannes Berg2485f712008-02-25 16:27:41 +01002270 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03002271 * for a single hardware must be synchronized against each other. Calls to
2272 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2273 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002274 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002275 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02002276 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002277 * @hw: the hardware this frame came in on
2278 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002279 */
John W. Linville103bf9f2009-08-20 16:34:15 -04002280void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002281
2282/**
2283 * ieee80211_rx_irqsafe - receive frame
2284 *
2285 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01002286 * (internally defers to a tasklet.)
2287 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002288 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2289 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002290 *
2291 * @hw: the hardware this frame came in on
2292 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002293 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02002294void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07002295
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002296/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03002297 * ieee80211_rx_ni - receive frame (in process context)
2298 *
2299 * Like ieee80211_rx() but can be called in process context
2300 * (internally disables bottom halves).
2301 *
2302 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2303 * not be mixed for a single hardware.
2304 *
2305 * @hw: the hardware this frame came in on
2306 * @skb: the buffer to receive, owned by mac80211 after this call
2307 */
2308static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2309 struct sk_buff *skb)
2310{
2311 local_bh_disable();
2312 ieee80211_rx(hw, skb);
2313 local_bh_enable();
2314}
2315
Arik Nemtsovd057e5a2011-01-31 22:29:13 +02002316/**
2317 * ieee80211_sta_ps_transition - PS transition for connected sta
2318 *
2319 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2320 * flag set, use this function to inform mac80211 about a connected station
2321 * entering/leaving PS mode.
2322 *
2323 * This function may not be called in IRQ context or with softirqs enabled.
2324 *
2325 * Calls to this function for a single hardware must be synchronized against
2326 * each other.
2327 *
2328 * The function returns -EINVAL when the requested PS mode is already set.
2329 *
2330 * @sta: currently connected sta
2331 * @start: start or stop PS
2332 */
2333int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2334
2335/**
2336 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2337 * (in process context)
2338 *
2339 * Like ieee80211_sta_ps_transition() but can be called in process context
2340 * (internally disables bottom halves). Concurrent call restriction still
2341 * applies.
2342 *
2343 * @sta: currently connected sta
2344 * @start: start or stop PS
2345 */
2346static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2347 bool start)
2348{
2349 int ret;
2350
2351 local_bh_disable();
2352 ret = ieee80211_sta_ps_transition(sta, start);
2353 local_bh_enable();
2354
2355 return ret;
2356}
2357
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01002358/*
2359 * The TX headroom reserved by mac80211 for its own tx_status functions.
2360 * This is enough for the radiotap header.
2361 */
2362#define IEEE80211_TX_STATUS_HEADROOM 13
2363
Kalle Valoe36e49f2009-10-13 20:33:13 +03002364/**
Johannes Berg042ec452011-09-29 16:04:26 +02002365 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
Randy Dunlapbdfbe802011-05-22 17:22:45 -07002366 * @sta: &struct ieee80211_sta pointer for the sleeping station
Johannes Berg042ec452011-09-29 16:04:26 +02002367 * @tid: the TID that has buffered frames
2368 * @buffered: indicates whether or not frames are buffered for this TID
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02002369 *
2370 * If a driver buffers frames for a powersave station instead of passing
Johannes Berg042ec452011-09-29 16:04:26 +02002371 * them back to mac80211 for retransmission, the station may still need
2372 * to be told that there are buffered frames via the TIM bit.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02002373 *
Johannes Berg042ec452011-09-29 16:04:26 +02002374 * This function informs mac80211 whether or not there are frames that are
2375 * buffered in the driver for a given TID; mac80211 can then use this data
2376 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2377 * call! Beware of the locking!)
2378 *
2379 * If all frames are released to the station (due to PS-poll or uAPSD)
2380 * then the driver needs to inform mac80211 that there no longer are
2381 * frames buffered. However, when the station wakes up mac80211 assumes
2382 * that all buffered frames will be transmitted and clears this data,
2383 * drivers need to make sure they inform mac80211 about all buffered
2384 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2385 *
2386 * Note that technically mac80211 only needs to know this per AC, not per
2387 * TID, but since driver buffering will inevitably happen per TID (since
2388 * it is related to aggregation) it is easier to make mac80211 map the
2389 * TID to the AC as required instead of keeping track in all drivers that
2390 * use this API.
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02002391 */
Johannes Berg042ec452011-09-29 16:04:26 +02002392void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2393 u8 tid, bool buffered);
Felix Fietkaudcf55fb2011-04-17 17:45:00 +02002394
2395/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002396 * ieee80211_tx_status - transmit status callback
2397 *
2398 * Call this function for all transmitted frames after they have been
2399 * transmitted. It is permissible to not call this function for
2400 * multicast frames but this can affect statistics.
2401 *
Johannes Berg2485f712008-02-25 16:27:41 +01002402 * This function may not be called in IRQ context. Calls to this function
2403 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002404 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2405 * may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002406 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002407 * @hw: the hardware the frame was transmitted by
2408 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002409 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002410void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002411 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01002412
2413/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002414 * ieee80211_tx_status_ni - transmit status callback (in process context)
2415 *
2416 * Like ieee80211_tx_status() but can be called in process context.
2417 *
2418 * Calls to this function, ieee80211_tx_status() and
2419 * ieee80211_tx_status_irqsafe() may not be mixed
2420 * for a single hardware.
2421 *
2422 * @hw: the hardware the frame was transmitted by
2423 * @skb: the frame that was transmitted, owned by mac80211 after this call
2424 */
2425static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2426 struct sk_buff *skb)
2427{
2428 local_bh_disable();
2429 ieee80211_tx_status(hw, skb);
2430 local_bh_enable();
2431}
2432
2433/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002434 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01002435 *
2436 * Like ieee80211_tx_status() but can be called in IRQ context
2437 * (internally defers to a tasklet.)
2438 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002439 * Calls to this function, ieee80211_tx_status() and
2440 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002441 *
2442 * @hw: the hardware the frame was transmitted by
2443 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01002444 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002445void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002446 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07002447
2448/**
Arik Nemtsov8178d382011-04-18 14:22:28 +03002449 * ieee80211_report_low_ack - report non-responding station
2450 *
2451 * When operating in AP-mode, call this function to report a non-responding
2452 * connected STA.
2453 *
2454 * @sta: the non-responding connected sta
2455 * @num_packets: number of packets sent to @sta without a response
2456 */
2457void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2458
2459/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01002460 * ieee80211_beacon_get_tim - beacon generation function
2461 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002462 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01002463 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2464 * Set to 0 if invalid (in non-AP modes).
2465 * @tim_length: pointer to variable that will receive the TIM IE length,
2466 * (including the ID and length bytes!).
2467 * Set to 0 if invalid (in non-AP modes).
2468 *
2469 * If the driver implements beaconing modes, it must use this function to
2470 * obtain the beacon frame/template.
2471 *
2472 * If the beacon frames are generated by the host system (i.e., not in
2473 * hardware/firmware), the driver uses this function to get each beacon
2474 * frame from mac80211 -- it is responsible for calling this function
2475 * before the beacon is needed (e.g. based on hardware interrupt).
2476 *
2477 * If the beacon frames are generated by the device, then the driver
2478 * must use the returned beacon as the template and change the TIM IE
2479 * according to the current DTIM parameters/TIM bitmap.
2480 *
2481 * The driver is responsible for freeing the returned skb.
2482 */
2483struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2484 struct ieee80211_vif *vif,
2485 u16 *tim_offset, u16 *tim_length);
2486
2487/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002488 * ieee80211_beacon_get - beacon generation function
2489 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002490 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002491 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01002492 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07002493 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01002494static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2495 struct ieee80211_vif *vif)
2496{
2497 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2498}
Jiri Bencf0706e82007-05-05 11:45:53 -07002499
2500/**
Kalle Valo7044cc52010-01-05 20:16:19 +02002501 * ieee80211_pspoll_get - retrieve a PS Poll template
2502 * @hw: pointer obtained from ieee80211_alloc_hw().
2503 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2504 *
2505 * Creates a PS Poll a template which can, for example, uploaded to
2506 * hardware. The template must be updated after association so that correct
2507 * AID, BSSID and MAC address is used.
2508 *
2509 * Note: Caller (or hardware) is responsible for setting the
2510 * &IEEE80211_FCTL_PM bit.
2511 */
2512struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2513 struct ieee80211_vif *vif);
2514
2515/**
2516 * ieee80211_nullfunc_get - retrieve a nullfunc template
2517 * @hw: pointer obtained from ieee80211_alloc_hw().
2518 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2519 *
2520 * Creates a Nullfunc template which can, for example, uploaded to
2521 * hardware. The template must be updated after association so that correct
2522 * BSSID and address is used.
2523 *
2524 * Note: Caller (or hardware) is responsible for setting the
2525 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2526 */
2527struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2528 struct ieee80211_vif *vif);
2529
2530/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02002531 * ieee80211_probereq_get - retrieve a Probe Request template
2532 * @hw: pointer obtained from ieee80211_alloc_hw().
2533 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2534 * @ssid: SSID buffer
2535 * @ssid_len: length of SSID
2536 * @ie: buffer containing all IEs except SSID for the template
2537 * @ie_len: length of the IE buffer
2538 *
2539 * Creates a Probe Request template which can, for example, be uploaded to
2540 * hardware.
2541 */
2542struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2543 struct ieee80211_vif *vif,
2544 const u8 *ssid, size_t ssid_len,
2545 const u8 *ie, size_t ie_len);
2546
2547/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002548 * ieee80211_rts_get - RTS frame generation function
2549 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002550 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002551 * @frame: pointer to the frame that is going to be protected by the RTS.
2552 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002553 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002554 * @rts: The buffer where to store the RTS frame.
2555 *
2556 * If the RTS frames are generated by the host system (i.e., not in
2557 * hardware/firmware), the low-level driver uses this function to receive
2558 * the next RTS frame from the 802.11 code. The low-level is responsible
2559 * for calling this function before and RTS frame is needed.
2560 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002561void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002562 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002563 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002564 struct ieee80211_rts *rts);
2565
2566/**
2567 * ieee80211_rts_duration - Get the duration field for an RTS frame
2568 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002569 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002570 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02002571 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002572 *
2573 * If the RTS is generated in firmware, but the host system must provide
2574 * the duration field, the low-level driver uses this function to receive
2575 * the duration field value in little-endian byteorder.
2576 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002577__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2578 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002579 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002580
2581/**
2582 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2583 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002584 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002585 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2586 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002587 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002588 * @cts: The buffer where to store the CTS-to-self frame.
2589 *
2590 * If the CTS-to-self frames are generated by the host system (i.e., not in
2591 * hardware/firmware), the low-level driver uses this function to receive
2592 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2593 * for calling this function before and CTS-to-self frame is needed.
2594 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002595void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2596 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002597 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002598 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002599 struct ieee80211_cts *cts);
2600
2601/**
2602 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2603 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002604 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002605 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
Johannes Berge039fa42008-05-15 12:55:29 +02002606 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002607 *
2608 * If the CTS-to-self is generated in firmware, but the host system must provide
2609 * the duration field, the low-level driver uses this function to receive
2610 * the duration field value in little-endian byteorder.
2611 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002612__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2613 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002614 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002615 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002616
2617/**
2618 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2619 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002620 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002621 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01002622 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07002623 *
2624 * Calculate the duration field of some generic frame, given its
2625 * length and transmission rate (in 100kbps).
2626 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002627__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2628 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002629 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002630 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07002631
2632/**
2633 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2634 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002635 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002636 *
2637 * Function for accessing buffered broadcast and multicast frames. If
2638 * hardware/firmware does not implement buffering of broadcast/multicast
2639 * frames when power saving is used, 802.11 code buffers them in the host
2640 * memory. The low-level driver uses this function to fetch next buffered
2641 * frame. In most cases, this is used when generating beacon frame. This
2642 * function returns a pointer to the next buffered skb or NULL if no more
2643 * buffered frames are available.
2644 *
2645 * Note: buffered frames are returned only after DTIM beacon frame was
2646 * generated with ieee80211_beacon_get() and the low-level driver must thus
2647 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2648 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2649 * does not need to check for DTIM beacons separately and should be able to
2650 * use common code for all beacons.
2651 */
2652struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002653ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002654
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002655/**
Johannes Berg42d98792011-07-07 18:58:01 +02002656 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
2657 *
2658 * This function returns the TKIP phase 1 key for the given IV32.
2659 *
2660 * @keyconf: the parameter passed with the set key
2661 * @iv32: IV32 to get the P1K for
2662 * @p1k: a buffer to which the key will be written, as 5 u16 values
2663 */
2664void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
2665 u32 iv32, u16 *p1k);
2666
2667/**
Johannes Berg523b02e2011-07-07 22:28:01 +02002668 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002669 *
Johannes Berg523b02e2011-07-07 22:28:01 +02002670 * This function returns the TKIP phase 1 key for the IV32 taken
2671 * from the given packet.
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002672 *
2673 * @keyconf: the parameter passed with the set key
Johannes Berg523b02e2011-07-07 22:28:01 +02002674 * @skb: the packet to take the IV32 value from that will be encrypted
2675 * with this P1K
2676 * @p1k: a buffer to which the key will be written, as 5 u16 values
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002677 */
Johannes Berg42d98792011-07-07 18:58:01 +02002678static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
2679 struct sk_buff *skb, u16 *p1k)
2680{
2681 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
2682 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
2683 u32 iv32 = get_unaligned_le32(&data[4]);
2684
2685 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
2686}
Johannes Berg523b02e2011-07-07 22:28:01 +02002687
2688/**
Johannes Berg8bca5d82011-07-13 19:50:34 +02002689 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
2690 *
2691 * This function returns the TKIP phase 1 key for the given IV32
2692 * and transmitter address.
2693 *
2694 * @keyconf: the parameter passed with the set key
2695 * @ta: TA that will be used with the key
2696 * @iv32: IV32 to get the P1K for
2697 * @p1k: a buffer to which the key will be written, as 5 u16 values
2698 */
2699void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
2700 const u8 *ta, u32 iv32, u16 *p1k);
2701
2702/**
Johannes Berg523b02e2011-07-07 22:28:01 +02002703 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2704 *
2705 * This function computes the TKIP RC4 key for the IV values
2706 * in the packet.
2707 *
2708 * @keyconf: the parameter passed with the set key
2709 * @skb: the packet to take the IV32/IV16 values from that will be
2710 * encrypted with this key
2711 * @p2k: a buffer to which the key will be written, 16 bytes
2712 */
2713void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
2714 struct sk_buff *skb, u8 *p2k);
Johannes Bergc68f4b82011-07-05 16:35:41 +02002715
2716/**
Johannes Berg3ea542d2011-07-07 18:58:00 +02002717 * struct ieee80211_key_seq - key sequence counter
2718 *
2719 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2720 * @ccmp: PN data, most significant byte first (big endian,
2721 * reverse order than in packet)
2722 * @aes_cmac: PN data, most significant byte first (big endian,
2723 * reverse order than in packet)
2724 */
2725struct ieee80211_key_seq {
2726 union {
2727 struct {
2728 u32 iv32;
2729 u16 iv16;
2730 } tkip;
2731 struct {
2732 u8 pn[6];
2733 } ccmp;
2734 struct {
2735 u8 pn[6];
2736 } aes_cmac;
2737 };
2738};
2739
2740/**
2741 * ieee80211_get_key_tx_seq - get key TX sequence counter
2742 *
2743 * @keyconf: the parameter passed with the set key
2744 * @seq: buffer to receive the sequence data
2745 *
2746 * This function allows a driver to retrieve the current TX IV/PN
2747 * for the given key. It must not be called if IV generation is
2748 * offloaded to the device.
2749 *
2750 * Note that this function may only be called when no TX processing
2751 * can be done concurrently, for example when queues are stopped
2752 * and the stop has been synchronized.
2753 */
2754void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
2755 struct ieee80211_key_seq *seq);
2756
2757/**
2758 * ieee80211_get_key_rx_seq - get key RX sequence counter
2759 *
2760 * @keyconf: the parameter passed with the set key
2761 * @tid: The TID, or -1 for the management frame value (CCMP only);
2762 * the value on TID 0 is also used for non-QoS frames. For
2763 * CMAC, only TID 0 is valid.
2764 * @seq: buffer to receive the sequence data
2765 *
2766 * This function allows a driver to retrieve the current RX IV/PNs
2767 * for the given key. It must not be called if IV checking is done
2768 * by the device and not by mac80211.
2769 *
2770 * Note that this function may only be called when no RX processing
2771 * can be done concurrently.
2772 */
2773void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
2774 int tid, struct ieee80211_key_seq *seq);
2775
2776/**
Johannes Bergc68f4b82011-07-05 16:35:41 +02002777 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
2778 * @vif: virtual interface the rekeying was done on
2779 * @bssid: The BSSID of the AP, for checking association
2780 * @replay_ctr: the new replay counter after GTK rekeying
2781 * @gfp: allocation flags
2782 */
2783void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
2784 const u8 *replay_ctr, gfp_t gfp);
2785
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002786/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002787 * ieee80211_wake_queue - wake specific queue
2788 * @hw: pointer as obtained from ieee80211_alloc_hw().
2789 * @queue: queue number (counted from zero).
2790 *
2791 * Drivers should use this function instead of netif_wake_queue.
2792 */
2793void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2794
2795/**
2796 * ieee80211_stop_queue - stop specific queue
2797 * @hw: pointer as obtained from ieee80211_alloc_hw().
2798 * @queue: queue number (counted from zero).
2799 *
2800 * Drivers should use this function instead of netif_stop_queue.
2801 */
2802void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2803
2804/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03002805 * ieee80211_queue_stopped - test status of the queue
2806 * @hw: pointer as obtained from ieee80211_alloc_hw().
2807 * @queue: queue number (counted from zero).
2808 *
2809 * Drivers should use this function instead of netif_stop_queue.
2810 */
2811
2812int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2813
2814/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002815 * ieee80211_stop_queues - stop all queues
2816 * @hw: pointer as obtained from ieee80211_alloc_hw().
2817 *
2818 * Drivers should use this function instead of netif_stop_queue.
2819 */
2820void ieee80211_stop_queues(struct ieee80211_hw *hw);
2821
2822/**
2823 * ieee80211_wake_queues - wake all queues
2824 * @hw: pointer as obtained from ieee80211_alloc_hw().
2825 *
2826 * Drivers should use this function instead of netif_wake_queue.
2827 */
2828void ieee80211_wake_queues(struct ieee80211_hw *hw);
2829
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002830/**
2831 * ieee80211_scan_completed - completed hardware scan
2832 *
2833 * When hardware scan offload is used (i.e. the hw_scan() callback is
2834 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02002835 * mac80211 that the scan finished. This function can be called from
2836 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002837 *
2838 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01002839 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002840 */
Johannes Berg2a519312009-02-10 21:25:55 +01002841void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07002842
Johannes Bergdabeb342007-11-09 01:57:29 +01002843/**
Luciano Coelho79f460c2011-05-11 17:09:36 +03002844 * ieee80211_sched_scan_results - got results from scheduled scan
2845 *
2846 * When a scheduled scan is running, this function needs to be called by the
2847 * driver whenever there are new scan results available.
2848 *
2849 * @hw: the hardware that is performing scheduled scans
2850 */
2851void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
2852
2853/**
2854 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
2855 *
2856 * When a scheduled scan is running, this function can be called by
2857 * the driver if it needs to stop the scan to perform another task.
2858 * Usual scenarios are drivers that cannot continue the scheduled scan
2859 * while associating, for instance.
2860 *
2861 * @hw: the hardware that is performing scheduled scans
2862 */
2863void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
2864
2865/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002866 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01002867 *
2868 * This function iterates over the interfaces associated with a given
2869 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002870 * This function allows the iterator function to sleep, when the iterator
2871 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2872 * be used.
Felix Fietkau2944f452010-09-14 18:37:20 +02002873 * Does not iterate over a new interface during add_interface()
Johannes Bergdabeb342007-11-09 01:57:29 +01002874 *
2875 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002876 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002877 * @data: first argument of the iterator function
2878 */
2879void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2880 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002881 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002882 void *data);
2883
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002884/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002885 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2886 *
2887 * This function iterates over the interfaces associated with a given
2888 * hardware that are currently active and calls the callback for them.
2889 * This function requires the iterator callback function to be atomic,
2890 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Felix Fietkau2944f452010-09-14 18:37:20 +02002891 * Does not iterate over a new interface during add_interface()
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002892 *
2893 * @hw: the hardware struct of which the interfaces should be iterated over
2894 * @iterator: the iterator function to call, cannot sleep
2895 * @data: first argument of the iterator function
2896 */
2897void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2898 void (*iterator)(void *data,
2899 u8 *mac,
2900 struct ieee80211_vif *vif),
2901 void *data);
2902
2903/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002904 * ieee80211_queue_work - add work onto the mac80211 workqueue
2905 *
2906 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2907 * This helper ensures drivers are not queueing work when they should not be.
2908 *
2909 * @hw: the hardware struct for the interface we are adding work for
2910 * @work: the work we want to add onto the mac80211 workqueue
2911 */
2912void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2913
2914/**
2915 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2916 *
2917 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2918 * workqueue.
2919 *
2920 * @hw: the hardware struct for the interface we are adding work for
2921 * @dwork: delayable work to queue onto the mac80211 workqueue
2922 * @delay: number of jiffies to wait before queueing
2923 */
2924void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2925 struct delayed_work *dwork,
2926 unsigned long delay);
2927
2928/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002929 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002930 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002931 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05302932 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002933 *
2934 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002935 *
2936 * Although mac80211/low level driver/user space application can estimate
2937 * the need to start aggregation on a certain RA/TID, the session level
2938 * will be managed by the mac80211.
2939 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05302940int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2941 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002942
2943/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002944 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002945 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002946 * @ra: receiver address of the BA session recipient.
2947 * @tid: the TID to BA on.
2948 *
2949 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002950 * finished with preparations for the BA session. It can be called
2951 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002952 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002953void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002954 u16 tid);
2955
2956/**
2957 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002958 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002959 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002960 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02002961 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002962 *
2963 * Although mac80211/low level driver/user space application can estimate
2964 * the need to stop aggregation on a certain RA/TID, the session level
2965 * will be managed by the mac80211.
2966 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02002967int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002968
2969/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002970 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002971 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002972 * @ra: receiver address of the BA session recipient.
2973 * @tid: the desired TID to BA on.
2974 *
2975 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002976 * finished with preparations for the BA session tear down. It
2977 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002978 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002979void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002980 u16 tid);
2981
Mohamed Abbas84363e62008-04-04 16:59:58 -07002982/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002983 * ieee80211_find_sta - find a station
2984 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002985 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002986 * @addr: station's address
2987 *
2988 * This function must be called under RCU lock and the
2989 * resulting pointer is only valid under RCU lock as well.
2990 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002991struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002992 const u8 *addr);
2993
Kalle Valo04de8382009-03-22 21:57:35 +02002994/**
Ben Greear686b9cb2010-09-23 09:44:36 -07002995 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01002996 *
2997 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07002998 * @addr: remote station's address
2999 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003000 *
3001 * This function must be called under RCU lock and the
3002 * resulting pointer is only valid under RCU lock as well.
3003 *
Ben Greear686b9cb2010-09-23 09:44:36 -07003004 * NOTE: You may pass NULL for localaddr, but then you will just get
3005 * the first STA that matches the remote address 'addr'.
3006 * We can have multiple STA associated with multiple
3007 * logical stations (e.g. consider a station connecting to another
3008 * BSSID on the same AP hardware without disconnecting first).
3009 * In this case, the result of this method with localaddr NULL
3010 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003011 *
Ben Greear686b9cb2010-09-23 09:44:36 -07003012 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01003013 */
Ben Greear686b9cb2010-09-23 09:44:36 -07003014struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3015 const u8 *addr,
3016 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01003017
3018/**
Johannes Bergaf818582009-11-06 11:35:50 +01003019 * ieee80211_sta_block_awake - block station from waking up
3020 * @hw: the hardware
3021 * @pubsta: the station
3022 * @block: whether to block or unblock
3023 *
3024 * Some devices require that all frames that are on the queues
3025 * for a specific station that went to sleep are flushed before
3026 * a poll response or frames after the station woke up can be
3027 * delivered to that it. Note that such frames must be rejected
3028 * by the driver as filtered, with the appropriate status flag.
3029 *
3030 * This function allows implementing this mode in a race-free
3031 * manner.
3032 *
3033 * To do this, a driver must keep track of the number of frames
3034 * still enqueued for a specific station. If this number is not
3035 * zero when the station goes to sleep, the driver must call
3036 * this function to force mac80211 to consider the station to
3037 * be asleep regardless of the station's actual state. Once the
3038 * number of outstanding frames reaches zero, the driver must
3039 * call this function again to unblock the station. That will
3040 * cause mac80211 to be able to send ps-poll responses, and if
3041 * the station queried in the meantime then frames will also
3042 * be sent out as a result of this. Additionally, the driver
3043 * will be notified that the station woke up some time after
3044 * it is unblocked, regardless of whether the station actually
3045 * woke up while blocked or not.
3046 */
3047void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3048 struct ieee80211_sta *pubsta, bool block);
3049
3050/**
Johannes Berg830af022011-07-05 16:35:39 +02003051 * ieee80211_iter_keys - iterate keys programmed into the device
3052 * @hw: pointer obtained from ieee80211_alloc_hw()
3053 * @vif: virtual interface to iterate, may be %NULL for all
3054 * @iter: iterator function that will be called for each key
3055 * @iter_data: custom data to pass to the iterator function
3056 *
3057 * This function can be used to iterate all the keys known to
3058 * mac80211, even those that weren't previously programmed into
3059 * the device. This is intended for use in WoWLAN if the device
3060 * needs reprogramming of the keys during suspend. Note that due
3061 * to locking reasons, it is also only safe to call this at few
3062 * spots since it must hold the RTNL and be able to sleep.
Johannes Bergf850e002011-07-13 19:50:53 +02003063 *
3064 * The order in which the keys are iterated matches the order
3065 * in which they were originally installed and handed to the
3066 * set_key callback.
Johannes Berg830af022011-07-05 16:35:39 +02003067 */
3068void ieee80211_iter_keys(struct ieee80211_hw *hw,
3069 struct ieee80211_vif *vif,
3070 void (*iter)(struct ieee80211_hw *hw,
3071 struct ieee80211_vif *vif,
3072 struct ieee80211_sta *sta,
3073 struct ieee80211_key_conf *key,
3074 void *data),
3075 void *iter_data);
3076
3077/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02003078 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3079 * @hw: pointer obtained from ieee80211_alloc_hw().
3080 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3081 *
3082 * Creates a Probe Request template which can, for example, be uploaded to
3083 * hardware. The template is filled with bssid, ssid and supported rate
3084 * information. This function must only be called from within the
3085 * .bss_info_changed callback function and only in managed mode. The function
3086 * is only useful when the interface is associated, otherwise it will return
3087 * NULL.
3088 */
3089struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3090 struct ieee80211_vif *vif);
3091
3092/**
Kalle Valo04de8382009-03-22 21:57:35 +02003093 * ieee80211_beacon_loss - inform hardware does not receive beacons
3094 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01003095 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02003096 *
Bob Copeland2738bd62010-08-21 16:39:01 -04003097 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003098 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02003099 * hardware is not receiving beacons with this function.
3100 */
3101void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003102
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003103/**
3104 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3105 *
3106 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3107 *
Bob Copeland2738bd62010-08-21 16:39:01 -04003108 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02003109 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3110 * needs to inform if the connection to the AP has been lost.
3111 *
3112 * This function will cause immediate change to disassociated state,
3113 * without connection recovery attempts.
3114 */
3115void ieee80211_connection_loss(struct ieee80211_vif *vif);
3116
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02003117/**
Johannes Berg95acac62011-07-12 12:30:59 +02003118 * ieee80211_resume_disconnect - disconnect from AP after resume
3119 *
3120 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3121 *
3122 * Instructs mac80211 to disconnect from the AP after resume.
3123 * Drivers can use this after WoWLAN if they know that the
3124 * connection cannot be kept up, for example because keys were
3125 * used while the device was asleep but the replay counters or
3126 * similar cannot be retrieved from the device during resume.
3127 *
3128 * Note that due to implementation issues, if the driver uses
3129 * the reconfiguration functionality during resume the interface
3130 * will still be added as associated first during resume and then
3131 * disconnect normally later.
3132 *
3133 * This function can only be called from the resume callback and
3134 * the driver must not be holding any of its own locks while it
3135 * calls this function, or at least not any locks it needs in the
3136 * key configuration paths (if it supports HW crypto).
3137 */
3138void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3139
3140/**
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03003141 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3142 *
3143 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3144 *
3145 * Some hardware require full power save to manage simultaneous BT traffic
3146 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3147 * burst of BT traffic. The hardware gets information of BT traffic via
3148 * hardware co-existence lines, and consequentially requests mac80211 to
3149 * (temporarily) enter full psm.
3150 * This function will only temporarily disable dynamic PS, not enable PSM if
3151 * it was not already enabled.
3152 * The driver must make sure to re-enable dynamic PS using
3153 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3154 *
3155 */
3156void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3157
3158/**
3159 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3160 *
3161 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3162 *
3163 * This function restores dynamic PS after being temporarily disabled via
3164 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3165 * be coupled with an eventual call to this function.
3166 *
3167 */
3168void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3169
3170/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02003171 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3172 * rssi threshold triggered
3173 *
3174 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3175 * @rssi_event: the RSSI trigger event type
3176 * @gfp: context flags
3177 *
3178 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
3179 * monitoring is configured with an rssi threshold, the driver will inform
3180 * whenever the rssi level reaches the threshold.
3181 */
3182void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3183 enum nl80211_cqm_rssi_threshold_event rssi_event,
3184 gfp_t gfp);
3185
Johannes Berg5ce6e432010-05-11 16:20:57 +02003186/**
Eliad Peller1d34d102011-06-06 12:59:29 +03003187 * ieee80211_get_operstate - get the operstate of the vif
3188 *
3189 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3190 *
3191 * The driver might need to know the operstate of the net_device
3192 * (specifically, whether the link is IF_OPER_UP after resume)
3193 */
3194unsigned char ieee80211_get_operstate(struct ieee80211_vif *vif);
3195
3196/**
Johannes Berg5ce6e432010-05-11 16:20:57 +02003197 * ieee80211_chswitch_done - Complete channel switch process
3198 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3199 * @success: make the channel switch successful or not
3200 *
3201 * Complete the channel switch post-process: set the new operational channel
3202 * and wake up the suspended queues.
3203 */
3204void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3205
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02003206/**
3207 * ieee80211_request_smps - request SM PS transition
3208 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02003209 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02003210 *
3211 * This allows the driver to request an SM PS transition in managed
3212 * mode. This is useful when the driver has more information than
3213 * the stack about possible interference, for example by bluetooth.
3214 */
3215void ieee80211_request_smps(struct ieee80211_vif *vif,
3216 enum ieee80211_smps_mode smps_mode);
3217
Johannes Berge31b8212010-10-05 19:39:30 +02003218/**
3219 * ieee80211_key_removed - disable hw acceleration for key
3220 * @key_conf: The key hw acceleration should be disabled for
3221 *
3222 * This allows drivers to indicate that the given key has been
3223 * removed from hardware acceleration, due to a new key that
3224 * was added. Don't use this if the key can continue to be used
3225 * for TX, if the key restriction is on RX only it is permitted
3226 * to keep the key for TX only and not call this function.
3227 *
3228 * Due to locking constraints, it may only be called during
3229 * @set_key. This function must be allowed to sleep, and the
3230 * key it tries to disable may still be used until it returns.
3231 */
3232void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
3233
Johannes Berg21f83582010-12-18 17:20:47 +01003234/**
3235 * ieee80211_ready_on_channel - notification of remain-on-channel start
3236 * @hw: pointer as obtained from ieee80211_alloc_hw()
3237 */
3238void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3239
3240/**
3241 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3242 * @hw: pointer as obtained from ieee80211_alloc_hw()
3243 */
3244void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3245
Shahar Levif41ccd72011-05-22 16:10:21 +03003246/**
3247 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3248 *
3249 * in order not to harm the system performance and user experience, the device
3250 * may request not to allow any rx ba session and tear down existing rx ba
3251 * sessions based on system constraints such as periodic BT activity that needs
3252 * to limit wlan activity (eg.sco or a2dp)."
3253 * in such cases, the intention is to limit the duration of the rx ppdu and
3254 * therefore prevent the peer device to use a-mpdu aggregation.
3255 *
3256 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3257 * @ba_rx_bitmap: Bit map of open rx ba per tid
3258 * @addr: & to bssid mac address
3259 */
3260void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3261 const u8 *addr);
3262
Felix Fietkau8c771242011-08-20 15:53:55 +02003263/**
3264 * ieee80211_send_bar - send a BlockAckReq frame
3265 *
3266 * can be used to flush pending frames from the peer's aggregation reorder
3267 * buffer.
3268 *
3269 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3270 * @ra: the peer's destination address
3271 * @tid: the TID of the aggregation session
3272 * @ssn: the new starting sequence number for the receiver
3273 */
3274void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3275
Johannes Berg4b7679a2008-09-18 18:14:18 +02003276/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02003277
Johannes Berg4b7679a2008-09-18 18:14:18 +02003278/**
Sujith81cb7622009-02-12 11:38:37 +05303279 * enum rate_control_changed - flags to indicate which parameter changed
3280 *
3281 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
3282 * changed, rate control algorithm can update its internal state if needed.
3283 */
3284enum rate_control_changed {
3285 IEEE80211_RC_HT_CHANGED = BIT(0)
3286};
3287
3288/**
Johannes Berge6a98542008-10-21 12:40:02 +02003289 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02003290 *
Johannes Berge6a98542008-10-21 12:40:02 +02003291 * @hw: The hardware the algorithm is invoked for.
3292 * @sband: The band this frame is being transmitted on.
3293 * @bss_conf: the current BSS configuration
3294 * @reported_rate: The rate control algorithm can fill this in to indicate
3295 * which rate should be reported to userspace as the current rate and
3296 * used for rate calculations in the mesh network.
3297 * @rts: whether RTS will be used for this frame because it is longer than the
3298 * RTS threshold
3299 * @short_preamble: whether mac80211 will request short-preamble transmission
3300 * if the selected rate supports it
3301 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Jouni Malinen37eb0b12010-01-06 13:09:08 +02003302 * (deprecated; this will be removed once drivers get updated to use
3303 * rate_idx_mask)
3304 * @rate_idx_mask: user-requested rate mask (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02003305 * @skb: the skb that will be transmitted, the control information in it needs
3306 * to be filled in
Felix Fietkau8f0729b2010-11-11 15:07:23 +01003307 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02003308 */
Johannes Berge6a98542008-10-21 12:40:02 +02003309struct ieee80211_tx_rate_control {
3310 struct ieee80211_hw *hw;
3311 struct ieee80211_supported_band *sband;
3312 struct ieee80211_bss_conf *bss_conf;
3313 struct sk_buff *skb;
3314 struct ieee80211_tx_rate reported_rate;
3315 bool rts, short_preamble;
3316 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02003317 u32 rate_idx_mask;
Felix Fietkau8f0729b2010-11-11 15:07:23 +01003318 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02003319};
3320
3321struct rate_control_ops {
3322 struct module *module;
3323 const char *name;
3324 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003325 void (*free)(void *priv);
3326
3327 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3328 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3329 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05303330 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3331 struct ieee80211_sta *sta,
Sujith4fa00432010-03-01 14:42:57 +05303332 void *priv_sta, u32 changed,
3333 enum nl80211_channel_type oper_chan_type);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003334 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3335 void *priv_sta);
3336
3337 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3338 struct ieee80211_sta *sta, void *priv_sta,
3339 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02003340 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3341 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02003342
3343 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3344 struct dentry *dir);
3345 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3346};
3347
3348static inline int rate_supported(struct ieee80211_sta *sta,
3349 enum ieee80211_band band,
3350 int index)
3351{
3352 return (sta == NULL || sta->supp_rates[band] & BIT(index));
3353}
3354
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07003355/**
3356 * rate_control_send_low - helper for drivers for management/no-ack frames
3357 *
3358 * Rate control algorithms that agree to use the lowest rate to
3359 * send management frames and NO_ACK data with the respective hw
3360 * retries should use this in the beginning of their mac80211 get_rate
3361 * callback. If true is returned the rate control can simply return.
3362 * If false is returned we guarantee that sta and sta and priv_sta is
3363 * not null.
3364 *
3365 * Rate control algorithms wishing to do more intelligent selection of
3366 * rate for multicast/broadcast frames may choose to not use this.
3367 *
3368 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3369 * that this may be null.
3370 * @priv_sta: private rate control structure. This may be null.
3371 * @txrc: rate control information we sholud populate for mac80211.
3372 */
3373bool rate_control_send_low(struct ieee80211_sta *sta,
3374 void *priv_sta,
3375 struct ieee80211_tx_rate_control *txrc);
3376
3377
Johannes Berg4b7679a2008-09-18 18:14:18 +02003378static inline s8
3379rate_lowest_index(struct ieee80211_supported_band *sband,
3380 struct ieee80211_sta *sta)
3381{
3382 int i;
3383
3384 for (i = 0; i < sband->n_bitrates; i++)
3385 if (rate_supported(sta, sband->band, i))
3386 return i;
3387
3388 /* warn when we cannot find a rate. */
3389 WARN_ON(1);
3390
3391 return 0;
3392}
3393
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07003394static inline
3395bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3396 struct ieee80211_sta *sta)
3397{
3398 unsigned int i;
3399
3400 for (i = 0; i < sband->n_bitrates; i++)
3401 if (rate_supported(sta, sband->band, i))
3402 return true;
3403 return false;
3404}
Johannes Berg4b7679a2008-09-18 18:14:18 +02003405
3406int ieee80211_rate_control_register(struct rate_control_ops *ops);
3407void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3408
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003409static inline bool
3410conf_is_ht20(struct ieee80211_conf *conf)
3411{
Johannes Berg47979382009-01-07 10:13:27 +01003412 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003413}
3414
3415static inline bool
3416conf_is_ht40_minus(struct ieee80211_conf *conf)
3417{
Johannes Berg47979382009-01-07 10:13:27 +01003418 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003419}
3420
3421static inline bool
3422conf_is_ht40_plus(struct ieee80211_conf *conf)
3423{
Johannes Berg47979382009-01-07 10:13:27 +01003424 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003425}
3426
3427static inline bool
3428conf_is_ht40(struct ieee80211_conf *conf)
3429{
3430 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3431}
3432
3433static inline bool
3434conf_is_ht(struct ieee80211_conf *conf)
3435{
Johannes Berg47979382009-01-07 10:13:27 +01003436 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08003437}
3438
Johannes Berg2ca27bc2010-09-16 14:58:23 +02003439static inline enum nl80211_iftype
3440ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3441{
3442 if (p2p) {
3443 switch (type) {
3444 case NL80211_IFTYPE_STATION:
3445 return NL80211_IFTYPE_P2P_CLIENT;
3446 case NL80211_IFTYPE_AP:
3447 return NL80211_IFTYPE_P2P_GO;
3448 default:
3449 break;
3450 }
3451 }
3452 return type;
3453}
3454
3455static inline enum nl80211_iftype
3456ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3457{
3458 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3459}
3460
Meenakshi Venkataraman615f7b92011-07-08 08:46:22 -07003461void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3462 int rssi_min_thold,
3463 int rssi_max_thold);
3464
3465void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
Arik Nemtsov768db342011-09-28 14:12:51 +03003466
3467int ieee80211_add_srates_ie(struct ieee80211_vif *vif, struct sk_buff *skb);
3468
3469int ieee80211_add_ext_srates_ie(struct ieee80211_vif *vif,
3470 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07003471#endif /* MAC80211_H */