2 Copyright (C) 2004 - 2007 rt2x00 SourceForge Project
3 <http://rt2x00.serialmonkey.com>
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.
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.
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.
23 Abstract: rt2x00 ring datastructures and routines
31 * Each data entry also contains a descriptor which is used by the
32 * device to determine what should be done with the packet and
33 * what the current status is.
34 * This structure is greatly simplified, but the descriptors
35 * are basically a list of little endian 32 bit values.
36 * Make the array by default 1 word big, this will allow us
37 * to use sizeof() correctly.
45 * Summary of information that should be written into the
46 * descriptor for sending a TX frame.
48 struct data_entry_desc {
50 #define ENTRY_TXDONE 1
51 #define ENTRY_TXD_RTS_FRAME 2
52 #define ENTRY_TXD_OFDM_RATE 3
53 #define ENTRY_TXD_MORE_FRAG 4
54 #define ENTRY_TXD_REQ_TIMESTAMP 5
55 #define ENTRY_TXD_BURST 6
58 * Queue ID. ID's 0-4 are data TX rings
63 #define QUEUE_OTHER 15
84 * The data ring is a list of data entries.
85 * Each entry holds a reference to the descriptor
86 * and the data buffer. For TX rings the reference to the
87 * sk_buff of the packet being transmitted is also stored here.
94 #define ENTRY_OWNER_NIC 1
99 struct data_ring *ring;
102 * sk_buff for the packet which is being transmitted
103 * in this entry (Only used with TX related rings).
108 * Store a ieee80211_tx_status structure in each
109 * ring entry, this will optimize the txdone
112 struct ieee80211_tx_status tx_status;
115 * private pointer specific to driver.
120 * Data address for this entry.
128 * Data rings are used by the device to send and receive packets.
129 * The data_addr is the base address of the data memory.
130 * To determine at which point in the ring we are,
131 * have to use the rt2x00_ring_index_*() functions.
135 * Pointer to main rt2x00dev structure where this
138 struct rt2x00_dev *rt2x00dev;
141 * Base address for the device specific data entries.
143 struct data_entry *entry;
146 * TX queue statistic info.
148 struct ieee80211_tx_queue_stats_data stats;
151 * TX Queue parameters.
153 struct ieee80211_tx_queue_params tx_params;
156 * Base address for data ring.
168 * Size of packet and descriptor in bytes.
175 * Handlers to determine the address of the current device specific
176 * data entry, where either index or index_done points to.
178 static inline struct data_entry *rt2x00_get_data_entry(struct data_ring *ring)
180 return &ring->entry[ring->index];
183 static inline struct data_entry *rt2x00_get_data_entry_done(struct data_ring
186 return &ring->entry[ring->index_done];
192 static inline int rt2x00_get_ring_size(struct data_ring *ring)
194 return ring->stats.limit * (ring->desc_size + ring->data_size);
198 * Ring index manipulation functions.
200 static inline void rt2x00_ring_index_inc(struct data_ring *ring)
203 if (ring->index >= ring->stats.limit)
208 static inline void rt2x00_ring_index_done_inc(struct data_ring *ring)
211 if (ring->index_done >= ring->stats.limit)
212 ring->index_done = 0;
217 static inline void rt2x00_ring_index_clear(struct data_ring *ring)
220 ring->index_done = 0;
222 ring->stats.count = 0;
225 static inline int rt2x00_ring_empty(struct data_ring *ring)
227 return ring->stats.len == 0;
230 static inline int rt2x00_ring_full(struct data_ring *ring)
232 return ring->stats.len == ring->stats.limit;
235 static inline int rt2x00_ring_free(struct data_ring *ring)
237 return ring->stats.limit - ring->stats.len;
241 * TX/RX Descriptor access functions.
243 static inline void rt2x00_desc_read(struct data_desc *desc,
244 const u8 word, u32 *value)
246 *value = le32_to_cpu(desc->word[word]);
249 static inline void rt2x00_desc_write(struct data_desc *desc,
250 const u8 word, const u32 value)
252 desc->word[word] = cpu_to_le32(value);
255 #endif /* RT2X00RING_H */