blob: b397e4d984c7a0a870f6969741a01b3daba2fea0 [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 Berg3017b802007-08-28 17:01:53 -04006 * Copyright 2007 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/**
Mohamed Abbas84363e62008-04-04 16:59:58 -070077 * enum ieee80211_notification_type - Low level driver notification
78 * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
79 */
80enum ieee80211_notification_types {
81 IEEE80211_NOTIFY_RE_ASSOC,
82};
83
84/**
Ron Rindjunsky10816d42007-11-26 16:14:30 +020085 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
86 *
87 * This structure describes most essential parameters needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -070088 * to describe 802.11n HT characteristics in a BSS.
Ron Rindjunsky10816d42007-11-26 16:14:30 +020089 *
90 * @primary_channel: channel number of primery channel
91 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
92 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
93 */
94struct ieee80211_ht_bss_info {
95 u8 primary_channel;
96 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
97 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
98};
99
100/**
Johannes Berge100bb62008-04-30 18:51:21 +0200101 * enum ieee80211_max_queues - maximum number of queues
102 *
103 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
104 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
105 * for A-MPDU operation.
106 */
107enum ieee80211_max_queues {
108 IEEE80211_MAX_QUEUES = 16,
109 IEEE80211_MAX_AMPDU_QUEUES = 16,
110};
111
112/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400113 * struct ieee80211_tx_queue_params - transmit queue configuration
114 *
115 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100116 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400117 *
Johannes Bergf434b2d2008-07-10 11:22:31 +0200118 * @aifs: arbitration interface space [0..255]
119 * @cw_min: minimum contention window [a value of the form
120 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400121 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100122 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Johannes Berg6b301cd2007-09-18 17:29:20 -0400123 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700124struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200125 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100126 u16 cw_min;
127 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200128 u8 aifs;
Jiri Bencf0706e82007-05-05 11:45:53 -0700129};
130
Johannes Berg6b301cd2007-09-18 17:29:20 -0400131/**
Johannes Berg57ffc582008-04-29 17:18:59 +0200132 * struct ieee80211_tx_queue_stats - transmit queue statistics
Johannes Berg6b301cd2007-09-18 17:29:20 -0400133 *
134 * @len: number of packets in queue
135 * @limit: queue length limit
136 * @count: number of frames sent
137 */
Johannes Berg57ffc582008-04-29 17:18:59 +0200138struct ieee80211_tx_queue_stats {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400139 unsigned int len;
140 unsigned int limit;
141 unsigned int count;
Jiri Bencf0706e82007-05-05 11:45:53 -0700142};
143
Jiri Bencf0706e82007-05-05 11:45:53 -0700144struct ieee80211_low_level_stats {
145 unsigned int dot11ACKFailureCount;
146 unsigned int dot11RTSFailureCount;
147 unsigned int dot11FCSErrorCount;
148 unsigned int dot11RTSSuccessCount;
149};
150
Johannes Berg471b3ef2007-12-28 14:32:58 +0100151/**
152 * enum ieee80211_bss_change - BSS change notification flags
153 *
154 * These flags are used with the bss_info_changed() callback
155 * to indicate which BSS parameter changed.
156 *
157 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
158 * also implies a change in the AID.
159 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
160 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700161 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg471b3ef2007-12-28 14:32:58 +0100162 */
163enum ieee80211_bss_change {
164 BSS_CHANGED_ASSOC = 1<<0,
165 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
166 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Tomas Winkler38668c02008-03-28 16:33:32 -0700167 BSS_CHANGED_HT = 1<<4,
Johannes Berg471b3ef2007-12-28 14:32:58 +0100168};
169
170/**
171 * struct ieee80211_bss_conf - holds the BSS's changing parameters
172 *
173 * This structure keeps information about a BSS (and an association
174 * to that BSS) that can change during the lifetime of the BSS.
175 *
176 * @assoc: association status
177 * @aid: association ID number, valid only when @assoc is true
178 * @use_cts_prot: use CTS protection
179 * @use_short_preamble: use 802.11b short preamble
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800180 * @dtim_period: num of beacons before the next DTIM, for PSM
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700181 * @timestamp: beacon timestamp
182 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800183 * @assoc_capability: capabilities taken from assoc resp
Tomas Winkler38668c02008-03-28 16:33:32 -0700184 * @assoc_ht: association in HT mode
185 * @ht_conf: ht capabilities
186 * @ht_bss_conf: ht extended capabilities
Johannes Berg471b3ef2007-12-28 14:32:58 +0100187 */
188struct ieee80211_bss_conf {
189 /* association related data */
190 bool assoc;
191 u16 aid;
192 /* erp related data */
193 bool use_cts_prot;
194 bool use_short_preamble;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800195 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700196 u16 beacon_int;
197 u16 assoc_capability;
198 u64 timestamp;
Tomas Winkler38668c02008-03-28 16:33:32 -0700199 /* ht related data */
200 bool assoc_ht;
201 struct ieee80211_ht_info *ht_conf;
202 struct ieee80211_ht_bss_info *ht_bss_conf;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100203};
204
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800205/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700206 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800207 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700208 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800209 *
Johannes Berge039fa42008-05-15 12:55:29 +0200210 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
Johannes Berge039fa42008-05-15 12:55:29 +0200211 * @IEEE80211_TX_CTL_USE_RTS_CTS: use RTS-CTS before sending frame
212 * @IEEE80211_TX_CTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
213 * for combined 802.11g / 802.11b networks)
214 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700215 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200216 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
217 * station
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700218 * @IEEE80211_TX_CTL_REQUEUE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200219 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700220 * @IEEE80211_TX_CTL_SHORT_PREAMBLE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200221 * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
222 * through set_retry_limit configured long retry value
Johannes Berge039fa42008-05-15 12:55:29 +0200223 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
224 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
225 * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
226 * of streams when this flag is on can be extracted from antenna_sel_tx,
227 * so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
228 * antennas marked use MIMO_n.
229 * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
230 * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
231 * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
232 * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700233 * @IEEE80211_TX_CTL_INJECTED: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200234 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
235 * because the destination STA was in powersave mode.
236 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
237 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
238 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300239 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
240 * so consider using block ack request (BAR).
Johannes Bergf591fa52008-07-10 11:21:26 +0200241 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
242 * number to this frame, taking care of not overwriting the fragment
243 * number and increasing the sequence number only when the
244 * IEEE80211_TX_CTL_FIRST_FRAGMENT flags is set. mac80211 will properly
245 * assign sequence numbers to QoS-data frames but cannot do so correctly
246 * for non-QoS-data and management frames because beacons need them from
247 * that counter as well and mac80211 cannot guarantee proper sequencing.
248 * If this flag is set, the driver should instruct the hardware to
249 * assign a sequence number to the frame or assign one itself. Cf. IEEE
250 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
251 * beacons always be clear for frames without a sequence number field.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800252 */
253enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200254 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge039fa42008-05-15 12:55:29 +0200255 IEEE80211_TX_CTL_USE_RTS_CTS = BIT(2),
256 IEEE80211_TX_CTL_USE_CTS_PROTECT = BIT(3),
257 IEEE80211_TX_CTL_NO_ACK = BIT(4),
258 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(5),
259 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(6),
260 IEEE80211_TX_CTL_REQUEUE = BIT(7),
261 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(8),
262 IEEE80211_TX_CTL_SHORT_PREAMBLE = BIT(9),
263 IEEE80211_TX_CTL_LONG_RETRY_LIMIT = BIT(10),
Johannes Berge039fa42008-05-15 12:55:29 +0200264 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(12),
265 IEEE80211_TX_CTL_AMPDU = BIT(13),
266 IEEE80211_TX_CTL_OFDM_HT = BIT(14),
267 IEEE80211_TX_CTL_GREEN_FIELD = BIT(15),
268 IEEE80211_TX_CTL_40_MHZ_WIDTH = BIT(16),
269 IEEE80211_TX_CTL_DUP_DATA = BIT(17),
270 IEEE80211_TX_CTL_SHORT_GI = BIT(18),
271 IEEE80211_TX_CTL_INJECTED = BIT(19),
272 IEEE80211_TX_STAT_TX_FILTERED = BIT(20),
273 IEEE80211_TX_STAT_ACK = BIT(21),
274 IEEE80211_TX_STAT_AMPDU = BIT(22),
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300275 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(23),
Johannes Bergf591fa52008-07-10 11:21:26 +0200276 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(24),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800277};
278
Johannes Berge039fa42008-05-15 12:55:29 +0200279
280#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
281 (sizeof(((struct sk_buff *)0)->cb) - 8)
282#define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
283 (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
284
285/**
286 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200287 *
Johannes Berge039fa42008-05-15 12:55:29 +0200288 * This structure is placed in skb->cb for three uses:
289 * (1) mac80211 TX control - mac80211 tells the driver what to do
290 * (2) driver internal use (if applicable)
291 * (3) TX status information - driver tells mac80211 what happened
292 *
293 * @flags: transmit info flags, defined above
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700294 * @band: TBD
295 * @tx_rate_idx: TBD
296 * @antenna_sel_tx: TBD
297 * @control: union for control data
298 * @status: union for status data
299 * @driver_data: array of driver_data pointers
Johannes Berge039fa42008-05-15 12:55:29 +0200300 * @retry_count: number of retries
301 * @excessive_retries: set to 1 if the frame was retried many times
302 * but not acknowledged
303 * @ampdu_ack_len: number of aggregated frames.
304 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
305 * @ampdu_ack_map: block ack bit map for the aggregation.
306 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
307 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200308 */
Johannes Berge039fa42008-05-15 12:55:29 +0200309struct ieee80211_tx_info {
310 /* common information */
311 u32 flags;
312 u8 band;
313 s8 tx_rate_idx;
314 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100315
Johannes Berge2530082008-05-17 00:57:14 +0200316 /* 1 byte hole */
Johannes Berg8318d782008-01-24 19:38:38 +0100317
Johannes Berge039fa42008-05-15 12:55:29 +0200318 union {
319 struct {
320 struct ieee80211_vif *vif;
321 struct ieee80211_key_conf *hw_key;
322 unsigned long jiffies;
Johannes Berge039fa42008-05-15 12:55:29 +0200323 u16 aid;
324 s8 rts_cts_rate_idx, alt_retry_rate_idx;
325 u8 retry_limit;
326 u8 icv_len;
327 u8 iv_len;
328 } control;
329 struct {
330 u64 ampdu_ack_map;
331 int ack_signal;
332 u8 retry_count;
333 bool excessive_retries;
334 u8 ampdu_ack_len;
335 } status;
336 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
337 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700338};
339
Johannes Berge039fa42008-05-15 12:55:29 +0200340static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
341{
342 return (struct ieee80211_tx_info *)skb->cb;
343}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400344
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400345
346/**
347 * enum mac80211_rx_flags - receive flags
348 *
349 * These flags are used with the @flag member of &struct ieee80211_rx_status.
350 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
351 * Use together with %RX_FLAG_MMIC_STRIPPED.
352 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
353 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
354 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
355 * verification has been done by the hardware.
356 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
357 * If this flag is set, the stack cannot do any replay detection
358 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400359 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
360 * the frame.
361 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
362 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100363 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900364 * is valid. This is useful in monitor mode and necessary for beacon frames
365 * to enable IBSS merging.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400366 */
367enum mac80211_rx_flags {
368 RX_FLAG_MMIC_ERROR = 1<<0,
369 RX_FLAG_DECRYPTED = 1<<1,
370 RX_FLAG_RADIOTAP = 1<<2,
371 RX_FLAG_MMIC_STRIPPED = 1<<3,
372 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400373 RX_FLAG_FAILED_FCS_CRC = 1<<5,
374 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100375 RX_FLAG_TSFT = 1<<7,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400376};
377
378/**
379 * struct ieee80211_rx_status - receive status
380 *
381 * The low-level driver should provide this information (the subset
382 * supported by hardware) to the 802.11 code with each received
383 * frame.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200384 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900385 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
386 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100387 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400388 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200389 * @signal: signal strength when receiving this frame, either in dBm, in dB or
390 * unspecified depending on the hardware capabilities flags
391 * @IEEE80211_HW_SIGNAL_*
392 * @noise: noise when receiving this frame, in dBm.
393 * @qual: overall signal quality indication, in percent (0-100).
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400394 * @antenna: antenna used
Johannes Berg8318d782008-01-24 19:38:38 +0100395 * @rate_idx: index of data rate into band's supported rates
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400396 * @flag: %RX_FLAG_*
397 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700398struct ieee80211_rx_status {
399 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100400 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400401 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400402 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700403 int noise;
Bruno Randolf566bfe52008-05-08 19:15:40 +0200404 int qual;
Jiri Bencf0706e82007-05-05 11:45:53 -0700405 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100406 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700407 int flag;
408};
409
Johannes Berg6b301cd2007-09-18 17:29:20 -0400410/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400411 * enum ieee80211_conf_flags - configuration flags
412 *
413 * Flags to define PHY configuration options
414 *
415 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
416 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200417 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
Samuel Ortiz49292d52008-07-04 10:49:31 +0200418 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
Johannes Berg6b301cd2007-09-18 17:29:20 -0400419 */
420enum ieee80211_conf_flags {
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200421 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
422 IEEE80211_CONF_RADIOTAP = (1<<1),
423 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
Samuel Ortiz49292d52008-07-04 10:49:31 +0200424 IEEE80211_CONF_PS = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400425};
Jiri Bencf0706e82007-05-05 11:45:53 -0700426
427/**
428 * struct ieee80211_conf - configuration of the device
429 *
430 * This struct indicates how the driver shall configure the hardware.
431 *
432 * @radio_enabled: when zero, driver is required to switch off the radio.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400433 * TODO make a flag
Johannes Berg6b301cd2007-09-18 17:29:20 -0400434 * @beacon_int: beacon interval (TODO make interface config)
Tomas Winklerea95bba2008-07-18 13:53:00 +0800435 * @listen_interval: listen interval in units of beacon interval
Johannes Berg6b301cd2007-09-18 17:29:20 -0400436 * @flags: configuration flags defined above
Johannes Berg8318d782008-01-24 19:38:38 +0100437 * @power_level: requested transmit power (in dBm)
438 * @max_antenna_gain: maximum antenna gain (in dBi)
Johannes Berg6b301cd2007-09-18 17:29:20 -0400439 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
440 * 1/2: antenna 0/1
441 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200442 * @ht_conf: describes current self configuration of 802.11n HT capabilies
443 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
Johannes Berg8318d782008-01-24 19:38:38 +0100444 * @channel: the channel to tune to
Jiri Bencf0706e82007-05-05 11:45:53 -0700445 */
446struct ieee80211_conf {
Jiri Bencf0706e82007-05-05 11:45:53 -0700447 int radio_enabled;
448
449 int beacon_int;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800450 u16 listen_interval;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400451 u32 flags;
Johannes Berg8318d782008-01-24 19:38:38 +0100452 int power_level;
453 int max_antenna_gain;
Jiri Bencf0706e82007-05-05 11:45:53 -0700454 u8 antenna_sel_tx;
455 u8 antenna_sel_rx;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200456
Johannes Berg8318d782008-01-24 19:38:38 +0100457 struct ieee80211_channel *channel;
458
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200459 struct ieee80211_ht_info ht_conf;
460 struct ieee80211_ht_bss_info ht_bss_conf;
Jiri Bencf0706e82007-05-05 11:45:53 -0700461};
462
463/**
464 * enum ieee80211_if_types - types of 802.11 network interfaces
465 *
Johannes Berga2897552007-09-28 14:01:25 +0200466 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
467 * by mac80211 itself
Jiri Bencf0706e82007-05-05 11:45:53 -0700468 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
469 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
470 * daemon. Drivers should never see this type.
471 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
472 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
473 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
474 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400475 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
476 * will never see this type.
Johannes Bergdbbea672008-02-26 14:34:06 +0100477 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
Jiri Bencf0706e82007-05-05 11:45:53 -0700478 */
479enum ieee80211_if_types {
Johannes Berga2897552007-09-28 14:01:25 +0200480 IEEE80211_IF_TYPE_INVALID,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400481 IEEE80211_IF_TYPE_AP,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400482 IEEE80211_IF_TYPE_STA,
483 IEEE80211_IF_TYPE_IBSS,
Johannes Berg6032f932008-02-23 15:17:07 +0100484 IEEE80211_IF_TYPE_MESH_POINT,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400485 IEEE80211_IF_TYPE_MNTR,
486 IEEE80211_IF_TYPE_WDS,
487 IEEE80211_IF_TYPE_VLAN,
Jiri Bencf0706e82007-05-05 11:45:53 -0700488};
489
490/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100491 * struct ieee80211_vif - per-interface data
492 *
493 * Data in this structure is continually present for driver
494 * use during the life of a virtual interface.
495 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100496 * @type: type of this virtual interface
Johannes Berg32bfd352007-12-19 01:31:26 +0100497 * @drv_priv: data area for driver use, will always be aligned to
498 * sizeof(void *).
499 */
500struct ieee80211_vif {
Johannes Berg51fb61e2007-12-19 01:31:27 +0100501 enum ieee80211_if_types type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100502 /* must be last */
503 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
504};
505
Johannes Berg902acc72008-02-23 15:17:19 +0100506static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
507{
508#ifdef CONFIG_MAC80211_MESH
509 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
510#endif
511 return false;
512}
513
Johannes Berg32bfd352007-12-19 01:31:26 +0100514/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700515 * struct ieee80211_if_init_conf - initial configuration of an interface
516 *
Johannes Berg32bfd352007-12-19 01:31:26 +0100517 * @vif: pointer to a driver-use per-interface structure. The pointer
518 * itself is also used for various functions including
519 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
Jiri Bencf0706e82007-05-05 11:45:53 -0700520 * @type: one of &enum ieee80211_if_types constants. Determines the type of
521 * added/removed interface.
522 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
523 * until the interface is removed (i.e. it cannot be used after
524 * remove_interface() callback was called for this interface).
525 *
526 * This structure is used in add_interface() and remove_interface()
527 * callbacks of &struct ieee80211_hw.
Johannes Berg4480f15c2007-07-10 19:32:10 +0200528 *
529 * When you allow multiple interfaces to be added to your PHY, take care
530 * that the hardware can actually handle multiple MAC addresses. However,
531 * also take care that when there's no interface left with mac_addr != %NULL
532 * you remove the MAC address from the device to avoid acknowledging packets
533 * in pure monitor mode.
Jiri Bencf0706e82007-05-05 11:45:53 -0700534 */
535struct ieee80211_if_init_conf {
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400536 enum ieee80211_if_types type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100537 struct ieee80211_vif *vif;
Jiri Bencf0706e82007-05-05 11:45:53 -0700538 void *mac_addr;
539};
540
541/**
Johannes Berg9d139c82008-07-09 14:40:37 +0200542 * enum ieee80211_if_conf_change - interface config change flags
543 *
544 * @IEEE80211_IFCC_BSSID: The BSSID changed.
545 * @IEEE80211_IFCC_SSID: The SSID changed.
546 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
547 * (currently AP and MESH only), use ieee80211_beacon_get().
548 */
549enum ieee80211_if_conf_change {
550 IEEE80211_IFCC_BSSID = BIT(0),
551 IEEE80211_IFCC_SSID = BIT(1),
552 IEEE80211_IFCC_BEACON = BIT(2),
553};
554
555/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700556 * struct ieee80211_if_conf - configuration of an interface
557 *
Johannes Berg9d139c82008-07-09 14:40:37 +0200558 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
Jiri Bencf0706e82007-05-05 11:45:53 -0700559 * @bssid: BSSID of the network we are associated to/creating.
560 * @ssid: used (together with @ssid_len) by drivers for hardware that
561 * generate beacons independently. The pointer is valid only during the
562 * config_interface() call, so copy the value somewhere if you need
563 * it.
564 * @ssid_len: length of the @ssid field.
Jiri Bencf0706e82007-05-05 11:45:53 -0700565 *
566 * This structure is passed to the config_interface() callback of
567 * &struct ieee80211_hw.
568 */
569struct ieee80211_if_conf {
Johannes Berg9d139c82008-07-09 14:40:37 +0200570 u32 changed;
Jiri Bencf0706e82007-05-05 11:45:53 -0700571 u8 *bssid;
572 u8 *ssid;
573 size_t ssid_len;
Jiri Bencf0706e82007-05-05 11:45:53 -0700574};
575
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400576/**
577 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400578 * @ALG_WEP: WEP40 or WEP104
579 * @ALG_TKIP: TKIP
580 * @ALG_CCMP: CCMP (AES)
581 */
Johannes Bergea49c352007-09-18 17:29:21 -0400582enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400583 ALG_WEP,
584 ALG_TKIP,
585 ALG_CCMP,
Johannes Bergea49c352007-09-18 17:29:21 -0400586};
Jiri Bencf0706e82007-05-05 11:45:53 -0700587
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300588/**
589 * enum ieee80211_key_len - key length
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700590 * @LEN_WEP40: WEP 5-byte long key
591 * @LEN_WEP104: WEP 13-byte long key
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300592 */
593enum ieee80211_key_len {
594 LEN_WEP40 = 5,
595 LEN_WEP104 = 13,
596};
Johannes Berg11a843b2007-08-28 17:01:55 -0400597
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400598/**
599 * enum ieee80211_key_flags - key flags
600 *
601 * These flags are used for communication about keys between the driver
602 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
603 *
604 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
605 * that the STA this key will be used with could be using QoS.
606 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
607 * driver to indicate that it requires IV generation for this
608 * particular key.
609 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
610 * the driver for a TKIP key if it requires Michael MIC
611 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200612 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
613 * that the key is pairwise rather then a shared key.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400614 */
615enum ieee80211_key_flags {
616 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
617 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
618 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200619 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400620};
621
622/**
623 * struct ieee80211_key_conf - key information
624 *
625 * This key information is given by mac80211 to the driver by
626 * the set_key() callback in &struct ieee80211_ops.
627 *
628 * @hw_key_idx: To be set by the driver, this is the key index the driver
629 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400630 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400631 * @alg: The key algorithm.
632 * @flags: key flags, see &enum ieee80211_key_flags.
633 * @keyidx: the key index (0-3)
634 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400635 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
636 * data block:
637 * - Temporal Encryption Key (128 bits)
638 * - Temporal Authenticator Tx MIC Key (64 bits)
639 * - Temporal Authenticator Rx MIC Key (64 bits)
640 *
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400641 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700642struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400643 enum ieee80211_key_alg alg;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400644 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400645 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400646 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400647 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700648 u8 key[0];
649};
650
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400651/**
652 * enum set_key_cmd - key command
653 *
654 * Used with the set_key() callback in &struct ieee80211_ops, this
655 * indicates whether a key is being removed or added.
656 *
657 * @SET_KEY: a key is set
658 * @DISABLE_KEY: a key must be disabled
659 */
Johannes Bergea49c352007-09-18 17:29:21 -0400660enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400661 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400662};
Jiri Bencf0706e82007-05-05 11:45:53 -0700663
Tomas Winkler478f8d22007-09-30 13:52:37 +0200664/**
665 * enum sta_notify_cmd - sta notify command
666 *
667 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700668 * indicates addition and removal of a station to station table.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200669 *
670 * @STA_NOTIFY_ADD: a station was added to the station table
671 * @STA_NOTIFY_REMOVE: a station being removed from the station table
672 */
673enum sta_notify_cmd {
674 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
675};
Johannes Berg1bc08262007-09-18 17:29:15 -0400676
677/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200678 * enum ieee80211_tkip_key_type - get tkip key
679 *
680 * Used by drivers which need to get a tkip key for skb. Some drivers need a
681 * phase 1 key, others need a phase 2 key. A single function allows the driver
682 * to get the key, this enum indicates what type of key is required.
683 *
684 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
685 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
686 */
687enum ieee80211_tkip_key_type {
688 IEEE80211_TKIP_P1_KEY,
689 IEEE80211_TKIP_P2_KEY,
690};
691
692/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400693 * enum ieee80211_hw_flags - hardware flags
694 *
695 * These flags are used to indicate hardware capabilities to
696 * the stack. Generally, flags here should have their meaning
697 * done in a way that the simplest hardware doesn't need setting
698 * any particular flags. There are some exceptions to this rule,
699 * however, so you are advised to review these flags carefully.
700 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400701 * @IEEE80211_HW_RX_INCLUDES_FCS:
702 * Indicates that received frames passed to the stack include
703 * the FCS at the end.
704 *
705 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
706 * Some wireless LAN chipsets buffer broadcast/multicast frames
707 * for power saving stations in the hardware/firmware and others
708 * rely on the host system for such buffering. This option is used
709 * to configure the IEEE 802.11 upper layer to buffer broadcast and
710 * multicast frames when there are power saving stations so that
711 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
712 * that not setting this flag works properly only when the
713 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
714 * otherwise the stack will not know when the DTIM beacon was sent.
715 *
Johannes Berg8318d782008-01-24 19:38:38 +0100716 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
717 * Hardware is not capable of short slot operation on the 2.4 GHz band.
718 *
719 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
720 * Hardware is not capable of receiving frames with short preamble on
721 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200722 *
723 * @IEEE80211_HW_SIGNAL_UNSPEC:
724 * Hardware can provide signal values but we don't know its units. We
725 * expect values between 0 and @max_signal.
726 * If possible please provide dB or dBm instead.
727 *
728 * @IEEE80211_HW_SIGNAL_DB:
729 * Hardware gives signal values in dB, decibel difference from an
730 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
731 * If possible please provide dBm instead.
732 *
733 * @IEEE80211_HW_SIGNAL_DBM:
734 * Hardware gives signal values in dBm, decibel difference from
735 * one milliwatt. This is the preferred method since it is standardized
736 * between different devices. @max_signal does not need to be set.
737 *
738 * @IEEE80211_HW_NOISE_DBM:
739 * Hardware can provide noise (radio interference) values in units dBm,
740 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300741 *
742 * @IEEE80211_HW_SPECTRUM_MGMT:
743 * Hardware supports spectrum management defined in 802.11h
744 * Measurement, Channel Switch, Quieting, TPC
Johannes Berg1bc08262007-09-18 17:29:15 -0400745 */
746enum ieee80211_hw_flags {
Johannes Berg1bc08262007-09-18 17:29:15 -0400747 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
748 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100749 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
750 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200751 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
752 IEEE80211_HW_SIGNAL_DB = 1<<6,
753 IEEE80211_HW_SIGNAL_DBM = 1<<7,
754 IEEE80211_HW_NOISE_DBM = 1<<8,
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300755 IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
Johannes Berg1bc08262007-09-18 17:29:15 -0400756};
757
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400758/**
759 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400760 *
761 * This structure contains the configuration and hardware
762 * information for an 802.11 PHY.
763 *
764 * @wiphy: This points to the &struct wiphy allocated for this
765 * 802.11 PHY. You must fill in the @perm_addr and @dev
766 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100767 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
768 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400769 *
770 * @conf: &struct ieee80211_conf, device configuration, don't use.
771 *
772 * @workqueue: single threaded workqueue available for driver use,
Ivo van Doorn428da762008-06-24 19:23:36 +0200773 * allocated by mac80211 on registration and flushed when an
774 * interface is removed.
775 * NOTICE: All work performed on this workqueue should NEVER
776 * acquire the RTNL lock (i.e. Don't use the function
777 * ieee80211_iterate_active_interfaces())
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400778 *
779 * @priv: pointer to private area that was allocated for driver use
780 * along with this structure.
781 *
782 * @flags: hardware flags, see &enum ieee80211_hw_flags.
783 *
784 * @extra_tx_headroom: headroom to reserve in each transmit skb
785 * for use by the driver (e.g. for transmit headers.)
786 *
787 * @channel_change_time: time (in microseconds) it takes to change channels.
788 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200789 * @max_signal: Maximum value for signal (rssi) in RX information, used
790 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400791 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800792 * @max_listen_interval: max listen interval in units of beacon interval
793 * that HW supports
794 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400795 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +0200796 * data packets. WMM/QoS requires at least four, these
797 * queues need to have configurable access parameters.
798 *
799 * @ampdu_queues: number of available hardware transmit queues
800 * for A-MPDU packets, these have no access parameters
801 * because they're used only for A-MPDU frames. Note that
802 * mac80211 will not currently use any of the regular queues
803 * for aggregation.
Johannes Berg830f9032007-10-28 14:51:05 +0100804 *
805 * @rate_control_algorithm: rate control algorithm for this hardware.
806 * If unset (NULL), the default algorithm will be used. Must be
807 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100808 *
809 * @vif_data_size: size (in bytes) of the drv_priv data area
810 * within &struct ieee80211_vif.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400811 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700812struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -0700813 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400814 struct wiphy *wiphy;
Jiri Bencf0706e82007-05-05 11:45:53 -0700815 struct workqueue_struct *workqueue;
Johannes Berg830f9032007-10-28 14:51:05 +0100816 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -0700817 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400818 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -0700819 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -0700820 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +0100821 int vif_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800822 u16 queues;
823 u16 ampdu_queues;
824 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -0700825 s8 max_signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700826};
827
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400828/**
829 * SET_IEEE80211_DEV - set device for 802.11 hardware
830 *
831 * @hw: the &struct ieee80211_hw to set the device for
832 * @dev: the &struct device of this 802.11 device
833 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700834static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
835{
836 set_wiphy_dev(hw->wiphy, dev);
837}
838
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400839/**
840 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
841 *
842 * @hw: the &struct ieee80211_hw to set the MAC address for
843 * @addr: the address to set
844 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700845static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
846{
847 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
848}
849
Johannes Berge2530082008-05-17 00:57:14 +0200850static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
851{
Johannes Berge2530082008-05-17 00:57:14 +0200852 return hw->queues;
Johannes Berge2530082008-05-17 00:57:14 +0200853}
854
855static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
856{
Johannes Berge2530082008-05-17 00:57:14 +0200857 return hw->queues + hw->ampdu_queues;
Johannes Berge2530082008-05-17 00:57:14 +0200858}
859
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200860static inline struct ieee80211_rate *
861ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200862 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200863{
864 if (WARN_ON(c->tx_rate_idx < 0))
865 return NULL;
866 return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
867}
868
869static inline struct ieee80211_rate *
870ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200871 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200872{
Johannes Berge039fa42008-05-15 12:55:29 +0200873 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200874 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +0200875 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200876}
877
878static inline struct ieee80211_rate *
879ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200880 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200881{
Johannes Berge039fa42008-05-15 12:55:29 +0200882 if (c->control.alt_retry_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200883 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +0200884 return &hw->wiphy->bands[c->band]->bitrates[c->control.alt_retry_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200885}
886
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400887/**
888 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -0400889 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400890 * mac80211 is capable of taking advantage of many hardware
891 * acceleration designs for encryption and decryption operations.
892 *
893 * The set_key() callback in the &struct ieee80211_ops for a given
894 * device is called to enable hardware acceleration of encryption and
895 * decryption. The callback takes an @address parameter that will be
896 * the broadcast address for default keys, the other station's hardware
897 * address for individual keys or the zero address for keys that will
898 * be used only for transmission.
899 * Multiple transmission keys with the same key index may be used when
900 * VLANs are configured for an access point.
901 *
902 * The @local_address parameter will always be set to our own address,
903 * this is only relevant if you support multiple local addresses.
904 *
905 * When transmitting, the TX control data will use the @hw_key_idx
906 * selected by the driver by modifying the &struct ieee80211_key_conf
907 * pointed to by the @key parameter to the set_key() function.
908 *
909 * The set_key() call for the %SET_KEY command should return 0 if
910 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
911 * added; if you return 0 then hw_key_idx must be assigned to the
912 * hardware key index, you are free to use the full u8 range.
913 *
914 * When the cmd is %DISABLE_KEY then it must succeed.
915 *
916 * Note that it is permissible to not decrypt a frame even if a key
917 * for it has been uploaded to hardware, the stack will not make any
918 * decision based on whether a key has been uploaded or not but rather
919 * based on the receive flags.
920 *
921 * The &struct ieee80211_key_conf structure pointed to by the @key
922 * parameter is guaranteed to be valid until another call to set_key()
923 * removes it, but it can only be used as a cookie to differentiate
924 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +0200925 *
926 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
927 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
928 * handler.
929 * The update_tkip_key() call updates the driver with the new phase 1 key.
930 * This happens everytime the iv16 wraps around (every 65536 packets). The
931 * set_key() call will happen only once for each key (unless the AP did
932 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
933 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
934 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -0400935 */
Johannes Berg4150c572007-09-17 01:29:23 -0400936
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400937/**
938 * DOC: Frame filtering
939 *
940 * mac80211 requires to see many management frames for proper
941 * operation, and users may want to see many more frames when
942 * in monitor mode. However, for best CPU usage and power consumption,
943 * having as few frames as possible percolate through the stack is
944 * desirable. Hence, the hardware should filter as much as possible.
945 *
946 * To achieve this, mac80211 uses filter flags (see below) to tell
947 * the driver's configure_filter() function which frames should be
948 * passed to mac80211 and which should be filtered out.
949 *
950 * The configure_filter() callback is invoked with the parameters
951 * @mc_count and @mc_list for the combined multicast address list
952 * of all virtual interfaces, @changed_flags telling which flags
953 * were changed and @total_flags with the new flag states.
954 *
955 * If your device has no multicast address filters your driver will
956 * need to check both the %FIF_ALLMULTI flag and the @mc_count
957 * parameter to see whether multicast frames should be accepted
958 * or dropped.
959 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +0100960 * All unsupported flags in @total_flags must be cleared.
961 * Hardware does not support a flag if it is incapable of _passing_
962 * the frame to the stack. Otherwise the driver must ignore
963 * the flag, but not clear it.
964 * You must _only_ clear the flag (announce no support for the
965 * flag to mac80211) if you are not able to pass the packet type
966 * to the stack (so the hardware always filters it).
967 * So for example, you should clear @FIF_CONTROL, if your hardware
968 * always filters control frames. If your hardware always passes
969 * control frames to the kernel and is incapable of filtering them,
970 * you do _not_ clear the @FIF_CONTROL flag.
971 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400972 */
973
974/**
975 * enum ieee80211_filter_flags - hardware filter flags
976 *
977 * These flags determine what the filter in hardware should be
978 * programmed to let through and what should not be passed to the
979 * stack. It is always safe to pass more frames than requested,
980 * but this has negative impact on power consumption.
981 *
982 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
983 * think of the BSS as your network segment and then this corresponds
984 * to the regular ethernet device promiscuous mode.
985 *
986 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
987 * by the user or if the hardware is not capable of filtering by
988 * multicast address.
989 *
990 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
991 * %RX_FLAG_FAILED_FCS_CRC for them)
992 *
993 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
994 * the %RX_FLAG_FAILED_PLCP_CRC for them
995 *
996 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
997 * to the hardware that it should not filter beacons or probe responses
998 * by BSSID. Filtering them can greatly reduce the amount of processing
999 * mac80211 needs to do and the amount of CPU wakeups, so you should
1000 * honour this flag if possible.
1001 *
1002 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1003 * only those addressed to this station
1004 *
1005 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1006 */
1007enum ieee80211_filter_flags {
1008 FIF_PROMISC_IN_BSS = 1<<0,
1009 FIF_ALLMULTI = 1<<1,
1010 FIF_FCSFAIL = 1<<2,
1011 FIF_PLCPFAIL = 1<<3,
1012 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1013 FIF_CONTROL = 1<<5,
1014 FIF_OTHER_BSS = 1<<6,
1015};
1016
1017/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001018 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1019 *
1020 * These flags are used with the ampdu_action() callback in
1021 * &struct ieee80211_ops to indicate which action is needed.
1022 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1023 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001024 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1025 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001026 */
1027enum ieee80211_ampdu_mlme_action {
1028 IEEE80211_AMPDU_RX_START,
1029 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001030 IEEE80211_AMPDU_TX_START,
1031 IEEE80211_AMPDU_TX_STOP,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001032};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001033
1034/**
1035 * struct ieee80211_ops - callbacks from mac80211 to the driver
1036 *
1037 * This structure contains various callbacks that the driver may
1038 * handle or, in some cases, must handle, for example to configure
1039 * the hardware to a new channel or to transmit a frame.
1040 *
1041 * @tx: Handler that 802.11 module calls for each transmitted frame.
1042 * skb contains the buffer starting from the IEEE 802.11 header.
1043 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001044 * configuration in the TX control data. This handler should,
1045 * preferably, never fail and stop queues appropriately, more
1046 * importantly, however, it must never fail for A-MPDU-queues.
1047 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001048 *
1049 * @start: Called before the first netdevice attached to the hardware
1050 * is enabled. This should turn on the hardware and must turn on
1051 * frame reception (for possibly enabled monitor interfaces.)
1052 * Returns negative error codes, these may be seen in userspace,
1053 * or zero.
1054 * When the device is started it should not have a MAC address
1055 * to avoid acknowledging frames before a non-monitor device
1056 * is added.
1057 * Must be implemented.
1058 *
1059 * @stop: Called after last netdevice attached to the hardware
1060 * is disabled. This should turn off the hardware (at least
1061 * it must turn off frame reception.)
1062 * May be called right after add_interface if that rejects
1063 * an interface.
1064 * Must be implemented.
1065 *
1066 * @add_interface: Called when a netdevice attached to the hardware is
1067 * enabled. Because it is not called for monitor mode devices, @open
1068 * and @stop must be implemented.
1069 * The driver should perform any initialization it needs before
1070 * the device can be enabled. The initial configuration for the
1071 * interface is given in the conf parameter.
1072 * The callback may refuse to add an interface by returning a
1073 * negative error code (which will be seen in userspace.)
1074 * Must be implemented.
1075 *
1076 * @remove_interface: Notifies a driver that an interface is going down.
1077 * The @stop callback is called after this if it is the last interface
1078 * and no monitor interfaces are present.
1079 * When all interfaces are removed, the MAC address in the hardware
1080 * must be cleared so the device no longer acknowledges packets,
1081 * the mac_addr member of the conf structure is, however, set to the
1082 * MAC address of the device going away.
1083 * Hence, this callback must be implemented.
1084 *
1085 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1086 * function to change hardware configuration, e.g., channel.
1087 *
1088 * @config_interface: Handler for configuration requests related to interfaces
1089 * (e.g. BSSID changes.)
1090 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001091 * @bss_info_changed: Handler for configuration requests related to BSS
1092 * parameters that may vary during BSS's lifespan, and may affect low
1093 * level driver (e.g. assoc/disassoc status, erp parameters).
1094 * This function should not be used if no BSS has been set, unless
1095 * for association indication. The @changed parameter indicates which
Reinette Chatred18ef292008-04-09 16:56:15 -07001096 * of the bss parameters has changed when a call is made.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001097 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001098 * @configure_filter: Configure the device's RX filter.
1099 * See the section "Frame filtering" for more information.
1100 * This callback must be implemented and atomic.
1101 *
1102 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1103 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1104 * mac80211 calls this function when a TIM bit must be set or cleared
1105 * for a given AID. Must be atomic.
1106 *
1107 * @set_key: See the section "Hardware crypto acceleration"
1108 * This callback can sleep, and is only called between add_interface
1109 * and remove_interface calls, i.e. while the interface with the
1110 * given local_address is enabled.
1111 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001112 * @update_tkip_key: See the section "Hardware crypto acceleration"
1113 * This callback will be called in the context of Rx. Called for drivers
1114 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1115 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001116 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001117 * the scan state machine in stack. The scan must honour the channel
1118 * configuration done by the regulatory agent in the wiphy's registered
1119 * bands.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001120 *
1121 * @get_stats: return low-level statistics
1122 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001123 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1124 * callback should be provided to read the TKIP transmit IVs (both IV32
1125 * and IV16) for the given key from hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001126 *
1127 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1128 *
1129 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1130 * the device does fragmentation by itself; if this method is assigned then
1131 * the stack will not do fragmentation.
1132 *
1133 * @set_retry_limit: Configuration of retry limits (if device needs it)
1134 *
Tomas Winkler478f8d22007-09-30 13:52:37 +02001135 * @sta_notify: Notifies low level driver about addition or removal
1136 * of assocaited station or AP.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001137 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001138 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Berge100bb62008-04-30 18:51:21 +02001139 * bursting) for a hardware TX queue. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001140 *
1141 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1142 * to get number of currently queued packets (queue length), maximum queue
1143 * size (limit), and total number of packets sent using each TX queue
Johannes Berg57ffc582008-04-29 17:18:59 +02001144 * (count). The 'stats' pointer points to an array that has hw->queues +
1145 * hw->ampdu_queues items.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001146 *
1147 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1148 * this is only used for IBSS mode debugging and, as such, is not a
1149 * required function. Must be atomic.
1150 *
1151 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1152 * with other STAs in the IBSS. This is only used in IBSS mode. This
1153 * function is optional if the firmware/hardware takes full care of
1154 * TSF synchronization.
1155 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001156 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1157 * This is needed only for IBSS mode and the result of this function is
1158 * used to determine whether to reply to Probe Requests.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001159 *
1160 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001161 *
1162 * @ampdu_action: Perform a certain A-MPDU action
1163 * The RA/TID combination determines the destination and TID we want
1164 * the ampdu action to be performed for. The action is defined through
1165 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001166 * is the first frame we expect to perform the action on. notice
1167 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001168 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001169struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001170 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001171 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001172 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001173 int (*add_interface)(struct ieee80211_hw *hw,
1174 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001175 void (*remove_interface)(struct ieee80211_hw *hw,
1176 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001177 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001178 int (*config_interface)(struct ieee80211_hw *hw,
Johannes Berg32bfd352007-12-19 01:31:26 +01001179 struct ieee80211_vif *vif,
1180 struct ieee80211_if_conf *conf);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001181 void (*bss_info_changed)(struct ieee80211_hw *hw,
1182 struct ieee80211_vif *vif,
1183 struct ieee80211_bss_conf *info,
1184 u32 changed);
Johannes Berg4150c572007-09-17 01:29:23 -04001185 void (*configure_filter)(struct ieee80211_hw *hw,
1186 unsigned int changed_flags,
1187 unsigned int *total_flags,
1188 int mc_count, struct dev_addr_list *mc_list);
Jiri Bencf0706e82007-05-05 11:45:53 -07001189 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
Johannes Bergea49c352007-09-18 17:29:21 -04001190 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Berg11a843b2007-08-28 17:01:55 -04001191 const u8 *local_address, const u8 *address,
1192 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001193 void (*update_tkip_key)(struct ieee80211_hw *hw,
1194 struct ieee80211_key_conf *conf, const u8 *address,
1195 u32 iv32, u16 *phase1key);
Jiri Bencf0706e82007-05-05 11:45:53 -07001196 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
Jiri Bencf0706e82007-05-05 11:45:53 -07001197 int (*get_stats)(struct ieee80211_hw *hw,
1198 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001199 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1200 u32 *iv32, u16 *iv16);
Jiri Bencf0706e82007-05-05 11:45:53 -07001201 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07001202 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07001203 int (*set_retry_limit)(struct ieee80211_hw *hw,
1204 u32 short_retry, u32 long_retr);
Johannes Berg32bfd352007-12-19 01:31:26 +01001205 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Tomas Winkler478f8d22007-09-30 13:52:37 +02001206 enum sta_notify_cmd, const u8 *addr);
Johannes Berge100bb62008-04-30 18:51:21 +02001207 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07001208 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e82007-05-05 11:45:53 -07001209 int (*get_tx_stats)(struct ieee80211_hw *hw,
1210 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e82007-05-05 11:45:53 -07001211 u64 (*get_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001212 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001213 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001214 int (*ampdu_action)(struct ieee80211_hw *hw,
1215 enum ieee80211_ampdu_mlme_action action,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001216 const u8 *addr, u16 tid, u16 *ssn);
Jiri Bencf0706e82007-05-05 11:45:53 -07001217};
1218
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001219/**
1220 * ieee80211_alloc_hw - Allocate a new hardware device
1221 *
1222 * This must be called once for each hardware device. The returned pointer
1223 * must be used to refer to this device when calling other functions.
1224 * mac80211 allocates a private data area for the driver pointed to by
1225 * @priv in &struct ieee80211_hw, the size of this area is given as
1226 * @priv_data_len.
1227 *
1228 * @priv_data_len: length of private data
1229 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07001230 */
1231struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1232 const struct ieee80211_ops *ops);
1233
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001234/**
1235 * ieee80211_register_hw - Register hardware device
1236 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001237 * You must call this function before any other functions in
1238 * mac80211. Note that before a hardware can be registered, you
1239 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001240 *
1241 * @hw: the device to register as returned by ieee80211_alloc_hw()
1242 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001243int ieee80211_register_hw(struct ieee80211_hw *hw);
1244
Jiri Bencf0706e82007-05-05 11:45:53 -07001245#ifdef CONFIG_MAC80211_LEDS
1246extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1247extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001248extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001249extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001250#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001251/**
1252 * ieee80211_get_tx_led_name - get name of TX LED
1253 *
1254 * mac80211 creates a transmit LED trigger for each wireless hardware
1255 * that can be used to drive LEDs if your driver registers a LED device.
1256 * This function returns the name (or %NULL if not configured for LEDs)
1257 * of the trigger so you can automatically link the LED device.
1258 *
1259 * @hw: the hardware to get the LED trigger name for
1260 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001261static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1262{
1263#ifdef CONFIG_MAC80211_LEDS
1264 return __ieee80211_get_tx_led_name(hw);
1265#else
1266 return NULL;
1267#endif
1268}
1269
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001270/**
1271 * ieee80211_get_rx_led_name - get name of RX LED
1272 *
1273 * mac80211 creates a receive LED trigger for each wireless hardware
1274 * that can be used to drive LEDs if your driver registers a LED device.
1275 * This function returns the name (or %NULL if not configured for LEDs)
1276 * of the trigger so you can automatically link the LED device.
1277 *
1278 * @hw: the hardware to get the LED trigger name for
1279 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001280static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1281{
1282#ifdef CONFIG_MAC80211_LEDS
1283 return __ieee80211_get_rx_led_name(hw);
1284#else
1285 return NULL;
1286#endif
1287}
1288
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001289/**
1290 * ieee80211_get_assoc_led_name - get name of association LED
1291 *
1292 * mac80211 creates a association LED trigger for each wireless hardware
1293 * that can be used to drive LEDs if your driver registers a LED device.
1294 * This function returns the name (or %NULL if not configured for LEDs)
1295 * of the trigger so you can automatically link the LED device.
1296 *
1297 * @hw: the hardware to get the LED trigger name for
1298 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001299static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1300{
1301#ifdef CONFIG_MAC80211_LEDS
1302 return __ieee80211_get_assoc_led_name(hw);
1303#else
1304 return NULL;
1305#endif
1306}
1307
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001308/**
1309 * ieee80211_get_radio_led_name - get name of radio LED
1310 *
1311 * mac80211 creates a radio change LED trigger for each wireless hardware
1312 * that can be used to drive LEDs if your driver registers a LED device.
1313 * This function returns the name (or %NULL if not configured for LEDs)
1314 * of the trigger so you can automatically link the LED device.
1315 *
1316 * @hw: the hardware to get the LED trigger name for
1317 */
1318static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1319{
1320#ifdef CONFIG_MAC80211_LEDS
1321 return __ieee80211_get_radio_led_name(hw);
1322#else
1323 return NULL;
1324#endif
1325}
Michael Buesch47f0c502007-09-27 15:10:44 +02001326
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001327/**
1328 * ieee80211_unregister_hw - Unregister a hardware device
1329 *
1330 * This function instructs mac80211 to free allocated resources
1331 * and unregister netdevices from the networking subsystem.
1332 *
1333 * @hw: the hardware to unregister
1334 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001335void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1336
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001337/**
1338 * ieee80211_free_hw - free hardware descriptor
1339 *
1340 * This function frees everything that was allocated, including the
1341 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001342 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001343 *
1344 * @hw: the hardware to free
1345 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001346void ieee80211_free_hw(struct ieee80211_hw *hw);
1347
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001348/* trick to avoid symbol clashes with the ieee80211 subsystem */
Jiri Bencf0706e82007-05-05 11:45:53 -07001349void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1350 struct ieee80211_rx_status *status);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001351
1352/**
1353 * ieee80211_rx - receive frame
1354 *
1355 * Use this function to hand received frames to mac80211. The receive
1356 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1357 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1358 *
Johannes Berg2485f712008-02-25 16:27:41 +01001359 * This function may not be called in IRQ context. Calls to this function
1360 * for a single hardware must be synchronized against each other. Calls
1361 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1362 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001363 *
1364 * @hw: the hardware this frame came in on
1365 * @skb: the buffer to receive, owned by mac80211 after this call
1366 * @status: status of this frame; the status pointer need not be valid
1367 * after this function returns
1368 */
1369static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1370 struct ieee80211_rx_status *status)
1371{
1372 __ieee80211_rx(hw, skb, status);
1373}
1374
1375/**
1376 * ieee80211_rx_irqsafe - receive frame
1377 *
1378 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001379 * (internally defers to a tasklet.)
1380 *
1381 * Calls to this function and ieee80211_rx() may not be mixed for a
1382 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001383 *
1384 * @hw: the hardware this frame came in on
1385 * @skb: the buffer to receive, owned by mac80211 after this call
1386 * @status: status of this frame; the status pointer need not be valid
1387 * after this function returns and is not freed by mac80211,
1388 * it is recommended that it points to a stack area
1389 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001390void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1391 struct sk_buff *skb,
1392 struct ieee80211_rx_status *status);
1393
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001394/**
1395 * ieee80211_tx_status - transmit status callback
1396 *
1397 * Call this function for all transmitted frames after they have been
1398 * transmitted. It is permissible to not call this function for
1399 * multicast frames but this can affect statistics.
1400 *
Johannes Berg2485f712008-02-25 16:27:41 +01001401 * This function may not be called in IRQ context. Calls to this function
1402 * for a single hardware must be synchronized against each other. Calls
1403 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1404 * for a single hardware.
1405 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001406 * @hw: the hardware the frame was transmitted by
1407 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001408 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001409void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001410 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001411
1412/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001413 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001414 *
1415 * Like ieee80211_tx_status() but can be called in IRQ context
1416 * (internally defers to a tasklet.)
1417 *
1418 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1419 * single hardware.
1420 *
1421 * @hw: the hardware the frame was transmitted by
1422 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001423 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001424void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001425 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001426
1427/**
1428 * ieee80211_beacon_get - beacon generation function
1429 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001430 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001431 * @control: will be filled with information needed to send this beacon.
1432 *
1433 * If the beacon frames are generated by the host system (i.e., not in
1434 * hardware/firmware), the low-level driver uses this function to receive
1435 * the next beacon frame from the 802.11 code. The low-level is responsible
1436 * for calling this function before beacon data is needed (e.g., based on
1437 * hardware interrupt). Returned skb is used only once and low-level driver
1438 * is responsible of freeing it.
1439 */
1440struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001441 struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001442
1443/**
1444 * ieee80211_rts_get - RTS frame generation function
1445 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001446 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001447 * @frame: pointer to the frame that is going to be protected by the RTS.
1448 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001449 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001450 * @rts: The buffer where to store the RTS frame.
1451 *
1452 * If the RTS frames are generated by the host system (i.e., not in
1453 * hardware/firmware), the low-level driver uses this function to receive
1454 * the next RTS frame from the 802.11 code. The low-level is responsible
1455 * for calling this function before and RTS frame is needed.
1456 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001457void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001458 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001459 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001460 struct ieee80211_rts *rts);
1461
1462/**
1463 * ieee80211_rts_duration - Get the duration field for an RTS frame
1464 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001465 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001466 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02001467 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001468 *
1469 * If the RTS is generated in firmware, but the host system must provide
1470 * the duration field, the low-level driver uses this function to receive
1471 * the duration field value in little-endian byteorder.
1472 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001473__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1474 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001475 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07001476
1477/**
1478 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1479 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001480 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001481 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1482 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001483 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001484 * @cts: The buffer where to store the CTS-to-self frame.
1485 *
1486 * If the CTS-to-self frames are generated by the host system (i.e., not in
1487 * hardware/firmware), the low-level driver uses this function to receive
1488 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1489 * for calling this function before and CTS-to-self frame is needed.
1490 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001491void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1492 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001493 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001494 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001495 struct ieee80211_cts *cts);
1496
1497/**
1498 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1499 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001500 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001501 * @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 +02001502 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001503 *
1504 * If the CTS-to-self is generated in firmware, but the host system must provide
1505 * the duration field, the low-level driver uses this function to receive
1506 * the duration field value in little-endian byteorder.
1507 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001508__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1509 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001510 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001511 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07001512
1513/**
1514 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1515 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001516 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001517 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001518 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07001519 *
1520 * Calculate the duration field of some generic frame, given its
1521 * length and transmission rate (in 100kbps).
1522 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001523__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1524 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001525 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01001526 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07001527
1528/**
1529 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1530 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001531 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001532 * @control: will be filled with information needed to send returned frame.
1533 *
1534 * Function for accessing buffered broadcast and multicast frames. If
1535 * hardware/firmware does not implement buffering of broadcast/multicast
1536 * frames when power saving is used, 802.11 code buffers them in the host
1537 * memory. The low-level driver uses this function to fetch next buffered
1538 * frame. In most cases, this is used when generating beacon frame. This
1539 * function returns a pointer to the next buffered skb or NULL if no more
1540 * buffered frames are available.
1541 *
1542 * Note: buffered frames are returned only after DTIM beacon frame was
1543 * generated with ieee80211_beacon_get() and the low-level driver must thus
1544 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1545 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1546 * does not need to check for DTIM beacons separately and should be able to
1547 * use common code for all beacons.
1548 */
1549struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02001550ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001551
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001552/**
1553 * ieee80211_get_hdrlen_from_skb - get header length from data
1554 *
1555 * Given an skb with a raw 802.11 header at the data pointer this function
Jiri Bencf0706e82007-05-05 11:45:53 -07001556 * returns the 802.11 header length in bytes (not including encryption
1557 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1558 * header the function returns 0.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001559 *
1560 * @skb: the frame
Jiri Bencf0706e82007-05-05 11:45:53 -07001561 */
Harvey Harrisonc9c69502008-06-11 14:21:57 -07001562unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001563
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001564/**
1565 * ieee80211_get_hdrlen - get header length from frame control
1566 *
1567 * This function returns the 802.11 header length in bytes (not including
1568 * encryption headers.)
1569 *
1570 * @fc: the frame control field (in CPU endianness)
1571 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001572int ieee80211_get_hdrlen(u16 fc);
1573
1574/**
Harvey Harrison6693be72008-06-11 14:21:57 -07001575 * ieee80211_hdrlen - get header length in bytes from frame control
1576 * @fc: frame control field in little-endian format
1577 */
1578unsigned int ieee80211_hdrlen(__le16 fc);
1579
1580/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001581 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1582 *
1583 * This function computes a TKIP rc4 key for an skb. It computes
1584 * a phase 1 key if needed (iv16 wraps around). This function is to
1585 * be used by drivers which can do HW encryption but need to compute
1586 * to phase 1/2 key in SW.
1587 *
1588 * @keyconf: the parameter passed with the set key
1589 * @skb: the skb for which the key is needed
1590 * @rc4key: a buffer to which the key will be written
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001591 * @type: TBD
1592 * @key: TBD
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001593 */
1594void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1595 struct sk_buff *skb,
1596 enum ieee80211_tkip_key_type type, u8 *key);
1597/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001598 * ieee80211_wake_queue - wake specific queue
1599 * @hw: pointer as obtained from ieee80211_alloc_hw().
1600 * @queue: queue number (counted from zero).
1601 *
1602 * Drivers should use this function instead of netif_wake_queue.
1603 */
1604void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1605
1606/**
1607 * ieee80211_stop_queue - stop specific queue
1608 * @hw: pointer as obtained from ieee80211_alloc_hw().
1609 * @queue: queue number (counted from zero).
1610 *
1611 * Drivers should use this function instead of netif_stop_queue.
1612 */
1613void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1614
1615/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001616 * ieee80211_stop_queues - stop all queues
1617 * @hw: pointer as obtained from ieee80211_alloc_hw().
1618 *
1619 * Drivers should use this function instead of netif_stop_queue.
1620 */
1621void ieee80211_stop_queues(struct ieee80211_hw *hw);
1622
1623/**
1624 * ieee80211_wake_queues - wake all queues
1625 * @hw: pointer as obtained from ieee80211_alloc_hw().
1626 *
1627 * Drivers should use this function instead of netif_wake_queue.
1628 */
1629void ieee80211_wake_queues(struct ieee80211_hw *hw);
1630
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001631/**
1632 * ieee80211_scan_completed - completed hardware scan
1633 *
1634 * When hardware scan offload is used (i.e. the hw_scan() callback is
1635 * assigned) this function needs to be called by the driver to notify
1636 * mac80211 that the scan finished.
1637 *
1638 * @hw: the hardware that finished the scan
1639 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001640void ieee80211_scan_completed(struct ieee80211_hw *hw);
1641
Johannes Bergdabeb342007-11-09 01:57:29 +01001642/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001643 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01001644 *
1645 * This function iterates over the interfaces associated with a given
1646 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001647 * This function allows the iterator function to sleep, when the iterator
1648 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1649 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01001650 *
1651 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001652 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01001653 * @data: first argument of the iterator function
1654 */
1655void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1656 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01001657 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01001658 void *data);
1659
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001660/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001661 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1662 *
1663 * This function iterates over the interfaces associated with a given
1664 * hardware that are currently active and calls the callback for them.
1665 * This function requires the iterator callback function to be atomic,
1666 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1667 *
1668 * @hw: the hardware struct of which the interfaces should be iterated over
1669 * @iterator: the iterator function to call, cannot sleep
1670 * @data: first argument of the iterator function
1671 */
1672void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1673 void (*iterator)(void *data,
1674 u8 *mac,
1675 struct ieee80211_vif *vif),
1676 void *data);
1677
1678/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001679 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1680 * @hw: pointer as obtained from ieee80211_alloc_hw().
1681 * @ra: receiver address of the BA session recipient
1682 * @tid: the TID to BA on.
1683 * @return: success if addBA request was sent, failure otherwise
1684 *
1685 * Although mac80211/low level driver/user space application can estimate
1686 * the need to start aggregation on a certain RA/TID, the session level
1687 * will be managed by the mac80211.
1688 */
1689int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1690
1691/**
1692 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1693 * @hw: pointer as obtained from ieee80211_alloc_hw().
1694 * @ra: receiver address of the BA session recipient.
1695 * @tid: the TID to BA on.
1696 *
1697 * This function must be called by low level driver once it has
1698 * finished with preparations for the BA session.
1699 */
1700void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1701
1702/**
1703 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1704 * @hw: pointer as obtained from ieee80211_alloc_hw().
1705 * @ra: receiver address of the BA session recipient.
1706 * @tid: the TID to BA on.
1707 *
1708 * This function must be called by low level driver once it has
1709 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001710 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001711 */
1712void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1713 u16 tid);
1714
1715/**
1716 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1717 * @hw: pointer as obtained from ieee80211_alloc_hw().
1718 * @ra: receiver address of the BA session recipient
1719 * @tid: the TID to stop BA.
1720 * @initiator: if indicates initiator DELBA frame will be sent.
1721 * @return: error if no sta with matching da found, success otherwise
1722 *
1723 * Although mac80211/low level driver/user space application can estimate
1724 * the need to stop aggregation on a certain RA/TID, the session level
1725 * will be managed by the mac80211.
1726 */
1727int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1728 u8 *ra, u16 tid,
1729 enum ieee80211_back_parties initiator);
1730
1731/**
1732 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1733 * @hw: pointer as obtained from ieee80211_alloc_hw().
1734 * @ra: receiver address of the BA session recipient.
1735 * @tid: the desired TID to BA on.
1736 *
1737 * This function must be called by low level driver once it has
1738 * finished with preparations for the BA session tear down.
1739 */
1740void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1741
1742/**
1743 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1744 * @hw: pointer as obtained from ieee80211_alloc_hw().
1745 * @ra: receiver address of the BA session recipient.
1746 * @tid: the desired TID to BA on.
1747 *
1748 * This function must be called by low level driver once it has
1749 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001750 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001751 */
1752void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1753 u16 tid);
1754
Mohamed Abbas84363e62008-04-04 16:59:58 -07001755/**
1756 * ieee80211_notify_mac - low level driver notification
1757 * @hw: pointer as obtained from ieee80211_alloc_hw().
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001758 * @notif_type: enum ieee80211_notification_types
Mohamed Abbas84363e62008-04-04 16:59:58 -07001759 *
1760 * This function must be called by low level driver to inform mac80211 of
1761 * low level driver status change or force mac80211 to re-assoc for low
1762 * level driver internal error that require re-assoc.
1763 */
1764void ieee80211_notify_mac(struct ieee80211_hw *hw,
1765 enum ieee80211_notification_types notif_type);
Jiri Bencf0706e82007-05-05 11:45:53 -07001766#endif /* MAC80211_H */