]>
Commit | Line | Data |
---|---|---|
181d6902 ID |
1 | /* |
2 | Copyright (C) 2004 - 2008 rt2x00 SourceForge Project | |
3 | <http://rt2x00.serialmonkey.com> | |
4 | ||
5 | This program is free software; you can redistribute it and/or modify | |
6 | it under the terms of the GNU General Public License as published by | |
7 | the Free Software Foundation; either version 2 of the License, or | |
8 | (at your option) any later version. | |
9 | ||
10 | This program is distributed in the hope that it will be useful, | |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | GNU General Public License for more details. | |
14 | ||
15 | You should have received a copy of the GNU General Public License | |
16 | along with this program; if not, write to the | |
17 | Free Software Foundation, Inc., | |
18 | 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
19 | */ | |
20 | ||
21 | /* | |
22 | Module: rt2x00 | |
23 | Abstract: rt2x00 queue datastructures and routines | |
24 | */ | |
25 | ||
26 | #ifndef RT2X00QUEUE_H | |
27 | #define RT2X00QUEUE_H | |
28 | ||
29 | #include <linux/prefetch.h> | |
30 | ||
31 | /** | |
32 | * DOC: Entrie frame size | |
33 | * | |
34 | * Ralink PCI devices demand the Frame size to be a multiple of 128 bytes, | |
35 | * for USB devices this restriction does not apply, but the value of | |
36 | * 2432 makes sense since it is big enough to contain the maximum fragment | |
37 | * size according to the ieee802.11 specs. | |
38 | */ | |
39 | #define DATA_FRAME_SIZE 2432 | |
40 | #define MGMT_FRAME_SIZE 256 | |
41 | ||
42 | /** | |
43 | * DOC: Number of entries per queue | |
44 | * | |
45 | * After research it was concluded that 12 entries in a RX and TX | |
46 | * queue would be sufficient. Although this is almost one third of | |
47 | * the amount the legacy driver allocated, the queues aren't getting | |
48 | * filled to the maximum even when working with the maximum rate. | |
181d6902 ID |
49 | */ |
50 | #define RX_ENTRIES 12 | |
51 | #define TX_ENTRIES 12 | |
52 | #define BEACON_ENTRIES 1 | |
53 | #define ATIM_ENTRIES 1 | |
54 | ||
55 | /** | |
56 | * enum data_queue_qid: Queue identification | |
e58c6aca ID |
57 | * |
58 | * @QID_AC_BE: AC BE queue | |
59 | * @QID_AC_BK: AC BK queue | |
60 | * @QID_AC_VI: AC VI queue | |
61 | * @QID_AC_VO: AC VO queue | |
62 | * @QID_HCCA: HCCA queue | |
63 | * @QID_MGMT: MGMT queue (prio queue) | |
64 | * @QID_RX: RX queue | |
65 | * @QID_OTHER: None of the above (don't use, only present for completeness) | |
66 | * @QID_BEACON: Beacon queue (value unspecified, don't send it to device) | |
67 | * @QID_ATIM: Atim queue (value unspeficied, don't send it to device) | |
181d6902 ID |
68 | */ |
69 | enum data_queue_qid { | |
70 | QID_AC_BE = 0, | |
71 | QID_AC_BK = 1, | |
72 | QID_AC_VI = 2, | |
73 | QID_AC_VO = 3, | |
74 | QID_HCCA = 4, | |
75 | QID_MGMT = 13, | |
76 | QID_RX = 14, | |
77 | QID_OTHER = 15, | |
e58c6aca ID |
78 | QID_BEACON, |
79 | QID_ATIM, | |
181d6902 ID |
80 | }; |
81 | ||
baf26a7e ID |
82 | /** |
83 | * enum skb_frame_desc_flags: Flags for &struct skb_frame_desc | |
84 | * | |
85 | * @FRAME_DESC_DRIVER_GENERATED: Frame was generated inside driver | |
86 | * and should not be reported back to mac80211 during txdone. | |
87 | */ | |
88 | enum skb_frame_desc_flags { | |
89 | FRAME_DESC_DRIVER_GENERATED = 1 << 0, | |
90 | }; | |
91 | ||
181d6902 ID |
92 | /** |
93 | * struct skb_frame_desc: Descriptor information for the skb buffer | |
94 | * | |
e039fa4a JB |
95 | * This structure is placed over the driver_data array, this means that |
96 | * this structure should not exceed the size of that array (40 bytes). | |
181d6902 | 97 | * |
baf26a7e | 98 | * @flags: Frame flags, see &enum skb_frame_desc_flags. |
181d6902 ID |
99 | * @data: Pointer to data part of frame (Start of ieee80211 header). |
100 | * @desc: Pointer to descriptor part of the frame. | |
101 | * Note that this pointer could point to something outside | |
102 | * of the scope of the skb->data pointer. | |
103 | * @data_len: Length of the frame data. | |
104 | * @desc_len: Length of the frame descriptor. | |
181d6902 ID |
105 | * @entry: The entry to which this sk buffer belongs. |
106 | */ | |
107 | struct skb_frame_desc { | |
108 | unsigned int flags; | |
109 | ||
5a6e5999 ID |
110 | unsigned short data_len; |
111 | unsigned short desc_len; | |
181d6902 ID |
112 | |
113 | void *data; | |
114 | void *desc; | |
115 | ||
181d6902 ID |
116 | struct queue_entry *entry; |
117 | }; | |
118 | ||
e039fa4a JB |
119 | /** |
120 | * get_skb_frame_desc - Obtain the rt2x00 frame descriptor from a sk_buff. | |
121 | * @skb: &struct sk_buff from where we obtain the &struct skb_frame_desc | |
122 | */ | |
181d6902 ID |
123 | static inline struct skb_frame_desc* get_skb_frame_desc(struct sk_buff *skb) |
124 | { | |
e039fa4a JB |
125 | BUILD_BUG_ON(sizeof(struct skb_frame_desc) > |
126 | IEEE80211_TX_INFO_DRIVER_DATA_SIZE); | |
127 | return (struct skb_frame_desc *)&IEEE80211_SKB_CB(skb)->driver_data; | |
181d6902 ID |
128 | } |
129 | ||
19d30e02 ID |
130 | /** |
131 | * enum rxdone_entry_desc_flags: Flags for &struct rxdone_entry_desc | |
132 | * | |
133 | * @RXDONE_SIGNAL_PLCP: Does the signal field contain the plcp value, | |
134 | * or does it contain the bitrate itself. | |
135 | * @RXDONE_MY_BSS: Does this frame originate from device's BSS. | |
136 | */ | |
137 | enum rxdone_entry_desc_flags { | |
138 | RXDONE_SIGNAL_PLCP = 1 << 0, | |
139 | RXDONE_MY_BSS = 1 << 1, | |
140 | }; | |
141 | ||
181d6902 ID |
142 | /** |
143 | * struct rxdone_entry_desc: RX Entry descriptor | |
144 | * | |
145 | * Summary of information that has been read from the RX frame descriptor. | |
146 | * | |
147 | * @signal: Signal of the received frame. | |
148 | * @rssi: RSSI of the received frame. | |
181d6902 ID |
149 | * @size: Data size of the received frame. |
150 | * @flags: MAC80211 receive flags (See &enum mac80211_rx_flags). | |
19d30e02 ID |
151 | * @dev_flags: Ralink receive flags (See &enum rxdone_entry_desc_flags). |
152 | ||
181d6902 ID |
153 | */ |
154 | struct rxdone_entry_desc { | |
155 | int signal; | |
156 | int rssi; | |
181d6902 ID |
157 | int size; |
158 | int flags; | |
19d30e02 | 159 | int dev_flags; |
181d6902 ID |
160 | }; |
161 | ||
fb55f4d1 ID |
162 | /** |
163 | * enum txdone_entry_desc_flags: Flags for &struct txdone_entry_desc | |
164 | * | |
165 | * @TXDONE_UNKNOWN: Hardware could not determine success of transmission. | |
166 | * @TXDONE_SUCCESS: Frame was successfully send | |
167 | * @TXDONE_FAILURE: Frame was not successfully send | |
168 | * @TXDONE_EXCESSIVE_RETRY: In addition to &TXDONE_FAILURE, the | |
169 | * frame transmission failed due to excessive retries. | |
170 | */ | |
171 | enum txdone_entry_desc_flags { | |
172 | TXDONE_UNKNOWN = 1 << 0, | |
173 | TXDONE_SUCCESS = 1 << 1, | |
174 | TXDONE_FAILURE = 1 << 2, | |
175 | TXDONE_EXCESSIVE_RETRY = 1 << 3, | |
176 | }; | |
177 | ||
181d6902 ID |
178 | /** |
179 | * struct txdone_entry_desc: TX done entry descriptor | |
180 | * | |
181 | * Summary of information that has been read from the TX frame descriptor | |
182 | * after the device is done with transmission. | |
183 | * | |
fb55f4d1 | 184 | * @flags: TX done flags (See &enum txdone_entry_desc_flags). |
181d6902 ID |
185 | * @retry: Retry count. |
186 | */ | |
187 | struct txdone_entry_desc { | |
fb55f4d1 | 188 | unsigned long flags; |
181d6902 ID |
189 | int retry; |
190 | }; | |
191 | ||
192 | /** | |
193 | * enum txentry_desc_flags: Status flags for TX entry descriptor | |
194 | * | |
195 | * @ENTRY_TXD_RTS_FRAME: This frame is a RTS frame. | |
7050ec82 | 196 | * @ENTRY_TXD_CTS_FRAME: This frame is a CTS-to-self frame. |
181d6902 | 197 | * @ENTRY_TXD_OFDM_RATE: This frame is send out with an OFDM rate. |
61486e0f | 198 | * @ENTRY_TXD_FIRST_FRAGMENT: This is the first frame. |
181d6902 ID |
199 | * @ENTRY_TXD_MORE_FRAG: This frame is followed by another fragment. |
200 | * @ENTRY_TXD_REQ_TIMESTAMP: Require timestamp to be inserted. | |
201 | * @ENTRY_TXD_BURST: This frame belongs to the same burst event. | |
202 | * @ENTRY_TXD_ACK: An ACK is required for this frame. | |
61486e0f | 203 | * @ENTRY_TXD_RETRY_MODE: When set, the long retry count is used. |
181d6902 ID |
204 | */ |
205 | enum txentry_desc_flags { | |
206 | ENTRY_TXD_RTS_FRAME, | |
7050ec82 | 207 | ENTRY_TXD_CTS_FRAME, |
181d6902 | 208 | ENTRY_TXD_OFDM_RATE, |
61486e0f | 209 | ENTRY_TXD_FIRST_FRAGMENT, |
181d6902 ID |
210 | ENTRY_TXD_MORE_FRAG, |
211 | ENTRY_TXD_REQ_TIMESTAMP, | |
212 | ENTRY_TXD_BURST, | |
213 | ENTRY_TXD_ACK, | |
61486e0f | 214 | ENTRY_TXD_RETRY_MODE, |
181d6902 ID |
215 | }; |
216 | ||
217 | /** | |
218 | * struct txentry_desc: TX Entry descriptor | |
219 | * | |
220 | * Summary of information for the frame descriptor before sending a TX frame. | |
221 | * | |
222 | * @flags: Descriptor flags (See &enum queue_entry_flags). | |
223 | * @queue: Queue identification (See &enum data_queue_qid). | |
224 | * @length_high: PLCP length high word. | |
225 | * @length_low: PLCP length low word. | |
226 | * @signal: PLCP signal. | |
227 | * @service: PLCP service. | |
61486e0f | 228 | * @retry_limit: Max number of retries. |
181d6902 ID |
229 | * @aifs: AIFS value. |
230 | * @ifs: IFS value. | |
231 | * @cw_min: cwmin value. | |
232 | * @cw_max: cwmax value. | |
233 | */ | |
234 | struct txentry_desc { | |
235 | unsigned long flags; | |
236 | ||
237 | enum data_queue_qid queue; | |
238 | ||
239 | u16 length_high; | |
240 | u16 length_low; | |
241 | u16 signal; | |
242 | u16 service; | |
243 | ||
61486e0f ID |
244 | short retry_limit; |
245 | short aifs; | |
246 | short ifs; | |
247 | short cw_min; | |
248 | short cw_max; | |
181d6902 ID |
249 | }; |
250 | ||
251 | /** | |
252 | * enum queue_entry_flags: Status flags for queue entry | |
253 | * | |
254 | * @ENTRY_BCN_ASSIGNED: This entry has been assigned to an interface. | |
255 | * As long as this bit is set, this entry may only be touched | |
256 | * through the interface structure. | |
257 | * @ENTRY_OWNER_DEVICE_DATA: This entry is owned by the device for data | |
258 | * transfer (either TX or RX depending on the queue). The entry should | |
259 | * only be touched after the device has signaled it is done with it. | |
260 | * @ENTRY_OWNER_DEVICE_CRYPTO: This entry is owned by the device for data | |
261 | * encryption or decryption. The entry should only be touched after | |
262 | * the device has signaled it is done with it. | |
263 | */ | |
181d6902 ID |
264 | enum queue_entry_flags { |
265 | ENTRY_BCN_ASSIGNED, | |
266 | ENTRY_OWNER_DEVICE_DATA, | |
267 | ENTRY_OWNER_DEVICE_CRYPTO, | |
268 | }; | |
269 | ||
270 | /** | |
271 | * struct queue_entry: Entry inside the &struct data_queue | |
272 | * | |
273 | * @flags: Entry flags, see &enum queue_entry_flags. | |
274 | * @queue: The data queue (&struct data_queue) to which this entry belongs. | |
275 | * @skb: The buffer which is currently being transmitted (for TX queue), | |
276 | * or used to directly recieve data in (for RX queue). | |
277 | * @entry_idx: The entry index number. | |
278 | * @priv_data: Private data belonging to this queue entry. The pointer | |
279 | * points to data specific to a particular driver and queue type. | |
280 | */ | |
281 | struct queue_entry { | |
282 | unsigned long flags; | |
283 | ||
284 | struct data_queue *queue; | |
285 | ||
286 | struct sk_buff *skb; | |
287 | ||
288 | unsigned int entry_idx; | |
289 | ||
290 | void *priv_data; | |
291 | }; | |
292 | ||
293 | /** | |
294 | * enum queue_index: Queue index type | |
295 | * | |
296 | * @Q_INDEX: Index pointer to the current entry in the queue, if this entry is | |
297 | * owned by the hardware then the queue is considered to be full. | |
298 | * @Q_INDEX_DONE: Index pointer to the next entry which will be completed by | |
299 | * the hardware and for which we need to run the txdone handler. If this | |
300 | * entry is not owned by the hardware the queue is considered to be empty. | |
301 | * @Q_INDEX_CRYPTO: Index pointer to the next entry which encryption/decription | |
302 | * will be completed by the hardware next. | |
303 | * @Q_INDEX_MAX: Keep last, used in &struct data_queue to determine the size | |
304 | * of the index array. | |
305 | */ | |
306 | enum queue_index { | |
307 | Q_INDEX, | |
308 | Q_INDEX_DONE, | |
309 | Q_INDEX_CRYPTO, | |
310 | Q_INDEX_MAX, | |
311 | }; | |
312 | ||
313 | /** | |
314 | * struct data_queue: Data queue | |
315 | * | |
316 | * @rt2x00dev: Pointer to main &struct rt2x00dev where this queue belongs to. | |
317 | * @entries: Base address of the &struct queue_entry which are | |
318 | * part of this queue. | |
319 | * @qid: The queue identification, see &enum data_queue_qid. | |
320 | * @lock: Spinlock to protect index handling. Whenever @index, @index_done or | |
321 | * @index_crypt needs to be changed this lock should be grabbed to prevent | |
322 | * index corruption due to concurrency. | |
323 | * @count: Number of frames handled in the queue. | |
324 | * @limit: Maximum number of entries in the queue. | |
325 | * @length: Number of frames in queue. | |
326 | * @index: Index pointers to entry positions in the queue, | |
327 | * use &enum queue_index to get a specific index field. | |
328 | * @aifs: The aifs value for outgoing frames (field ignored in RX queue). | |
329 | * @cw_min: The cw min value for outgoing frames (field ignored in RX queue). | |
330 | * @cw_max: The cw max value for outgoing frames (field ignored in RX queue). | |
331 | * @data_size: Maximum data size for the frames in this queue. | |
332 | * @desc_size: Hardware descriptor size for the data in this queue. | |
333 | */ | |
334 | struct data_queue { | |
335 | struct rt2x00_dev *rt2x00dev; | |
336 | struct queue_entry *entries; | |
337 | ||
338 | enum data_queue_qid qid; | |
339 | ||
340 | spinlock_t lock; | |
341 | unsigned int count; | |
342 | unsigned short limit; | |
343 | unsigned short length; | |
344 | unsigned short index[Q_INDEX_MAX]; | |
345 | ||
346 | unsigned short aifs; | |
347 | unsigned short cw_min; | |
348 | unsigned short cw_max; | |
349 | ||
350 | unsigned short data_size; | |
351 | unsigned short desc_size; | |
352 | }; | |
353 | ||
354 | /** | |
355 | * struct data_queue_desc: Data queue description | |
356 | * | |
357 | * The information in this structure is used by drivers | |
358 | * to inform rt2x00lib about the creation of the data queue. | |
359 | * | |
360 | * @entry_num: Maximum number of entries for a queue. | |
361 | * @data_size: Maximum data size for the frames in this queue. | |
362 | * @desc_size: Hardware descriptor size for the data in this queue. | |
363 | * @priv_size: Size of per-queue_entry private data. | |
364 | */ | |
365 | struct data_queue_desc { | |
366 | unsigned short entry_num; | |
367 | unsigned short data_size; | |
368 | unsigned short desc_size; | |
369 | unsigned short priv_size; | |
370 | }; | |
371 | ||
372 | /** | |
373 | * queue_end - Return pointer to the last queue (HELPER MACRO). | |
374 | * @__dev: Pointer to &struct rt2x00_dev | |
375 | * | |
376 | * Using the base rx pointer and the maximum number of available queues, | |
377 | * this macro will return the address of 1 position beyond the end of the | |
378 | * queues array. | |
379 | */ | |
380 | #define queue_end(__dev) \ | |
381 | &(__dev)->rx[(__dev)->data_queues] | |
382 | ||
383 | /** | |
384 | * tx_queue_end - Return pointer to the last TX queue (HELPER MACRO). | |
385 | * @__dev: Pointer to &struct rt2x00_dev | |
386 | * | |
387 | * Using the base tx pointer and the maximum number of available TX | |
388 | * queues, this macro will return the address of 1 position beyond | |
389 | * the end of the TX queue array. | |
390 | */ | |
391 | #define tx_queue_end(__dev) \ | |
61448f88 | 392 | &(__dev)->tx[(__dev)->ops->tx_queues] |
181d6902 ID |
393 | |
394 | /** | |
395 | * queue_loop - Loop through the queues within a specific range (HELPER MACRO). | |
396 | * @__entry: Pointer where the current queue entry will be stored in. | |
397 | * @__start: Start queue pointer. | |
398 | * @__end: End queue pointer. | |
399 | * | |
400 | * This macro will loop through all queues between &__start and &__end. | |
401 | */ | |
402 | #define queue_loop(__entry, __start, __end) \ | |
403 | for ((__entry) = (__start); \ | |
404 | prefetch(&(__entry)[1]), (__entry) != (__end); \ | |
405 | (__entry) = &(__entry)[1]) | |
406 | ||
407 | /** | |
408 | * queue_for_each - Loop through all queues | |
409 | * @__dev: Pointer to &struct rt2x00_dev | |
410 | * @__entry: Pointer where the current queue entry will be stored in. | |
411 | * | |
412 | * This macro will loop through all available queues. | |
413 | */ | |
414 | #define queue_for_each(__dev, __entry) \ | |
415 | queue_loop(__entry, (__dev)->rx, queue_end(__dev)) | |
416 | ||
417 | /** | |
418 | * tx_queue_for_each - Loop through the TX queues | |
419 | * @__dev: Pointer to &struct rt2x00_dev | |
420 | * @__entry: Pointer where the current queue entry will be stored in. | |
421 | * | |
422 | * This macro will loop through all TX related queues excluding | |
423 | * the Beacon and Atim queues. | |
424 | */ | |
425 | #define tx_queue_for_each(__dev, __entry) \ | |
426 | queue_loop(__entry, (__dev)->tx, tx_queue_end(__dev)) | |
427 | ||
428 | /** | |
429 | * txall_queue_for_each - Loop through all TX related queues | |
430 | * @__dev: Pointer to &struct rt2x00_dev | |
431 | * @__entry: Pointer where the current queue entry will be stored in. | |
432 | * | |
433 | * This macro will loop through all TX related queues including | |
434 | * the Beacon and Atim queues. | |
435 | */ | |
436 | #define txall_queue_for_each(__dev, __entry) \ | |
437 | queue_loop(__entry, (__dev)->tx, queue_end(__dev)) | |
438 | ||
439 | /** | |
440 | * rt2x00queue_empty - Check if the queue is empty. | |
441 | * @queue: Queue to check if empty. | |
442 | */ | |
443 | static inline int rt2x00queue_empty(struct data_queue *queue) | |
444 | { | |
445 | return queue->length == 0; | |
446 | } | |
447 | ||
448 | /** | |
449 | * rt2x00queue_full - Check if the queue is full. | |
450 | * @queue: Queue to check if full. | |
451 | */ | |
452 | static inline int rt2x00queue_full(struct data_queue *queue) | |
453 | { | |
454 | return queue->length == queue->limit; | |
455 | } | |
456 | ||
457 | /** | |
458 | * rt2x00queue_free - Check the number of available entries in queue. | |
459 | * @queue: Queue to check. | |
460 | */ | |
461 | static inline int rt2x00queue_available(struct data_queue *queue) | |
462 | { | |
463 | return queue->limit - queue->length; | |
464 | } | |
465 | ||
466 | /** | |
467 | * rt2x00_desc_read - Read a word from the hardware descriptor. | |
468 | * @desc: Base descriptor address | |
469 | * @word: Word index from where the descriptor should be read. | |
470 | * @value: Address where the descriptor value should be written into. | |
471 | */ | |
472 | static inline void rt2x00_desc_read(__le32 *desc, const u8 word, u32 *value) | |
473 | { | |
474 | *value = le32_to_cpu(desc[word]); | |
475 | } | |
476 | ||
477 | /** | |
478 | * rt2x00_desc_write - wrote a word to the hardware descriptor. | |
479 | * @desc: Base descriptor address | |
480 | * @word: Word index from where the descriptor should be written. | |
481 | * @value: Value that should be written into the descriptor. | |
482 | */ | |
483 | static inline void rt2x00_desc_write(__le32 *desc, const u8 word, u32 value) | |
484 | { | |
485 | desc[word] = cpu_to_le32(value); | |
486 | } | |
487 | ||
488 | #endif /* RT2X00QUEUE_H */ |