blob: de22cbfef23224c6aed205de5179c59644f5384c [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>
19#include <linux/wireless.h>
20#include <linux/device.h>
21#include <linux/ieee80211.h>
Jiri Bencf0706e82007-05-05 11:45:53 -070022#include <net/cfg80211.h>
23
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 Berg6b301cd2007-09-18 17:29:20 -0400100 * struct ieee80211_tx_queue_params - transmit queue configuration
101 *
102 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100103 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400104 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400105 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200106 * @cw_min: minimum contention window [a value of the form
107 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400108 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100109 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Kalle Valo9d173fc2010-01-14 13:09:14 +0200110 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400111 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700112struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200113 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100114 u16 cw_min;
115 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200116 u8 aifs;
Kalle Valoab133152010-01-12 10:42:31 +0200117 bool uapsd;
Jiri Bencf0706e82007-05-05 11:45:53 -0700118};
119
Jiri Bencf0706e82007-05-05 11:45:53 -0700120struct ieee80211_low_level_stats {
121 unsigned int dot11ACKFailureCount;
122 unsigned int dot11RTSFailureCount;
123 unsigned int dot11FCSErrorCount;
124 unsigned int dot11RTSSuccessCount;
125};
126
Johannes Berg471b3ef2007-12-28 14:32:58 +0100127/**
128 * enum ieee80211_bss_change - BSS change notification flags
129 *
130 * These flags are used with the bss_info_changed() callback
131 * to indicate which BSS parameter changed.
132 *
133 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
134 * also implies a change in the AID.
135 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
136 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300137 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700138 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200139 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200140 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200141 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
142 * reason (IBSS and managed mode)
143 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
144 * new beacon (beaconing modes)
145 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
146 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200147 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200148 * @BSS_CHANGED_IBSS: IBSS join status changed
Johannes Berg471b3ef2007-12-28 14:32:58 +0100149 */
150enum ieee80211_bss_change {
151 BSS_CHANGED_ASSOC = 1<<0,
152 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
153 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300154 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700155 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200156 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200157 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200158 BSS_CHANGED_BSSID = 1<<7,
159 BSS_CHANGED_BEACON = 1<<8,
160 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200161 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200162 BSS_CHANGED_IBSS = 1<<11,
Johannes Bergac8dd502010-05-05 09:44:02 +0200163
164 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100165};
166
167/**
168 * struct ieee80211_bss_conf - holds the BSS's changing parameters
169 *
170 * This structure keeps information about a BSS (and an association
171 * to that BSS) that can change during the lifetime of the BSS.
172 *
173 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200174 * @ibss_joined: indicates whether this station is part of an IBSS
175 * or not
Johannes Berg471b3ef2007-12-28 14:32:58 +0100176 * @aid: association ID number, valid only when @assoc is true
177 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200178 * @use_short_preamble: use 802.11b short preamble;
179 * if the hardware cannot handle this it must set the
180 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
181 * @use_short_slot: use short slot time (only relevant for ERP);
182 * if the hardware cannot handle this it must set the
183 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100184 * @dtim_period: num of beacons before the next DTIM, for beaconing,
185 * not valid in station mode (cf. hw conf ps_dtim_period)
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700186 * @timestamp: beacon timestamp
187 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800188 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200189 * @basic_rates: bitmap of basic rates, each bit stands for an
190 * index into the rate table configured by the driver in
191 * the current band.
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200192 * @bssid: The BSSID for this BSS
193 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg0aaffa92010-05-05 15:28:27 +0200194 * @channel_type: Channel type for this BSS -- the hardware might be
195 * configured for HT40+ while this BSS only uses no-HT, for
196 * example.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200197 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
198 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200199 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
200 * implies disabled
201 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Johannes Berg471b3ef2007-12-28 14:32:58 +0100202 */
203struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200204 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100205 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200206 bool assoc, ibss_joined;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100207 u16 aid;
208 /* erp related data */
209 bool use_cts_prot;
210 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300211 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200212 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800213 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700214 u16 beacon_int;
215 u16 assoc_capability;
216 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100217 u32 basic_rates;
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200218 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200219 s32 cqm_rssi_thold;
220 u32 cqm_rssi_hyst;
Johannes Berg0aaffa92010-05-05 15:28:27 +0200221 enum nl80211_channel_type channel_type;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100222};
223
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800224/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700225 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800226 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700227 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800228 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100229 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200230 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
231 * number to this frame, taking care of not overwriting the fragment
232 * number and increasing the sequence number only when the
233 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
234 * assign sequence numbers to QoS-data frames but cannot do so correctly
235 * for non-QoS-data and management frames because beacons need them from
236 * that counter as well and mac80211 cannot guarantee proper sequencing.
237 * If this flag is set, the driver should instruct the hardware to
238 * assign a sequence number to the frame or assign one itself. Cf. IEEE
239 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
240 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200241 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200242 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
243 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200244 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200245 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
246 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200247 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200248 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200249 * because the destination STA was in powersave mode. Note that to
250 * avoid race conditions, the filter must be set by the hardware or
251 * firmware upon receiving a frame that indicates that the station
252 * went to sleep (must be done on device to filter frames already on
253 * the queue) and may only be unset after mac80211 gives the OK for
254 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
255 * since only then is it guaranteed that no more frames are in the
256 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200257 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
258 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
259 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300260 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
261 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200262 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
263 * set by rate control algorithms to indicate probe rate, will
264 * be cleared for fragmented frames (except on the last fragment)
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100265 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
266 * used to indicate that a pending frame requires TX processing before
267 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200268 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
269 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200270 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
271 * used to indicate frame should not be encrypted
Johannes Berg3fa52052009-07-24 13:23:09 +0200272 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
273 * This frame is a response to a PS-poll frame and should be sent
274 * although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200275 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
276 * transmit function after the current frame, this can be used
277 * by drivers to kick the DMA queue only if unset or when the
278 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100279 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
280 * after TX status because the destination was asleep, it must not
281 * be modified again (no seqno assignment, crypto, etc.)
Felix Fietkau17ad3532010-01-31 21:56:25 +0100282 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
283 * has a radiotap header at skb->data.
Jouni Malinen026331c2010-02-15 12:53:10 +0200284 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
285 * MLME command (internal to mac80211 to figure out whether to send TX
286 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400287 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200288 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
289 * frame and selects the maximum number of streams that it can use.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800290 */
291enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200292 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200293 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
294 IEEE80211_TX_CTL_NO_ACK = BIT(2),
295 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
296 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
297 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
298 IEEE80211_TX_CTL_AMPDU = BIT(6),
299 IEEE80211_TX_CTL_INJECTED = BIT(7),
300 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
301 IEEE80211_TX_STAT_ACK = BIT(9),
302 IEEE80211_TX_STAT_AMPDU = BIT(10),
303 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
304 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100305 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200306 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200307 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200308 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200309 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100310 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Felix Fietkau17ad3532010-01-31 21:56:25 +0100311 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200312 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400313 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200314 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
315#define IEEE80211_TX_CTL_STBC_SHIFT 23
Johannes Berge6a98542008-10-21 12:40:02 +0200316};
317
Sujith2134e7e2009-01-22 09:00:52 +0530318/**
319 * enum mac80211_rate_control_flags - per-rate flags set by the
320 * Rate Control algorithm.
321 *
322 * These flags are set by the Rate control algorithm for each rate during tx,
323 * in the @flags member of struct ieee80211_tx_rate.
324 *
325 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
326 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
327 * This is set if the current BSS requires ERP protection.
328 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
329 * @IEEE80211_TX_RC_MCS: HT rate.
330 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
331 * Greenfield mode.
332 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
333 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
334 * adjacent 20 MHz channels, if the current channel type is
335 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
336 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
337 */
Johannes Berge6a98542008-10-21 12:40:02 +0200338enum mac80211_rate_control_flags {
339 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
340 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
341 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
342
343 /* rate index is an MCS rate number instead of an index */
344 IEEE80211_TX_RC_MCS = BIT(3),
345 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
346 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
347 IEEE80211_TX_RC_DUP_DATA = BIT(6),
348 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800349};
350
Johannes Berge039fa42008-05-15 12:55:29 +0200351
Johannes Berge6a98542008-10-21 12:40:02 +0200352/* there are 40 bytes if you don't need the rateset to be kept */
353#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200354
Johannes Berge6a98542008-10-21 12:40:02 +0200355/* if you do need the rateset, then you have less space */
356#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
357
358/* maximum number of rate stages */
359#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200360
361/**
Johannes Berge6a98542008-10-21 12:40:02 +0200362 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200363 *
Johannes Berge6a98542008-10-21 12:40:02 +0200364 * @idx: rate index to attempt to send with
365 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200366 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200367 *
368 * A value of -1 for @idx indicates an invalid rate and, if used
369 * in an array of retry rates, that no more rates should be tried.
370 *
371 * When used for transmit status reporting, the driver should
372 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200373 *
374 * &struct ieee80211_tx_info contains an array of these structs
375 * in the control information, and it will be filled by the rate
376 * control algorithm according to what should be sent. For example,
377 * if this array contains, in the format { <idx>, <count> } the
378 * information
379 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
380 * then this means that the frame should be transmitted
381 * up to twice at rate 3, up to twice at rate 2, and up to four
382 * times at rate 1 if it doesn't get acknowledged. Say it gets
383 * acknowledged by the peer after the fifth attempt, the status
384 * information should then contain
385 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
386 * since it was transmitted twice at rate 3, twice at rate 2
387 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200388 */
Johannes Berge6a98542008-10-21 12:40:02 +0200389struct ieee80211_tx_rate {
390 s8 idx;
391 u8 count;
392 u8 flags;
Felix Fietkau48212772008-11-03 21:05:01 +0100393} __attribute__((packed));
Felix Fietkau870abdf2008-10-05 18:04:24 +0200394
Johannes Berge039fa42008-05-15 12:55:29 +0200395/**
396 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200397 *
Johannes Berge039fa42008-05-15 12:55:29 +0200398 * This structure is placed in skb->cb for three uses:
399 * (1) mac80211 TX control - mac80211 tells the driver what to do
400 * (2) driver internal use (if applicable)
401 * (3) TX status information - driver tells mac80211 what happened
402 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200403 * The TX control's sta pointer is only valid during the ->tx call,
404 * it may be NULL.
405 *
Johannes Berge039fa42008-05-15 12:55:29 +0200406 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200407 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200408 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200409 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700410 * @control: union for control data
411 * @status: union for status data
412 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100413 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700414 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200415 * @ampdu_ack_map: block ack bit map for the aggregation.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700416 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100417 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700418 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200419 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200420 */
Johannes Berge039fa42008-05-15 12:55:29 +0200421struct ieee80211_tx_info {
422 /* common information */
423 u32 flags;
424 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200425
Johannes Berge039fa42008-05-15 12:55:29 +0200426 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100427
Johannes Berge6a98542008-10-21 12:40:02 +0200428 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500429 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100430
Johannes Berge039fa42008-05-15 12:55:29 +0200431 union {
432 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200433 union {
434 /* rate control */
435 struct {
436 struct ieee80211_tx_rate rates[
437 IEEE80211_TX_MAX_RATES];
438 s8 rts_cts_rate_idx;
439 };
440 /* only needed before rate control */
441 unsigned long jiffies;
442 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200443 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200444 struct ieee80211_vif *vif;
445 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200446 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200447 } control;
448 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200449 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
450 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200451 u64 ampdu_ack_map;
452 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100453 u8 ampdu_len;
454 /* 7 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200455 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200456 struct {
457 struct ieee80211_tx_rate driver_rates[
458 IEEE80211_TX_MAX_RATES];
459 void *rate_driver_data[
460 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
461 };
462 void *driver_data[
463 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200464 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700465};
466
Johannes Berge039fa42008-05-15 12:55:29 +0200467static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
468{
469 return (struct ieee80211_tx_info *)skb->cb;
470}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400471
Johannes Bergf1d58c22009-06-17 13:13:00 +0200472static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
473{
474 return (struct ieee80211_rx_status *)skb->cb;
475}
476
Johannes Berge6a98542008-10-21 12:40:02 +0200477/**
478 * ieee80211_tx_info_clear_status - clear TX status
479 *
480 * @info: The &struct ieee80211_tx_info to be cleared.
481 *
482 * When the driver passes an skb back to mac80211, it must report
483 * a number of things in TX status. This function clears everything
484 * in the TX status but the rate control information (it does clear
485 * the count since you need to fill that in anyway).
486 *
487 * NOTE: You can only use this function if you do NOT use
488 * info->driver_data! Use info->rate_driver_data
489 * instead if you need only the less space that allows.
490 */
491static inline void
492ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
493{
494 int i;
495
496 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
497 offsetof(struct ieee80211_tx_info, control.rates));
498 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
499 offsetof(struct ieee80211_tx_info, driver_rates));
500 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
501 /* clear the rate counts */
502 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
503 info->status.rates[i].count = 0;
504
505 BUILD_BUG_ON(
506 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
507 memset(&info->status.ampdu_ack_len, 0,
508 sizeof(struct ieee80211_tx_info) -
509 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
510}
511
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400512
513/**
514 * enum mac80211_rx_flags - receive flags
515 *
516 * These flags are used with the @flag member of &struct ieee80211_rx_status.
517 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
518 * Use together with %RX_FLAG_MMIC_STRIPPED.
519 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400520 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
521 * verification has been done by the hardware.
522 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
523 * If this flag is set, the stack cannot do any replay detection
524 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400525 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
526 * the frame.
527 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
528 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100529 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900530 * is valid. This is useful in monitor mode and necessary for beacon frames
531 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200532 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200533 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
534 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
535 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg8c0c7092009-11-25 17:46:15 +0100536 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
537 * on cooked monitor to avoid double-reporting it for multiple
538 * virtual interfaces
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400539 */
540enum mac80211_rx_flags {
541 RX_FLAG_MMIC_ERROR = 1<<0,
542 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400543 RX_FLAG_MMIC_STRIPPED = 1<<3,
544 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400545 RX_FLAG_FAILED_FCS_CRC = 1<<5,
546 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100547 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200548 RX_FLAG_SHORTPRE = 1<<8,
549 RX_FLAG_HT = 1<<9,
550 RX_FLAG_40MHZ = 1<<10,
551 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg8c0c7092009-11-25 17:46:15 +0100552 RX_FLAG_INTERNAL_CMTR = 1<<12,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400553};
554
555/**
556 * struct ieee80211_rx_status - receive status
557 *
558 * The low-level driver should provide this information (the subset
559 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200560 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200561 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900562 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
563 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100564 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400565 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200566 * @signal: signal strength when receiving this frame, either in dBm, in dB or
567 * unspecified depending on the hardware capabilities flags
568 * @IEEE80211_HW_SIGNAL_*
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400569 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200570 * @rate_idx: index of data rate into band's supported rates or MCS index if
571 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400572 * @flag: %RX_FLAG_*
573 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700574struct ieee80211_rx_status {
575 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100576 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400577 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400578 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700579 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100580 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700581 int flag;
582};
583
Johannes Berg6b301cd2007-09-18 17:29:20 -0400584/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400585 * enum ieee80211_conf_flags - configuration flags
586 *
587 * Flags to define PHY configuration options
588 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100589 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
590 * to determine for example whether to calculate timestamps for packets
591 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200592 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
593 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
594 * meaning that the hardware still wakes up for beacons, is able to
595 * transmit frames and receive the possible acknowledgment frames.
596 * Not to be confused with hardware specific wakeup/sleep states,
597 * driver is responsible for that. See the section "Powersave support"
598 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200599 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
600 * the driver should be prepared to handle configuration requests but
601 * may turn the device off as much as possible. Typically, this flag will
602 * be set when an interface is set UP but not associated or scanning, but
603 * it can also be unset in that case when monitor interfaces are active.
Stanislaw Gruszkae1b3ec12010-03-29 12:18:34 +0200604 * @IEEE80211_CONF_QOS: Enable 802.11e QoS also know as WMM (Wireless
605 * Multimedia). On some drivers (iwlwifi is one of know) we have
606 * to enable/disable QoS explicitly.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400607 */
608enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100609 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200610 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200611 IEEE80211_CONF_IDLE = (1<<2),
Stanislaw Gruszkae1b3ec12010-03-29 12:18:34 +0200612 IEEE80211_CONF_QOS = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400613};
Jiri Bencf0706e82007-05-05 11:45:53 -0700614
Johannes Berg7a5158e2008-10-08 10:59:33 +0200615
Jiri Bencf0706e82007-05-05 11:45:53 -0700616/**
Johannes Berge8975582008-10-09 12:18:51 +0200617 * enum ieee80211_conf_changed - denotes which configuration changed
618 *
Johannes Berge8975582008-10-09 12:18:51 +0200619 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100620 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200621 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200622 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100623 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200624 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200625 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100626 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Stanislaw Gruszka80725f42010-04-20 08:16:37 +0200627 * @IEEE80211_CONF_CHANGE_QOS: Quality of service was enabled or disabled
Johannes Berge8975582008-10-09 12:18:51 +0200628 */
629enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100630 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200631 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100632 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200633 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200634 IEEE80211_CONF_CHANGE_POWER = BIT(5),
635 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
636 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200637 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Stanislaw Gruszkae1b3ec12010-03-29 12:18:34 +0200638 IEEE80211_CONF_CHANGE_QOS = BIT(9),
Johannes Berge8975582008-10-09 12:18:51 +0200639};
640
641/**
Johannes Berg0f782312009-12-01 13:37:02 +0100642 * enum ieee80211_smps_mode - spatial multiplexing power save mode
643 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200644 * @IEEE80211_SMPS_AUTOMATIC: automatic
645 * @IEEE80211_SMPS_OFF: off
646 * @IEEE80211_SMPS_STATIC: static
647 * @IEEE80211_SMPS_DYNAMIC: dynamic
648 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100649 */
650enum ieee80211_smps_mode {
651 IEEE80211_SMPS_AUTOMATIC,
652 IEEE80211_SMPS_OFF,
653 IEEE80211_SMPS_STATIC,
654 IEEE80211_SMPS_DYNAMIC,
655
656 /* keep last */
657 IEEE80211_SMPS_NUM_MODES,
658};
659
660/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700661 * struct ieee80211_conf - configuration of the device
662 *
663 * This struct indicates how the driver shall configure the hardware.
664 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200665 * @flags: configuration flags defined above
666 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800667 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200668 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200669 * before checking the beacon for a TIM bit (managed mode only); this
670 * value will be only achievable between DTIM frames, the hardware
671 * needs to check for the multicast traffic bit in DTIM beacons.
672 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100673 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
674 * in power saving. Power saving will not be enabled until a beacon
675 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200676 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
677 * powersave documentation below. This variable is valid only when
678 * the CONF_PS flag is set.
Juuso Oikarinen195e2942010-04-27 12:47:40 +0300679 * @dynamic_ps_forced_timeout: The dynamic powersave timeout (in ms) configured
680 * by cfg80211 (essentially, wext) If set, this value overrules the value
681 * chosen by mac80211 based on ps qos network latency.
Johannes Berg04fe2032009-04-22 18:44:37 +0200682 *
Johannes Berg8318d782008-01-24 19:38:38 +0100683 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200684 *
Johannes Berg8318d782008-01-24 19:38:38 +0100685 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100686 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200687 *
Johannes Berg9124b072008-10-14 19:17:54 +0200688 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
689 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
690 * but actually means the number of transmissions not the number of retries
691 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
692 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
693 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100694 *
695 * @smps_mode: spatial multiplexing powersave mode; note that
696 * %IEEE80211_SMPS_STATIC is used when the device is not
697 * configured for an HT channel
Jiri Bencf0706e82007-05-05 11:45:53 -0700698 */
699struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400700 u32 flags;
Juuso Oikarinen195e2942010-04-27 12:47:40 +0300701 int power_level, dynamic_ps_timeout, dynamic_ps_forced_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200702 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200703
Johannes Berge8975582008-10-09 12:18:51 +0200704 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +0100705 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +0200706
Johannes Berg9124b072008-10-14 19:17:54 +0200707 u8 long_frame_max_tx_count, short_frame_max_tx_count;
708
Johannes Berg8318d782008-01-24 19:38:38 +0100709 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100710 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100711 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -0700712};
713
714/**
Johannes Berg5ce6e432010-05-11 16:20:57 +0200715 * struct ieee80211_channel_switch - holds the channel switch data
716 *
717 * The information provided in this structure is required for channel switch
718 * operation.
719 *
720 * @timestamp: value in microseconds of the 64-bit Time Synchronization
721 * Function (TSF) timer when the frame containing the channel switch
722 * announcement was received. This is simply the rx.mactime parameter
723 * the driver passed into mac80211.
724 * @block_tx: Indicates whether transmission must be blocked before the
725 * scheduled channel switch, as indicated by the AP.
726 * @channel: the new channel to switch to
727 * @count: the number of TBTT's until the channel switch event
728 */
729struct ieee80211_channel_switch {
730 u64 timestamp;
731 bool block_tx;
732 struct ieee80211_channel *channel;
733 u8 count;
734};
735
736/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100737 * struct ieee80211_vif - per-interface data
738 *
739 * Data in this structure is continually present for driver
740 * use during the life of a virtual interface.
741 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100742 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200743 * @bss_conf: BSS configuration for this interface, either our own
744 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100745 * @addr: address of this interface
Johannes Berg32bfd352007-12-19 01:31:26 +0100746 * @drv_priv: data area for driver use, will always be aligned to
747 * sizeof(void *).
748 */
749struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200750 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200751 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100752 u8 addr[ETH_ALEN];
Johannes Berg32bfd352007-12-19 01:31:26 +0100753 /* must be last */
754 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
755};
756
Johannes Berg902acc72008-02-23 15:17:19 +0100757static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
758{
759#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200760 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100761#endif
762 return false;
763}
764
Johannes Berg32bfd352007-12-19 01:31:26 +0100765/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400766 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400767 * @ALG_WEP: WEP40 or WEP104
768 * @ALG_TKIP: TKIP
769 * @ALG_CCMP: CCMP (AES)
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +0200770 * @ALG_AES_CMAC: AES-128-CMAC
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400771 */
Johannes Bergea49c352007-09-18 17:29:21 -0400772enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400773 ALG_WEP,
774 ALG_TKIP,
775 ALG_CCMP,
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +0200776 ALG_AES_CMAC,
Johannes Bergea49c352007-09-18 17:29:21 -0400777};
Jiri Bencf0706e82007-05-05 11:45:53 -0700778
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300779/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400780 * enum ieee80211_key_flags - key flags
781 *
782 * These flags are used for communication about keys between the driver
783 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
784 *
785 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
786 * that the STA this key will be used with could be using QoS.
787 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
788 * driver to indicate that it requires IV generation for this
789 * particular key.
790 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
791 * the driver for a TKIP key if it requires Michael MIC
792 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200793 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
794 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200795 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
796 * CCMP key if it requires CCMP encryption of management frames (MFP) to
797 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400798 */
799enum ieee80211_key_flags {
800 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
801 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
802 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200803 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200804 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400805};
806
807/**
808 * struct ieee80211_key_conf - key information
809 *
810 * This key information is given by mac80211 to the driver by
811 * the set_key() callback in &struct ieee80211_ops.
812 *
813 * @hw_key_idx: To be set by the driver, this is the key index the driver
814 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400815 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400816 * @alg: The key algorithm.
817 * @flags: key flags, see &enum ieee80211_key_flags.
Randy Dunlap4e8998f2010-05-21 11:28:33 -0700818 * @ap_addr: AP's MAC address
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400819 * @keyidx: the key index (0-3)
820 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400821 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
822 * data block:
823 * - Temporal Encryption Key (128 bits)
824 * - Temporal Authenticator Tx MIC Key (64 bits)
825 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100826 * @icv_len: The ICV length for this key type
827 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400828 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700829struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400830 enum ieee80211_key_alg alg;
Felix Fietkau76708de2008-10-05 18:02:48 +0200831 u8 icv_len;
832 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400833 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400834 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400835 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400836 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700837 u8 key[0];
838};
839
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400840/**
841 * enum set_key_cmd - key command
842 *
843 * Used with the set_key() callback in &struct ieee80211_ops, this
844 * indicates whether a key is being removed or added.
845 *
846 * @SET_KEY: a key is set
847 * @DISABLE_KEY: a key must be disabled
848 */
Johannes Bergea49c352007-09-18 17:29:21 -0400849enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400850 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400851};
Jiri Bencf0706e82007-05-05 11:45:53 -0700852
Tomas Winkler478f8d22007-09-30 13:52:37 +0200853/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200854 * struct ieee80211_sta - station table entry
855 *
856 * A station table entry represents a station we are possibly
857 * communicating with. Since stations are RCU-managed in
858 * mac80211, any ieee80211_sta pointer you get access to must
859 * either be protected by rcu_read_lock() explicitly or implicitly,
860 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +0100861 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +0200862 *
863 * @addr: MAC address
864 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200865 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200866 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200867 * @drv_priv: data area for driver use, will always be aligned to
868 * sizeof(void *), size is determined in hw information.
869 */
870struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100871 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200872 u8 addr[ETH_ALEN];
873 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200874 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200875
876 /* must be last */
877 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
878};
879
880/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200881 * enum sta_notify_cmd - sta notify command
882 *
883 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Christian Lamparter89fad572008-12-09 16:28:06 +0100884 * indicates addition and removal of a station to station table,
885 * or if a associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200886 *
Johannes Berg34e89502010-02-03 13:59:58 +0100887 * @STA_NOTIFY_ADD: (DEPRECATED) a station was added to the station table
888 * @STA_NOTIFY_REMOVE: (DEPRECATED) a station being removed from the station table
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100889 * @STA_NOTIFY_SLEEP: a station is now sleeping
890 * @STA_NOTIFY_AWAKE: a sleeping station woke up
891 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100892enum sta_notify_cmd {
893 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100894 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
895};
896
897/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200898 * enum ieee80211_tkip_key_type - get tkip key
899 *
900 * Used by drivers which need to get a tkip key for skb. Some drivers need a
901 * phase 1 key, others need a phase 2 key. A single function allows the driver
902 * to get the key, this enum indicates what type of key is required.
903 *
904 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
905 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
906 */
907enum ieee80211_tkip_key_type {
908 IEEE80211_TKIP_P1_KEY,
909 IEEE80211_TKIP_P2_KEY,
910};
911
912/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400913 * enum ieee80211_hw_flags - hardware flags
914 *
915 * These flags are used to indicate hardware capabilities to
916 * the stack. Generally, flags here should have their meaning
917 * done in a way that the simplest hardware doesn't need setting
918 * any particular flags. There are some exceptions to this rule,
919 * however, so you are advised to review these flags carefully.
920 *
Johannes Bergaf65cd962009-11-17 18:18:36 +0100921 * @IEEE80211_HW_HAS_RATE_CONTROL:
922 * The hardware or firmware includes rate control, and cannot be
923 * controlled by the stack. As such, no rate control algorithm
924 * should be instantiated, and the TX rate reported to userspace
925 * will be taken from the TX status instead of the rate control
926 * algorithm.
927 * Note that this requires that the driver implement a number of
928 * callbacks so it has the correct information, it needs to have
929 * the @set_rts_threshold callback and must look at the BSS config
930 * @use_cts_prot for G/N protection, @use_short_slot for slot
931 * timing in 2.4 GHz and @use_short_preamble for preambles for
932 * CCK frames.
933 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400934 * @IEEE80211_HW_RX_INCLUDES_FCS:
935 * Indicates that received frames passed to the stack include
936 * the FCS at the end.
937 *
938 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
939 * Some wireless LAN chipsets buffer broadcast/multicast frames
940 * for power saving stations in the hardware/firmware and others
941 * rely on the host system for such buffering. This option is used
942 * to configure the IEEE 802.11 upper layer to buffer broadcast and
943 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -0700944 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400945 *
Johannes Berg8318d782008-01-24 19:38:38 +0100946 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
947 * Hardware is not capable of short slot operation on the 2.4 GHz band.
948 *
949 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
950 * Hardware is not capable of receiving frames with short preamble on
951 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200952 *
953 * @IEEE80211_HW_SIGNAL_UNSPEC:
954 * Hardware can provide signal values but we don't know its units. We
955 * expect values between 0 and @max_signal.
956 * If possible please provide dB or dBm instead.
957 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200958 * @IEEE80211_HW_SIGNAL_DBM:
959 * Hardware gives signal values in dBm, decibel difference from
960 * one milliwatt. This is the preferred method since it is standardized
961 * between different devices. @max_signal does not need to be set.
962 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300963 * @IEEE80211_HW_SPECTRUM_MGMT:
964 * Hardware supports spectrum management defined in 802.11h
965 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +0530966 *
967 * @IEEE80211_HW_AMPDU_AGGREGATION:
968 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +0200969 *
Johannes Berg4be8c382009-01-07 18:28:20 +0100970 * @IEEE80211_HW_SUPPORTS_PS:
971 * Hardware has power save support (i.e. can go to sleep).
972 *
973 * @IEEE80211_HW_PS_NULLFUNC_STACK:
974 * Hardware requires nullfunc frame handling in stack, implies
975 * stack support for dynamic PS.
976 *
977 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
978 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +0200979 *
980 * @IEEE80211_HW_MFP_CAPABLE:
981 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +0200982 *
983 * @IEEE80211_HW_BEACON_FILTER:
984 * Hardware supports dropping of irrelevant beacon frames to
985 * avoid waking up cpu.
Johannes Berg0f782312009-12-01 13:37:02 +0100986 *
987 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
988 * Hardware supports static spatial multiplexing powersave,
989 * ie. can turn off all but one chain even on HT connections
990 * that should be using more chains.
991 *
992 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
993 * Hardware supports dynamic spatial multiplexing powersave,
994 * ie. can turn off all but one chain and then wake the rest
995 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +0200996 *
997 * @IEEE80211_HW_SUPPORTS_UAPSD:
998 * Hardware supports Unscheduled Automatic Power Save Delivery
999 * (U-APSD) in managed mode. The mode is configured with
1000 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301001 *
1002 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1003 * Hardware can provide ack status reports of Tx frames to
1004 * the stack.
1005 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001006 * @IEEE80211_HW_CONNECTION_MONITOR:
1007 * The hardware performs its own connection monitoring, including
1008 * periodic keep-alives to the AP and probing the AP on beacon loss.
1009 * When this flag is set, signaling beacon-loss will cause an immediate
1010 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001011 *
1012 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1013 * Hardware can do connection quality monitoring - i.e. it can monitor
1014 * connection quality related parameters, such as the RSSI level and
1015 * provide notifications if configured trigger levels are reached.
1016 *
Johannes Berg1bc08262007-09-18 17:29:15 -04001017 */
1018enum ieee80211_hw_flags {
Johannes Bergaf65cd962009-11-17 18:18:36 +01001019 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001020 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1021 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001022 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1023 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001024 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001025 IEEE80211_HW_SIGNAL_DBM = 1<<6,
John W. Linvillef5c044e2010-04-30 15:37:00 -04001026 /* use this hole */
Johannes Berg7fee5372009-01-30 11:13:06 +01001027 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1028 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1029 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1030 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1031 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1032 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +02001033 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001034 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1035 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001036 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301037 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001038 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001039 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
Johannes Berg1bc08262007-09-18 17:29:15 -04001040};
1041
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001042/**
1043 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001044 *
1045 * This structure contains the configuration and hardware
1046 * information for an 802.11 PHY.
1047 *
1048 * @wiphy: This points to the &struct wiphy allocated for this
1049 * 802.11 PHY. You must fill in the @perm_addr and @dev
1050 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001051 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1052 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001053 *
1054 * @conf: &struct ieee80211_conf, device configuration, don't use.
1055 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001056 * @priv: pointer to private area that was allocated for driver use
1057 * along with this structure.
1058 *
1059 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1060 *
1061 * @extra_tx_headroom: headroom to reserve in each transmit skb
1062 * for use by the driver (e.g. for transmit headers.)
1063 *
1064 * @channel_change_time: time (in microseconds) it takes to change channels.
1065 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001066 * @max_signal: Maximum value for signal (rssi) in RX information, used
1067 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001068 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001069 * @max_listen_interval: max listen interval in units of beacon interval
1070 * that HW supports
1071 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001072 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001073 * data packets. WMM/QoS requires at least four, these
1074 * queues need to have configurable access parameters.
1075 *
Johannes Berg830f9032007-10-28 14:51:05 +01001076 * @rate_control_algorithm: rate control algorithm for this hardware.
1077 * If unset (NULL), the default algorithm will be used. Must be
1078 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001079 *
1080 * @vif_data_size: size (in bytes) of the drv_priv data area
1081 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001082 * @sta_data_size: size (in bytes) of the drv_priv data area
1083 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001084 *
Johannes Berge6a98542008-10-21 12:40:02 +02001085 * @max_rates: maximum number of alternate rate retry stages
1086 * @max_rate_tries: maximum number of tries for each stage
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001087 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001088struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07001089 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001090 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001091 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07001092 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001093 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -07001094 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -07001095 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001096 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001097 int sta_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001098 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001099 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07001100 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001101 u8 max_rates;
1102 u8 max_rate_tries;
Jiri Bencf0706e82007-05-05 11:45:53 -07001103};
1104
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001105/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001106 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1107 *
1108 * @wiphy: the &struct wiphy which we want to query
1109 *
1110 * mac80211 drivers can use this to get to their respective
1111 * &struct ieee80211_hw. Drivers wishing to get to their own private
1112 * structure can then access it via hw->priv. Note that mac802111 drivers should
1113 * not use wiphy_priv() to try to get their private driver structure as this
1114 * is already used internally by mac80211.
1115 */
1116struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1117
1118/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001119 * SET_IEEE80211_DEV - set device for 802.11 hardware
1120 *
1121 * @hw: the &struct ieee80211_hw to set the device for
1122 * @dev: the &struct device of this 802.11 device
1123 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001124static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1125{
1126 set_wiphy_dev(hw->wiphy, dev);
1127}
1128
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001129/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001130 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001131 *
1132 * @hw: the &struct ieee80211_hw to set the MAC address for
1133 * @addr: the address to set
1134 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001135static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1136{
1137 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1138}
1139
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001140static inline struct ieee80211_rate *
1141ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001142 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001143{
Johannes Berge6a98542008-10-21 12:40:02 +02001144 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001145 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001146 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001147}
1148
1149static inline struct ieee80211_rate *
1150ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001151 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001152{
Johannes Berge039fa42008-05-15 12:55:29 +02001153 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001154 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001155 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001156}
1157
1158static inline struct ieee80211_rate *
1159ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001160 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001161{
Johannes Berge6a98542008-10-21 12:40:02 +02001162 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001163 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001164 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001165}
1166
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001167/**
1168 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001169 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001170 * mac80211 is capable of taking advantage of many hardware
1171 * acceleration designs for encryption and decryption operations.
1172 *
1173 * The set_key() callback in the &struct ieee80211_ops for a given
1174 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001175 * decryption. The callback takes a @sta parameter that will be NULL
1176 * for default keys or keys used for transmission only, or point to
1177 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001178 * Multiple transmission keys with the same key index may be used when
1179 * VLANs are configured for an access point.
1180 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001181 * When transmitting, the TX control data will use the @hw_key_idx
1182 * selected by the driver by modifying the &struct ieee80211_key_conf
1183 * pointed to by the @key parameter to the set_key() function.
1184 *
1185 * The set_key() call for the %SET_KEY command should return 0 if
1186 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1187 * added; if you return 0 then hw_key_idx must be assigned to the
1188 * hardware key index, you are free to use the full u8 range.
1189 *
1190 * When the cmd is %DISABLE_KEY then it must succeed.
1191 *
1192 * Note that it is permissible to not decrypt a frame even if a key
1193 * for it has been uploaded to hardware, the stack will not make any
1194 * decision based on whether a key has been uploaded or not but rather
1195 * based on the receive flags.
1196 *
1197 * The &struct ieee80211_key_conf structure pointed to by the @key
1198 * parameter is guaranteed to be valid until another call to set_key()
1199 * removes it, but it can only be used as a cookie to differentiate
1200 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001201 *
1202 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1203 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1204 * handler.
1205 * The update_tkip_key() call updates the driver with the new phase 1 key.
1206 * This happens everytime the iv16 wraps around (every 65536 packets). The
1207 * set_key() call will happen only once for each key (unless the AP did
1208 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001209 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001210 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001211 */
Johannes Berg4150c572007-09-17 01:29:23 -04001212
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001213/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001214 * DOC: Powersave support
1215 *
1216 * mac80211 has support for various powersave implementations.
1217 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001218 * First, it can support hardware that handles all powersaving by itself,
1219 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1220 * flag. In that case, it will be told about the desired powersave mode
1221 * with the %IEEE80211_CONF_PS flag depending on the association status.
1222 * The hardware must take care of sending nullfunc frames when necessary,
1223 * i.e. when entering and leaving powersave mode. The hardware is required
1224 * to look at the AID in beacons and signal to the AP that it woke up when
1225 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001226 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001227 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1228 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1229 * with hardware wakeup and sleep states. Driver is responsible for waking
1230 * up the hardware before issueing commands to the hardware and putting it
1231 * back to sleep at approriate times.
1232 *
1233 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1234 * buffered multicast/broadcast frames after the beacon. Also it must be
1235 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001236 *
1237 * Other hardware designs cannot send nullfunc frames by themselves and also
1238 * need software support for parsing the TIM bitmap. This is also supported
1239 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1240 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001241 * required to pass up beacons. The hardware is still required to handle
1242 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001243 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001244 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001245 * Dynamic powersave is an extension to normal powersave in which the
1246 * hardware stays awake for a user-specified period of time after sending a
1247 * frame so that reply frames need not be buffered and therefore delayed to
1248 * the next wakeup. It's compromise of getting good enough latency when
1249 * there's data traffic and still saving significantly power in idle
1250 * periods.
1251 *
1252 * Dynamic powersave is supported by simply mac80211 enabling and disabling
1253 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1254 * flag and mac80211 will handle everything automatically. Additionally,
1255 * hardware having support for the dynamic PS feature may set the
1256 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1257 * dynamic PS mode itself. The driver needs to look at the
1258 * @dynamic_ps_timeout hardware configuration value and use it that value
1259 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1260 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1261 * enabled whenever user has enabled powersave.
1262 *
1263 * Driver informs U-APSD client support by enabling
1264 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1265 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1266 * Nullfunc frames and stay awake until the service period has ended. To
1267 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1268 * from that AC are transmitted with powersave enabled.
1269 *
1270 * Note: U-APSD client mode is not yet supported with
1271 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001272 */
1273
1274/**
Kalle Valo04de8382009-03-22 21:57:35 +02001275 * DOC: Beacon filter support
1276 *
1277 * Some hardware have beacon filter support to reduce host cpu wakeups
1278 * which will reduce system power consumption. It usuallly works so that
1279 * the firmware creates a checksum of the beacon but omits all constantly
1280 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1281 * beacon is forwarded to the host, otherwise it will be just dropped. That
1282 * way the host will only receive beacons where some relevant information
1283 * (for example ERP protection or WMM settings) have changed.
1284 *
Johannes Berg955394c2009-04-16 17:04:25 +02001285 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1286 * hardware capability. The driver needs to enable beacon filter support
1287 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1288 * power save is enabled, the stack will not check for beacon loss and the
1289 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1290 *
1291 * The time (or number of beacons missed) until the firmware notifies the
1292 * driver of a beacon loss event (which in turn causes the driver to call
1293 * ieee80211_beacon_loss()) should be configurable and will be controlled
1294 * by mac80211 and the roaming algorithm in the future.
1295 *
1296 * Since there may be constantly changing information elements that nothing
1297 * in the software stack cares about, we will, in the future, have mac80211
1298 * tell the driver which information elements are interesting in the sense
1299 * that we want to see changes in them. This will include
1300 * - a list of information element IDs
1301 * - a list of OUIs for the vendor information element
1302 *
1303 * Ideally, the hardware would filter out any beacons without changes in the
1304 * requested elements, but if it cannot support that it may, at the expense
1305 * of some efficiency, filter out only a subset. For example, if the device
1306 * doesn't support checking for OUIs it should pass up all changes in all
1307 * vendor information elements.
1308 *
1309 * Note that change, for the sake of simplification, also includes information
1310 * elements appearing or disappearing from the beacon.
1311 *
1312 * Some hardware supports an "ignore list" instead, just make sure nothing
1313 * that was requested is on the ignore list, and include commonly changing
1314 * information element IDs in the ignore list, for example 11 (BSS load) and
1315 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1316 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1317 * it could also include some currently unused IDs.
1318 *
1319 *
1320 * In addition to these capabilities, hardware should support notifying the
1321 * host of changes in the beacon RSSI. This is relevant to implement roaming
1322 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1323 * the received data packets). This can consist in notifying the host when
1324 * the RSSI changes significantly or when it drops below or rises above
1325 * configurable thresholds. In the future these thresholds will also be
1326 * configured by mac80211 (which gets them from userspace) to implement
1327 * them as the roaming algorithm requires.
1328 *
1329 * If the hardware cannot implement this, the driver should ask it to
1330 * periodically pass beacon frames to the host so that software can do the
1331 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001332 */
1333
1334/**
Johannes Berg0f782312009-12-01 13:37:02 +01001335 * DOC: Spatial multiplexing power save
1336 *
1337 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1338 * power in an 802.11n implementation. For details on the mechanism
1339 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1340 * "11.2.3 SM power save".
1341 *
1342 * The mac80211 implementation is capable of sending action frames
1343 * to update the AP about the station's SMPS mode, and will instruct
1344 * the driver to enter the specific mode. It will also announce the
1345 * requested SMPS mode during the association handshake. Hardware
1346 * support for this feature is required, and can be indicated by
1347 * hardware flags.
1348 *
1349 * The default mode will be "automatic", which nl80211/cfg80211
1350 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1351 * turned off otherwise.
1352 *
1353 * To support this feature, the driver must set the appropriate
1354 * hardware support flags, and handle the SMPS flag to the config()
1355 * operation. It will then with this mechanism be instructed to
1356 * enter the requested SMPS mode while associated to an HT AP.
1357 */
1358
1359/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001360 * DOC: Frame filtering
1361 *
1362 * mac80211 requires to see many management frames for proper
1363 * operation, and users may want to see many more frames when
1364 * in monitor mode. However, for best CPU usage and power consumption,
1365 * having as few frames as possible percolate through the stack is
1366 * desirable. Hence, the hardware should filter as much as possible.
1367 *
1368 * To achieve this, mac80211 uses filter flags (see below) to tell
1369 * the driver's configure_filter() function which frames should be
1370 * passed to mac80211 and which should be filtered out.
1371 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001372 * Before configure_filter() is invoked, the prepare_multicast()
1373 * callback is invoked with the parameters @mc_count and @mc_list
1374 * for the combined multicast address list of all virtual interfaces.
1375 * It's use is optional, and it returns a u64 that is passed to
1376 * configure_filter(). Additionally, configure_filter() has the
1377 * arguments @changed_flags telling which flags were changed and
1378 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001379 *
1380 * If your device has no multicast address filters your driver will
1381 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1382 * parameter to see whether multicast frames should be accepted
1383 * or dropped.
1384 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001385 * All unsupported flags in @total_flags must be cleared.
1386 * Hardware does not support a flag if it is incapable of _passing_
1387 * the frame to the stack. Otherwise the driver must ignore
1388 * the flag, but not clear it.
1389 * You must _only_ clear the flag (announce no support for the
1390 * flag to mac80211) if you are not able to pass the packet type
1391 * to the stack (so the hardware always filters it).
1392 * So for example, you should clear @FIF_CONTROL, if your hardware
1393 * always filters control frames. If your hardware always passes
1394 * control frames to the kernel and is incapable of filtering them,
1395 * you do _not_ clear the @FIF_CONTROL flag.
1396 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001397 */
1398
1399/**
1400 * enum ieee80211_filter_flags - hardware filter flags
1401 *
1402 * These flags determine what the filter in hardware should be
1403 * programmed to let through and what should not be passed to the
1404 * stack. It is always safe to pass more frames than requested,
1405 * but this has negative impact on power consumption.
1406 *
1407 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1408 * think of the BSS as your network segment and then this corresponds
1409 * to the regular ethernet device promiscuous mode.
1410 *
1411 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1412 * by the user or if the hardware is not capable of filtering by
1413 * multicast address.
1414 *
1415 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1416 * %RX_FLAG_FAILED_FCS_CRC for them)
1417 *
1418 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1419 * the %RX_FLAG_FAILED_PLCP_CRC for them
1420 *
1421 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1422 * to the hardware that it should not filter beacons or probe responses
1423 * by BSSID. Filtering them can greatly reduce the amount of processing
1424 * mac80211 needs to do and the amount of CPU wakeups, so you should
1425 * honour this flag if possible.
1426 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001427 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1428 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001429 *
1430 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001431 *
1432 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1433 * those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001434 */
1435enum ieee80211_filter_flags {
1436 FIF_PROMISC_IN_BSS = 1<<0,
1437 FIF_ALLMULTI = 1<<1,
1438 FIF_FCSFAIL = 1<<2,
1439 FIF_PLCPFAIL = 1<<3,
1440 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1441 FIF_CONTROL = 1<<5,
1442 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001443 FIF_PSPOLL = 1<<7,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001444};
1445
1446/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001447 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1448 *
1449 * These flags are used with the ampdu_action() callback in
1450 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001451 *
1452 * Note that drivers MUST be able to deal with a TX aggregation
1453 * session being stopped even before they OK'ed starting it by
1454 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
1455 * might receive the addBA frame and send a delBA right away!
1456 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001457 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1458 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001459 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1460 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001461 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001462 */
1463enum ieee80211_ampdu_mlme_action {
1464 IEEE80211_AMPDU_RX_START,
1465 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001466 IEEE80211_AMPDU_TX_START,
1467 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001468 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001469};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001470
1471/**
1472 * struct ieee80211_ops - callbacks from mac80211 to the driver
1473 *
1474 * This structure contains various callbacks that the driver may
1475 * handle or, in some cases, must handle, for example to configure
1476 * the hardware to a new channel or to transmit a frame.
1477 *
1478 * @tx: Handler that 802.11 module calls for each transmitted frame.
1479 * skb contains the buffer starting from the IEEE 802.11 header.
1480 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001481 * configuration in the TX control data. This handler should,
1482 * preferably, never fail and stop queues appropriately, more
1483 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001484 * This function should return NETDEV_TX_OK except in very
1485 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001486 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001487 *
1488 * @start: Called before the first netdevice attached to the hardware
1489 * is enabled. This should turn on the hardware and must turn on
1490 * frame reception (for possibly enabled monitor interfaces.)
1491 * Returns negative error codes, these may be seen in userspace,
1492 * or zero.
1493 * When the device is started it should not have a MAC address
1494 * to avoid acknowledging frames before a non-monitor device
1495 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001496 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001497 *
1498 * @stop: Called after last netdevice attached to the hardware
1499 * is disabled. This should turn off the hardware (at least
1500 * it must turn off frame reception.)
1501 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001502 * an interface. If you added any work onto the mac80211 workqueue
1503 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001504 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001505 *
1506 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001507 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001508 * and @stop must be implemented.
1509 * The driver should perform any initialization it needs before
1510 * the device can be enabled. The initial configuration for the
1511 * interface is given in the conf parameter.
1512 * The callback may refuse to add an interface by returning a
1513 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001514 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001515 *
1516 * @remove_interface: Notifies a driver that an interface is going down.
1517 * The @stop callback is called after this if it is the last interface
1518 * and no monitor interfaces are present.
1519 * When all interfaces are removed, the MAC address in the hardware
1520 * must be cleared so the device no longer acknowledges packets,
1521 * the mac_addr member of the conf structure is, however, set to the
1522 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001523 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001524 *
1525 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1526 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001527 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001528 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001529 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001530 * @bss_info_changed: Handler for configuration requests related to BSS
1531 * parameters that may vary during BSS's lifespan, and may affect low
1532 * level driver (e.g. assoc/disassoc status, erp parameters).
1533 * This function should not be used if no BSS has been set, unless
1534 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001535 * of the bss parameters has changed when a call is made. The callback
1536 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001537 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001538 * @prepare_multicast: Prepare for multicast filter configuration.
1539 * This callback is optional, and its return value is passed
1540 * to configure_filter(). This callback must be atomic.
1541 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001542 * @configure_filter: Configure the device's RX filter.
1543 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001544 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001545 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001546 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001547 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001548 *
1549 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001550 * This callback is only called between add_interface and
1551 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001552 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001553 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001554 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001555 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001556 * @update_tkip_key: See the section "Hardware crypto acceleration"
1557 * This callback will be called in the context of Rx. Called for drivers
1558 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02001559 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001560 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001561 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001562 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001563 * configuration done by the regulatory agent in the wiphy's
1564 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001565 * that power save is disabled.
1566 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1567 * entire IEs after the SSID, so that drivers need not look at these
1568 * at all but just send them after the SSID -- mac80211 includes the
1569 * (extended) supported rates and HT information (where applicable).
1570 * When the scan finishes, ieee80211_scan_completed() must be called;
1571 * note that it also must be called when the scan cannot finish due to
1572 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001573 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001574 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001575 * @sw_scan_start: Notifier function that is called just before a software scan
1576 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001577 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001578 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001579 * @sw_scan_complete: Notifier function that is called just after a
1580 * software scan finished. Can be NULL, if the driver doesn't need
1581 * this notification.
1582 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001583 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001584 * @get_stats: Return low-level statistics.
1585 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001586 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001587 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001588 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1589 * callback should be provided to read the TKIP transmit IVs (both IV32
1590 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001591 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001592 *
1593 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001594 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001595 *
Johannes Berg34e89502010-02-03 13:59:58 +01001596 * @sta_add: Notifies low level driver about addition of an associated station,
1597 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1598 *
1599 * @sta_remove: Notifies low level driver about removal of an associated
1600 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1601 *
1602 * @sta_notify: Notifies low level driver about power state transition of an
1603 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001604 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001605 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001606 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001607 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001608 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001609 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001610 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001611 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001612 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001613 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001614 *
1615 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1616 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001617 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001618 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001619 *
1620 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1621 * with other STAs in the IBSS. This is only used in IBSS mode. This
1622 * function is optional if the firmware/hardware takes full care of
1623 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001624 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001625 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001626 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1627 * This is needed only for IBSS mode and the result of this function is
1628 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001629 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001630 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001631 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001632 * @ampdu_action: Perform a certain A-MPDU action
1633 * The RA/TID combination determines the destination and TID we want
1634 * the ampdu action to be performed for. The action is defined through
1635 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001636 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001637 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001638 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001639 * The callback must be atomic.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001640 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07001641 * @get_survey: Return per-channel survey information
1642 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001643 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1644 * need to set wiphy->rfkill_poll to %true before registration,
1645 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001646 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02001647 *
Lukáš Turek310bc672009-12-21 22:50:48 +01001648 * @set_coverage_class: Set slot time for given coverage class as specified
1649 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1650 * accordingly. This callback is not required and may sleep.
1651 *
Johannes Bergaff89a92009-07-01 21:26:51 +02001652 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001653 * The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01001654 *
1655 * @flush: Flush all pending frames from the hardware queue, making sure
1656 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01001657 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02001658 *
1659 * @channel_switch: Drivers that need (or want) to offload the channel
1660 * switch operation for CSAs received from the AP may implement this
1661 * callback. They must then call ieee80211_chswitch_done() to indicate
1662 * completion of the channel switch.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001663 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001664struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001665 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001666 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001667 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001668 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001669 struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001670 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001671 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02001672 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001673 void (*bss_info_changed)(struct ieee80211_hw *hw,
1674 struct ieee80211_vif *vif,
1675 struct ieee80211_bss_conf *info,
1676 u32 changed);
Johannes Berg3ac64be2009-08-17 16:16:53 +02001677 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad32010-04-01 21:22:57 +00001678 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001679 void (*configure_filter)(struct ieee80211_hw *hw,
1680 unsigned int changed_flags,
1681 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001682 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001683 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1684 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001685 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001686 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001687 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001688 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01001689 struct ieee80211_vif *vif,
1690 struct ieee80211_key_conf *conf,
1691 struct ieee80211_sta *sta,
1692 u32 iv32, u16 *phase1key);
Johannes Berga060bbf2010-04-27 11:59:34 +02001693 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01001694 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001695 void (*sw_scan_start)(struct ieee80211_hw *hw);
1696 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001697 int (*get_stats)(struct ieee80211_hw *hw,
1698 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001699 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1700 u32 *iv32, u16 *iv16);
Jiri Bencf0706e82007-05-05 11:45:53 -07001701 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01001702 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1703 struct ieee80211_sta *sta);
1704 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1705 struct ieee80211_sta *sta);
Johannes Berg32bfd352007-12-19 01:31:26 +01001706 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001707 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001708 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07001709 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e82007-05-05 11:45:53 -07001710 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001711 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001712 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001713 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001714 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01001715 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001716 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001717 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Holger Schurig12897232010-04-19 10:23:57 +02001718 int (*get_survey)(struct ieee80211_hw *hw, int idx,
1719 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001720 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01001721 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02001722#ifdef CONFIG_NL80211_TESTMODE
1723 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1724#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01001725 void (*flush)(struct ieee80211_hw *hw, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02001726 void (*channel_switch)(struct ieee80211_hw *hw,
1727 struct ieee80211_channel_switch *ch_switch);
Jiri Bencf0706e82007-05-05 11:45:53 -07001728};
1729
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001730/**
1731 * ieee80211_alloc_hw - Allocate a new hardware device
1732 *
1733 * This must be called once for each hardware device. The returned pointer
1734 * must be used to refer to this device when calling other functions.
1735 * mac80211 allocates a private data area for the driver pointed to by
1736 * @priv in &struct ieee80211_hw, the size of this area is given as
1737 * @priv_data_len.
1738 *
1739 * @priv_data_len: length of private data
1740 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07001741 */
1742struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1743 const struct ieee80211_ops *ops);
1744
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001745/**
1746 * ieee80211_register_hw - Register hardware device
1747 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001748 * You must call this function before any other functions in
1749 * mac80211. Note that before a hardware can be registered, you
1750 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001751 *
1752 * @hw: the device to register as returned by ieee80211_alloc_hw()
1753 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001754int ieee80211_register_hw(struct ieee80211_hw *hw);
1755
Jiri Bencf0706e82007-05-05 11:45:53 -07001756#ifdef CONFIG_MAC80211_LEDS
1757extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1758extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001759extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001760extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001761#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001762/**
1763 * ieee80211_get_tx_led_name - get name of TX LED
1764 *
1765 * mac80211 creates a transmit LED trigger for each wireless hardware
1766 * that can be used to drive LEDs if your driver registers a LED device.
1767 * This function returns the name (or %NULL if not configured for LEDs)
1768 * of the trigger so you can automatically link the LED device.
1769 *
1770 * @hw: the hardware to get the LED trigger name for
1771 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001772static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1773{
1774#ifdef CONFIG_MAC80211_LEDS
1775 return __ieee80211_get_tx_led_name(hw);
1776#else
1777 return NULL;
1778#endif
1779}
1780
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001781/**
1782 * ieee80211_get_rx_led_name - get name of RX LED
1783 *
1784 * mac80211 creates a receive LED trigger for each wireless hardware
1785 * that can be used to drive LEDs if your driver registers a LED device.
1786 * This function returns the name (or %NULL if not configured for LEDs)
1787 * of the trigger so you can automatically link the LED device.
1788 *
1789 * @hw: the hardware to get the LED trigger name for
1790 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001791static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1792{
1793#ifdef CONFIG_MAC80211_LEDS
1794 return __ieee80211_get_rx_led_name(hw);
1795#else
1796 return NULL;
1797#endif
1798}
1799
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001800/**
1801 * ieee80211_get_assoc_led_name - get name of association LED
1802 *
1803 * mac80211 creates a association LED trigger for each wireless hardware
1804 * that can be used to drive LEDs if your driver registers a LED device.
1805 * This function returns the name (or %NULL if not configured for LEDs)
1806 * of the trigger so you can automatically link the LED device.
1807 *
1808 * @hw: the hardware to get the LED trigger name for
1809 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001810static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1811{
1812#ifdef CONFIG_MAC80211_LEDS
1813 return __ieee80211_get_assoc_led_name(hw);
1814#else
1815 return NULL;
1816#endif
1817}
1818
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001819/**
1820 * ieee80211_get_radio_led_name - get name of radio LED
1821 *
1822 * mac80211 creates a radio change LED trigger for each wireless hardware
1823 * that can be used to drive LEDs if your driver registers a LED device.
1824 * This function returns the name (or %NULL if not configured for LEDs)
1825 * of the trigger so you can automatically link the LED device.
1826 *
1827 * @hw: the hardware to get the LED trigger name for
1828 */
1829static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1830{
1831#ifdef CONFIG_MAC80211_LEDS
1832 return __ieee80211_get_radio_led_name(hw);
1833#else
1834 return NULL;
1835#endif
1836}
Michael Buesch47f0c502007-09-27 15:10:44 +02001837
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001838/**
1839 * ieee80211_unregister_hw - Unregister a hardware device
1840 *
1841 * This function instructs mac80211 to free allocated resources
1842 * and unregister netdevices from the networking subsystem.
1843 *
1844 * @hw: the hardware to unregister
1845 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001846void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1847
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001848/**
1849 * ieee80211_free_hw - free hardware descriptor
1850 *
1851 * This function frees everything that was allocated, including the
1852 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001853 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001854 *
1855 * @hw: the hardware to free
1856 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001857void ieee80211_free_hw(struct ieee80211_hw *hw);
1858
Johannes Bergf2753dd2009-04-14 10:09:24 +02001859/**
1860 * ieee80211_restart_hw - restart hardware completely
1861 *
1862 * Call this function when the hardware was restarted for some reason
1863 * (hardware error, ...) and the driver is unable to restore its state
1864 * by itself. mac80211 assumes that at this point the driver/hardware
1865 * is completely uninitialised and stopped, it starts the process by
1866 * calling the ->start() operation. The driver will need to reset all
1867 * internal state that it has prior to calling this function.
1868 *
1869 * @hw: the hardware to restart
1870 */
1871void ieee80211_restart_hw(struct ieee80211_hw *hw);
1872
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001873/**
1874 * ieee80211_rx - receive frame
1875 *
1876 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08001877 * buffer in @skb must start with an IEEE 802.11 header. In case of a
1878 * paged @skb is used, the driver is recommended to put the ieee80211
1879 * header of the frame on the linear part of the @skb to avoid memory
1880 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001881 *
Johannes Berg2485f712008-02-25 16:27:41 +01001882 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03001883 * for a single hardware must be synchronized against each other. Calls to
1884 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1885 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001886 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001887 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02001888 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001889 * @hw: the hardware this frame came in on
1890 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001891 */
John W. Linville103bf9f2009-08-20 16:34:15 -04001892void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001893
1894/**
1895 * ieee80211_rx_irqsafe - receive frame
1896 *
1897 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001898 * (internally defers to a tasklet.)
1899 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03001900 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1901 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001902 *
1903 * @hw: the hardware this frame came in on
1904 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001905 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02001906void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001907
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001908/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03001909 * ieee80211_rx_ni - receive frame (in process context)
1910 *
1911 * Like ieee80211_rx() but can be called in process context
1912 * (internally disables bottom halves).
1913 *
1914 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
1915 * not be mixed for a single hardware.
1916 *
1917 * @hw: the hardware this frame came in on
1918 * @skb: the buffer to receive, owned by mac80211 after this call
1919 */
1920static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
1921 struct sk_buff *skb)
1922{
1923 local_bh_disable();
1924 ieee80211_rx(hw, skb);
1925 local_bh_enable();
1926}
1927
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01001928/*
1929 * The TX headroom reserved by mac80211 for its own tx_status functions.
1930 * This is enough for the radiotap header.
1931 */
1932#define IEEE80211_TX_STATUS_HEADROOM 13
1933
Kalle Valoe36e49f2009-10-13 20:33:13 +03001934/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001935 * ieee80211_tx_status - transmit status callback
1936 *
1937 * Call this function for all transmitted frames after they have been
1938 * transmitted. It is permissible to not call this function for
1939 * multicast frames but this can affect statistics.
1940 *
Johannes Berg2485f712008-02-25 16:27:41 +01001941 * This function may not be called in IRQ context. Calls to this function
1942 * for a single hardware must be synchronized against each other. Calls
1943 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1944 * for a single hardware.
1945 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001946 * @hw: the hardware the frame was transmitted by
1947 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001948 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001949void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001950 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001951
1952/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001953 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001954 *
1955 * Like ieee80211_tx_status() but can be called in IRQ context
1956 * (internally defers to a tasklet.)
1957 *
1958 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1959 * single hardware.
1960 *
1961 * @hw: the hardware the frame was transmitted by
1962 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001963 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001964void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001965 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001966
1967/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01001968 * ieee80211_beacon_get_tim - beacon generation function
1969 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001970 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01001971 * @tim_offset: pointer to variable that will receive the TIM IE offset.
1972 * Set to 0 if invalid (in non-AP modes).
1973 * @tim_length: pointer to variable that will receive the TIM IE length,
1974 * (including the ID and length bytes!).
1975 * Set to 0 if invalid (in non-AP modes).
1976 *
1977 * If the driver implements beaconing modes, it must use this function to
1978 * obtain the beacon frame/template.
1979 *
1980 * If the beacon frames are generated by the host system (i.e., not in
1981 * hardware/firmware), the driver uses this function to get each beacon
1982 * frame from mac80211 -- it is responsible for calling this function
1983 * before the beacon is needed (e.g. based on hardware interrupt).
1984 *
1985 * If the beacon frames are generated by the device, then the driver
1986 * must use the returned beacon as the template and change the TIM IE
1987 * according to the current DTIM parameters/TIM bitmap.
1988 *
1989 * The driver is responsible for freeing the returned skb.
1990 */
1991struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
1992 struct ieee80211_vif *vif,
1993 u16 *tim_offset, u16 *tim_length);
1994
1995/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001996 * ieee80211_beacon_get - beacon generation function
1997 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01001998 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07001999 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01002000 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07002001 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01002002static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2003 struct ieee80211_vif *vif)
2004{
2005 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2006}
Jiri Bencf0706e82007-05-05 11:45:53 -07002007
2008/**
Kalle Valo7044cc52010-01-05 20:16:19 +02002009 * ieee80211_pspoll_get - retrieve a PS Poll template
2010 * @hw: pointer obtained from ieee80211_alloc_hw().
2011 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2012 *
2013 * Creates a PS Poll a template which can, for example, uploaded to
2014 * hardware. The template must be updated after association so that correct
2015 * AID, BSSID and MAC address is used.
2016 *
2017 * Note: Caller (or hardware) is responsible for setting the
2018 * &IEEE80211_FCTL_PM bit.
2019 */
2020struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2021 struct ieee80211_vif *vif);
2022
2023/**
2024 * ieee80211_nullfunc_get - retrieve a nullfunc template
2025 * @hw: pointer obtained from ieee80211_alloc_hw().
2026 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2027 *
2028 * Creates a Nullfunc template which can, for example, uploaded to
2029 * hardware. The template must be updated after association so that correct
2030 * BSSID and address is used.
2031 *
2032 * Note: Caller (or hardware) is responsible for setting the
2033 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2034 */
2035struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2036 struct ieee80211_vif *vif);
2037
2038/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02002039 * ieee80211_probereq_get - retrieve a Probe Request template
2040 * @hw: pointer obtained from ieee80211_alloc_hw().
2041 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2042 * @ssid: SSID buffer
2043 * @ssid_len: length of SSID
2044 * @ie: buffer containing all IEs except SSID for the template
2045 * @ie_len: length of the IE buffer
2046 *
2047 * Creates a Probe Request template which can, for example, be uploaded to
2048 * hardware.
2049 */
2050struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2051 struct ieee80211_vif *vif,
2052 const u8 *ssid, size_t ssid_len,
2053 const u8 *ie, size_t ie_len);
2054
2055/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002056 * ieee80211_rts_get - RTS frame generation function
2057 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002058 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002059 * @frame: pointer to the frame that is going to be protected by the RTS.
2060 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002061 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002062 * @rts: The buffer where to store the RTS frame.
2063 *
2064 * If the RTS frames are generated by the host system (i.e., not in
2065 * hardware/firmware), the low-level driver uses this function to receive
2066 * the next RTS frame from the 802.11 code. The low-level is responsible
2067 * for calling this function before and RTS frame is needed.
2068 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002069void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002070 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002071 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002072 struct ieee80211_rts *rts);
2073
2074/**
2075 * ieee80211_rts_duration - Get the duration field for an RTS frame
2076 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002077 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002078 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02002079 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002080 *
2081 * If the RTS is generated in firmware, but the host system must provide
2082 * the duration field, the low-level driver uses this function to receive
2083 * the duration field value in little-endian byteorder.
2084 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002085__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2086 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002087 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002088
2089/**
2090 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2091 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002092 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002093 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2094 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002095 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002096 * @cts: The buffer where to store the CTS-to-self frame.
2097 *
2098 * If the CTS-to-self frames are generated by the host system (i.e., not in
2099 * hardware/firmware), the low-level driver uses this function to receive
2100 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2101 * for calling this function before and CTS-to-self frame is needed.
2102 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002103void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2104 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002105 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002106 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002107 struct ieee80211_cts *cts);
2108
2109/**
2110 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2111 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002112 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002113 * @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 +02002114 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002115 *
2116 * If the CTS-to-self is generated in firmware, but the host system must provide
2117 * the duration field, the low-level driver uses this function to receive
2118 * the duration field value in little-endian byteorder.
2119 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002120__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2121 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002122 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002123 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002124
2125/**
2126 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2127 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002128 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002129 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01002130 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07002131 *
2132 * Calculate the duration field of some generic frame, given its
2133 * length and transmission rate (in 100kbps).
2134 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002135__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2136 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002137 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002138 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07002139
2140/**
2141 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2142 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002143 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002144 *
2145 * Function for accessing buffered broadcast and multicast frames. If
2146 * hardware/firmware does not implement buffering of broadcast/multicast
2147 * frames when power saving is used, 802.11 code buffers them in the host
2148 * memory. The low-level driver uses this function to fetch next buffered
2149 * frame. In most cases, this is used when generating beacon frame. This
2150 * function returns a pointer to the next buffered skb or NULL if no more
2151 * buffered frames are available.
2152 *
2153 * Note: buffered frames are returned only after DTIM beacon frame was
2154 * generated with ieee80211_beacon_get() and the low-level driver must thus
2155 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2156 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2157 * does not need to check for DTIM beacons separately and should be able to
2158 * use common code for all beacons.
2159 */
2160struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002161ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002162
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002163/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002164 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2165 *
2166 * This function computes a TKIP rc4 key for an skb. It computes
2167 * a phase 1 key if needed (iv16 wraps around). This function is to
2168 * be used by drivers which can do HW encryption but need to compute
2169 * to phase 1/2 key in SW.
2170 *
2171 * @keyconf: the parameter passed with the set key
2172 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002173 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002174 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002175 */
2176void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2177 struct sk_buff *skb,
2178 enum ieee80211_tkip_key_type type, u8 *key);
2179/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002180 * ieee80211_wake_queue - wake specific queue
2181 * @hw: pointer as obtained from ieee80211_alloc_hw().
2182 * @queue: queue number (counted from zero).
2183 *
2184 * Drivers should use this function instead of netif_wake_queue.
2185 */
2186void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2187
2188/**
2189 * ieee80211_stop_queue - stop specific queue
2190 * @hw: pointer as obtained from ieee80211_alloc_hw().
2191 * @queue: queue number (counted from zero).
2192 *
2193 * Drivers should use this function instead of netif_stop_queue.
2194 */
2195void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2196
2197/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03002198 * ieee80211_queue_stopped - test status of the queue
2199 * @hw: pointer as obtained from ieee80211_alloc_hw().
2200 * @queue: queue number (counted from zero).
2201 *
2202 * Drivers should use this function instead of netif_stop_queue.
2203 */
2204
2205int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2206
2207/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002208 * ieee80211_stop_queues - stop all queues
2209 * @hw: pointer as obtained from ieee80211_alloc_hw().
2210 *
2211 * Drivers should use this function instead of netif_stop_queue.
2212 */
2213void ieee80211_stop_queues(struct ieee80211_hw *hw);
2214
2215/**
2216 * ieee80211_wake_queues - wake all queues
2217 * @hw: pointer as obtained from ieee80211_alloc_hw().
2218 *
2219 * Drivers should use this function instead of netif_wake_queue.
2220 */
2221void ieee80211_wake_queues(struct ieee80211_hw *hw);
2222
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002223/**
2224 * ieee80211_scan_completed - completed hardware scan
2225 *
2226 * When hardware scan offload is used (i.e. the hw_scan() callback is
2227 * assigned) this function needs to be called by the driver to notify
2228 * mac80211 that the scan finished.
2229 *
2230 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01002231 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002232 */
Johannes Berg2a519312009-02-10 21:25:55 +01002233void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07002234
Johannes Bergdabeb342007-11-09 01:57:29 +01002235/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002236 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01002237 *
2238 * This function iterates over the interfaces associated with a given
2239 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002240 * This function allows the iterator function to sleep, when the iterator
2241 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2242 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01002243 *
2244 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002245 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002246 * @data: first argument of the iterator function
2247 */
2248void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2249 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002250 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002251 void *data);
2252
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002253/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002254 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2255 *
2256 * This function iterates over the interfaces associated with a given
2257 * hardware that are currently active and calls the callback for them.
2258 * This function requires the iterator callback function to be atomic,
2259 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2260 *
2261 * @hw: the hardware struct of which the interfaces should be iterated over
2262 * @iterator: the iterator function to call, cannot sleep
2263 * @data: first argument of the iterator function
2264 */
2265void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2266 void (*iterator)(void *data,
2267 u8 *mac,
2268 struct ieee80211_vif *vif),
2269 void *data);
2270
2271/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002272 * ieee80211_queue_work - add work onto the mac80211 workqueue
2273 *
2274 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2275 * This helper ensures drivers are not queueing work when they should not be.
2276 *
2277 * @hw: the hardware struct for the interface we are adding work for
2278 * @work: the work we want to add onto the mac80211 workqueue
2279 */
2280void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2281
2282/**
2283 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2284 *
2285 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2286 * workqueue.
2287 *
2288 * @hw: the hardware struct for the interface we are adding work for
2289 * @dwork: delayable work to queue onto the mac80211 workqueue
2290 * @delay: number of jiffies to wait before queueing
2291 */
2292void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2293 struct delayed_work *dwork,
2294 unsigned long delay);
2295
2296/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002297 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002298 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002299 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002300 *
2301 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002302 *
2303 * Although mac80211/low level driver/user space application can estimate
2304 * the need to start aggregation on a certain RA/TID, the session level
2305 * will be managed by the mac80211.
2306 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002307int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002308
2309/**
2310 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002311 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002312 * @ra: receiver address of the BA session recipient.
2313 * @tid: the TID to BA on.
2314 *
2315 * This function must be called by low level driver once it has
2316 * finished with preparations for the BA session.
2317 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002318void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002319
2320/**
2321 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002322 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002323 * @ra: receiver address of the BA session recipient.
2324 * @tid: the TID to BA on.
2325 *
2326 * This function must be called by low level driver once it has
2327 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002328 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002329 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002330void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002331 u16 tid);
2332
2333/**
2334 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002335 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002336 * @tid: the TID to stop BA.
2337 * @initiator: if indicates initiator DELBA frame will be sent.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002338 *
2339 * Return: error if no sta with matching da found, success otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002340 *
2341 * Although mac80211/low level driver/user space application can estimate
2342 * the need to stop aggregation on a certain RA/TID, the session level
2343 * will be managed by the mac80211.
2344 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002345int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002346 enum ieee80211_back_parties initiator);
2347
2348/**
2349 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002350 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002351 * @ra: receiver address of the BA session recipient.
2352 * @tid: the desired TID to BA on.
2353 *
2354 * This function must be called by low level driver once it has
2355 * finished with preparations for the BA session tear down.
2356 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002357void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002358
2359/**
2360 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002361 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002362 * @ra: receiver address of the BA session recipient.
2363 * @tid: the desired TID to BA on.
2364 *
2365 * This function must be called by low level driver once it has
2366 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002367 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002368 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002369void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002370 u16 tid);
2371
Mohamed Abbas84363e62008-04-04 16:59:58 -07002372/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002373 * ieee80211_find_sta - find a station
2374 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002375 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002376 * @addr: station's address
2377 *
2378 * This function must be called under RCU lock and the
2379 * resulting pointer is only valid under RCU lock as well.
2380 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002381struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002382 const u8 *addr);
2383
Kalle Valo04de8382009-03-22 21:57:35 +02002384/**
Johannes Berg5ed176e2009-11-04 14:42:28 +01002385 * ieee80211_find_sta_by_hw - find a station on hardware
2386 *
2387 * @hw: pointer as obtained from ieee80211_alloc_hw()
2388 * @addr: station's address
2389 *
2390 * This function must be called under RCU lock and the
2391 * resulting pointer is only valid under RCU lock as well.
2392 *
2393 * NOTE: This function should not be used! When mac80211 is converted
2394 * internally to properly keep track of stations on multiple
2395 * virtual interfaces, it will not always know which station to
2396 * return here since a single address might be used by multiple
2397 * logical stations (e.g. consider a station connecting to another
2398 * BSSID on the same AP hardware without disconnecting first).
2399 *
2400 * DO NOT USE THIS FUNCTION.
2401 */
2402struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
2403 const u8 *addr);
2404
2405/**
Johannes Bergaf818582009-11-06 11:35:50 +01002406 * ieee80211_sta_block_awake - block station from waking up
2407 * @hw: the hardware
2408 * @pubsta: the station
2409 * @block: whether to block or unblock
2410 *
2411 * Some devices require that all frames that are on the queues
2412 * for a specific station that went to sleep are flushed before
2413 * a poll response or frames after the station woke up can be
2414 * delivered to that it. Note that such frames must be rejected
2415 * by the driver as filtered, with the appropriate status flag.
2416 *
2417 * This function allows implementing this mode in a race-free
2418 * manner.
2419 *
2420 * To do this, a driver must keep track of the number of frames
2421 * still enqueued for a specific station. If this number is not
2422 * zero when the station goes to sleep, the driver must call
2423 * this function to force mac80211 to consider the station to
2424 * be asleep regardless of the station's actual state. Once the
2425 * number of outstanding frames reaches zero, the driver must
2426 * call this function again to unblock the station. That will
2427 * cause mac80211 to be able to send ps-poll responses, and if
2428 * the station queried in the meantime then frames will also
2429 * be sent out as a result of this. Additionally, the driver
2430 * will be notified that the station woke up some time after
2431 * it is unblocked, regardless of whether the station actually
2432 * woke up while blocked or not.
2433 */
2434void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2435 struct ieee80211_sta *pubsta, bool block);
2436
2437/**
Kalle Valo04de8382009-03-22 21:57:35 +02002438 * ieee80211_beacon_loss - inform hardware does not receive beacons
2439 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01002440 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02002441 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002442 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING and
2443 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02002444 * hardware is not receiving beacons with this function.
2445 */
2446void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002447
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002448/**
2449 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2450 *
2451 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2452 *
2453 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING, and
2454 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2455 * needs to inform if the connection to the AP has been lost.
2456 *
2457 * This function will cause immediate change to disassociated state,
2458 * without connection recovery attempts.
2459 */
2460void ieee80211_connection_loss(struct ieee80211_vif *vif);
2461
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002462/**
2463 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2464 * rssi threshold triggered
2465 *
2466 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2467 * @rssi_event: the RSSI trigger event type
2468 * @gfp: context flags
2469 *
2470 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2471 * monitoring is configured with an rssi threshold, the driver will inform
2472 * whenever the rssi level reaches the threshold.
2473 */
2474void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2475 enum nl80211_cqm_rssi_threshold_event rssi_event,
2476 gfp_t gfp);
2477
Johannes Berg5ce6e432010-05-11 16:20:57 +02002478/**
2479 * ieee80211_chswitch_done - Complete channel switch process
2480 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2481 * @success: make the channel switch successful or not
2482 *
2483 * Complete the channel switch post-process: set the new operational channel
2484 * and wake up the suspended queues.
2485 */
2486void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
2487
Johannes Berg4b7679a2008-09-18 18:14:18 +02002488/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002489
Johannes Berg4b7679a2008-09-18 18:14:18 +02002490/**
Sujith81cb7622009-02-12 11:38:37 +05302491 * enum rate_control_changed - flags to indicate which parameter changed
2492 *
2493 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2494 * changed, rate control algorithm can update its internal state if needed.
2495 */
2496enum rate_control_changed {
2497 IEEE80211_RC_HT_CHANGED = BIT(0)
2498};
2499
2500/**
Johannes Berge6a98542008-10-21 12:40:02 +02002501 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002502 *
Johannes Berge6a98542008-10-21 12:40:02 +02002503 * @hw: The hardware the algorithm is invoked for.
2504 * @sband: The band this frame is being transmitted on.
2505 * @bss_conf: the current BSS configuration
2506 * @reported_rate: The rate control algorithm can fill this in to indicate
2507 * which rate should be reported to userspace as the current rate and
2508 * used for rate calculations in the mesh network.
2509 * @rts: whether RTS will be used for this frame because it is longer than the
2510 * RTS threshold
2511 * @short_preamble: whether mac80211 will request short-preamble transmission
2512 * if the selected rate supports it
2513 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002514 * (deprecated; this will be removed once drivers get updated to use
2515 * rate_idx_mask)
2516 * @rate_idx_mask: user-requested rate mask (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002517 * @skb: the skb that will be transmitted, the control information in it needs
2518 * to be filled in
Jouni Malinene00cfce2009-12-29 12:59:19 +02002519 * @ap: whether this frame is sent out in AP mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02002520 */
Johannes Berge6a98542008-10-21 12:40:02 +02002521struct ieee80211_tx_rate_control {
2522 struct ieee80211_hw *hw;
2523 struct ieee80211_supported_band *sband;
2524 struct ieee80211_bss_conf *bss_conf;
2525 struct sk_buff *skb;
2526 struct ieee80211_tx_rate reported_rate;
2527 bool rts, short_preamble;
2528 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002529 u32 rate_idx_mask;
Jouni Malinene00cfce2009-12-29 12:59:19 +02002530 bool ap;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002531};
2532
2533struct rate_control_ops {
2534 struct module *module;
2535 const char *name;
2536 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002537 void (*free)(void *priv);
2538
2539 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2540 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2541 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302542 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2543 struct ieee80211_sta *sta,
Sujith4fa00432010-03-01 14:42:57 +05302544 void *priv_sta, u32 changed,
2545 enum nl80211_channel_type oper_chan_type);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002546 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2547 void *priv_sta);
2548
2549 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2550 struct ieee80211_sta *sta, void *priv_sta,
2551 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002552 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2553 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002554
2555 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2556 struct dentry *dir);
2557 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2558};
2559
2560static inline int rate_supported(struct ieee80211_sta *sta,
2561 enum ieee80211_band band,
2562 int index)
2563{
2564 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2565}
2566
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07002567/**
2568 * rate_control_send_low - helper for drivers for management/no-ack frames
2569 *
2570 * Rate control algorithms that agree to use the lowest rate to
2571 * send management frames and NO_ACK data with the respective hw
2572 * retries should use this in the beginning of their mac80211 get_rate
2573 * callback. If true is returned the rate control can simply return.
2574 * If false is returned we guarantee that sta and sta and priv_sta is
2575 * not null.
2576 *
2577 * Rate control algorithms wishing to do more intelligent selection of
2578 * rate for multicast/broadcast frames may choose to not use this.
2579 *
2580 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2581 * that this may be null.
2582 * @priv_sta: private rate control structure. This may be null.
2583 * @txrc: rate control information we sholud populate for mac80211.
2584 */
2585bool rate_control_send_low(struct ieee80211_sta *sta,
2586 void *priv_sta,
2587 struct ieee80211_tx_rate_control *txrc);
2588
2589
Johannes Berg4b7679a2008-09-18 18:14:18 +02002590static inline s8
2591rate_lowest_index(struct ieee80211_supported_band *sband,
2592 struct ieee80211_sta *sta)
2593{
2594 int i;
2595
2596 for (i = 0; i < sband->n_bitrates; i++)
2597 if (rate_supported(sta, sband->band, i))
2598 return i;
2599
2600 /* warn when we cannot find a rate. */
2601 WARN_ON(1);
2602
2603 return 0;
2604}
2605
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07002606static inline
2607bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2608 struct ieee80211_sta *sta)
2609{
2610 unsigned int i;
2611
2612 for (i = 0; i < sband->n_bitrates; i++)
2613 if (rate_supported(sta, sband->band, i))
2614 return true;
2615 return false;
2616}
Johannes Berg4b7679a2008-09-18 18:14:18 +02002617
2618int ieee80211_rate_control_register(struct rate_control_ops *ops);
2619void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2620
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002621static inline bool
2622conf_is_ht20(struct ieee80211_conf *conf)
2623{
Johannes Berg47979382009-01-07 10:13:27 +01002624 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002625}
2626
2627static inline bool
2628conf_is_ht40_minus(struct ieee80211_conf *conf)
2629{
Johannes Berg47979382009-01-07 10:13:27 +01002630 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002631}
2632
2633static inline bool
2634conf_is_ht40_plus(struct ieee80211_conf *conf)
2635{
Johannes Berg47979382009-01-07 10:13:27 +01002636 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002637}
2638
2639static inline bool
2640conf_is_ht40(struct ieee80211_conf *conf)
2641{
2642 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2643}
2644
2645static inline bool
2646conf_is_ht(struct ieee80211_conf *conf)
2647{
Johannes Berg47979382009-01-07 10:13:27 +01002648 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002649}
2650
Jiri Bencf0706e82007-05-05 11:45:53 -07002651#endif /* MAC80211_H */