b43: Enforce DMA descriptor memory constraints
[safe/jmp/linux-2.6] / drivers / net / wireless / b43 / dma.h
1 #ifndef B43_DMA_H_
2 #define B43_DMA_H_
3
4 #include <linux/ieee80211.h>
5
6 #include "b43.h"
7
8
9 /* DMA-Interrupt reasons. */
10 #define B43_DMAIRQ_FATALMASK    ((1 << 10) | (1 << 11) | (1 << 12) \
11                                          | (1 << 14) | (1 << 15))
12 #define B43_DMAIRQ_NONFATALMASK (1 << 13)
13 #define B43_DMAIRQ_RX_DONE              (1 << 16)
14
15 /*** 32-bit DMA Engine. ***/
16
17 /* 32-bit DMA controller registers. */
18 #define B43_DMA32_TXCTL                         0x00
19 #define         B43_DMA32_TXENABLE                      0x00000001
20 #define         B43_DMA32_TXSUSPEND                     0x00000002
21 #define         B43_DMA32_TXLOOPBACK            0x00000004
22 #define         B43_DMA32_TXFLUSH                       0x00000010
23 #define         B43_DMA32_TXADDREXT_MASK                0x00030000
24 #define         B43_DMA32_TXADDREXT_SHIFT               16
25 #define B43_DMA32_TXRING                                0x04
26 #define B43_DMA32_TXINDEX                               0x08
27 #define B43_DMA32_TXSTATUS                              0x0C
28 #define         B43_DMA32_TXDPTR                        0x00000FFF
29 #define         B43_DMA32_TXSTATE                       0x0000F000
30 #define                 B43_DMA32_TXSTAT_DISABLED       0x00000000
31 #define                 B43_DMA32_TXSTAT_ACTIVE 0x00001000
32 #define                 B43_DMA32_TXSTAT_IDLEWAIT       0x00002000
33 #define                 B43_DMA32_TXSTAT_STOPPED        0x00003000
34 #define                 B43_DMA32_TXSTAT_SUSP   0x00004000
35 #define         B43_DMA32_TXERROR                       0x000F0000
36 #define                 B43_DMA32_TXERR_NOERR   0x00000000
37 #define                 B43_DMA32_TXERR_PROT    0x00010000
38 #define                 B43_DMA32_TXERR_UNDERRUN        0x00020000
39 #define                 B43_DMA32_TXERR_BUFREAD 0x00030000
40 #define                 B43_DMA32_TXERR_DESCREAD        0x00040000
41 #define         B43_DMA32_TXACTIVE                      0xFFF00000
42 #define B43_DMA32_RXCTL                         0x10
43 #define         B43_DMA32_RXENABLE                      0x00000001
44 #define         B43_DMA32_RXFROFF_MASK          0x000000FE
45 #define         B43_DMA32_RXFROFF_SHIFT         1
46 #define         B43_DMA32_RXDIRECTFIFO          0x00000100
47 #define         B43_DMA32_RXADDREXT_MASK                0x00030000
48 #define         B43_DMA32_RXADDREXT_SHIFT               16
49 #define B43_DMA32_RXRING                                0x14
50 #define B43_DMA32_RXINDEX                               0x18
51 #define B43_DMA32_RXSTATUS                              0x1C
52 #define         B43_DMA32_RXDPTR                        0x00000FFF
53 #define         B43_DMA32_RXSTATE                       0x0000F000
54 #define                 B43_DMA32_RXSTAT_DISABLED       0x00000000
55 #define                 B43_DMA32_RXSTAT_ACTIVE 0x00001000
56 #define                 B43_DMA32_RXSTAT_IDLEWAIT       0x00002000
57 #define                 B43_DMA32_RXSTAT_STOPPED        0x00003000
58 #define         B43_DMA32_RXERROR                       0x000F0000
59 #define                 B43_DMA32_RXERR_NOERR   0x00000000
60 #define                 B43_DMA32_RXERR_PROT    0x00010000
61 #define                 B43_DMA32_RXERR_OVERFLOW        0x00020000
62 #define                 B43_DMA32_RXERR_BUFWRITE        0x00030000
63 #define                 B43_DMA32_RXERR_DESCREAD        0x00040000
64 #define         B43_DMA32_RXACTIVE                      0xFFF00000
65
66 /* 32-bit DMA descriptor. */
67 struct b43_dmadesc32 {
68         __le32 control;
69         __le32 address;
70 } __attribute__ ((__packed__));
71 #define B43_DMA32_DCTL_BYTECNT          0x00001FFF
72 #define B43_DMA32_DCTL_ADDREXT_MASK             0x00030000
73 #define B43_DMA32_DCTL_ADDREXT_SHIFT    16
74 #define B43_DMA32_DCTL_DTABLEEND                0x10000000
75 #define B43_DMA32_DCTL_IRQ                      0x20000000
76 #define B43_DMA32_DCTL_FRAMEEND         0x40000000
77 #define B43_DMA32_DCTL_FRAMESTART               0x80000000
78
79 /*** 64-bit DMA Engine. ***/
80
81 /* 64-bit DMA controller registers. */
82 #define B43_DMA64_TXCTL                         0x00
83 #define         B43_DMA64_TXENABLE                      0x00000001
84 #define         B43_DMA64_TXSUSPEND                     0x00000002
85 #define         B43_DMA64_TXLOOPBACK            0x00000004
86 #define         B43_DMA64_TXFLUSH                       0x00000010
87 #define         B43_DMA64_TXADDREXT_MASK                0x00030000
88 #define         B43_DMA64_TXADDREXT_SHIFT               16
89 #define B43_DMA64_TXINDEX                               0x04
90 #define B43_DMA64_TXRINGLO                              0x08
91 #define B43_DMA64_TXRINGHI                              0x0C
92 #define B43_DMA64_TXSTATUS                              0x10
93 #define         B43_DMA64_TXSTATDPTR            0x00001FFF
94 #define         B43_DMA64_TXSTAT                        0xF0000000
95 #define                 B43_DMA64_TXSTAT_DISABLED       0x00000000
96 #define                 B43_DMA64_TXSTAT_ACTIVE 0x10000000
97 #define                 B43_DMA64_TXSTAT_IDLEWAIT       0x20000000
98 #define                 B43_DMA64_TXSTAT_STOPPED        0x30000000
99 #define                 B43_DMA64_TXSTAT_SUSP   0x40000000
100 #define B43_DMA64_TXERROR                               0x14
101 #define         B43_DMA64_TXERRDPTR                     0x0001FFFF
102 #define         B43_DMA64_TXERR                 0xF0000000
103 #define                 B43_DMA64_TXERR_NOERR   0x00000000
104 #define                 B43_DMA64_TXERR_PROT    0x10000000
105 #define                 B43_DMA64_TXERR_UNDERRUN        0x20000000
106 #define                 B43_DMA64_TXERR_TRANSFER        0x30000000
107 #define                 B43_DMA64_TXERR_DESCREAD        0x40000000
108 #define                 B43_DMA64_TXERR_CORE    0x50000000
109 #define B43_DMA64_RXCTL                         0x20
110 #define         B43_DMA64_RXENABLE                      0x00000001
111 #define         B43_DMA64_RXFROFF_MASK          0x000000FE
112 #define         B43_DMA64_RXFROFF_SHIFT         1
113 #define         B43_DMA64_RXDIRECTFIFO          0x00000100
114 #define         B43_DMA64_RXADDREXT_MASK                0x00030000
115 #define         B43_DMA64_RXADDREXT_SHIFT               16
116 #define B43_DMA64_RXINDEX                               0x24
117 #define B43_DMA64_RXRINGLO                              0x28
118 #define B43_DMA64_RXRINGHI                              0x2C
119 #define B43_DMA64_RXSTATUS                              0x30
120 #define         B43_DMA64_RXSTATDPTR            0x00001FFF
121 #define         B43_DMA64_RXSTAT                        0xF0000000
122 #define                 B43_DMA64_RXSTAT_DISABLED       0x00000000
123 #define                 B43_DMA64_RXSTAT_ACTIVE 0x10000000
124 #define                 B43_DMA64_RXSTAT_IDLEWAIT       0x20000000
125 #define                 B43_DMA64_RXSTAT_STOPPED        0x30000000
126 #define                 B43_DMA64_RXSTAT_SUSP   0x40000000
127 #define B43_DMA64_RXERROR                               0x34
128 #define         B43_DMA64_RXERRDPTR                     0x0001FFFF
129 #define         B43_DMA64_RXERR                 0xF0000000
130 #define                 B43_DMA64_RXERR_NOERR   0x00000000
131 #define                 B43_DMA64_RXERR_PROT    0x10000000
132 #define                 B43_DMA64_RXERR_UNDERRUN        0x20000000
133 #define                 B43_DMA64_RXERR_TRANSFER        0x30000000
134 #define                 B43_DMA64_RXERR_DESCREAD        0x40000000
135 #define                 B43_DMA64_RXERR_CORE    0x50000000
136
137 /* 64-bit DMA descriptor. */
138 struct b43_dmadesc64 {
139         __le32 control0;
140         __le32 control1;
141         __le32 address_low;
142         __le32 address_high;
143 } __attribute__ ((__packed__));
144 #define B43_DMA64_DCTL0_DTABLEEND               0x10000000
145 #define B43_DMA64_DCTL0_IRQ                     0x20000000
146 #define B43_DMA64_DCTL0_FRAMEEND                0x40000000
147 #define B43_DMA64_DCTL0_FRAMESTART              0x80000000
148 #define B43_DMA64_DCTL1_BYTECNT         0x00001FFF
149 #define B43_DMA64_DCTL1_ADDREXT_MASK    0x00030000
150 #define B43_DMA64_DCTL1_ADDREXT_SHIFT   16
151
152 struct b43_dmadesc_generic {
153         union {
154                 struct b43_dmadesc32 dma32;
155                 struct b43_dmadesc64 dma64;
156         } __attribute__ ((__packed__));
157 } __attribute__ ((__packed__));
158
159 /* Misc DMA constants */
160 #define B43_DMA0_RX_FRAMEOFFSET         30
161
162 /* DMA engine tuning knobs */
163 #define B43_TXRING_SLOTS                256
164 #define B43_RXRING_SLOTS                64
165 #define B43_DMA0_RX_BUFFERSIZE          IEEE80211_MAX_FRAME_LEN
166
167
168 struct sk_buff;
169 struct b43_private;
170 struct b43_txstatus;
171
172 struct b43_dmadesc_meta {
173         /* The kernel DMA-able buffer. */
174         struct sk_buff *skb;
175         /* DMA base bus-address of the descriptor buffer. */
176         dma_addr_t dmaaddr;
177         /* ieee80211 TX status. Only used once per 802.11 frag. */
178         bool is_last_fragment;
179 };
180
181 struct b43_dmaring;
182
183 /* Lowlevel DMA operations that differ between 32bit and 64bit DMA. */
184 struct b43_dma_ops {
185         struct b43_dmadesc_generic *(*idx2desc) (struct b43_dmaring * ring,
186                                                  int slot,
187                                                  struct b43_dmadesc_meta **
188                                                  meta);
189         void (*fill_descriptor) (struct b43_dmaring * ring,
190                                  struct b43_dmadesc_generic * desc,
191                                  dma_addr_t dmaaddr, u16 bufsize, int start,
192                                  int end, int irq);
193         void (*poke_tx) (struct b43_dmaring * ring, int slot);
194         void (*tx_suspend) (struct b43_dmaring * ring);
195         void (*tx_resume) (struct b43_dmaring * ring);
196         int (*get_current_rxslot) (struct b43_dmaring * ring);
197         void (*set_current_rxslot) (struct b43_dmaring * ring, int slot);
198 };
199
200 enum b43_dmatype {
201         B43_DMA_30BIT   = 30,
202         B43_DMA_32BIT   = 32,
203         B43_DMA_64BIT   = 64,
204 };
205
206 struct b43_dmaring {
207         /* Lowlevel DMA ops. */
208         const struct b43_dma_ops *ops;
209         /* Kernel virtual base address of the ring memory. */
210         void *descbase;
211         /* Meta data about all descriptors. */
212         struct b43_dmadesc_meta *meta;
213         /* Cache of TX headers for each TX frame.
214          * This is to avoid an allocation on each TX.
215          * This is NULL for an RX ring.
216          */
217         u8 *txhdr_cache;
218         /* (Unadjusted) DMA base bus-address of the ring memory. */
219         dma_addr_t dmabase;
220         /* Number of descriptor slots in the ring. */
221         int nr_slots;
222         /* Number of used descriptor slots. */
223         int used_slots;
224         /* Currently used slot in the ring. */
225         int current_slot;
226         /* Total number of packets sent. Statistics only. */
227         unsigned int nr_tx_packets;
228         /* Frameoffset in octets. */
229         u32 frameoffset;
230         /* Descriptor buffer size. */
231         u16 rx_buffersize;
232         /* The MMIO base register of the DMA controller. */
233         u16 mmio_base;
234         /* DMA controller index number (0-5). */
235         int index;
236         /* Boolean. Is this a TX ring? */
237         bool tx;
238         /* The type of DMA engine used. */
239         enum b43_dmatype type;
240         /* Boolean. Is this ring stopped at ieee80211 level? */
241         bool stopped;
242         /* The QOS priority assigned to this ring. Only used for TX rings.
243          * This is the mac80211 "queue" value. */
244         u8 queue_prio;
245         /* Pointers and size of the originally allocated and mapped memory
246          * region for the descriptor ring. */
247         void *alloc_descbase;
248         dma_addr_t alloc_dmabase;
249         unsigned int alloc_descsize;
250         /* Pointer to our wireless device. */
251         struct b43_wldev *dev;
252 #ifdef CONFIG_B43_DEBUG
253         /* Maximum number of used slots. */
254         int max_used_slots;
255         /* Last time we injected a ring overflow. */
256         unsigned long last_injected_overflow;
257         /* Statistics: Number of successfully transmitted packets */
258         u64 nr_succeed_tx_packets;
259         /* Statistics: Number of failed TX packets */
260         u64 nr_failed_tx_packets;
261         /* Statistics: Total number of TX plus all retries. */
262         u64 nr_total_packet_tries;
263 #endif /* CONFIG_B43_DEBUG */
264 };
265
266 static inline u32 b43_dma_read(struct b43_dmaring *ring, u16 offset)
267 {
268         return b43_read32(ring->dev, ring->mmio_base + offset);
269 }
270
271 static inline void b43_dma_write(struct b43_dmaring *ring, u16 offset, u32 value)
272 {
273         b43_write32(ring->dev, ring->mmio_base + offset, value);
274 }
275
276 int b43_dma_init(struct b43_wldev *dev);
277 void b43_dma_free(struct b43_wldev *dev);
278
279 void b43_dma_tx_suspend(struct b43_wldev *dev);
280 void b43_dma_tx_resume(struct b43_wldev *dev);
281
282 void b43_dma_get_tx_stats(struct b43_wldev *dev,
283                           struct ieee80211_tx_queue_stats *stats);
284
285 int b43_dma_tx(struct b43_wldev *dev,
286                struct sk_buff *skb);
287 void b43_dma_handle_txstatus(struct b43_wldev *dev,
288                              const struct b43_txstatus *status);
289
290 void b43_dma_rx(struct b43_dmaring *ring);
291
292 void b43_dma_direct_fifo_rx(struct b43_wldev *dev,
293                             unsigned int engine_index, bool enable);
294
295 #endif /* B43_DMA_H_ */