rt2x00: Cleanup struct skb_frame_desc.
[linux-2.6] / drivers / net / wireless / rt2x00 / rt2x00pci.c
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: rt2x00pci
23         Abstract: rt2x00 generic pci device routines.
24  */
25
26 #include <linux/dma-mapping.h>
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/pci.h>
30
31 #include "rt2x00.h"
32 #include "rt2x00pci.h"
33
34 /*
35  * TX data handlers.
36  */
37 int rt2x00pci_write_tx_data(struct queue_entry *entry)
38 {
39         struct queue_entry_priv_pci *entry_priv = entry->priv_data;
40         struct skb_frame_desc *skbdesc;
41         u32 word;
42
43         rt2x00_desc_read(entry_priv->desc, 0, &word);
44
45         /*
46          * This should not happen, we already checked the entry
47          * was ours. When the hardware disagrees there has been
48          * a queue corruption!
49          */
50         if (unlikely(rt2x00_get_field32(word, TXD_ENTRY_OWNER_NIC) ||
51                      rt2x00_get_field32(word, TXD_ENTRY_VALID))) {
52                 ERROR(entry->queue->rt2x00dev,
53                       "Corrupt queue %d, accessing entry which is not ours.\n"
54                       "Please file bug report to %s.\n",
55                       entry->queue->qid, DRV_PROJECT);
56                 return -EINVAL;
57         }
58
59         /*
60          * Fill in skb descriptor
61          */
62         skbdesc = get_skb_frame_desc(entry->skb);
63         memset(skbdesc, 0, sizeof(*skbdesc));
64         skbdesc->desc = entry_priv->desc;
65         skbdesc->desc_len = entry->queue->desc_size;
66         skbdesc->entry = entry;
67
68         memcpy(entry_priv->data, entry->skb->data, entry->skb->len);
69
70         return 0;
71 }
72 EXPORT_SYMBOL_GPL(rt2x00pci_write_tx_data);
73
74 /*
75  * TX/RX data handlers.
76  */
77 void rt2x00pci_rxdone(struct rt2x00_dev *rt2x00dev)
78 {
79         struct data_queue *queue = rt2x00dev->rx;
80         struct queue_entry *entry;
81         struct queue_entry_priv_pci *entry_priv;
82         struct ieee80211_hdr *hdr;
83         struct skb_frame_desc *skbdesc;
84         struct rxdone_entry_desc rxdesc;
85         int header_size;
86         int align;
87         u32 word;
88
89         while (1) {
90                 entry = rt2x00queue_get_entry(queue, Q_INDEX);
91                 entry_priv = entry->priv_data;
92                 rt2x00_desc_read(entry_priv->desc, 0, &word);
93
94                 if (rt2x00_get_field32(word, RXD_ENTRY_OWNER_NIC))
95                         break;
96
97                 memset(&rxdesc, 0, sizeof(rxdesc));
98                 rt2x00dev->ops->lib->fill_rxdone(entry, &rxdesc);
99
100                 hdr = (struct ieee80211_hdr *)entry_priv->data;
101                 header_size =
102                     ieee80211_get_hdrlen(le16_to_cpu(hdr->frame_control));
103
104                 /*
105                  * The data behind the ieee80211 header must be
106                  * aligned on a 4 byte boundary.
107                  */
108                 align = header_size % 4;
109
110                 /*
111                  * Allocate the sk_buffer, initialize it and copy
112                  * all data into it.
113                  */
114                 entry->skb = dev_alloc_skb(rxdesc.size + align);
115                 if (!entry->skb)
116                         return;
117
118                 skb_reserve(entry->skb, align);
119                 memcpy(skb_put(entry->skb, rxdesc.size),
120                        entry_priv->data, rxdesc.size);
121
122                 /*
123                  * Fill in skb descriptor
124                  */
125                 skbdesc = get_skb_frame_desc(entry->skb);
126                 memset(skbdesc, 0, sizeof(*skbdesc));
127                 skbdesc->desc = entry_priv->desc;
128                 skbdesc->desc_len = queue->desc_size;
129                 skbdesc->entry = entry;
130
131                 /*
132                  * Send the frame to rt2x00lib for further processing.
133                  */
134                 rt2x00lib_rxdone(entry, &rxdesc);
135
136                 if (test_bit(DEVICE_ENABLED_RADIO, &queue->rt2x00dev->flags)) {
137                         rt2x00_set_field32(&word, RXD_ENTRY_OWNER_NIC, 1);
138                         rt2x00_desc_write(entry_priv->desc, 0, word);
139                 }
140
141                 rt2x00queue_index_inc(queue, Q_INDEX);
142         }
143 }
144 EXPORT_SYMBOL_GPL(rt2x00pci_rxdone);
145
146 void rt2x00pci_txdone(struct rt2x00_dev *rt2x00dev, struct queue_entry *entry,
147                       struct txdone_entry_desc *txdesc)
148 {
149         struct queue_entry_priv_pci *entry_priv = entry->priv_data;
150         enum data_queue_qid qid = skb_get_queue_mapping(entry->skb);
151         u32 word;
152
153         rt2x00lib_txdone(entry, txdesc);
154
155         /*
156          * Make this entry available for reuse.
157          */
158         entry->flags = 0;
159
160         rt2x00_desc_read(entry_priv->desc, 0, &word);
161         rt2x00_set_field32(&word, TXD_ENTRY_OWNER_NIC, 0);
162         rt2x00_set_field32(&word, TXD_ENTRY_VALID, 0);
163         rt2x00_desc_write(entry_priv->desc, 0, word);
164
165         __clear_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags);
166         rt2x00queue_index_inc(entry->queue, Q_INDEX_DONE);
167
168         /*
169          * If the data queue was below the threshold before the txdone
170          * handler we must make sure the packet queue in the mac80211 stack
171          * is reenabled when the txdone handler has finished.
172          */
173         if (!rt2x00queue_threshold(entry->queue))
174                 ieee80211_wake_queue(rt2x00dev->hw, qid);
175
176 }
177 EXPORT_SYMBOL_GPL(rt2x00pci_txdone);
178
179 /*
180  * Device initialization handlers.
181  */
182 #define desc_size(__queue)                      \
183 ({                                              \
184          ((__queue)->limit * (__queue)->desc_size);\
185 })
186
187 #define data_size(__queue)                      \
188 ({                                              \
189          ((__queue)->limit * (__queue)->data_size);\
190 })
191
192 #define dma_size(__queue)                       \
193 ({                                              \
194         data_size(__queue) + desc_size(__queue);\
195 })
196
197 #define desc_offset(__queue, __base, __i)       \
198 ({                                              \
199         (__base) + data_size(__queue) +         \
200             ((__i) * (__queue)->desc_size);     \
201 })
202
203 #define data_offset(__queue, __base, __i)       \
204 ({                                              \
205         (__base) +                              \
206             ((__i) * (__queue)->data_size);     \
207 })
208
209 static int rt2x00pci_alloc_queue_dma(struct rt2x00_dev *rt2x00dev,
210                                      struct data_queue *queue)
211 {
212         struct pci_dev *pci_dev = rt2x00dev_pci(rt2x00dev);
213         struct queue_entry_priv_pci *entry_priv;
214         void *addr;
215         dma_addr_t dma;
216         unsigned int i;
217
218         /*
219          * Allocate DMA memory for descriptor and buffer.
220          */
221         addr = pci_alloc_consistent(pci_dev, dma_size(queue), &dma);
222         if (!addr)
223                 return -ENOMEM;
224
225         memset(addr, 0, dma_size(queue));
226
227         /*
228          * Initialize all queue entries to contain valid addresses.
229          */
230         for (i = 0; i < queue->limit; i++) {
231                 entry_priv = queue->entries[i].priv_data;
232                 entry_priv->desc = desc_offset(queue, addr, i);
233                 entry_priv->desc_dma = desc_offset(queue, dma, i);
234                 entry_priv->data = data_offset(queue, addr, i);
235                 entry_priv->data_dma = data_offset(queue, dma, i);
236         }
237
238         return 0;
239 }
240
241 static void rt2x00pci_free_queue_dma(struct rt2x00_dev *rt2x00dev,
242                                      struct data_queue *queue)
243 {
244         struct pci_dev *pci_dev = rt2x00dev_pci(rt2x00dev);
245         struct queue_entry_priv_pci *entry_priv =
246             queue->entries[0].priv_data;
247
248         if (entry_priv->data)
249                 pci_free_consistent(pci_dev, dma_size(queue),
250                                     entry_priv->data, entry_priv->data_dma);
251         entry_priv->data = NULL;
252 }
253
254 int rt2x00pci_initialize(struct rt2x00_dev *rt2x00dev)
255 {
256         struct pci_dev *pci_dev = rt2x00dev_pci(rt2x00dev);
257         struct data_queue *queue;
258         int status;
259
260         /*
261          * Allocate DMA
262          */
263         queue_for_each(rt2x00dev, queue) {
264                 status = rt2x00pci_alloc_queue_dma(rt2x00dev, queue);
265                 if (status)
266                         goto exit;
267         }
268
269         /*
270          * Register interrupt handler.
271          */
272         status = request_irq(pci_dev->irq, rt2x00dev->ops->lib->irq_handler,
273                              IRQF_SHARED, pci_name(pci_dev), rt2x00dev);
274         if (status) {
275                 ERROR(rt2x00dev, "IRQ %d allocation failed (error %d).\n",
276                       pci_dev->irq, status);
277                 goto exit;
278         }
279
280         return 0;
281
282 exit:
283         queue_for_each(rt2x00dev, queue)
284                 rt2x00pci_free_queue_dma(rt2x00dev, queue);
285
286         return status;
287 }
288 EXPORT_SYMBOL_GPL(rt2x00pci_initialize);
289
290 void rt2x00pci_uninitialize(struct rt2x00_dev *rt2x00dev)
291 {
292         struct data_queue *queue;
293
294         /*
295          * Free irq line.
296          */
297         free_irq(rt2x00dev_pci(rt2x00dev)->irq, rt2x00dev);
298
299         /*
300          * Free DMA
301          */
302         queue_for_each(rt2x00dev, queue)
303                 rt2x00pci_free_queue_dma(rt2x00dev, queue);
304 }
305 EXPORT_SYMBOL_GPL(rt2x00pci_uninitialize);
306
307 /*
308  * PCI driver handlers.
309  */
310 static void rt2x00pci_free_reg(struct rt2x00_dev *rt2x00dev)
311 {
312         kfree(rt2x00dev->rf);
313         rt2x00dev->rf = NULL;
314
315         kfree(rt2x00dev->eeprom);
316         rt2x00dev->eeprom = NULL;
317
318         if (rt2x00dev->csr.base) {
319                 iounmap(rt2x00dev->csr.base);
320                 rt2x00dev->csr.base = NULL;
321         }
322 }
323
324 static int rt2x00pci_alloc_reg(struct rt2x00_dev *rt2x00dev)
325 {
326         struct pci_dev *pci_dev = rt2x00dev_pci(rt2x00dev);
327
328         rt2x00dev->csr.base = ioremap(pci_resource_start(pci_dev, 0),
329                                       pci_resource_len(pci_dev, 0));
330         if (!rt2x00dev->csr.base)
331                 goto exit;
332
333         rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
334         if (!rt2x00dev->eeprom)
335                 goto exit;
336
337         rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
338         if (!rt2x00dev->rf)
339                 goto exit;
340
341         return 0;
342
343 exit:
344         ERROR_PROBE("Failed to allocate registers.\n");
345
346         rt2x00pci_free_reg(rt2x00dev);
347
348         return -ENOMEM;
349 }
350
351 int rt2x00pci_probe(struct pci_dev *pci_dev, const struct pci_device_id *id)
352 {
353         struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_data;
354         struct ieee80211_hw *hw;
355         struct rt2x00_dev *rt2x00dev;
356         int retval;
357
358         retval = pci_request_regions(pci_dev, pci_name(pci_dev));
359         if (retval) {
360                 ERROR_PROBE("PCI request regions failed.\n");
361                 return retval;
362         }
363
364         retval = pci_enable_device(pci_dev);
365         if (retval) {
366                 ERROR_PROBE("Enable device failed.\n");
367                 goto exit_release_regions;
368         }
369
370         pci_set_master(pci_dev);
371
372         if (pci_set_mwi(pci_dev))
373                 ERROR_PROBE("MWI not available.\n");
374
375         if (pci_set_dma_mask(pci_dev, DMA_64BIT_MASK) &&
376             pci_set_dma_mask(pci_dev, DMA_32BIT_MASK)) {
377                 ERROR_PROBE("PCI DMA not supported.\n");
378                 retval = -EIO;
379                 goto exit_disable_device;
380         }
381
382         hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
383         if (!hw) {
384                 ERROR_PROBE("Failed to allocate hardware.\n");
385                 retval = -ENOMEM;
386                 goto exit_disable_device;
387         }
388
389         pci_set_drvdata(pci_dev, hw);
390
391         rt2x00dev = hw->priv;
392         rt2x00dev->dev = pci_dev;
393         rt2x00dev->ops = ops;
394         rt2x00dev->hw = hw;
395
396         retval = rt2x00pci_alloc_reg(rt2x00dev);
397         if (retval)
398                 goto exit_free_device;
399
400         retval = rt2x00lib_probe_dev(rt2x00dev);
401         if (retval)
402                 goto exit_free_reg;
403
404         return 0;
405
406 exit_free_reg:
407         rt2x00pci_free_reg(rt2x00dev);
408
409 exit_free_device:
410         ieee80211_free_hw(hw);
411
412 exit_disable_device:
413         if (retval != -EBUSY)
414                 pci_disable_device(pci_dev);
415
416 exit_release_regions:
417         pci_release_regions(pci_dev);
418
419         pci_set_drvdata(pci_dev, NULL);
420
421         return retval;
422 }
423 EXPORT_SYMBOL_GPL(rt2x00pci_probe);
424
425 void rt2x00pci_remove(struct pci_dev *pci_dev)
426 {
427         struct ieee80211_hw *hw = pci_get_drvdata(pci_dev);
428         struct rt2x00_dev *rt2x00dev = hw->priv;
429
430         /*
431          * Free all allocated data.
432          */
433         rt2x00lib_remove_dev(rt2x00dev);
434         rt2x00pci_free_reg(rt2x00dev);
435         ieee80211_free_hw(hw);
436
437         /*
438          * Free the PCI device data.
439          */
440         pci_set_drvdata(pci_dev, NULL);
441         pci_disable_device(pci_dev);
442         pci_release_regions(pci_dev);
443 }
444 EXPORT_SYMBOL_GPL(rt2x00pci_remove);
445
446 #ifdef CONFIG_PM
447 int rt2x00pci_suspend(struct pci_dev *pci_dev, pm_message_t state)
448 {
449         struct ieee80211_hw *hw = pci_get_drvdata(pci_dev);
450         struct rt2x00_dev *rt2x00dev = hw->priv;
451         int retval;
452
453         retval = rt2x00lib_suspend(rt2x00dev, state);
454         if (retval)
455                 return retval;
456
457         rt2x00pci_free_reg(rt2x00dev);
458
459         pci_save_state(pci_dev);
460         pci_disable_device(pci_dev);
461         return pci_set_power_state(pci_dev, pci_choose_state(pci_dev, state));
462 }
463 EXPORT_SYMBOL_GPL(rt2x00pci_suspend);
464
465 int rt2x00pci_resume(struct pci_dev *pci_dev)
466 {
467         struct ieee80211_hw *hw = pci_get_drvdata(pci_dev);
468         struct rt2x00_dev *rt2x00dev = hw->priv;
469         int retval;
470
471         if (pci_set_power_state(pci_dev, PCI_D0) ||
472             pci_enable_device(pci_dev) ||
473             pci_restore_state(pci_dev)) {
474                 ERROR(rt2x00dev, "Failed to resume device.\n");
475                 return -EIO;
476         }
477
478         retval = rt2x00pci_alloc_reg(rt2x00dev);
479         if (retval)
480                 return retval;
481
482         retval = rt2x00lib_resume(rt2x00dev);
483         if (retval)
484                 goto exit_free_reg;
485
486         return 0;
487
488 exit_free_reg:
489         rt2x00pci_free_reg(rt2x00dev);
490
491         return retval;
492 }
493 EXPORT_SYMBOL_GPL(rt2x00pci_resume);
494 #endif /* CONFIG_PM */
495
496 /*
497  * rt2x00pci module information.
498  */
499 MODULE_AUTHOR(DRV_PROJECT);
500 MODULE_VERSION(DRV_VERSION);
501 MODULE_DESCRIPTION("rt2x00 pci library");
502 MODULE_LICENSE("GPL");