drivers/net/wireless/rt2x00/rt2x00pci.h

   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: Data structures for the rt2x00pci module.
  24  */
  25
  26 #ifndef RT2X00PCI_H
  27 #define RT2X00PCI_H
  28
  29 #include <linux/io.h>
  30
  31 /*
  32  * This variable should be used with the
  33  * pci_driver structure initialization.
  34  */
  35 #define PCI_DEVICE_DATA(__ops)  .driver_data = (kernel_ulong_t)(__ops)
  36
  37 /*
  38  * Register defines.
  39  * Some registers require multiple attempts before success,
  40  * in those cases REGISTER_BUSY_COUNT attempts should be
  41  * taken with a REGISTER_BUSY_DELAY interval.
  42  */
  43 #define REGISTER_BUSY_COUNT     5
  44 #define REGISTER_BUSY_DELAY     100
  45
  46 /*
  47  * Descriptor availability flags.
  48  * All PCI device descriptors have these 2 flags
  49  * with the exact same definition.
  50  * By storing them here we can use them inside rt2x00pci
  51  * for some simple entry availability checking.
  52  */
  53 #define TXD_ENTRY_OWNER_NIC     FIELD32(0x00000001)
  54 #define TXD_ENTRY_VALID         FIELD32(0x00000002)
  55 #define RXD_ENTRY_OWNER_NIC     FIELD32(0x00000001)
  56
  57 /*
  58  * Register access.
  59  */
  60 static inline void rt2x00pci_register_read(struct rt2x00_dev *rt2x00dev,
  61                                            const unsigned long offset,
  62                                            u32 *value)
  63 {
  64         *value = readl(rt2x00dev->csr.base + offset);
  65 }
  66
  67 static inline void
  68 rt2x00pci_register_multiread(struct rt2x00_dev *rt2x00dev,
  69                              const unsigned long offset,
  70                              void *value, const u16 length)
  71 {
  72         memcpy_fromio(value, rt2x00dev->csr.base + offset, length);
  73 }
  74
  75 static inline void rt2x00pci_register_write(struct rt2x00_dev *rt2x00dev,
  76                                             const unsigned long offset,
  77                                             u32 value)
  78 {
  79         writel(value, rt2x00dev->csr.base + offset);
  80 }
  81
  82 static inline void
  83 rt2x00pci_register_multiwrite(struct rt2x00_dev *rt2x00dev,
  84                               const unsigned long offset,
  85                               void *value, const u16 length)
  86 {
  87         memcpy_toio(rt2x00dev->csr.base + offset, value, length);
  88 }
  89
  90 /*
  91  * TX data handlers.
  92  */
  93 int rt2x00pci_write_tx_data(struct rt2x00_dev *rt2x00dev,
  94                             struct data_queue *queue, struct sk_buff *skb,
  95                             struct ieee80211_tx_control *control);
  96
  97 /**
  98  * struct queue_entry_priv_pci_rx: Per RX entry PCI specific information
  99  *
 100  * @desc: Pointer to device descriptor.
 101  * @data: Pointer to device's entry memory.
 102  * @dma: DMA pointer to &data.
 103  */
 104 struct queue_entry_priv_pci_rx {
 105         __le32 *desc;
 106         dma_addr_t desc_dma;
 107
 108         void *data;
 109         dma_addr_t data_dma;
 110 };
 111
 112 /**
 113  * struct queue_entry_priv_pci_tx: Per TX entry PCI specific information
 114  *
 115  * @desc: Pointer to device descriptor
 116  * @data: Pointer to device's entry memory.
 117  * @dma: DMA pointer to &data.
 118  * @control: mac80211 control structure used to transmit data.
 119  */
 120 struct queue_entry_priv_pci_tx {
 121         __le32 *desc;
 122         dma_addr_t desc_dma;
 123
 124         void *data;
 125         dma_addr_t data_dma;
 126
 127         struct ieee80211_tx_control control;
 128 };
 129
 130 /**
 131  * rt2x00pci_rxdone - Handle RX done events
 132  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 133  */
 134 void rt2x00pci_rxdone(struct rt2x00_dev *rt2x00dev);
 135
 136 /**
 137  * rt2x00pci_txdone - Handle TX done events
 138  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 139  * @entry: Entry which has completed the transmission of a frame.
 140  * @desc: TX done descriptor
 141  */
 142 void rt2x00pci_txdone(struct rt2x00_dev *rt2x00dev, struct queue_entry *entry,
 143                       struct txdone_entry_desc *desc);
 144
 145 /*
 146  * Device initialization handlers.
 147  */
 148 int rt2x00pci_initialize(struct rt2x00_dev *rt2x00dev);
 149 void rt2x00pci_uninitialize(struct rt2x00_dev *rt2x00dev);
 150
 151 /*
 152  * PCI driver handlers.
 153  */
 154 int rt2x00pci_probe(struct pci_dev *pci_dev, const struct pci_device_id *id);
 155 void rt2x00pci_remove(struct pci_dev *pci_dev);
 156 #ifdef CONFIG_PM
 157 int rt2x00pci_suspend(struct pci_dev *pci_dev, pm_message_t state);
 158 int rt2x00pci_resume(struct pci_dev *pci_dev);
 159 #else
 160 #define rt2x00pci_suspend       NULL
 161 #define rt2x00pci_resume        NULL
 162 #endif /* CONFIG_PM */
 163
 164 #endif /* RT2X00PCI_H */