blob: 841f7f804bb6566b0afb6fe13af72d97f03a77bb [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>
Johannes Bergae5eb022008-10-14 16:58:37 +02006 * Copyright 2007-2008 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>
22#include <net/wireless.h>
23#include <net/cfg80211.h>
24
Johannes Berg75a5f0c2007-09-18 17:29:20 -040025/**
26 * DOC: Introduction
27 *
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
31 * drivers.
32 */
33
34/**
35 * DOC: Calling mac80211 from interrupts
36 *
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
Jiri Bencf0706e82007-05-05 11:45:53 -070038 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
Johannes Berg2485f712008-02-25 16:27:41 +010041 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
42 * tasklet function.
43 *
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
Randy Dunlap6ef307b2008-07-03 13:52:18 -070045 * use the non-IRQ-safe functions!
Jiri Bencf0706e82007-05-05 11:45:53 -070046 */
47
Johannes Berg75a5f0c2007-09-18 17:29:20 -040048/**
49 * DOC: Warning
Jiri Bencf0706e82007-05-05 11:45:53 -070050 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040051 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
53 */
54
55/**
56 * DOC: Frame format
Jiri Bencf0706e82007-05-05 11:45:53 -070057 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040058 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
61 * hardware.
62 *
63 * There are, however, various exceptions to this rule for advanced features:
64 *
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
67 *
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
70 *
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
Jiri Bencf0706e82007-05-05 11:45:53 -070074 */
75
Ron Rindjunsky10816d42007-11-26 16:14:30 +020076/**
77 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
78 *
79 * This structure describes most essential parameters needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -070080 * to describe 802.11n HT characteristics in a BSS.
Ron Rindjunsky10816d42007-11-26 16:14:30 +020081 *
82 * @primary_channel: channel number of primery channel
83 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
84 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
Ron Rindjunsky10816d42007-11-26 16:14:30 +020085 */
Ron Rindjunsky10816d42007-11-26 16:14:30 +020086struct ieee80211_ht_bss_info {
87 u8 primary_channel;
88 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
89 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
Ron Rindjunsky10816d42007-11-26 16:14:30 +020090};
91
92/**
Johannes Berge100bb62008-04-30 18:51:21 +020093 * enum ieee80211_max_queues - maximum number of queues
94 *
95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
97 * for A-MPDU operation.
98 */
99enum ieee80211_max_queues {
Johannes Berg51b38142009-03-12 11:16:48 +0100100 IEEE80211_MAX_QUEUES = 4,
Johannes Berge100bb62008-04-30 18:51:21 +0200101 IEEE80211_MAX_AMPDU_QUEUES = 16,
102};
103
104/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400105 * struct ieee80211_tx_queue_params - transmit queue configuration
106 *
107 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100108 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400109 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400110 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200111 * @cw_min: minimum contention window [a value of the form
112 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400113 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100114 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Johannes Berg6b301cd2007-09-18 17:29:20 -0400115 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700116struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200117 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100118 u16 cw_min;
119 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200120 u8 aifs;
Jiri Bencf0706e82007-05-05 11:45:53 -0700121};
122
Johannes Berg6b301cd2007-09-18 17:29:20 -0400123/**
Johannes Berg57ffc582008-04-29 17:18:59 +0200124 * struct ieee80211_tx_queue_stats - transmit queue statistics
Johannes Berg6b301cd2007-09-18 17:29:20 -0400125 *
126 * @len: number of packets in queue
127 * @limit: queue length limit
128 * @count: number of frames sent
129 */
Johannes Berg57ffc582008-04-29 17:18:59 +0200130struct ieee80211_tx_queue_stats {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400131 unsigned int len;
132 unsigned int limit;
133 unsigned int count;
Jiri Bencf0706e82007-05-05 11:45:53 -0700134};
135
Jiri Bencf0706e82007-05-05 11:45:53 -0700136struct ieee80211_low_level_stats {
137 unsigned int dot11ACKFailureCount;
138 unsigned int dot11RTSFailureCount;
139 unsigned int dot11FCSErrorCount;
140 unsigned int dot11RTSSuccessCount;
141};
142
Johannes Berg471b3ef2007-12-28 14:32:58 +0100143/**
144 * enum ieee80211_bss_change - BSS change notification flags
145 *
146 * These flags are used with the bss_info_changed() callback
147 * to indicate which BSS parameter changed.
148 *
149 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
150 * also implies a change in the AID.
151 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
152 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300153 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700154 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200155 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg471b3ef2007-12-28 14:32:58 +0100156 */
157enum ieee80211_bss_change {
158 BSS_CHANGED_ASSOC = 1<<0,
159 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
160 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300161 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700162 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200163 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg471b3ef2007-12-28 14:32:58 +0100164};
165
166/**
Johannes Bergae5eb022008-10-14 16:58:37 +0200167 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration
Johannes Bergae5eb022008-10-14 16:58:37 +0200168 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info)
169 */
170struct ieee80211_bss_ht_conf {
Johannes Bergae5eb022008-10-14 16:58:37 +0200171 u16 operation_mode;
172};
173
174/**
Johannes Berg471b3ef2007-12-28 14:32:58 +0100175 * struct ieee80211_bss_conf - holds the BSS's changing parameters
176 *
177 * This structure keeps information about a BSS (and an association
178 * to that BSS) that can change during the lifetime of the BSS.
179 *
180 * @assoc: association status
181 * @aid: association ID number, valid only when @assoc is true
182 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200183 * @use_short_preamble: use 802.11b short preamble;
184 * if the hardware cannot handle this it must set the
185 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
186 * @use_short_slot: use short slot time (only relevant for ERP);
187 * if the hardware cannot handle this it must set the
188 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800189 * @dtim_period: num of beacons before the next DTIM, for PSM
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700190 * @timestamp: beacon timestamp
191 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800192 * @assoc_capability: capabilities taken from assoc resp
Johannes Bergae5eb022008-10-14 16:58:37 +0200193 * @ht: BSS's HT configuration
Johannes Berg96dd22a2008-09-11 00:01:57 +0200194 * @basic_rates: bitmap of basic rates, each bit stands for an
195 * index into the rate table configured by the driver in
196 * the current band.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100197 */
198struct ieee80211_bss_conf {
199 /* association related data */
200 bool assoc;
201 u16 aid;
202 /* erp related data */
203 bool use_cts_prot;
204 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300205 bool use_short_slot;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800206 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700207 u16 beacon_int;
208 u16 assoc_capability;
209 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100210 u32 basic_rates;
Johannes Bergae5eb022008-10-14 16:58:37 +0200211 struct ieee80211_bss_ht_conf ht;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100212};
213
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800214/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700215 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800216 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700217 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800218 *
Johannes Berge039fa42008-05-15 12:55:29 +0200219 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200220 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
221 * number to this frame, taking care of not overwriting the fragment
222 * number and increasing the sequence number only when the
223 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
224 * assign sequence numbers to QoS-data frames but cannot do so correctly
225 * for non-QoS-data and management frames because beacons need them from
226 * that counter as well and mac80211 cannot guarantee proper sequencing.
227 * If this flag is set, the driver should instruct the hardware to
228 * assign a sequence number to the frame or assign one itself. Cf. IEEE
229 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
230 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200231 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200232 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
233 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200234 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200235 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
236 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200237 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200238 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
239 * because the destination STA was in powersave mode.
240 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
241 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
242 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300243 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
244 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200245 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
246 * set by rate control algorithms to indicate probe rate, will
247 * be cleared for fragmented frames (except on the last fragment)
Johannes Berg2b874e82009-03-23 14:10:22 +0100248 * @IEEE80211_TX_INTFL_RCALGO: mac80211 internal flag, do not test or
249 * set this flag in the driver; indicates that the rate control
250 * algorithm was used and should be notified of TX status
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100251 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
252 * used to indicate that a pending frame requires TX processing before
253 * it can be sent out.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800254 */
255enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200256 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200257 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
258 IEEE80211_TX_CTL_NO_ACK = BIT(2),
259 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
260 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
261 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
262 IEEE80211_TX_CTL_AMPDU = BIT(6),
263 IEEE80211_TX_CTL_INJECTED = BIT(7),
264 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
265 IEEE80211_TX_STAT_ACK = BIT(9),
266 IEEE80211_TX_STAT_AMPDU = BIT(10),
267 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
268 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Berg2b874e82009-03-23 14:10:22 +0100269 IEEE80211_TX_INTFL_RCALGO = BIT(13),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100270 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berge6a98542008-10-21 12:40:02 +0200271};
272
Sujith2134e7e2009-01-22 09:00:52 +0530273/**
274 * enum mac80211_rate_control_flags - per-rate flags set by the
275 * Rate Control algorithm.
276 *
277 * These flags are set by the Rate control algorithm for each rate during tx,
278 * in the @flags member of struct ieee80211_tx_rate.
279 *
280 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
281 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
282 * This is set if the current BSS requires ERP protection.
283 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
284 * @IEEE80211_TX_RC_MCS: HT rate.
285 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
286 * Greenfield mode.
287 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
288 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
289 * adjacent 20 MHz channels, if the current channel type is
290 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
291 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
292 */
Johannes Berge6a98542008-10-21 12:40:02 +0200293enum mac80211_rate_control_flags {
294 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
295 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
296 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
297
298 /* rate index is an MCS rate number instead of an index */
299 IEEE80211_TX_RC_MCS = BIT(3),
300 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
301 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
302 IEEE80211_TX_RC_DUP_DATA = BIT(6),
303 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800304};
305
Johannes Berge039fa42008-05-15 12:55:29 +0200306
Johannes Berge6a98542008-10-21 12:40:02 +0200307/* there are 40 bytes if you don't need the rateset to be kept */
308#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200309
Johannes Berge6a98542008-10-21 12:40:02 +0200310/* if you do need the rateset, then you have less space */
311#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
312
313/* maximum number of rate stages */
314#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200315
316/**
Johannes Berge6a98542008-10-21 12:40:02 +0200317 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200318 *
Johannes Berge6a98542008-10-21 12:40:02 +0200319 * @idx: rate index to attempt to send with
320 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200321 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200322 *
323 * A value of -1 for @idx indicates an invalid rate and, if used
324 * in an array of retry rates, that no more rates should be tried.
325 *
326 * When used for transmit status reporting, the driver should
327 * always report the rate along with the flags it used.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200328 */
Johannes Berge6a98542008-10-21 12:40:02 +0200329struct ieee80211_tx_rate {
330 s8 idx;
331 u8 count;
332 u8 flags;
Felix Fietkau48212772008-11-03 21:05:01 +0100333} __attribute__((packed));
Felix Fietkau870abdf2008-10-05 18:04:24 +0200334
Johannes Berge039fa42008-05-15 12:55:29 +0200335/**
336 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200337 *
Johannes Berge039fa42008-05-15 12:55:29 +0200338 * This structure is placed in skb->cb for three uses:
339 * (1) mac80211 TX control - mac80211 tells the driver what to do
340 * (2) driver internal use (if applicable)
341 * (3) TX status information - driver tells mac80211 what happened
342 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200343 * The TX control's sta pointer is only valid during the ->tx call,
344 * it may be NULL.
345 *
Johannes Berge039fa42008-05-15 12:55:29 +0200346 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200347 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200348 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200349 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700350 * @control: union for control data
351 * @status: union for status data
352 * @driver_data: array of driver_data pointers
Johannes Berge039fa42008-05-15 12:55:29 +0200353 * @ampdu_ack_len: number of aggregated frames.
354 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
355 * @ampdu_ack_map: block ack bit map for the aggregation.
356 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
357 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200358 */
Johannes Berge039fa42008-05-15 12:55:29 +0200359struct ieee80211_tx_info {
360 /* common information */
361 u32 flags;
362 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200363
Johannes Berge039fa42008-05-15 12:55:29 +0200364 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100365
Johannes Berge6a98542008-10-21 12:40:02 +0200366 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500367 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100368
Johannes Berge039fa42008-05-15 12:55:29 +0200369 union {
370 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200371 union {
372 /* rate control */
373 struct {
374 struct ieee80211_tx_rate rates[
375 IEEE80211_TX_MAX_RATES];
376 s8 rts_cts_rate_idx;
377 };
378 /* only needed before rate control */
379 unsigned long jiffies;
380 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200381 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200382 struct ieee80211_vif *vif;
383 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200384 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200385 } control;
386 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200387 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
388 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200389 u64 ampdu_ack_map;
390 int ack_signal;
Johannes Berge6a98542008-10-21 12:40:02 +0200391 /* 8 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200392 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200393 struct {
394 struct ieee80211_tx_rate driver_rates[
395 IEEE80211_TX_MAX_RATES];
396 void *rate_driver_data[
397 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
398 };
399 void *driver_data[
400 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200401 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700402};
403
Johannes Berge039fa42008-05-15 12:55:29 +0200404static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
405{
406 return (struct ieee80211_tx_info *)skb->cb;
407}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400408
Johannes Berge6a98542008-10-21 12:40:02 +0200409/**
410 * ieee80211_tx_info_clear_status - clear TX status
411 *
412 * @info: The &struct ieee80211_tx_info to be cleared.
413 *
414 * When the driver passes an skb back to mac80211, it must report
415 * a number of things in TX status. This function clears everything
416 * in the TX status but the rate control information (it does clear
417 * the count since you need to fill that in anyway).
418 *
419 * NOTE: You can only use this function if you do NOT use
420 * info->driver_data! Use info->rate_driver_data
421 * instead if you need only the less space that allows.
422 */
423static inline void
424ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
425{
426 int i;
427
428 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
429 offsetof(struct ieee80211_tx_info, control.rates));
430 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
431 offsetof(struct ieee80211_tx_info, driver_rates));
432 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
433 /* clear the rate counts */
434 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
435 info->status.rates[i].count = 0;
436
437 BUILD_BUG_ON(
438 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
439 memset(&info->status.ampdu_ack_len, 0,
440 sizeof(struct ieee80211_tx_info) -
441 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
442}
443
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400444
445/**
446 * enum mac80211_rx_flags - receive flags
447 *
448 * These flags are used with the @flag member of &struct ieee80211_rx_status.
449 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
450 * Use together with %RX_FLAG_MMIC_STRIPPED.
451 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
452 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
453 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
454 * verification has been done by the hardware.
455 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
456 * If this flag is set, the stack cannot do any replay detection
457 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400458 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
459 * the frame.
460 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
461 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100462 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900463 * is valid. This is useful in monitor mode and necessary for beacon frames
464 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200465 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200466 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
467 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
468 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400469 */
470enum mac80211_rx_flags {
471 RX_FLAG_MMIC_ERROR = 1<<0,
472 RX_FLAG_DECRYPTED = 1<<1,
473 RX_FLAG_RADIOTAP = 1<<2,
474 RX_FLAG_MMIC_STRIPPED = 1<<3,
475 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400476 RX_FLAG_FAILED_FCS_CRC = 1<<5,
477 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100478 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200479 RX_FLAG_SHORTPRE = 1<<8,
480 RX_FLAG_HT = 1<<9,
481 RX_FLAG_40MHZ = 1<<10,
482 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400483};
484
485/**
486 * struct ieee80211_rx_status - receive status
487 *
488 * The low-level driver should provide this information (the subset
489 * supported by hardware) to the 802.11 code with each received
490 * frame.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200491 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900492 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
493 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100494 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400495 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200496 * @signal: signal strength when receiving this frame, either in dBm, in dB or
497 * unspecified depending on the hardware capabilities flags
498 * @IEEE80211_HW_SIGNAL_*
499 * @noise: noise when receiving this frame, in dBm.
500 * @qual: overall signal quality indication, in percent (0-100).
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400501 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200502 * @rate_idx: index of data rate into band's supported rates or MCS index if
503 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400504 * @flag: %RX_FLAG_*
505 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700506struct ieee80211_rx_status {
507 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100508 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400509 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400510 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700511 int noise;
Bruno Randolf566bfe52008-05-08 19:15:40 +0200512 int qual;
Jiri Bencf0706e82007-05-05 11:45:53 -0700513 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100514 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700515 int flag;
516};
517
Johannes Berg6b301cd2007-09-18 17:29:20 -0400518/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400519 * enum ieee80211_conf_flags - configuration flags
520 *
521 * Flags to define PHY configuration options
522 *
Johannes Berg6b301cd2007-09-18 17:29:20 -0400523 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
Samuel Ortiz49292d52008-07-04 10:49:31 +0200524 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
Johannes Berg6b301cd2007-09-18 17:29:20 -0400525 */
526enum ieee80211_conf_flags {
Johannes Berg7a5158e2008-10-08 10:59:33 +0200527 IEEE80211_CONF_RADIOTAP = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200528 IEEE80211_CONF_PS = (1<<1),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400529};
Jiri Bencf0706e82007-05-05 11:45:53 -0700530
Johannes Berg7a5158e2008-10-08 10:59:33 +0200531
Jiri Bencf0706e82007-05-05 11:45:53 -0700532/**
Johannes Berge8975582008-10-09 12:18:51 +0200533 * enum ieee80211_conf_changed - denotes which configuration changed
534 *
535 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
536 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
537 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
538 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
539 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100540 * @IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT: the dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200541 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100542 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200543 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berge8975582008-10-09 12:18:51 +0200544 */
545enum ieee80211_conf_changed {
546 IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0),
547 IEEE80211_CONF_CHANGE_BEACON_INTERVAL = BIT(1),
548 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
549 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3),
550 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100551 IEEE80211_CONF_CHANGE_DYNPS_TIMEOUT = BIT(5),
552 IEEE80211_CONF_CHANGE_POWER = BIT(6),
553 IEEE80211_CONF_CHANGE_CHANNEL = BIT(7),
554 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200555};
556
557/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700558 * struct ieee80211_conf - configuration of the device
559 *
560 * This struct indicates how the driver shall configure the hardware.
561 *
562 * @radio_enabled: when zero, driver is required to switch off the radio.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400563 * @beacon_int: beacon interval (TODO make interface config)
Tomas Winklerea95bba2008-07-18 13:53:00 +0800564 * @listen_interval: listen interval in units of beacon interval
Johannes Berg6b301cd2007-09-18 17:29:20 -0400565 * @flags: configuration flags defined above
Johannes Berg8318d782008-01-24 19:38:38 +0100566 * @power_level: requested transmit power (in dBm)
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100567 * @dynamic_ps_timeout: dynamic powersave timeout (in ms)
Johannes Berg8318d782008-01-24 19:38:38 +0100568 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100569 * @channel_type: the channel (HT) type
Johannes Berg9124b072008-10-14 19:17:54 +0200570 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
571 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
572 * but actually means the number of transmissions not the number of retries
573 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
574 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
575 * number of transmissions not the number of retries
Jiri Bencf0706e82007-05-05 11:45:53 -0700576 */
577struct ieee80211_conf {
Jiri Bencf0706e82007-05-05 11:45:53 -0700578 int beacon_int;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400579 u32 flags;
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100580 int power_level, dynamic_ps_timeout;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200581
Johannes Berge8975582008-10-09 12:18:51 +0200582 u16 listen_interval;
583 bool radio_enabled;
584
Johannes Berg9124b072008-10-14 19:17:54 +0200585 u8 long_frame_max_tx_count, short_frame_max_tx_count;
586
Johannes Berg8318d782008-01-24 19:38:38 +0100587 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100588 enum nl80211_channel_type channel_type;
Jiri Bencf0706e82007-05-05 11:45:53 -0700589};
590
591/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100592 * struct ieee80211_vif - per-interface data
593 *
594 * Data in this structure is continually present for driver
595 * use during the life of a virtual interface.
596 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100597 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200598 * @bss_conf: BSS configuration for this interface, either our own
599 * or the BSS we're associated to
Johannes Berg32bfd352007-12-19 01:31:26 +0100600 * @drv_priv: data area for driver use, will always be aligned to
601 * sizeof(void *).
602 */
603struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200604 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200605 struct ieee80211_bss_conf bss_conf;
Johannes Berg32bfd352007-12-19 01:31:26 +0100606 /* must be last */
607 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
608};
609
Johannes Berg902acc72008-02-23 15:17:19 +0100610static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
611{
612#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200613 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100614#endif
615 return false;
616}
617
Johannes Berg32bfd352007-12-19 01:31:26 +0100618/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700619 * struct ieee80211_if_init_conf - initial configuration of an interface
620 *
Johannes Berg32bfd352007-12-19 01:31:26 +0100621 * @vif: pointer to a driver-use per-interface structure. The pointer
622 * itself is also used for various functions including
623 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
Johannes Berg05c914f2008-09-11 00:01:58 +0200624 * @type: one of &enum nl80211_iftype constants. Determines the type of
Jiri Bencf0706e82007-05-05 11:45:53 -0700625 * added/removed interface.
626 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
627 * until the interface is removed (i.e. it cannot be used after
628 * remove_interface() callback was called for this interface).
629 *
630 * This structure is used in add_interface() and remove_interface()
631 * callbacks of &struct ieee80211_hw.
Johannes Berg4480f15c2007-07-10 19:32:10 +0200632 *
633 * When you allow multiple interfaces to be added to your PHY, take care
634 * that the hardware can actually handle multiple MAC addresses. However,
635 * also take care that when there's no interface left with mac_addr != %NULL
636 * you remove the MAC address from the device to avoid acknowledging packets
637 * in pure monitor mode.
Jiri Bencf0706e82007-05-05 11:45:53 -0700638 */
639struct ieee80211_if_init_conf {
Johannes Berg05c914f2008-09-11 00:01:58 +0200640 enum nl80211_iftype type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100641 struct ieee80211_vif *vif;
Jiri Bencf0706e82007-05-05 11:45:53 -0700642 void *mac_addr;
643};
644
645/**
Johannes Berg9d139c82008-07-09 14:40:37 +0200646 * enum ieee80211_if_conf_change - interface config change flags
647 *
648 * @IEEE80211_IFCC_BSSID: The BSSID changed.
Johannes Berg9d139c82008-07-09 14:40:37 +0200649 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
650 * (currently AP and MESH only), use ieee80211_beacon_get().
Johannes Berg078e1e62009-01-22 18:07:31 +0100651 * @IEEE80211_IFCC_BEACON_ENABLED: The enable_beacon value changed.
Johannes Berg9d139c82008-07-09 14:40:37 +0200652 */
653enum ieee80211_if_conf_change {
Johannes Berg078e1e62009-01-22 18:07:31 +0100654 IEEE80211_IFCC_BSSID = BIT(0),
655 IEEE80211_IFCC_BEACON = BIT(1),
656 IEEE80211_IFCC_BEACON_ENABLED = BIT(2),
Johannes Berg9d139c82008-07-09 14:40:37 +0200657};
658
659/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700660 * struct ieee80211_if_conf - configuration of an interface
661 *
Johannes Berg9d139c82008-07-09 14:40:37 +0200662 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
Jiri Bencf0706e82007-05-05 11:45:53 -0700663 * @bssid: BSSID of the network we are associated to/creating.
Johannes Berg078e1e62009-01-22 18:07:31 +0100664 * @enable_beacon: Indicates whether beacons can be sent.
665 * This is valid only for AP/IBSS/MESH modes.
Jiri Bencf0706e82007-05-05 11:45:53 -0700666 *
667 * This structure is passed to the config_interface() callback of
668 * &struct ieee80211_hw.
669 */
670struct ieee80211_if_conf {
Johannes Berg9d139c82008-07-09 14:40:37 +0200671 u32 changed;
Johannes Berg5f936f12009-01-21 12:47:05 +0100672 const u8 *bssid;
Johannes Berg078e1e62009-01-22 18:07:31 +0100673 bool enable_beacon;
Jiri Bencf0706e82007-05-05 11:45:53 -0700674};
675
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400676/**
677 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400678 * @ALG_WEP: WEP40 or WEP104
679 * @ALG_TKIP: TKIP
680 * @ALG_CCMP: CCMP (AES)
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +0200681 * @ALG_AES_CMAC: AES-128-CMAC
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400682 */
Johannes Bergea49c352007-09-18 17:29:21 -0400683enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400684 ALG_WEP,
685 ALG_TKIP,
686 ALG_CCMP,
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +0200687 ALG_AES_CMAC,
Johannes Bergea49c352007-09-18 17:29:21 -0400688};
Jiri Bencf0706e82007-05-05 11:45:53 -0700689
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300690/**
691 * enum ieee80211_key_len - key length
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700692 * @LEN_WEP40: WEP 5-byte long key
693 * @LEN_WEP104: WEP 13-byte long key
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300694 */
695enum ieee80211_key_len {
696 LEN_WEP40 = 5,
697 LEN_WEP104 = 13,
698};
Johannes Berg11a843b2007-08-28 17:01:55 -0400699
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400700/**
701 * enum ieee80211_key_flags - key flags
702 *
703 * These flags are used for communication about keys between the driver
704 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
705 *
706 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
707 * that the STA this key will be used with could be using QoS.
708 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
709 * driver to indicate that it requires IV generation for this
710 * particular key.
711 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
712 * the driver for a TKIP key if it requires Michael MIC
713 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200714 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
715 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200716 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
717 * CCMP key if it requires CCMP encryption of management frames (MFP) to
718 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400719 */
720enum ieee80211_key_flags {
721 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
722 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
723 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200724 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200725 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400726};
727
728/**
729 * struct ieee80211_key_conf - key information
730 *
731 * This key information is given by mac80211 to the driver by
732 * the set_key() callback in &struct ieee80211_ops.
733 *
734 * @hw_key_idx: To be set by the driver, this is the key index the driver
735 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400736 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400737 * @alg: The key algorithm.
738 * @flags: key flags, see &enum ieee80211_key_flags.
739 * @keyidx: the key index (0-3)
740 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400741 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
742 * data block:
743 * - Temporal Encryption Key (128 bits)
744 * - Temporal Authenticator Tx MIC Key (64 bits)
745 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100746 * @icv_len: The ICV length for this key type
747 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400748 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700749struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400750 enum ieee80211_key_alg alg;
Felix Fietkau76708de2008-10-05 18:02:48 +0200751 u8 icv_len;
752 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400753 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400754 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400755 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400756 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700757 u8 key[0];
758};
759
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400760/**
761 * enum set_key_cmd - key command
762 *
763 * Used with the set_key() callback in &struct ieee80211_ops, this
764 * indicates whether a key is being removed or added.
765 *
766 * @SET_KEY: a key is set
767 * @DISABLE_KEY: a key must be disabled
768 */
Johannes Bergea49c352007-09-18 17:29:21 -0400769enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400770 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400771};
Jiri Bencf0706e82007-05-05 11:45:53 -0700772
Tomas Winkler478f8d22007-09-30 13:52:37 +0200773/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200774 * struct ieee80211_sta - station table entry
775 *
776 * A station table entry represents a station we are possibly
777 * communicating with. Since stations are RCU-managed in
778 * mac80211, any ieee80211_sta pointer you get access to must
779 * either be protected by rcu_read_lock() explicitly or implicitly,
780 * or you must take good care to not use such a pointer after a
781 * call to your sta_notify callback that removed it.
782 *
783 * @addr: MAC address
784 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200785 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200786 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200787 * @drv_priv: data area for driver use, will always be aligned to
788 * sizeof(void *), size is determined in hw information.
789 */
790struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100791 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200792 u8 addr[ETH_ALEN];
793 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200794 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200795
796 /* must be last */
797 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
798};
799
800/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200801 * enum sta_notify_cmd - sta notify command
802 *
803 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Christian Lamparter89fad572008-12-09 16:28:06 +0100804 * indicates addition and removal of a station to station table,
805 * or if a associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200806 *
807 * @STA_NOTIFY_ADD: a station was added to the station table
808 * @STA_NOTIFY_REMOVE: a station being removed from the station table
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100809 * @STA_NOTIFY_SLEEP: a station is now sleeping
810 * @STA_NOTIFY_AWAKE: a sleeping station woke up
811 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100812enum sta_notify_cmd {
813 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100814 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
815};
816
817/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200818 * enum ieee80211_tkip_key_type - get tkip key
819 *
820 * Used by drivers which need to get a tkip key for skb. Some drivers need a
821 * phase 1 key, others need a phase 2 key. A single function allows the driver
822 * to get the key, this enum indicates what type of key is required.
823 *
824 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
825 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
826 */
827enum ieee80211_tkip_key_type {
828 IEEE80211_TKIP_P1_KEY,
829 IEEE80211_TKIP_P2_KEY,
830};
831
832/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400833 * enum ieee80211_hw_flags - hardware flags
834 *
835 * These flags are used to indicate hardware capabilities to
836 * the stack. Generally, flags here should have their meaning
837 * done in a way that the simplest hardware doesn't need setting
838 * any particular flags. There are some exceptions to this rule,
839 * however, so you are advised to review these flags carefully.
840 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400841 * @IEEE80211_HW_RX_INCLUDES_FCS:
842 * Indicates that received frames passed to the stack include
843 * the FCS at the end.
844 *
845 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
846 * Some wireless LAN chipsets buffer broadcast/multicast frames
847 * for power saving stations in the hardware/firmware and others
848 * rely on the host system for such buffering. This option is used
849 * to configure the IEEE 802.11 upper layer to buffer broadcast and
850 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -0700851 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400852 *
Johannes Berg8318d782008-01-24 19:38:38 +0100853 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
854 * Hardware is not capable of short slot operation on the 2.4 GHz band.
855 *
856 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
857 * Hardware is not capable of receiving frames with short preamble on
858 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200859 *
860 * @IEEE80211_HW_SIGNAL_UNSPEC:
861 * Hardware can provide signal values but we don't know its units. We
862 * expect values between 0 and @max_signal.
863 * If possible please provide dB or dBm instead.
864 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200865 * @IEEE80211_HW_SIGNAL_DBM:
866 * Hardware gives signal values in dBm, decibel difference from
867 * one milliwatt. This is the preferred method since it is standardized
868 * between different devices. @max_signal does not need to be set.
869 *
870 * @IEEE80211_HW_NOISE_DBM:
871 * Hardware can provide noise (radio interference) values in units dBm,
872 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300873 *
874 * @IEEE80211_HW_SPECTRUM_MGMT:
875 * Hardware supports spectrum management defined in 802.11h
876 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +0530877 *
878 * @IEEE80211_HW_AMPDU_AGGREGATION:
879 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +0200880 *
Johannes Berg4be8c382009-01-07 18:28:20 +0100881 * @IEEE80211_HW_SUPPORTS_PS:
882 * Hardware has power save support (i.e. can go to sleep).
883 *
884 * @IEEE80211_HW_PS_NULLFUNC_STACK:
885 * Hardware requires nullfunc frame handling in stack, implies
886 * stack support for dynamic PS.
887 *
888 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
889 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +0200890 *
891 * @IEEE80211_HW_MFP_CAPABLE:
892 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +0200893 *
894 * @IEEE80211_HW_BEACON_FILTER:
895 * Hardware supports dropping of irrelevant beacon frames to
896 * avoid waking up cpu.
Johannes Berg1bc08262007-09-18 17:29:15 -0400897 */
898enum ieee80211_hw_flags {
Johannes Berg1bc08262007-09-18 17:29:15 -0400899 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
900 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100901 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
902 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200903 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +0100904 IEEE80211_HW_SIGNAL_DBM = 1<<6,
905 IEEE80211_HW_NOISE_DBM = 1<<7,
906 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
907 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
908 IEEE80211_HW_SUPPORTS_PS = 1<<10,
909 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
910 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
911 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +0200912 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg1bc08262007-09-18 17:29:15 -0400913};
914
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400915/**
916 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400917 *
918 * This structure contains the configuration and hardware
919 * information for an 802.11 PHY.
920 *
921 * @wiphy: This points to the &struct wiphy allocated for this
922 * 802.11 PHY. You must fill in the @perm_addr and @dev
923 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100924 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
925 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400926 *
927 * @conf: &struct ieee80211_conf, device configuration, don't use.
928 *
929 * @workqueue: single threaded workqueue available for driver use,
Ivo van Doorn428da762008-06-24 19:23:36 +0200930 * allocated by mac80211 on registration and flushed when an
931 * interface is removed.
Johannes Bergc771c9d2009-01-23 22:54:03 +0100932 * NOTICE: All work performed on this workqueue must not
933 * acquire the RTNL lock.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400934 *
935 * @priv: pointer to private area that was allocated for driver use
936 * along with this structure.
937 *
938 * @flags: hardware flags, see &enum ieee80211_hw_flags.
939 *
940 * @extra_tx_headroom: headroom to reserve in each transmit skb
941 * for use by the driver (e.g. for transmit headers.)
942 *
943 * @channel_change_time: time (in microseconds) it takes to change channels.
944 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200945 * @max_signal: Maximum value for signal (rssi) in RX information, used
946 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400947 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800948 * @max_listen_interval: max listen interval in units of beacon interval
949 * that HW supports
950 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400951 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +0200952 * data packets. WMM/QoS requires at least four, these
953 * queues need to have configurable access parameters.
954 *
955 * @ampdu_queues: number of available hardware transmit queues
956 * for A-MPDU packets, these have no access parameters
957 * because they're used only for A-MPDU frames. Note that
958 * mac80211 will not currently use any of the regular queues
959 * for aggregation.
Johannes Berg830f9032007-10-28 14:51:05 +0100960 *
961 * @rate_control_algorithm: rate control algorithm for this hardware.
962 * If unset (NULL), the default algorithm will be used. Must be
963 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100964 *
965 * @vif_data_size: size (in bytes) of the drv_priv data area
966 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +0200967 * @sta_data_size: size (in bytes) of the drv_priv data area
968 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200969 *
Johannes Berge6a98542008-10-21 12:40:02 +0200970 * @max_rates: maximum number of alternate rate retry stages
971 * @max_rate_tries: maximum number of tries for each stage
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400972 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700973struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -0700974 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400975 struct wiphy *wiphy;
Jiri Bencf0706e82007-05-05 11:45:53 -0700976 struct workqueue_struct *workqueue;
Johannes Berg830f9032007-10-28 14:51:05 +0100977 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -0700978 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400979 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -0700980 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -0700981 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +0100982 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +0200983 int sta_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800984 u16 queues;
985 u16 ampdu_queues;
986 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -0700987 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +0200988 u8 max_rates;
989 u8 max_rate_tries;
Jiri Bencf0706e82007-05-05 11:45:53 -0700990};
991
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400992/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -0800993 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
994 *
995 * @wiphy: the &struct wiphy which we want to query
996 *
997 * mac80211 drivers can use this to get to their respective
998 * &struct ieee80211_hw. Drivers wishing to get to their own private
999 * structure can then access it via hw->priv. Note that mac802111 drivers should
1000 * not use wiphy_priv() to try to get their private driver structure as this
1001 * is already used internally by mac80211.
1002 */
1003struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1004
1005/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001006 * SET_IEEE80211_DEV - set device for 802.11 hardware
1007 *
1008 * @hw: the &struct ieee80211_hw to set the device for
1009 * @dev: the &struct device of this 802.11 device
1010 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001011static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1012{
1013 set_wiphy_dev(hw->wiphy, dev);
1014}
1015
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001016/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001017 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001018 *
1019 * @hw: the &struct ieee80211_hw to set the MAC address for
1020 * @addr: the address to set
1021 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001022static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1023{
1024 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1025}
1026
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001027static inline struct ieee80211_rate *
1028ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001029 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001030{
Johannes Berge6a98542008-10-21 12:40:02 +02001031 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001032 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001033 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001034}
1035
1036static inline struct ieee80211_rate *
1037ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001038 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001039{
Johannes Berge039fa42008-05-15 12:55:29 +02001040 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001041 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001042 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001043}
1044
1045static inline struct ieee80211_rate *
1046ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001047 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001048{
Johannes Berge6a98542008-10-21 12:40:02 +02001049 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001050 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001051 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001052}
1053
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001054/**
1055 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001056 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001057 * mac80211 is capable of taking advantage of many hardware
1058 * acceleration designs for encryption and decryption operations.
1059 *
1060 * The set_key() callback in the &struct ieee80211_ops for a given
1061 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001062 * decryption. The callback takes a @sta parameter that will be NULL
1063 * for default keys or keys used for transmission only, or point to
1064 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001065 * Multiple transmission keys with the same key index may be used when
1066 * VLANs are configured for an access point.
1067 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001068 * When transmitting, the TX control data will use the @hw_key_idx
1069 * selected by the driver by modifying the &struct ieee80211_key_conf
1070 * pointed to by the @key parameter to the set_key() function.
1071 *
1072 * The set_key() call for the %SET_KEY command should return 0 if
1073 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1074 * added; if you return 0 then hw_key_idx must be assigned to the
1075 * hardware key index, you are free to use the full u8 range.
1076 *
1077 * When the cmd is %DISABLE_KEY then it must succeed.
1078 *
1079 * Note that it is permissible to not decrypt a frame even if a key
1080 * for it has been uploaded to hardware, the stack will not make any
1081 * decision based on whether a key has been uploaded or not but rather
1082 * based on the receive flags.
1083 *
1084 * The &struct ieee80211_key_conf structure pointed to by the @key
1085 * parameter is guaranteed to be valid until another call to set_key()
1086 * removes it, but it can only be used as a cookie to differentiate
1087 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001088 *
1089 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1090 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1091 * handler.
1092 * The update_tkip_key() call updates the driver with the new phase 1 key.
1093 * This happens everytime the iv16 wraps around (every 65536 packets). The
1094 * set_key() call will happen only once for each key (unless the AP did
1095 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001096 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001097 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001098 */
Johannes Berg4150c572007-09-17 01:29:23 -04001099
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001100/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001101 * DOC: Powersave support
1102 *
1103 * mac80211 has support for various powersave implementations.
1104 *
1105 * First, it can support hardware that handles all powersaving by
1106 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1107 * hardware flag. In that case, it will be told about the desired
1108 * powersave mode depending on the association status, and the driver
1109 * must take care of sending nullfunc frames when necessary, i.e. when
1110 * entering and leaving powersave mode. The driver is required to look at
1111 * the AID in beacons and signal to the AP that it woke up when it finds
1112 * traffic directed to it. This mode supports dynamic PS by simply
1113 * enabling/disabling PS.
1114 *
1115 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1116 * flag to indicate that it can support dynamic PS mode itself (see below).
1117 *
1118 * Other hardware designs cannot send nullfunc frames by themselves and also
1119 * need software support for parsing the TIM bitmap. This is also supported
1120 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1121 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1122 * required to pass up beacons. Additionally, in this case, mac80211 will
1123 * wake up the hardware when multicast traffic is announced in the beacon.
1124 *
1125 * FIXME: I don't think we can be fast enough in software when we want to
1126 * receive multicast traffic?
1127 *
1128 * Dynamic powersave mode is an extension to normal powersave mode in which
1129 * the hardware stays awake for a user-specified period of time after sending
1130 * a frame so that reply frames need not be buffered and therefore delayed
1131 * to the next wakeup. This can either be supported by hardware, in which case
1132 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1133 * value, or by the stack if all nullfunc handling is in the stack.
1134 */
1135
1136/**
Kalle Valo04de8382009-03-22 21:57:35 +02001137 * DOC: Beacon filter support
1138 *
1139 * Some hardware have beacon filter support to reduce host cpu wakeups
1140 * which will reduce system power consumption. It usuallly works so that
1141 * the firmware creates a checksum of the beacon but omits all constantly
1142 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1143 * beacon is forwarded to the host, otherwise it will be just dropped. That
1144 * way the host will only receive beacons where some relevant information
1145 * (for example ERP protection or WMM settings) have changed.
1146 *
1147 * Beacon filter support is informed with %IEEE80211_HW_BEACON_FILTER flag.
1148 * The driver needs to enable beacon filter support whenever power save is
1149 * enabled, that is %IEEE80211_CONF_PS is set. When power save is enabled,
1150 * the stack will not check for beacon miss at all and the driver needs to
1151 * notify about complete loss of beacons with ieee80211_beacon_loss().
1152 */
1153
1154/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001155 * DOC: Frame filtering
1156 *
1157 * mac80211 requires to see many management frames for proper
1158 * operation, and users may want to see many more frames when
1159 * in monitor mode. However, for best CPU usage and power consumption,
1160 * having as few frames as possible percolate through the stack is
1161 * desirable. Hence, the hardware should filter as much as possible.
1162 *
1163 * To achieve this, mac80211 uses filter flags (see below) to tell
1164 * the driver's configure_filter() function which frames should be
1165 * passed to mac80211 and which should be filtered out.
1166 *
1167 * The configure_filter() callback is invoked with the parameters
1168 * @mc_count and @mc_list for the combined multicast address list
1169 * of all virtual interfaces, @changed_flags telling which flags
1170 * were changed and @total_flags with the new flag states.
1171 *
1172 * If your device has no multicast address filters your driver will
1173 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1174 * parameter to see whether multicast frames should be accepted
1175 * or dropped.
1176 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001177 * All unsupported flags in @total_flags must be cleared.
1178 * Hardware does not support a flag if it is incapable of _passing_
1179 * the frame to the stack. Otherwise the driver must ignore
1180 * the flag, but not clear it.
1181 * You must _only_ clear the flag (announce no support for the
1182 * flag to mac80211) if you are not able to pass the packet type
1183 * to the stack (so the hardware always filters it).
1184 * So for example, you should clear @FIF_CONTROL, if your hardware
1185 * always filters control frames. If your hardware always passes
1186 * control frames to the kernel and is incapable of filtering them,
1187 * you do _not_ clear the @FIF_CONTROL flag.
1188 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001189 */
1190
1191/**
1192 * enum ieee80211_filter_flags - hardware filter flags
1193 *
1194 * These flags determine what the filter in hardware should be
1195 * programmed to let through and what should not be passed to the
1196 * stack. It is always safe to pass more frames than requested,
1197 * but this has negative impact on power consumption.
1198 *
1199 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1200 * think of the BSS as your network segment and then this corresponds
1201 * to the regular ethernet device promiscuous mode.
1202 *
1203 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1204 * by the user or if the hardware is not capable of filtering by
1205 * multicast address.
1206 *
1207 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1208 * %RX_FLAG_FAILED_FCS_CRC for them)
1209 *
1210 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1211 * the %RX_FLAG_FAILED_PLCP_CRC for them
1212 *
1213 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1214 * to the hardware that it should not filter beacons or probe responses
1215 * by BSSID. Filtering them can greatly reduce the amount of processing
1216 * mac80211 needs to do and the amount of CPU wakeups, so you should
1217 * honour this flag if possible.
1218 *
1219 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1220 * only those addressed to this station
1221 *
1222 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1223 */
1224enum ieee80211_filter_flags {
1225 FIF_PROMISC_IN_BSS = 1<<0,
1226 FIF_ALLMULTI = 1<<1,
1227 FIF_FCSFAIL = 1<<2,
1228 FIF_PLCPFAIL = 1<<3,
1229 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1230 FIF_CONTROL = 1<<5,
1231 FIF_OTHER_BSS = 1<<6,
1232};
1233
1234/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001235 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1236 *
1237 * These flags are used with the ampdu_action() callback in
1238 * &struct ieee80211_ops to indicate which action is needed.
1239 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1240 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001241 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1242 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001243 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001244 */
1245enum ieee80211_ampdu_mlme_action {
1246 IEEE80211_AMPDU_RX_START,
1247 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001248 IEEE80211_AMPDU_TX_START,
1249 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001250 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001251};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001252
1253/**
1254 * struct ieee80211_ops - callbacks from mac80211 to the driver
1255 *
1256 * This structure contains various callbacks that the driver may
1257 * handle or, in some cases, must handle, for example to configure
1258 * the hardware to a new channel or to transmit a frame.
1259 *
1260 * @tx: Handler that 802.11 module calls for each transmitted frame.
1261 * skb contains the buffer starting from the IEEE 802.11 header.
1262 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001263 * configuration in the TX control data. This handler should,
1264 * preferably, never fail and stop queues appropriately, more
1265 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001266 * This function should return NETDEV_TX_OK except in very
1267 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001268 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001269 *
1270 * @start: Called before the first netdevice attached to the hardware
1271 * is enabled. This should turn on the hardware and must turn on
1272 * frame reception (for possibly enabled monitor interfaces.)
1273 * Returns negative error codes, these may be seen in userspace,
1274 * or zero.
1275 * When the device is started it should not have a MAC address
1276 * to avoid acknowledging frames before a non-monitor device
1277 * is added.
1278 * Must be implemented.
1279 *
1280 * @stop: Called after last netdevice attached to the hardware
1281 * is disabled. This should turn off the hardware (at least
1282 * it must turn off frame reception.)
1283 * May be called right after add_interface if that rejects
1284 * an interface.
1285 * Must be implemented.
1286 *
1287 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001288 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001289 * and @stop must be implemented.
1290 * The driver should perform any initialization it needs before
1291 * the device can be enabled. The initial configuration for the
1292 * interface is given in the conf parameter.
1293 * The callback may refuse to add an interface by returning a
1294 * negative error code (which will be seen in userspace.)
1295 * Must be implemented.
1296 *
1297 * @remove_interface: Notifies a driver that an interface is going down.
1298 * The @stop callback is called after this if it is the last interface
1299 * and no monitor interfaces are present.
1300 * When all interfaces are removed, the MAC address in the hardware
1301 * must be cleared so the device no longer acknowledges packets,
1302 * the mac_addr member of the conf structure is, however, set to the
1303 * MAC address of the device going away.
1304 * Hence, this callback must be implemented.
1305 *
1306 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1307 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001308 * This function should never fail but returns a negative error code
1309 * if it does.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001310 *
1311 * @config_interface: Handler for configuration requests related to interfaces
1312 * (e.g. BSSID changes.)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001313 * Returns a negative error code which will be seen in userspace.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001314 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001315 * @bss_info_changed: Handler for configuration requests related to BSS
1316 * parameters that may vary during BSS's lifespan, and may affect low
1317 * level driver (e.g. assoc/disassoc status, erp parameters).
1318 * This function should not be used if no BSS has been set, unless
1319 * for association indication. The @changed parameter indicates which
Reinette Chatred18ef292008-04-09 16:56:15 -07001320 * of the bss parameters has changed when a call is made.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001321 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001322 * @configure_filter: Configure the device's RX filter.
1323 * See the section "Frame filtering" for more information.
1324 * This callback must be implemented and atomic.
1325 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001326 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001327 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001328 *
1329 * @set_key: See the section "Hardware crypto acceleration"
1330 * This callback can sleep, and is only called between add_interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001331 * and remove_interface calls, i.e. while the given virtual interface
1332 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001333 * Returns a negative error code if the key can't be added.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001334 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001335 * @update_tkip_key: See the section "Hardware crypto acceleration"
1336 * This callback will be called in the context of Rx. Called for drivers
1337 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1338 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001339 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001340 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001341 * configuration done by the regulatory agent in the wiphy's
1342 * registered bands. The hardware (or the driver) needs to make sure
1343 * that power save is disabled. When the scan finishes,
1344 * ieee80211_scan_completed() must be called; note that it also must
1345 * be called when the scan cannot finish because the hardware is
1346 * turned off! Anything else is a bug! Returns a negative error code
1347 * which will be seen in userspace.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001348 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001349 * @sw_scan_start: Notifier function that is called just before a software scan
1350 * is started. Can be NULL, if the driver doesn't need this notification.
1351 *
1352 * @sw_scan_complete: Notifier function that is called just after a software scan
1353 * finished. Can be NULL, if the driver doesn't need this notification.
1354 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001355 * @get_stats: Return low-level statistics.
1356 * Returns zero if statistics are available.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001357 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001358 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1359 * callback should be provided to read the TKIP transmit IVs (both IV32
1360 * and IV16) for the given key from hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001361 *
1362 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1363 *
Christian Lamparter89fad572008-12-09 16:28:06 +01001364 * @sta_notify: Notifies low level driver about addition, removal or power
1365 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1366 * Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001367 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001368 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001369 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001370 * Returns a negative error code on failure.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001371 *
1372 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1373 * to get number of currently queued packets (queue length), maximum queue
1374 * size (limit), and total number of packets sent using each TX queue
Johannes Berg57ffc582008-04-29 17:18:59 +02001375 * (count). The 'stats' pointer points to an array that has hw->queues +
1376 * hw->ampdu_queues items.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001377 *
1378 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001379 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001380 * required function.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001381 *
1382 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1383 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001384 * required function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001385 *
1386 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1387 * with other STAs in the IBSS. This is only used in IBSS mode. This
1388 * function is optional if the firmware/hardware takes full care of
1389 * TSF synchronization.
1390 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001391 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1392 * This is needed only for IBSS mode and the result of this function is
1393 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001394 * Returns non-zero if this device sent the last beacon.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001395 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001396 * @ampdu_action: Perform a certain A-MPDU action
1397 * The RA/TID combination determines the destination and TID we want
1398 * the ampdu action to be performed for. The action is defined through
1399 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001400 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001401 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001402 * Returns a negative error code on failure.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001403 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001404struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001405 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001406 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001407 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001408 int (*add_interface)(struct ieee80211_hw *hw,
1409 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001410 void (*remove_interface)(struct ieee80211_hw *hw,
1411 struct ieee80211_if_init_conf *conf);
Johannes Berge8975582008-10-09 12:18:51 +02001412 int (*config)(struct ieee80211_hw *hw, u32 changed);
Jiri Bencf0706e82007-05-05 11:45:53 -07001413 int (*config_interface)(struct ieee80211_hw *hw,
Johannes Berg32bfd352007-12-19 01:31:26 +01001414 struct ieee80211_vif *vif,
1415 struct ieee80211_if_conf *conf);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001416 void (*bss_info_changed)(struct ieee80211_hw *hw,
1417 struct ieee80211_vif *vif,
1418 struct ieee80211_bss_conf *info,
1419 u32 changed);
Johannes Berg4150c572007-09-17 01:29:23 -04001420 void (*configure_filter)(struct ieee80211_hw *hw,
1421 unsigned int changed_flags,
1422 unsigned int *total_flags,
1423 int mc_count, struct dev_addr_list *mc_list);
Johannes Berg17741cd2008-09-11 00:02:02 +02001424 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1425 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001426 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001427 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001428 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001429 void (*update_tkip_key)(struct ieee80211_hw *hw,
1430 struct ieee80211_key_conf *conf, const u8 *address,
1431 u32 iv32, u16 *phase1key);
Johannes Berg2a519312009-02-10 21:25:55 +01001432 int (*hw_scan)(struct ieee80211_hw *hw,
1433 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001434 void (*sw_scan_start)(struct ieee80211_hw *hw);
1435 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001436 int (*get_stats)(struct ieee80211_hw *hw,
1437 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001438 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1439 u32 *iv32, u16 *iv16);
Jiri Bencf0706e82007-05-05 11:45:53 -07001440 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg32bfd352007-12-19 01:31:26 +01001441 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001442 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001443 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07001444 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e82007-05-05 11:45:53 -07001445 int (*get_tx_stats)(struct ieee80211_hw *hw,
1446 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e82007-05-05 11:45:53 -07001447 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001448 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001449 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001450 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001451 int (*ampdu_action)(struct ieee80211_hw *hw,
1452 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001453 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Jiri Bencf0706e82007-05-05 11:45:53 -07001454};
1455
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001456/**
1457 * ieee80211_alloc_hw - Allocate a new hardware device
1458 *
1459 * This must be called once for each hardware device. The returned pointer
1460 * must be used to refer to this device when calling other functions.
1461 * mac80211 allocates a private data area for the driver pointed to by
1462 * @priv in &struct ieee80211_hw, the size of this area is given as
1463 * @priv_data_len.
1464 *
1465 * @priv_data_len: length of private data
1466 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07001467 */
1468struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1469 const struct ieee80211_ops *ops);
1470
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001471/**
1472 * ieee80211_register_hw - Register hardware device
1473 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001474 * You must call this function before any other functions in
1475 * mac80211. Note that before a hardware can be registered, you
1476 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001477 *
1478 * @hw: the device to register as returned by ieee80211_alloc_hw()
1479 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001480int ieee80211_register_hw(struct ieee80211_hw *hw);
1481
Jiri Bencf0706e82007-05-05 11:45:53 -07001482#ifdef CONFIG_MAC80211_LEDS
1483extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1484extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001485extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001486extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001487#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001488/**
1489 * ieee80211_get_tx_led_name - get name of TX LED
1490 *
1491 * mac80211 creates a transmit LED trigger for each wireless hardware
1492 * that can be used to drive LEDs if your driver registers a LED device.
1493 * This function returns the name (or %NULL if not configured for LEDs)
1494 * of the trigger so you can automatically link the LED device.
1495 *
1496 * @hw: the hardware to get the LED trigger name for
1497 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001498static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1499{
1500#ifdef CONFIG_MAC80211_LEDS
1501 return __ieee80211_get_tx_led_name(hw);
1502#else
1503 return NULL;
1504#endif
1505}
1506
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001507/**
1508 * ieee80211_get_rx_led_name - get name of RX LED
1509 *
1510 * mac80211 creates a receive LED trigger for each wireless hardware
1511 * that can be used to drive LEDs if your driver registers a LED device.
1512 * This function returns the name (or %NULL if not configured for LEDs)
1513 * of the trigger so you can automatically link the LED device.
1514 *
1515 * @hw: the hardware to get the LED trigger name for
1516 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001517static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1518{
1519#ifdef CONFIG_MAC80211_LEDS
1520 return __ieee80211_get_rx_led_name(hw);
1521#else
1522 return NULL;
1523#endif
1524}
1525
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001526/**
1527 * ieee80211_get_assoc_led_name - get name of association LED
1528 *
1529 * mac80211 creates a association LED trigger for each wireless hardware
1530 * that can be used to drive LEDs if your driver registers a LED device.
1531 * This function returns the name (or %NULL if not configured for LEDs)
1532 * of the trigger so you can automatically link the LED device.
1533 *
1534 * @hw: the hardware to get the LED trigger name for
1535 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001536static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1537{
1538#ifdef CONFIG_MAC80211_LEDS
1539 return __ieee80211_get_assoc_led_name(hw);
1540#else
1541 return NULL;
1542#endif
1543}
1544
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001545/**
1546 * ieee80211_get_radio_led_name - get name of radio LED
1547 *
1548 * mac80211 creates a radio change LED trigger for each wireless hardware
1549 * that can be used to drive LEDs if your driver registers a LED device.
1550 * This function returns the name (or %NULL if not configured for LEDs)
1551 * of the trigger so you can automatically link the LED device.
1552 *
1553 * @hw: the hardware to get the LED trigger name for
1554 */
1555static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1556{
1557#ifdef CONFIG_MAC80211_LEDS
1558 return __ieee80211_get_radio_led_name(hw);
1559#else
1560 return NULL;
1561#endif
1562}
Michael Buesch47f0c502007-09-27 15:10:44 +02001563
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001564/**
1565 * ieee80211_unregister_hw - Unregister a hardware device
1566 *
1567 * This function instructs mac80211 to free allocated resources
1568 * and unregister netdevices from the networking subsystem.
1569 *
1570 * @hw: the hardware to unregister
1571 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001572void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1573
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001574/**
1575 * ieee80211_free_hw - free hardware descriptor
1576 *
1577 * This function frees everything that was allocated, including the
1578 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001579 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001580 *
1581 * @hw: the hardware to free
1582 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001583void ieee80211_free_hw(struct ieee80211_hw *hw);
1584
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001585/* trick to avoid symbol clashes with the ieee80211 subsystem */
Jiri Bencf0706e82007-05-05 11:45:53 -07001586void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1587 struct ieee80211_rx_status *status);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001588
1589/**
1590 * ieee80211_rx - receive frame
1591 *
1592 * Use this function to hand received frames to mac80211. The receive
1593 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1594 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1595 *
Johannes Berg2485f712008-02-25 16:27:41 +01001596 * This function may not be called in IRQ context. Calls to this function
1597 * for a single hardware must be synchronized against each other. Calls
1598 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1599 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001600 *
1601 * @hw: the hardware this frame came in on
1602 * @skb: the buffer to receive, owned by mac80211 after this call
1603 * @status: status of this frame; the status pointer need not be valid
1604 * after this function returns
1605 */
1606static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1607 struct ieee80211_rx_status *status)
1608{
1609 __ieee80211_rx(hw, skb, status);
1610}
1611
1612/**
1613 * ieee80211_rx_irqsafe - receive frame
1614 *
1615 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001616 * (internally defers to a tasklet.)
1617 *
1618 * Calls to this function and ieee80211_rx() may not be mixed for a
1619 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001620 *
1621 * @hw: the hardware this frame came in on
1622 * @skb: the buffer to receive, owned by mac80211 after this call
1623 * @status: status of this frame; the status pointer need not be valid
1624 * after this function returns and is not freed by mac80211,
1625 * it is recommended that it points to a stack area
1626 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001627void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1628 struct sk_buff *skb,
1629 struct ieee80211_rx_status *status);
1630
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001631/**
1632 * ieee80211_tx_status - transmit status callback
1633 *
1634 * Call this function for all transmitted frames after they have been
1635 * transmitted. It is permissible to not call this function for
1636 * multicast frames but this can affect statistics.
1637 *
Johannes Berg2485f712008-02-25 16:27:41 +01001638 * This function may not be called in IRQ context. Calls to this function
1639 * for a single hardware must be synchronized against each other. Calls
1640 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1641 * for a single hardware.
1642 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001643 * @hw: the hardware the frame was transmitted by
1644 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001645 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001646void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001647 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001648
1649/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001650 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001651 *
1652 * Like ieee80211_tx_status() but can be called in IRQ context
1653 * (internally defers to a tasklet.)
1654 *
1655 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1656 * single hardware.
1657 *
1658 * @hw: the hardware the frame was transmitted by
1659 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001660 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001661void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001662 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001663
1664/**
1665 * ieee80211_beacon_get - beacon generation function
1666 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001667 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001668 *
1669 * If the beacon frames are generated by the host system (i.e., not in
1670 * hardware/firmware), the low-level driver uses this function to receive
1671 * the next beacon frame from the 802.11 code. The low-level is responsible
1672 * for calling this function before beacon data is needed (e.g., based on
1673 * hardware interrupt). Returned skb is used only once and low-level driver
Bob Copelande37d4df2008-10-20 21:20:27 -04001674 * is responsible for freeing it.
Jiri Bencf0706e82007-05-05 11:45:53 -07001675 */
1676struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001677 struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001678
1679/**
1680 * ieee80211_rts_get - RTS frame generation function
1681 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001682 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001683 * @frame: pointer to the frame that is going to be protected by the RTS.
1684 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001685 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001686 * @rts: The buffer where to store the RTS frame.
1687 *
1688 * If the RTS frames are generated by the host system (i.e., not in
1689 * hardware/firmware), the low-level driver uses this function to receive
1690 * the next RTS frame from the 802.11 code. The low-level is responsible
1691 * for calling this function before and RTS frame is needed.
1692 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001693void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001694 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001695 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001696 struct ieee80211_rts *rts);
1697
1698/**
1699 * ieee80211_rts_duration - Get the duration field for an RTS frame
1700 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001701 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001702 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02001703 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001704 *
1705 * If the RTS is generated in firmware, but the host system must provide
1706 * the duration field, the low-level driver uses this function to receive
1707 * the duration field value in little-endian byteorder.
1708 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001709__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1710 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001711 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07001712
1713/**
1714 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1715 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001716 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001717 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1718 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001719 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001720 * @cts: The buffer where to store the CTS-to-self frame.
1721 *
1722 * If the CTS-to-self frames are generated by the host system (i.e., not in
1723 * hardware/firmware), the low-level driver uses this function to receive
1724 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1725 * for calling this function before and CTS-to-self frame is needed.
1726 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001727void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1728 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001729 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001730 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001731 struct ieee80211_cts *cts);
1732
1733/**
1734 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1735 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001736 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001737 * @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 +02001738 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001739 *
1740 * If the CTS-to-self is generated in firmware, but the host system must provide
1741 * the duration field, the low-level driver uses this function to receive
1742 * the duration field value in little-endian byteorder.
1743 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001744__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1745 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001746 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001747 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07001748
1749/**
1750 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1751 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001752 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001753 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001754 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07001755 *
1756 * Calculate the duration field of some generic frame, given its
1757 * length and transmission rate (in 100kbps).
1758 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001759__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1760 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001761 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01001762 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07001763
1764/**
1765 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1766 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001767 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001768 *
1769 * Function for accessing buffered broadcast and multicast frames. If
1770 * hardware/firmware does not implement buffering of broadcast/multicast
1771 * frames when power saving is used, 802.11 code buffers them in the host
1772 * memory. The low-level driver uses this function to fetch next buffered
1773 * frame. In most cases, this is used when generating beacon frame. This
1774 * function returns a pointer to the next buffered skb or NULL if no more
1775 * buffered frames are available.
1776 *
1777 * Note: buffered frames are returned only after DTIM beacon frame was
1778 * generated with ieee80211_beacon_get() and the low-level driver must thus
1779 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1780 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1781 * does not need to check for DTIM beacons separately and should be able to
1782 * use common code for all beacons.
1783 */
1784struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02001785ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001786
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001787/**
1788 * ieee80211_get_hdrlen_from_skb - get header length from data
1789 *
1790 * Given an skb with a raw 802.11 header at the data pointer this function
Jiri Bencf0706e82007-05-05 11:45:53 -07001791 * returns the 802.11 header length in bytes (not including encryption
1792 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1793 * header the function returns 0.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001794 *
1795 * @skb: the frame
Jiri Bencf0706e82007-05-05 11:45:53 -07001796 */
Harvey Harrisonc9c69502008-06-11 14:21:57 -07001797unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001798
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001799/**
Harvey Harrison6693be72008-06-11 14:21:57 -07001800 * ieee80211_hdrlen - get header length in bytes from frame control
1801 * @fc: frame control field in little-endian format
1802 */
1803unsigned int ieee80211_hdrlen(__le16 fc);
1804
1805/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001806 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1807 *
1808 * This function computes a TKIP rc4 key for an skb. It computes
1809 * a phase 1 key if needed (iv16 wraps around). This function is to
1810 * be used by drivers which can do HW encryption but need to compute
1811 * to phase 1/2 key in SW.
1812 *
1813 * @keyconf: the parameter passed with the set key
1814 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001815 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001816 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001817 */
1818void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1819 struct sk_buff *skb,
1820 enum ieee80211_tkip_key_type type, u8 *key);
1821/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001822 * ieee80211_wake_queue - wake specific queue
1823 * @hw: pointer as obtained from ieee80211_alloc_hw().
1824 * @queue: queue number (counted from zero).
1825 *
1826 * Drivers should use this function instead of netif_wake_queue.
1827 */
1828void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1829
1830/**
1831 * ieee80211_stop_queue - stop specific queue
1832 * @hw: pointer as obtained from ieee80211_alloc_hw().
1833 * @queue: queue number (counted from zero).
1834 *
1835 * Drivers should use this function instead of netif_stop_queue.
1836 */
1837void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1838
1839/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03001840 * ieee80211_queue_stopped - test status of the queue
1841 * @hw: pointer as obtained from ieee80211_alloc_hw().
1842 * @queue: queue number (counted from zero).
1843 *
1844 * Drivers should use this function instead of netif_stop_queue.
1845 */
1846
1847int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1848
1849/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001850 * ieee80211_stop_queues - stop all queues
1851 * @hw: pointer as obtained from ieee80211_alloc_hw().
1852 *
1853 * Drivers should use this function instead of netif_stop_queue.
1854 */
1855void ieee80211_stop_queues(struct ieee80211_hw *hw);
1856
1857/**
1858 * ieee80211_wake_queues - wake all queues
1859 * @hw: pointer as obtained from ieee80211_alloc_hw().
1860 *
1861 * Drivers should use this function instead of netif_wake_queue.
1862 */
1863void ieee80211_wake_queues(struct ieee80211_hw *hw);
1864
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001865/**
1866 * ieee80211_scan_completed - completed hardware scan
1867 *
1868 * When hardware scan offload is used (i.e. the hw_scan() callback is
1869 * assigned) this function needs to be called by the driver to notify
1870 * mac80211 that the scan finished.
1871 *
1872 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01001873 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001874 */
Johannes Berg2a519312009-02-10 21:25:55 +01001875void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07001876
Johannes Bergdabeb342007-11-09 01:57:29 +01001877/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001878 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01001879 *
1880 * This function iterates over the interfaces associated with a given
1881 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001882 * This function allows the iterator function to sleep, when the iterator
1883 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1884 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01001885 *
1886 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001887 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01001888 * @data: first argument of the iterator function
1889 */
1890void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1891 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01001892 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01001893 void *data);
1894
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001895/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001896 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1897 *
1898 * This function iterates over the interfaces associated with a given
1899 * hardware that are currently active and calls the callback for them.
1900 * This function requires the iterator callback function to be atomic,
1901 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1902 *
1903 * @hw: the hardware struct of which the interfaces should be iterated over
1904 * @iterator: the iterator function to call, cannot sleep
1905 * @data: first argument of the iterator function
1906 */
1907void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1908 void (*iterator)(void *data,
1909 u8 *mac,
1910 struct ieee80211_vif *vif),
1911 void *data);
1912
1913/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001914 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1915 * @hw: pointer as obtained from ieee80211_alloc_hw().
1916 * @ra: receiver address of the BA session recipient
1917 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001918 *
1919 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001920 *
1921 * Although mac80211/low level driver/user space application can estimate
1922 * the need to start aggregation on a certain RA/TID, the session level
1923 * will be managed by the mac80211.
1924 */
1925int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1926
1927/**
1928 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1929 * @hw: pointer as obtained from ieee80211_alloc_hw().
1930 * @ra: receiver address of the BA session recipient.
1931 * @tid: the TID to BA on.
1932 *
1933 * This function must be called by low level driver once it has
1934 * finished with preparations for the BA session.
1935 */
1936void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1937
1938/**
1939 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1940 * @hw: pointer as obtained from ieee80211_alloc_hw().
1941 * @ra: receiver address of the BA session recipient.
1942 * @tid: the TID to BA on.
1943 *
1944 * This function must be called by low level driver once it has
1945 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001946 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001947 */
1948void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1949 u16 tid);
1950
1951/**
1952 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1953 * @hw: pointer as obtained from ieee80211_alloc_hw().
1954 * @ra: receiver address of the BA session recipient
1955 * @tid: the TID to stop BA.
1956 * @initiator: if indicates initiator DELBA frame will be sent.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001957 *
1958 * Return: error if no sta with matching da found, success otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001959 *
1960 * Although mac80211/low level driver/user space application can estimate
1961 * the need to stop aggregation on a certain RA/TID, the session level
1962 * will be managed by the mac80211.
1963 */
1964int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1965 u8 *ra, u16 tid,
1966 enum ieee80211_back_parties initiator);
1967
1968/**
1969 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1970 * @hw: pointer as obtained from ieee80211_alloc_hw().
1971 * @ra: receiver address of the BA session recipient.
1972 * @tid: the desired TID to BA on.
1973 *
1974 * This function must be called by low level driver once it has
1975 * finished with preparations for the BA session tear down.
1976 */
1977void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1978
1979/**
1980 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1981 * @hw: pointer as obtained from ieee80211_alloc_hw().
1982 * @ra: receiver address of the BA session recipient.
1983 * @tid: the desired TID to BA on.
1984 *
1985 * This function must be called by low level driver once it has
1986 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001987 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001988 */
1989void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1990 u16 tid);
1991
Mohamed Abbas84363e62008-04-04 16:59:58 -07001992/**
Johannes Berg17741cd2008-09-11 00:02:02 +02001993 * ieee80211_find_sta - find a station
1994 *
1995 * @hw: pointer as obtained from ieee80211_alloc_hw()
1996 * @addr: station's address
1997 *
1998 * This function must be called under RCU lock and the
1999 * resulting pointer is only valid under RCU lock as well.
2000 */
2001struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
2002 const u8 *addr);
2003
Kalle Valo04de8382009-03-22 21:57:35 +02002004/**
2005 * ieee80211_beacon_loss - inform hardware does not receive beacons
2006 *
2007 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
2008 *
2009 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2010 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2011 * hardware is not receiving beacons with this function.
2012 */
2013void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002014
2015/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002016
Johannes Berg4b7679a2008-09-18 18:14:18 +02002017/**
Sujith81cb7622009-02-12 11:38:37 +05302018 * enum rate_control_changed - flags to indicate which parameter changed
2019 *
2020 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2021 * changed, rate control algorithm can update its internal state if needed.
2022 */
2023enum rate_control_changed {
2024 IEEE80211_RC_HT_CHANGED = BIT(0)
2025};
2026
2027/**
Johannes Berge6a98542008-10-21 12:40:02 +02002028 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002029 *
Johannes Berge6a98542008-10-21 12:40:02 +02002030 * @hw: The hardware the algorithm is invoked for.
2031 * @sband: The band this frame is being transmitted on.
2032 * @bss_conf: the current BSS configuration
2033 * @reported_rate: The rate control algorithm can fill this in to indicate
2034 * which rate should be reported to userspace as the current rate and
2035 * used for rate calculations in the mesh network.
2036 * @rts: whether RTS will be used for this frame because it is longer than the
2037 * RTS threshold
2038 * @short_preamble: whether mac80211 will request short-preamble transmission
2039 * if the selected rate supports it
2040 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002041 * @skb: the skb that will be transmitted, the control information in it needs
2042 * to be filled in
Johannes Berg4b7679a2008-09-18 18:14:18 +02002043 */
Johannes Berge6a98542008-10-21 12:40:02 +02002044struct ieee80211_tx_rate_control {
2045 struct ieee80211_hw *hw;
2046 struct ieee80211_supported_band *sband;
2047 struct ieee80211_bss_conf *bss_conf;
2048 struct sk_buff *skb;
2049 struct ieee80211_tx_rate reported_rate;
2050 bool rts, short_preamble;
2051 u8 max_rate_idx;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002052};
2053
2054struct rate_control_ops {
2055 struct module *module;
2056 const char *name;
2057 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002058 void (*free)(void *priv);
2059
2060 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2061 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2062 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302063 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2064 struct ieee80211_sta *sta,
2065 void *priv_sta, u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002066 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2067 void *priv_sta);
2068
2069 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2070 struct ieee80211_sta *sta, void *priv_sta,
2071 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002072 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2073 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002074
2075 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2076 struct dentry *dir);
2077 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2078};
2079
2080static inline int rate_supported(struct ieee80211_sta *sta,
2081 enum ieee80211_band band,
2082 int index)
2083{
2084 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2085}
2086
2087static inline s8
2088rate_lowest_index(struct ieee80211_supported_band *sband,
2089 struct ieee80211_sta *sta)
2090{
2091 int i;
2092
2093 for (i = 0; i < sband->n_bitrates; i++)
2094 if (rate_supported(sta, sband->band, i))
2095 return i;
2096
2097 /* warn when we cannot find a rate. */
2098 WARN_ON(1);
2099
2100 return 0;
2101}
2102
2103
2104int ieee80211_rate_control_register(struct rate_control_ops *ops);
2105void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2106
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002107static inline bool
2108conf_is_ht20(struct ieee80211_conf *conf)
2109{
Johannes Berg47979382009-01-07 10:13:27 +01002110 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002111}
2112
2113static inline bool
2114conf_is_ht40_minus(struct ieee80211_conf *conf)
2115{
Johannes Berg47979382009-01-07 10:13:27 +01002116 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002117}
2118
2119static inline bool
2120conf_is_ht40_plus(struct ieee80211_conf *conf)
2121{
Johannes Berg47979382009-01-07 10:13:27 +01002122 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002123}
2124
2125static inline bool
2126conf_is_ht40(struct ieee80211_conf *conf)
2127{
2128 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2129}
2130
2131static inline bool
2132conf_is_ht(struct ieee80211_conf *conf)
2133{
Johannes Berg47979382009-01-07 10:13:27 +01002134 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002135}
2136
Jiri Bencf0706e82007-05-05 11:45:53 -07002137#endif /* MAC80211_H */