]>
Commit | Line | Data |
---|---|---|
f0706e82 | 1 | /* |
3017b80b JB |
2 | * mac80211 <-> driver interface |
3 | * | |
f0706e82 JB |
4 | * Copyright 2002-2005, Devicescape Software, Inc. |
5 | * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz> | |
3017b80b | 6 | * Copyright 2007 Johannes Berg <johannes@sipsolutions.net> |
f0706e82 JB |
7 | * |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License version 2 as | |
10 | * published by the Free Software Foundation. | |
11 | */ | |
12 | ||
13 | #ifndef MAC80211_H | |
14 | #define MAC80211_H | |
15 | ||
16 | #include <linux/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 | ||
25 | /* Note! Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be | |
26 | * called in hardware interrupt context. The low-level driver must not call any | |
27 | * other functions in hardware interrupt context. If there is a need for such | |
28 | * call, the low-level driver should first ACK the interrupt and perform the | |
29 | * IEEE 802.11 code call after this, e.g., from a scheduled tasklet (in | |
30 | * software interrupt context). | |
31 | */ | |
32 | ||
33 | /* | |
34 | * Frame format used when passing frame between low-level hardware drivers | |
35 | * and IEEE 802.11 driver the same as used in the wireless media, i.e., | |
36 | * buffers start with IEEE 802.11 header and include the same octets that | |
37 | * are sent over air. | |
38 | * | |
39 | * If hardware uses IEEE 802.3 headers (and perform 802.3 <-> 802.11 | |
40 | * conversion in firmware), upper layer 802.11 code needs to be changed to | |
41 | * support this. | |
42 | * | |
43 | * If the receive frame format is not the same as the real frame sent | |
44 | * on the wireless media (e.g., due to padding etc.), upper layer 802.11 code | |
45 | * could be updated to provide support for such format assuming this would | |
46 | * optimize the performance, e.g., by removing need to re-allocation and | |
47 | * copying of the data. | |
48 | */ | |
49 | ||
50 | #define IEEE80211_CHAN_W_SCAN 0x00000001 | |
51 | #define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002 | |
52 | #define IEEE80211_CHAN_W_IBSS 0x00000004 | |
53 | ||
54 | /* Channel information structure. Low-level driver is expected to fill in chan, | |
55 | * freq, and val fields. Other fields will be filled in by 80211.o based on | |
56 | * hostapd information and low-level driver does not need to use them. The | |
57 | * limits for each channel will be provided in 'struct ieee80211_conf' when | |
58 | * configuring the low-level driver with hw->config callback. If a device has | |
59 | * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED | |
60 | * can be set to let the driver configure all fields */ | |
61 | struct ieee80211_channel { | |
62 | short chan; /* channel number (IEEE 802.11) */ | |
63 | short freq; /* frequency in MHz */ | |
64 | int val; /* hw specific value for the channel */ | |
65 | int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */ | |
66 | unsigned char power_level; | |
67 | unsigned char antenna_max; | |
68 | }; | |
69 | ||
70 | #define IEEE80211_RATE_ERP 0x00000001 | |
71 | #define IEEE80211_RATE_BASIC 0x00000002 | |
72 | #define IEEE80211_RATE_PREAMBLE2 0x00000004 | |
73 | #define IEEE80211_RATE_SUPPORTED 0x00000010 | |
74 | #define IEEE80211_RATE_OFDM 0x00000020 | |
75 | #define IEEE80211_RATE_CCK 0x00000040 | |
f0706e82 JB |
76 | #define IEEE80211_RATE_MANDATORY 0x00000100 |
77 | ||
78 | #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2) | |
79 | #define IEEE80211_RATE_MODULATION(f) \ | |
80 | (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM)) | |
81 | ||
b708e610 | 82 | /* Low-level driver should set PREAMBLE2, OFDM and CCK flags. |
f0706e82 JB |
83 | * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the |
84 | * configuration. */ | |
85 | struct ieee80211_rate { | |
86 | int rate; /* rate in 100 kbps */ | |
87 | int val; /* hw specific value for the rate */ | |
88 | int flags; /* IEEE80211_RATE_ flags */ | |
89 | int val2; /* hw specific value for the rate when using short preamble | |
90 | * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for | |
91 | * 2, 5.5, and 11 Mbps) */ | |
92 | signed char min_rssi_ack; | |
93 | unsigned char min_rssi_ack_delta; | |
94 | ||
95 | /* following fields are set by 80211.o and need not be filled by the | |
96 | * low-level driver */ | |
97 | int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for | |
98 | * optimizing channel utilization estimates */ | |
99 | }; | |
100 | ||
6b301cdf JB |
101 | /** |
102 | * enum ieee80211_phymode - PHY modes | |
103 | * | |
104 | * @MODE_IEEE80211A: 5GHz as defined by 802.11a/802.11h | |
105 | * @MODE_IEEE80211B: 2.4 GHz as defined by 802.11b | |
106 | * @MODE_IEEE80211G: 2.4 GHz as defined by 802.11g (with OFDM), | |
107 | * backwards compatible with 11b mode | |
108 | * @NUM_IEEE80211_MODES: internal | |
109 | */ | |
b708e610 | 110 | enum ieee80211_phymode { |
6b301cdf JB |
111 | MODE_IEEE80211A, |
112 | MODE_IEEE80211B, | |
113 | MODE_IEEE80211G, | |
f0706e82 JB |
114 | |
115 | /* keep last */ | |
116 | NUM_IEEE80211_MODES | |
117 | }; | |
118 | ||
6b301cdf JB |
119 | /** |
120 | * struct ieee80211_hw_mode - PHY mode definition | |
121 | * | |
122 | * This structure describes the capabilities supported by the device | |
123 | * in a single PHY mode. | |
124 | * | |
125 | * @mode: the PHY mode for this definition | |
126 | * @num_channels: number of supported channels | |
127 | * @channels: pointer to array of supported channels | |
128 | * @num_rates: number of supported bitrates | |
129 | * @rates: pointer to array of supported bitrates | |
130 | * @list: internal | |
131 | */ | |
f0706e82 | 132 | struct ieee80211_hw_mode { |
6b301cdf JB |
133 | struct list_head list; |
134 | struct ieee80211_channel *channels; | |
135 | struct ieee80211_rate *rates; | |
136 | enum ieee80211_phymode mode; | |
137 | int num_channels; | |
138 | int num_rates; | |
f0706e82 JB |
139 | }; |
140 | ||
6b301cdf JB |
141 | /** |
142 | * struct ieee80211_tx_queue_params - transmit queue configuration | |
143 | * | |
144 | * The information provided in this structure is required for QoS | |
145 | * transmit queue configuration. | |
146 | * | |
147 | * @aifs: arbitration interface space [0..255, -1: use default] | |
148 | * @cw_min: minimum contention window [will be a value of the form | |
149 | * 2^n-1 in the range 1..1023; 0: use default] | |
150 | * @cw_max: maximum contention window [like @cw_min] | |
151 | * @burst_time: maximum burst time in units of 0.1ms, 0 meaning disabled | |
152 | */ | |
f0706e82 | 153 | struct ieee80211_tx_queue_params { |
6b301cdf JB |
154 | int aifs; |
155 | int cw_min; | |
156 | int cw_max; | |
157 | int burst_time; | |
f0706e82 JB |
158 | }; |
159 | ||
6b301cdf JB |
160 | /** |
161 | * struct ieee80211_tx_queue_stats_data - transmit queue statistics | |
162 | * | |
163 | * @len: number of packets in queue | |
164 | * @limit: queue length limit | |
165 | * @count: number of frames sent | |
166 | */ | |
f0706e82 | 167 | struct ieee80211_tx_queue_stats_data { |
6b301cdf JB |
168 | unsigned int len; |
169 | unsigned int limit; | |
170 | unsigned int count; | |
f0706e82 JB |
171 | }; |
172 | ||
6b301cdf JB |
173 | /** |
174 | * enum ieee80211_tx_queue - transmit queue number | |
175 | * | |
176 | * These constants are used with some callbacks that take a | |
177 | * queue number to set parameters for a queue. | |
178 | * | |
179 | * @IEEE80211_TX_QUEUE_DATA0: data queue 0 | |
180 | * @IEEE80211_TX_QUEUE_DATA1: data queue 1 | |
181 | * @IEEE80211_TX_QUEUE_DATA2: data queue 2 | |
182 | * @IEEE80211_TX_QUEUE_DATA3: data queue 3 | |
183 | * @IEEE80211_TX_QUEUE_DATA4: data queue 4 | |
184 | * @IEEE80211_TX_QUEUE_SVP: ?? | |
185 | * @NUM_TX_DATA_QUEUES: number of data queues | |
186 | * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be | |
187 | * sent after a beacon | |
188 | * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames | |
189 | */ | |
190 | enum ieee80211_tx_queue { | |
f0706e82 JB |
191 | IEEE80211_TX_QUEUE_DATA0, |
192 | IEEE80211_TX_QUEUE_DATA1, | |
193 | IEEE80211_TX_QUEUE_DATA2, | |
194 | IEEE80211_TX_QUEUE_DATA3, | |
195 | IEEE80211_TX_QUEUE_DATA4, | |
196 | IEEE80211_TX_QUEUE_SVP, | |
197 | ||
198 | NUM_TX_DATA_QUEUES, | |
199 | ||
200 | /* due to stupidity in the sub-ioctl userspace interface, the items in | |
201 | * this struct need to have fixed values. As soon as it is removed, we can | |
202 | * fix these entries. */ | |
203 | IEEE80211_TX_QUEUE_AFTER_BEACON = 6, | |
204 | IEEE80211_TX_QUEUE_BEACON = 7 | |
205 | }; | |
206 | ||
207 | struct ieee80211_tx_queue_stats { | |
208 | struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES]; | |
209 | }; | |
210 | ||
211 | struct ieee80211_low_level_stats { | |
212 | unsigned int dot11ACKFailureCount; | |
213 | unsigned int dot11RTSFailureCount; | |
214 | unsigned int dot11FCSErrorCount; | |
215 | unsigned int dot11RTSSuccessCount; | |
216 | }; | |
217 | ||
218 | /* Transmit control fields. This data structure is passed to low-level driver | |
219 | * with each TX frame. The low-level driver is responsible for configuring | |
220 | * the hardware to use given values (depending on what is supported). */ | |
f0706e82 JB |
221 | |
222 | struct ieee80211_tx_control { | |
223 | int tx_rate; /* Transmit rate, given as the hw specific value for the | |
224 | * rate (from struct ieee80211_rate) */ | |
225 | int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw | |
226 | * specific value for the rate (from | |
227 | * struct ieee80211_rate) */ | |
228 | ||
229 | #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for | |
230 | * this frame */ | |
231 | #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without | |
232 | * encryption; e.g., for EAPOL | |
233 | * frames */ | |
234 | #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending | |
235 | * frame */ | |
236 | #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the | |
237 | * frame (e.g., for combined | |
238 | * 802.11g / 802.11b networks) */ | |
239 | #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to | |
240 | * wait for an ack */ | |
241 | #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5) | |
242 | #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6) | |
243 | #define IEEE80211_TXCTL_REQUEUE (1<<7) | |
244 | #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of | |
245 | * the frame */ | |
d5d08def ID |
246 | #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send |
247 | * using the through | |
248 | * set_retry_limit configured | |
249 | * long retry value */ | |
f0706e82 JB |
250 | u32 flags; /* tx control flags defined |
251 | * above */ | |
6a7664d4 JB |
252 | u8 key_idx; /* keyidx from hw->set_key(), undefined if |
253 | * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */ | |
d5d08def ID |
254 | u8 retry_limit; /* 1 = only first attempt, 2 = one retry, .. |
255 | * This could be used when set_retry_limit | |
256 | * is not implemented by the driver */ | |
f0706e82 JB |
257 | u8 power_level; /* per-packet transmit power level, in dBm */ |
258 | u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */ | |
f0706e82 JB |
259 | u8 icv_len; /* length of the ICV/MIC field in octets */ |
260 | u8 iv_len; /* length of the IV field in octets */ | |
f0706e82 JB |
261 | u8 queue; /* hardware queue to use for this frame; |
262 | * 0 = highest, hw->queues-1 = lowest */ | |
f0706e82 JB |
263 | struct ieee80211_rate *rate; /* internal 80211.o rate */ |
264 | struct ieee80211_rate *rts_rate; /* internal 80211.o rate | |
265 | * for RTS/CTS */ | |
266 | int alt_retry_rate; /* retry rate for the last retries, given as the | |
267 | * hw specific value for the rate (from | |
268 | * struct ieee80211_rate). To be used to limit | |
269 | * packet dropping when probing higher rates, if hw | |
270 | * supports multiple retry rates. -1 = not used */ | |
271 | int type; /* internal */ | |
272 | int ifindex; /* internal */ | |
273 | }; | |
274 | ||
7ac1bd6a JB |
275 | |
276 | /** | |
277 | * enum mac80211_rx_flags - receive flags | |
278 | * | |
279 | * These flags are used with the @flag member of &struct ieee80211_rx_status. | |
280 | * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. | |
281 | * Use together with %RX_FLAG_MMIC_STRIPPED. | |
282 | * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. | |
283 | * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header. | |
284 | * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, | |
285 | * verification has been done by the hardware. | |
286 | * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. | |
287 | * If this flag is set, the stack cannot do any replay detection | |
288 | * hence the driver or hardware will have to do that. | |
72abd81b JB |
289 | * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on |
290 | * the frame. | |
291 | * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on | |
292 | * the frame. | |
7ac1bd6a JB |
293 | */ |
294 | enum mac80211_rx_flags { | |
295 | RX_FLAG_MMIC_ERROR = 1<<0, | |
296 | RX_FLAG_DECRYPTED = 1<<1, | |
297 | RX_FLAG_RADIOTAP = 1<<2, | |
298 | RX_FLAG_MMIC_STRIPPED = 1<<3, | |
299 | RX_FLAG_IV_STRIPPED = 1<<4, | |
72abd81b JB |
300 | RX_FLAG_FAILED_FCS_CRC = 1<<5, |
301 | RX_FLAG_FAILED_PLCP_CRC = 1<<6, | |
7ac1bd6a JB |
302 | }; |
303 | ||
304 | /** | |
305 | * struct ieee80211_rx_status - receive status | |
306 | * | |
307 | * The low-level driver should provide this information (the subset | |
308 | * supported by hardware) to the 802.11 code with each received | |
309 | * frame. | |
310 | * @mactime: MAC timestamp as defined by 802.11 | |
311 | * @freq: frequency the radio was tuned to when receiving this frame, in MHz | |
312 | * @channel: channel the radio was tuned to | |
313 | * @phymode: active PHY mode | |
314 | * @ssi: signal strength when receiving this frame | |
315 | * @signal: used as 'qual' in statistics reporting | |
316 | * @noise: PHY noise when receiving this frame | |
317 | * @antenna: antenna used | |
318 | * @rate: data rate | |
319 | * @flag: %RX_FLAG_* | |
320 | */ | |
f0706e82 JB |
321 | struct ieee80211_rx_status { |
322 | u64 mactime; | |
7ac1bd6a | 323 | int freq; |
f0706e82 | 324 | int channel; |
6b301cdf | 325 | enum ieee80211_phymode phymode; |
f0706e82 | 326 | int ssi; |
7ac1bd6a | 327 | int signal; |
f0706e82 JB |
328 | int noise; |
329 | int antenna; | |
330 | int rate; | |
f0706e82 JB |
331 | int flag; |
332 | }; | |
333 | ||
6b301cdf JB |
334 | /** |
335 | * enum ieee80211_tx_status_flags - transmit status flags | |
336 | * | |
337 | * Status flags to indicate various transmit conditions. | |
338 | * | |
339 | * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted | |
340 | * because the destination STA was in powersave mode. | |
341 | * | |
342 | * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged | |
343 | */ | |
344 | enum ieee80211_tx_status_flags { | |
345 | IEEE80211_TX_STATUS_TX_FILTERED = 1<<0, | |
346 | IEEE80211_TX_STATUS_ACK = 1<<1, | |
347 | }; | |
348 | ||
349 | /** | |
350 | * struct ieee80211_tx_status - transmit status | |
351 | * | |
352 | * As much information as possible should be provided for each transmitted | |
353 | * frame with ieee80211_tx_status(). | |
354 | * | |
355 | * @control: a copy of the &struct ieee80211_tx_control passed to the driver | |
356 | * in the tx() callback. | |
357 | * | |
358 | * @flags: transmit status flags, defined above | |
359 | * | |
360 | * @ack_signal: signal strength of the ACK frame | |
361 | * | |
362 | * @excessive_retries: set to 1 if the frame was retried many times | |
363 | * but not acknowledged | |
364 | * | |
365 | * @retry_count: number of retries | |
366 | * | |
367 | * @queue_length: ?? REMOVE | |
368 | * @queue_number: ?? REMOVE | |
369 | */ | |
f0706e82 | 370 | struct ieee80211_tx_status { |
f0706e82 | 371 | struct ieee80211_tx_control control; |
6b301cdf JB |
372 | u8 flags; |
373 | bool excessive_retries; | |
374 | u8 retry_count; | |
375 | int ack_signal; | |
376 | int queue_length; | |
f0706e82 JB |
377 | int queue_number; |
378 | }; | |
379 | ||
6b301cdf JB |
380 | /** |
381 | * enum ieee80211_conf_flags - configuration flags | |
382 | * | |
383 | * Flags to define PHY configuration options | |
384 | * | |
385 | * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time | |
386 | * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported) | |
387 | * | |
388 | */ | |
389 | enum ieee80211_conf_flags { | |
390 | IEEE80211_CONF_SHORT_SLOT_TIME = 1<<0, | |
391 | IEEE80211_CONF_RADIOTAP = 1<<1, | |
392 | }; | |
f0706e82 JB |
393 | |
394 | /** | |
395 | * struct ieee80211_conf - configuration of the device | |
396 | * | |
397 | * This struct indicates how the driver shall configure the hardware. | |
398 | * | |
399 | * @radio_enabled: when zero, driver is required to switch off the radio. | |
6b301cdf JB |
400 | * TODO make a flag |
401 | * @channel: IEEE 802.11 channel number | |
402 | * @freq: frequency in MHz | |
403 | * @channel_val: hardware specific channel value for the channel | |
404 | * @phymode: PHY mode to activate (REMOVE) | |
405 | * @chan: channel to switch to, pointer to the channel information | |
406 | * @mode: pointer to mode definition | |
407 | * @regulatory_domain: ?? | |
408 | * @beacon_int: beacon interval (TODO make interface config) | |
409 | * @flags: configuration flags defined above | |
410 | * @power_level: transmit power limit for current regulatory domain in dBm | |
411 | * @antenna_max: maximum antenna gain | |
412 | * @antenna_sel_tx: transmit antenna selection, 0: default/diversity, | |
413 | * 1/2: antenna 0/1 | |
414 | * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx | |
f0706e82 JB |
415 | */ |
416 | struct ieee80211_conf { | |
417 | int channel; /* IEEE 802.11 channel number */ | |
418 | int freq; /* MHz */ | |
419 | int channel_val; /* hw specific value for the channel */ | |
420 | ||
6b301cdf | 421 | enum ieee80211_phymode phymode; |
f0706e82 JB |
422 | struct ieee80211_channel *chan; |
423 | struct ieee80211_hw_mode *mode; | |
424 | unsigned int regulatory_domain; | |
425 | int radio_enabled; | |
426 | ||
427 | int beacon_int; | |
6b301cdf JB |
428 | u32 flags; |
429 | u8 power_level; | |
430 | u8 antenna_max; | |
f0706e82 JB |
431 | u8 antenna_sel_tx; |
432 | u8 antenna_sel_rx; | |
f0706e82 JB |
433 | }; |
434 | ||
435 | /** | |
436 | * enum ieee80211_if_types - types of 802.11 network interfaces | |
437 | * | |
438 | * @IEEE80211_IF_TYPE_AP: interface in AP mode. | |
439 | * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap | |
440 | * daemon. Drivers should never see this type. | |
441 | * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode. | |
442 | * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode. | |
443 | * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode. | |
444 | * @IEEE80211_IF_TYPE_WDS: interface in WDS mode. | |
445 | * @IEEE80211_IF_TYPE_VLAN: not used. | |
446 | */ | |
447 | enum ieee80211_if_types { | |
448 | IEEE80211_IF_TYPE_AP = 0x00000000, | |
449 | IEEE80211_IF_TYPE_MGMT = 0x00000001, | |
450 | IEEE80211_IF_TYPE_STA = 0x00000002, | |
451 | IEEE80211_IF_TYPE_IBSS = 0x00000003, | |
452 | IEEE80211_IF_TYPE_MNTR = 0x00000004, | |
453 | IEEE80211_IF_TYPE_WDS = 0x5A580211, | |
454 | IEEE80211_IF_TYPE_VLAN = 0x00080211, | |
455 | }; | |
456 | ||
457 | /** | |
458 | * struct ieee80211_if_init_conf - initial configuration of an interface | |
459 | * | |
460 | * @if_id: internal interface ID. This number has no particular meaning to | |
461 | * drivers and the only allowed usage is to pass it to | |
462 | * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions. | |
463 | * This field is not valid for monitor interfaces | |
464 | * (interfaces of %IEEE80211_IF_TYPE_MNTR type). | |
465 | * @type: one of &enum ieee80211_if_types constants. Determines the type of | |
466 | * added/removed interface. | |
467 | * @mac_addr: pointer to MAC address of the interface. This pointer is valid | |
468 | * until the interface is removed (i.e. it cannot be used after | |
469 | * remove_interface() callback was called for this interface). | |
470 | * | |
471 | * This structure is used in add_interface() and remove_interface() | |
472 | * callbacks of &struct ieee80211_hw. | |
4480f15c JB |
473 | * |
474 | * When you allow multiple interfaces to be added to your PHY, take care | |
475 | * that the hardware can actually handle multiple MAC addresses. However, | |
476 | * also take care that when there's no interface left with mac_addr != %NULL | |
477 | * you remove the MAC address from the device to avoid acknowledging packets | |
478 | * in pure monitor mode. | |
f0706e82 JB |
479 | */ |
480 | struct ieee80211_if_init_conf { | |
481 | int if_id; | |
482 | int type; | |
483 | void *mac_addr; | |
484 | }; | |
485 | ||
486 | /** | |
487 | * struct ieee80211_if_conf - configuration of an interface | |
488 | * | |
489 | * @type: type of the interface. This is always the same as was specified in | |
490 | * &struct ieee80211_if_init_conf. The type of an interface never changes | |
491 | * during the life of the interface; this field is present only for | |
492 | * convenience. | |
493 | * @bssid: BSSID of the network we are associated to/creating. | |
494 | * @ssid: used (together with @ssid_len) by drivers for hardware that | |
495 | * generate beacons independently. The pointer is valid only during the | |
496 | * config_interface() call, so copy the value somewhere if you need | |
497 | * it. | |
498 | * @ssid_len: length of the @ssid field. | |
499 | * @generic_elem: used (together with @generic_elem_len) by drivers for | |
500 | * hardware that generate beacons independently. The pointer is valid | |
501 | * only during the config_interface() call, so copy the value somewhere | |
502 | * if you need it. | |
503 | * @generic_elem_len: length of the generic element. | |
504 | * @beacon: beacon template. Valid only if @host_gen_beacon_template in | |
505 | * &struct ieee80211_hw is set. The driver is responsible of freeing | |
506 | * the sk_buff. | |
507 | * @beacon_control: tx_control for the beacon template, this field is only | |
508 | * valid when the @beacon field was set. | |
509 | * | |
510 | * This structure is passed to the config_interface() callback of | |
511 | * &struct ieee80211_hw. | |
512 | */ | |
513 | struct ieee80211_if_conf { | |
514 | int type; | |
515 | u8 *bssid; | |
516 | u8 *ssid; | |
517 | size_t ssid_len; | |
518 | u8 *generic_elem; | |
519 | size_t generic_elem_len; | |
520 | struct sk_buff *beacon; | |
521 | struct ieee80211_tx_control *beacon_control; | |
522 | }; | |
523 | ||
7ac1bd6a JB |
524 | /** |
525 | * enum ieee80211_key_alg - key algorithm | |
526 | * @ALG_NONE: Unset key algorithm, will never be passed to the driver | |
527 | * @ALG_WEP: WEP40 or WEP104 | |
528 | * @ALG_TKIP: TKIP | |
529 | * @ALG_CCMP: CCMP (AES) | |
530 | */ | |
531 | typedef enum ieee80211_key_alg { | |
8f20fc24 JB |
532 | ALG_NONE, |
533 | ALG_WEP, | |
534 | ALG_TKIP, | |
535 | ALG_CCMP, | |
536 | } ieee80211_key_alg; | |
f0706e82 | 537 | |
7ac1bd6a JB |
538 | |
539 | /** | |
540 | * enum ieee80211_key_flags - key flags | |
541 | * | |
542 | * These flags are used for communication about keys between the driver | |
543 | * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. | |
544 | * | |
545 | * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates | |
546 | * that the STA this key will be used with could be using QoS. | |
547 | * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the | |
548 | * driver to indicate that it requires IV generation for this | |
549 | * particular key. | |
550 | * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by | |
551 | * the driver for a TKIP key if it requires Michael MIC | |
552 | * generation in software. | |
7848ba7d | 553 | */ |
7ac1bd6a JB |
554 | enum ieee80211_key_flags { |
555 | IEEE80211_KEY_FLAG_WMM_STA = 1<<0, | |
556 | IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, | |
557 | IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, | |
558 | }; | |
11a843b7 | 559 | |
7ac1bd6a JB |
560 | /** |
561 | * struct ieee80211_key_conf - key information | |
562 | * | |
563 | * This key information is given by mac80211 to the driver by | |
564 | * the set_key() callback in &struct ieee80211_ops. | |
565 | * | |
566 | * @hw_key_idx: To be set by the driver, this is the key index the driver | |
567 | * wants to be given when a frame is transmitted and needs to be | |
6a7664d4 | 568 | * encrypted in hardware. |
7ac1bd6a JB |
569 | * @alg: The key algorithm. |
570 | * @flags: key flags, see &enum ieee80211_key_flags. | |
571 | * @keyidx: the key index (0-3) | |
572 | * @keylen: key material length | |
573 | * @key: key material | |
574 | */ | |
f0706e82 | 575 | struct ieee80211_key_conf { |
f0706e82 | 576 | ieee80211_key_alg alg; |
6a7664d4 | 577 | u8 hw_key_idx; |
11a843b7 | 578 | u8 flags; |
11a843b7 | 579 | s8 keyidx; |
11a843b7 | 580 | u8 keylen; |
f0706e82 JB |
581 | u8 key[0]; |
582 | }; | |
583 | ||
584 | #define IEEE80211_SEQ_COUNTER_RX 0 | |
585 | #define IEEE80211_SEQ_COUNTER_TX 1 | |
586 | ||
7ac1bd6a JB |
587 | /** |
588 | * enum set_key_cmd - key command | |
589 | * | |
590 | * Used with the set_key() callback in &struct ieee80211_ops, this | |
591 | * indicates whether a key is being removed or added. | |
592 | * | |
593 | * @SET_KEY: a key is set | |
594 | * @DISABLE_KEY: a key must be disabled | |
595 | */ | |
596 | typedef enum set_key_cmd { | |
11a843b7 | 597 | SET_KEY, DISABLE_KEY, |
f0706e82 JB |
598 | } set_key_cmd; |
599 | ||
7ac1bd6a JB |
600 | /** |
601 | * struct ieee80211_hw - hardware information and state | |
602 | * TODO: move documentation into kernel-doc format | |
603 | */ | |
f0706e82 JB |
604 | struct ieee80211_hw { |
605 | /* points to the cfg80211 wiphy for this piece. Note | |
606 | * that you must fill in the perm_addr and dev fields | |
607 | * of this structure, use the macros provided below. */ | |
608 | struct wiphy *wiphy; | |
609 | ||
610 | /* assigned by mac80211, don't write */ | |
611 | struct ieee80211_conf conf; | |
612 | ||
613 | /* Single thread workqueue available for driver use | |
614 | * Allocated by mac80211 on registration */ | |
615 | struct workqueue_struct *workqueue; | |
616 | ||
617 | /* Pointer to the private area that was | |
618 | * allocated with this struct for you. */ | |
619 | void *priv; | |
620 | ||
621 | /* The rest is information about your hardware */ | |
622 | ||
623 | /* TODO: frame_type 802.11/802.3, sw_encryption requirements */ | |
624 | ||
0ef6e49b JB |
625 | /* hole at 0 */ |
626 | ||
627 | /* | |
628 | * The device only needs to be supplied with a beacon template. | |
629 | * If you need the host to generate each beacon then don't use | |
630 | * this flag and use ieee80211_beacon_get(). | |
631 | */ | |
f0706e82 JB |
632 | #define IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE (1<<1) |
633 | ||
7848ba7d | 634 | /* hole at 2 */ |
f0706e82 JB |
635 | |
636 | /* Whether RX frames passed to ieee80211_rx() include FCS in the end */ | |
637 | #define IEEE80211_HW_RX_INCLUDES_FCS (1<<3) | |
638 | ||
639 | /* Some wireless LAN chipsets buffer broadcast/multicast frames for | |
640 | * power saving stations in the hardware/firmware and others rely on | |
641 | * the host system for such buffering. This option is used to | |
642 | * configure the IEEE 802.11 upper layer to buffer broadcast/multicast | |
643 | * frames when there are power saving stations so that low-level driver | |
644 | * can fetch them with ieee80211_get_buffered_bc(). */ | |
645 | #define IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING (1<<4) | |
646 | ||
7848ba7d | 647 | /* hole at 5 */ |
f0706e82 | 648 | |
aaa92e9a | 649 | /* hole at 6 */ |
f0706e82 | 650 | |
11a843b7 | 651 | /* hole at 7 */ |
f0706e82 | 652 | |
7848ba7d | 653 | /* hole at 8 */ |
f0706e82 | 654 | |
4150c572 | 655 | /* hole at 9 */ |
f0706e82 | 656 | |
4150c572 | 657 | /* hole at 10 */ |
f0706e82 JB |
658 | |
659 | /* Channels are already configured to the default regulatory domain | |
660 | * specified in the device's EEPROM */ | |
661 | #define IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED (1<<11) | |
662 | ||
f0706e82 JB |
663 | u32 flags; /* hardware flags defined above */ |
664 | ||
665 | /* Set to the size of a needed device specific skb headroom for TX skbs. */ | |
666 | unsigned int extra_tx_headroom; | |
667 | ||
668 | /* This is the time in us to change channels | |
669 | */ | |
670 | int channel_change_time; | |
671 | /* Maximum values for various statistics. | |
672 | * Leave at 0 to indicate no support. Use negative numbers for dBm. */ | |
673 | s8 max_rssi; | |
674 | s8 max_signal; | |
675 | s8 max_noise; | |
676 | ||
677 | /* Number of available hardware TX queues for data packets. | |
678 | * WMM requires at least four queues. */ | |
679 | int queues; | |
680 | }; | |
681 | ||
682 | static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) | |
683 | { | |
684 | set_wiphy_dev(hw->wiphy, dev); | |
685 | } | |
686 | ||
687 | static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) | |
688 | { | |
689 | memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); | |
690 | } | |
691 | ||
4150c572 JB |
692 | /* |
693 | * flags for change_filter_flags() | |
694 | * | |
695 | * Note that e.g. if PROMISC_IN_BSS is unset then | |
696 | * you should still do MAC address filtering if | |
697 | * possible even if OTHER_BSS is set to indicate | |
698 | * no BSSID filtering should be done. | |
699 | */ | |
700 | /* | |
701 | * promiscuous mode within your BSS, | |
702 | * think of the BSS as your network segment and then this corresponds | |
703 | * to the regular ethernet device promiscuous mode | |
704 | */ | |
705 | #define FIF_PROMISC_IN_BSS 0x01 | |
706 | /* show all multicast frames */ | |
707 | #define FIF_ALLMULTI 0x02 | |
708 | /* show frames with failed FCS, but set RX_FLAG_FAILED_FCS_CRC for them */ | |
709 | #define FIF_FCSFAIL 0x04 | |
710 | /* show frames with failed PLCP CRC, but set RX_FLAG_FAILED_PLCP_CRC for them */ | |
711 | #define FIF_PLCPFAIL 0x08 | |
712 | /* | |
713 | * This flag is set during scanning to indicate to the hardware | |
714 | * that it should not filter beacons or probe responses by BSSID. | |
715 | */ | |
716 | #define FIF_BCN_PRBRESP_PROMISC 0x10 | |
717 | /* | |
718 | * show control frames, if PROMISC_IN_BSS is not set then | |
719 | * only those addressed to this station | |
720 | */ | |
721 | #define FIF_CONTROL 0x20 | |
722 | /* show frames from other BSSes */ | |
723 | #define FIF_OTHER_BSS 0x40 | |
724 | ||
f0706e82 JB |
725 | /* Configuration block used by the low-level driver to tell the 802.11 code |
726 | * about supported hardware features and to pass function pointers to callback | |
727 | * functions. */ | |
728 | struct ieee80211_ops { | |
729 | /* Handler that 802.11 module calls for each transmitted frame. | |
730 | * skb contains the buffer starting from the IEEE 802.11 header. | |
731 | * The low-level driver should send the frame out based on | |
732 | * configuration in the TX control data. | |
733 | * Must be atomic. */ | |
734 | int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb, | |
735 | struct ieee80211_tx_control *control); | |
736 | ||
4150c572 JB |
737 | /* |
738 | * Called before the first netdevice attached to the hardware | |
739 | * is enabled. This should turn on the hardware and must turn on | |
740 | * frame reception (for possibly enabled monitor interfaces.) | |
741 | * Returns negative error codes, these may be seen in userspace, | |
742 | * or zero. | |
743 | * When the device is started it should not have a MAC address | |
744 | * to avoid acknowledging frames before a non-monitor device | |
745 | * is added. | |
746 | * | |
747 | * Must be implemented. | |
748 | */ | |
749 | int (*start)(struct ieee80211_hw *hw); | |
750 | ||
751 | /* | |
752 | * Called after last netdevice attached to the hardware | |
753 | * is disabled. This should turn off the hardware (at least | |
754 | * it must turn off frame reception.) | |
755 | * May be called right after add_interface if that rejects | |
756 | * an interface. | |
757 | * | |
758 | * Must be implemented. | |
759 | */ | |
760 | void (*stop)(struct ieee80211_hw *hw); | |
761 | ||
762 | /* | |
763 | * Called when a netdevice attached to the hardware is enabled. | |
764 | * Because it is not called for monitor mode devices, open() | |
765 | * and stop() must be implemented. | |
766 | * The driver should perform any initialization it needs before | |
767 | * the device can be enabled. The initial configuration for the | |
768 | * interface is given in the conf parameter. | |
769 | * | |
770 | * Must be implemented. | |
4480f15c | 771 | */ |
f0706e82 JB |
772 | int (*add_interface)(struct ieee80211_hw *hw, |
773 | struct ieee80211_if_init_conf *conf); | |
774 | ||
4150c572 JB |
775 | /* |
776 | * Notifies a driver that an interface is going down. The stop() handler | |
777 | * is called after this if it is the last interface and no monitor | |
778 | * interfaces are present. | |
779 | * When all interfaces are removed, the MAC address in the hardware | |
780 | * must be cleared so the device no longer acknowledges packets, | |
781 | * the mac_addr member of the conf structure is, however, set to the | |
782 | * MAC address of the device going away. | |
783 | * | |
784 | * Hence, this callback must be implemented. | |
785 | */ | |
f0706e82 JB |
786 | void (*remove_interface)(struct ieee80211_hw *hw, |
787 | struct ieee80211_if_init_conf *conf); | |
788 | ||
789 | /* Handler for configuration requests. IEEE 802.11 code calls this | |
790 | * function to change hardware configuration, e.g., channel. */ | |
791 | int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); | |
792 | ||
793 | /* Handler for configuration requests related to interfaces (e.g. | |
794 | * BSSID). */ | |
795 | int (*config_interface)(struct ieee80211_hw *hw, | |
796 | int if_id, struct ieee80211_if_conf *conf); | |
797 | ||
4150c572 JB |
798 | /* |
799 | * Configure the device's RX filter. | |
800 | * | |
801 | * The multicast address filter must be changed if the hardware flags | |
802 | * indicate that one is present. | |
803 | * | |
804 | * All unsupported flags in 'total_flags' must be cleared, | |
805 | * clear all bits except those you honoured. | |
806 | * | |
807 | * The callback must be implemented and must be atomic. | |
808 | */ | |
809 | void (*configure_filter)(struct ieee80211_hw *hw, | |
810 | unsigned int changed_flags, | |
811 | unsigned int *total_flags, | |
812 | int mc_count, struct dev_addr_list *mc_list); | |
f0706e82 JB |
813 | |
814 | /* Set TIM bit handler. If the hardware/firmware takes care of beacon | |
815 | * generation, IEEE 802.11 code uses this function to tell the | |
816 | * low-level to set (or clear if set==0) TIM bit for the given aid. If | |
817 | * host system is used to generate beacons, this handler is not used | |
818 | * and low-level driver should set it to NULL. | |
819 | * Must be atomic. */ | |
820 | int (*set_tim)(struct ieee80211_hw *hw, int aid, int set); | |
821 | ||
8f20fc24 JB |
822 | /* |
823 | * Set encryption key. | |
824 | * | |
825 | * This is called to enable hardware acceleration of encryption and | |
826 | * decryption. The address will be the broadcast address for default | |
11a843b7 JB |
827 | * keys, the other station's hardware address for individual keys or |
828 | * the zero address for keys that will be used only for transmission. | |
829 | * | |
830 | * The local_address parameter will always be set to our own address, | |
831 | * this is only relevant if you support multiple local addresses. | |
832 | * | |
8f20fc24 JB |
833 | * When transmitting, the TX control data will use the hw_key_idx |
834 | * selected by the low-level driver. | |
11a843b7 JB |
835 | * |
836 | * Return 0 if the key is now in use, -EOPNOTSUPP or -ENOSPC if it | |
6a7664d4 JB |
837 | * couldn't be added; if you return 0 then hw_key_idx must be assigned |
838 | * to the hardware key index, you are free to use the full u8 range. | |
839 | * | |
840 | * When the cmd is DISABLE_KEY then it must succeed. | |
11a843b7 | 841 | * |
7ac1bd6a JB |
842 | * Note that it is permissible to not decrypt a frame even if a key |
843 | * for it has been uploaded to hardware, the stack will not make any | |
844 | * decision based on whether a key has been uploaded or not but rather | |
845 | * based on the receive flags. | |
846 | * | |
11a843b7 JB |
847 | * This callback can sleep, and is only called between add_interface |
848 | * and remove_interface calls, i.e. while the interface with the | |
849 | * given local_address is enabled. | |
850 | * | |
851 | * The ieee80211_key_conf structure pointed to by the key parameter | |
852 | * is guaranteed to be valid until another call to set_key removes | |
853 | * it, but it can only be used as a cookie to differentiate keys. | |
8f20fc24 | 854 | */ |
f0706e82 | 855 | int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd, |
11a843b7 JB |
856 | const u8 *local_address, const u8 *address, |
857 | struct ieee80211_key_conf *key); | |
f0706e82 | 858 | |
f0706e82 JB |
859 | /* Enable/disable IEEE 802.1X. This item requests wlan card to pass |
860 | * unencrypted EAPOL-Key frames even when encryption is configured. | |
861 | * If the wlan card does not require such a configuration, this | |
862 | * function pointer can be set to NULL. */ | |
863 | int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x); | |
864 | ||
865 | /* Set port authorization state (IEEE 802.1X PAE) to be authorized | |
866 | * (authorized=1) or unauthorized (authorized=0). This function can be | |
867 | * used if the wlan hardware or low-level driver implements PAE. | |
868 | * 80211.o module will anyway filter frames based on authorization | |
869 | * state, so this function pointer can be NULL if low-level driver does | |
870 | * not require event notification about port state changes. | |
871 | * Currently unused. */ | |
872 | int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr, | |
873 | int authorized); | |
874 | ||
875 | /* Ask the hardware to service the scan request, no need to start | |
876 | * the scan state machine in stack. */ | |
877 | int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); | |
878 | ||
879 | /* return low-level statistics */ | |
880 | int (*get_stats)(struct ieee80211_hw *hw, | |
881 | struct ieee80211_low_level_stats *stats); | |
882 | ||
883 | /* For devices that generate their own beacons and probe response | |
884 | * or association responses this updates the state of privacy_invoked | |
885 | * returns 0 for success or an error number */ | |
886 | int (*set_privacy_invoked)(struct ieee80211_hw *hw, | |
887 | int privacy_invoked); | |
888 | ||
889 | /* For devices that have internal sequence counters, allow 802.11 | |
890 | * code to access the current value of a counter */ | |
891 | int (*get_sequence_counter)(struct ieee80211_hw *hw, | |
892 | u8* addr, u8 keyidx, u8 txrx, | |
893 | u32* iv32, u16* iv16); | |
894 | ||
895 | /* Configuration of RTS threshold (if device needs it) */ | |
896 | int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); | |
897 | ||
898 | /* Configuration of fragmentation threshold. | |
899 | * Assign this if the device does fragmentation by itself, | |
900 | * if this method is assigned then the stack will not do | |
901 | * fragmentation. */ | |
902 | int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); | |
903 | ||
904 | /* Configuration of retry limits (if device needs it) */ | |
905 | int (*set_retry_limit)(struct ieee80211_hw *hw, | |
906 | u32 short_retry, u32 long_retr); | |
907 | ||
908 | /* Number of STAs in STA table notification (NULL = disabled). | |
909 | * Must be atomic. */ | |
910 | void (*sta_table_notification)(struct ieee80211_hw *hw, | |
911 | int num_sta); | |
912 | ||
d9430a32 DD |
913 | /* Handle ERP IE change notifications. Must be atomic. */ |
914 | void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes, | |
915 | int cts_protection, int preamble); | |
916 | ||
917 | /* Flags for the erp_ie_changed changes parameter */ | |
918 | #define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */ | |
919 | #define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */ | |
920 | ||
f0706e82 JB |
921 | /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), |
922 | * bursting) for a hardware TX queue. | |
923 | * queue = IEEE80211_TX_QUEUE_*. | |
924 | * Must be atomic. */ | |
925 | int (*conf_tx)(struct ieee80211_hw *hw, int queue, | |
926 | const struct ieee80211_tx_queue_params *params); | |
927 | ||
928 | /* Get statistics of the current TX queue status. This is used to get | |
929 | * number of currently queued packets (queue length), maximum queue | |
930 | * size (limit), and total number of packets sent using each TX queue | |
931 | * (count). | |
932 | * Currently unused. */ | |
933 | int (*get_tx_stats)(struct ieee80211_hw *hw, | |
934 | struct ieee80211_tx_queue_stats *stats); | |
935 | ||
936 | /* Get the current TSF timer value from firmware/hardware. Currently, | |
937 | * this is only used for IBSS mode debugging and, as such, is not a | |
938 | * required function. | |
939 | * Must be atomic. */ | |
940 | u64 (*get_tsf)(struct ieee80211_hw *hw); | |
941 | ||
942 | /* Reset the TSF timer and allow firmware/hardware to synchronize with | |
943 | * other STAs in the IBSS. This is only used in IBSS mode. This | |
944 | * function is optional if the firmware/hardware takes full care of | |
945 | * TSF synchronization. */ | |
946 | void (*reset_tsf)(struct ieee80211_hw *hw); | |
947 | ||
948 | /* Setup beacon data for IBSS beacons. Unlike access point (Master), | |
949 | * IBSS uses a fixed beacon frame which is configured using this | |
950 | * function. This handler is required only for IBSS mode. */ | |
951 | int (*beacon_update)(struct ieee80211_hw *hw, | |
952 | struct sk_buff *skb, | |
953 | struct ieee80211_tx_control *control); | |
954 | ||
955 | /* Determine whether the last IBSS beacon was sent by us. This is | |
956 | * needed only for IBSS mode and the result of this function is used to | |
957 | * determine whether to reply to Probe Requests. */ | |
958 | int (*tx_last_beacon)(struct ieee80211_hw *hw); | |
959 | }; | |
960 | ||
961 | /* Allocate a new hardware device. This must be called once for each | |
962 | * hardware device. The returned pointer must be used to refer to this | |
963 | * device when calling other functions. 802.11 code allocates a private data | |
964 | * area for the low-level driver. The size of this area is given as | |
965 | * priv_data_len. | |
966 | */ | |
967 | struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, | |
968 | const struct ieee80211_ops *ops); | |
969 | ||
970 | /* Register hardware device to the IEEE 802.11 code and kernel. Low-level | |
971 | * drivers must call this function before using any other IEEE 802.11 | |
972 | * function except ieee80211_register_hwmode. */ | |
973 | int ieee80211_register_hw(struct ieee80211_hw *hw); | |
974 | ||
975 | /* driver can use this and ieee80211_get_rx_led_name to get the | |
976 | * name of the registered LEDs after ieee80211_register_hw | |
977 | * was called. | |
978 | * This is useful to set the default trigger on the LED class | |
979 | * device that your driver should export for each LED the device | |
980 | * has, that way the default behaviour will be as expected but | |
981 | * the user can still change it/turn off the LED etc. | |
982 | */ | |
983 | #ifdef CONFIG_MAC80211_LEDS | |
984 | extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); | |
985 | extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); | |
986 | #endif | |
987 | static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) | |
988 | { | |
989 | #ifdef CONFIG_MAC80211_LEDS | |
990 | return __ieee80211_get_tx_led_name(hw); | |
991 | #else | |
992 | return NULL; | |
993 | #endif | |
994 | } | |
995 | ||
996 | static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) | |
997 | { | |
998 | #ifdef CONFIG_MAC80211_LEDS | |
999 | return __ieee80211_get_rx_led_name(hw); | |
1000 | #else | |
1001 | return NULL; | |
1002 | #endif | |
1003 | } | |
1004 | ||
1005 | /* Register a new hardware PHYMODE capability to the stack. */ | |
1006 | int ieee80211_register_hwmode(struct ieee80211_hw *hw, | |
1007 | struct ieee80211_hw_mode *mode); | |
1008 | ||
1009 | /* Unregister a hardware device. This function instructs 802.11 code to free | |
1010 | * allocated resources and unregister netdevices from the kernel. */ | |
1011 | void ieee80211_unregister_hw(struct ieee80211_hw *hw); | |
1012 | ||
1013 | /* Free everything that was allocated including private data of a driver. */ | |
1014 | void ieee80211_free_hw(struct ieee80211_hw *hw); | |
1015 | ||
1016 | /* Receive frame callback function. The low-level driver uses this function to | |
1017 | * send received frames to the IEEE 802.11 code. Receive buffer (skb) must | |
1018 | * start with IEEE 802.11 header. */ | |
1019 | void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, | |
1020 | struct ieee80211_rx_status *status); | |
1021 | void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, | |
1022 | struct sk_buff *skb, | |
1023 | struct ieee80211_rx_status *status); | |
1024 | ||
1025 | /* Transmit status callback function. The low-level driver must call this | |
1026 | * function to report transmit status for all the TX frames that had | |
1027 | * req_tx_status set in the transmit control fields. In addition, this should | |
1028 | * be called at least for all unicast frames to provide information for TX rate | |
1029 | * control algorithm. In order to maintain all statistics, this function is | |
1030 | * recommended to be called after each frame, including multicast/broadcast, is | |
1031 | * sent. */ | |
1032 | void ieee80211_tx_status(struct ieee80211_hw *hw, | |
1033 | struct sk_buff *skb, | |
1034 | struct ieee80211_tx_status *status); | |
1035 | void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, | |
1036 | struct sk_buff *skb, | |
1037 | struct ieee80211_tx_status *status); | |
1038 | ||
1039 | /** | |
1040 | * ieee80211_beacon_get - beacon generation function | |
1041 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
1042 | * @if_id: interface ID from &struct ieee80211_if_init_conf. | |
1043 | * @control: will be filled with information needed to send this beacon. | |
1044 | * | |
1045 | * If the beacon frames are generated by the host system (i.e., not in | |
1046 | * hardware/firmware), the low-level driver uses this function to receive | |
1047 | * the next beacon frame from the 802.11 code. The low-level is responsible | |
1048 | * for calling this function before beacon data is needed (e.g., based on | |
1049 | * hardware interrupt). Returned skb is used only once and low-level driver | |
1050 | * is responsible of freeing it. | |
1051 | */ | |
1052 | struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, | |
1053 | int if_id, | |
1054 | struct ieee80211_tx_control *control); | |
1055 | ||
1056 | /** | |
1057 | * ieee80211_rts_get - RTS frame generation function | |
1058 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
7e9ed188 | 1059 | * @if_id: interface ID from &struct ieee80211_if_init_conf. |
f0706e82 JB |
1060 | * @frame: pointer to the frame that is going to be protected by the RTS. |
1061 | * @frame_len: the frame length (in octets). | |
1062 | * @frame_txctl: &struct ieee80211_tx_control of the frame. | |
1063 | * @rts: The buffer where to store the RTS frame. | |
1064 | * | |
1065 | * If the RTS frames are generated by the host system (i.e., not in | |
1066 | * hardware/firmware), the low-level driver uses this function to receive | |
1067 | * the next RTS frame from the 802.11 code. The low-level is responsible | |
1068 | * for calling this function before and RTS frame is needed. | |
1069 | */ | |
7e9ed188 | 1070 | void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id, |
f0706e82 JB |
1071 | const void *frame, size_t frame_len, |
1072 | const struct ieee80211_tx_control *frame_txctl, | |
1073 | struct ieee80211_rts *rts); | |
1074 | ||
1075 | /** | |
1076 | * ieee80211_rts_duration - Get the duration field for an RTS frame | |
1077 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
7e9ed188 | 1078 | * @if_id: interface ID from &struct ieee80211_if_init_conf. |
f0706e82 JB |
1079 | * @frame_len: the length of the frame that is going to be protected by the RTS. |
1080 | * @frame_txctl: &struct ieee80211_tx_control of the frame. | |
1081 | * | |
1082 | * If the RTS is generated in firmware, but the host system must provide | |
1083 | * the duration field, the low-level driver uses this function to receive | |
1084 | * the duration field value in little-endian byteorder. | |
1085 | */ | |
7e9ed188 | 1086 | __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id, |
f0706e82 JB |
1087 | size_t frame_len, |
1088 | const struct ieee80211_tx_control *frame_txctl); | |
1089 | ||
1090 | /** | |
1091 | * ieee80211_ctstoself_get - CTS-to-self frame generation function | |
1092 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
7e9ed188 | 1093 | * @if_id: interface ID from &struct ieee80211_if_init_conf. |
f0706e82 JB |
1094 | * @frame: pointer to the frame that is going to be protected by the CTS-to-self. |
1095 | * @frame_len: the frame length (in octets). | |
1096 | * @frame_txctl: &struct ieee80211_tx_control of the frame. | |
1097 | * @cts: The buffer where to store the CTS-to-self frame. | |
1098 | * | |
1099 | * If the CTS-to-self frames are generated by the host system (i.e., not in | |
1100 | * hardware/firmware), the low-level driver uses this function to receive | |
1101 | * the next CTS-to-self frame from the 802.11 code. The low-level is responsible | |
1102 | * for calling this function before and CTS-to-self frame is needed. | |
1103 | */ | |
7e9ed188 | 1104 | void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id, |
f0706e82 JB |
1105 | const void *frame, size_t frame_len, |
1106 | const struct ieee80211_tx_control *frame_txctl, | |
1107 | struct ieee80211_cts *cts); | |
1108 | ||
1109 | /** | |
1110 | * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame | |
1111 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
7e9ed188 | 1112 | * @if_id: interface ID from &struct ieee80211_if_init_conf. |
f0706e82 JB |
1113 | * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. |
1114 | * @frame_txctl: &struct ieee80211_tx_control of the frame. | |
1115 | * | |
1116 | * If the CTS-to-self is generated in firmware, but the host system must provide | |
1117 | * the duration field, the low-level driver uses this function to receive | |
1118 | * the duration field value in little-endian byteorder. | |
1119 | */ | |
7e9ed188 | 1120 | __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id, |
f0706e82 JB |
1121 | size_t frame_len, |
1122 | const struct ieee80211_tx_control *frame_txctl); | |
1123 | ||
1124 | /** | |
1125 | * ieee80211_generic_frame_duration - Calculate the duration field for a frame | |
1126 | * @hw: pointer obtained from ieee80211_alloc_hw(). | |
7e9ed188 | 1127 | * @if_id: interface ID from &struct ieee80211_if_init_conf. |
f0706e82 JB |
1128 | * @frame_len: the length of the frame. |
1129 | * @rate: the rate (in 100kbps) at which the frame is going to be transmitted. | |
1130 | * | |
1131 | * Calculate the duration field of some generic frame, given its | |
1132 | * length and transmission rate (in 100kbps). | |
1133 | */ | |
7e9ed188 | 1134 | __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id, |
f0706e82 JB |
1135 | size_t frame_len, |
1136 | int rate); | |
1137 | ||
1138 | /** | |
1139 | * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames | |
1140 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
1141 | * @if_id: interface ID from &struct ieee80211_if_init_conf. | |
1142 | * @control: will be filled with information needed to send returned frame. | |
1143 | * | |
1144 | * Function for accessing buffered broadcast and multicast frames. If | |
1145 | * hardware/firmware does not implement buffering of broadcast/multicast | |
1146 | * frames when power saving is used, 802.11 code buffers them in the host | |
1147 | * memory. The low-level driver uses this function to fetch next buffered | |
1148 | * frame. In most cases, this is used when generating beacon frame. This | |
1149 | * function returns a pointer to the next buffered skb or NULL if no more | |
1150 | * buffered frames are available. | |
1151 | * | |
1152 | * Note: buffered frames are returned only after DTIM beacon frame was | |
1153 | * generated with ieee80211_beacon_get() and the low-level driver must thus | |
1154 | * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns | |
1155 | * NULL if the previous generated beacon was not DTIM, so the low-level driver | |
1156 | * does not need to check for DTIM beacons separately and should be able to | |
1157 | * use common code for all beacons. | |
1158 | */ | |
1159 | struct sk_buff * | |
1160 | ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id, | |
1161 | struct ieee80211_tx_control *control); | |
1162 | ||
f0706e82 JB |
1163 | /* Given an sk_buff with a raw 802.11 header at the data pointer this function |
1164 | * returns the 802.11 header length in bytes (not including encryption | |
1165 | * headers). If the data in the sk_buff is too short to contain a valid 802.11 | |
1166 | * header the function returns 0. | |
1167 | */ | |
1168 | int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); | |
1169 | ||
1170 | /* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */ | |
1171 | int ieee80211_get_hdrlen(u16 fc); | |
1172 | ||
1173 | /** | |
1174 | * ieee80211_wake_queue - wake specific queue | |
1175 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
1176 | * @queue: queue number (counted from zero). | |
1177 | * | |
1178 | * Drivers should use this function instead of netif_wake_queue. | |
1179 | */ | |
1180 | void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); | |
1181 | ||
1182 | /** | |
1183 | * ieee80211_stop_queue - stop specific queue | |
1184 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
1185 | * @queue: queue number (counted from zero). | |
1186 | * | |
1187 | * Drivers should use this function instead of netif_stop_queue. | |
1188 | */ | |
1189 | void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); | |
1190 | ||
1191 | /** | |
1192 | * ieee80211_start_queues - start all queues | |
1193 | * @hw: pointer to as obtained from ieee80211_alloc_hw(). | |
1194 | * | |
1195 | * Drivers should use this function instead of netif_start_queue. | |
1196 | */ | |
1197 | void ieee80211_start_queues(struct ieee80211_hw *hw); | |
1198 | ||
1199 | /** | |
1200 | * ieee80211_stop_queues - stop all queues | |
1201 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
1202 | * | |
1203 | * Drivers should use this function instead of netif_stop_queue. | |
1204 | */ | |
1205 | void ieee80211_stop_queues(struct ieee80211_hw *hw); | |
1206 | ||
1207 | /** | |
1208 | * ieee80211_wake_queues - wake all queues | |
1209 | * @hw: pointer as obtained from ieee80211_alloc_hw(). | |
1210 | * | |
1211 | * Drivers should use this function instead of netif_wake_queue. | |
1212 | */ | |
1213 | void ieee80211_wake_queues(struct ieee80211_hw *hw); | |
1214 | ||
f0706e82 JB |
1215 | /* called by driver to notify scan status completed */ |
1216 | void ieee80211_scan_completed(struct ieee80211_hw *hw); | |
1217 | ||
f0706e82 JB |
1218 | /* return a pointer to the source address (SA) */ |
1219 | static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr) | |
1220 | { | |
1221 | u8 *raw = (u8 *) hdr; | |
1222 | u8 tofrom = (*(raw+1)) & 3; /* get the TODS and FROMDS bits */ | |
1223 | ||
1224 | switch (tofrom) { | |
1225 | case 2: | |
1226 | return hdr->addr3; | |
1227 | case 3: | |
1228 | return hdr->addr4; | |
1229 | } | |
1230 | return hdr->addr2; | |
1231 | } | |
1232 | ||
1233 | /* return a pointer to the destination address (DA) */ | |
1234 | static inline u8 *ieee80211_get_DA(struct ieee80211_hdr *hdr) | |
1235 | { | |
1236 | u8 *raw = (u8 *) hdr; | |
1237 | u8 to_ds = (*(raw+1)) & 1; /* get the TODS bit */ | |
1238 | ||
1239 | if (to_ds) | |
1240 | return hdr->addr3; | |
1241 | return hdr->addr1; | |
1242 | } | |
1243 | ||
1244 | static inline int ieee80211_get_morefrag(struct ieee80211_hdr *hdr) | |
1245 | { | |
1246 | return (le16_to_cpu(hdr->frame_control) & | |
1247 | IEEE80211_FCTL_MOREFRAGS) != 0; | |
1248 | } | |
1249 | ||
f0706e82 | 1250 | #endif /* MAC80211_H */ |