drivers/net/wireless/rt2x00/rt2x00pci.h

   1 /*
   2         Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
   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 access.
  39  */
  40 static inline void rt2x00pci_register_read(struct rt2x00_dev *rt2x00dev,
  41                                            const unsigned int offset,
  42                                            u32 *value)
  43 {
  44         *value = readl(rt2x00dev->csr.base + offset);
  45 }
  46
  47 static inline void rt2x00pci_register_multiread(struct rt2x00_dev *rt2x00dev,
  48                                                 const unsigned int offset,
  49                                                 void *value, const u32 length)
  50 {
  51         memcpy_fromio(value, rt2x00dev->csr.base + offset, length);
  52 }
  53
  54 static inline void rt2x00pci_register_write(struct rt2x00_dev *rt2x00dev,
  55                                             const unsigned int offset,
  56                                             u32 value)
  57 {
  58         writel(value, rt2x00dev->csr.base + offset);
  59 }
  60
  61 static inline void rt2x00pci_register_multiwrite(struct rt2x00_dev *rt2x00dev,
  62                                                  const unsigned int offset,
  63                                                  const void *value,
  64                                                  const u32 length)
  65 {
  66         memcpy_toio(rt2x00dev->csr.base + offset, value, length);
  67 }
  68
  69 /**
  70  * rt2x00pci_regbusy_read - Read from register with busy check
  71  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
  72  * @offset: Register offset
  73  * @field: Field to check if register is busy
  74  * @reg: Pointer to where register contents should be stored
  75  *
  76  * This function will read the given register, and checks if the
  77  * register is busy. If it is, it will sleep for a couple of
  78  * microseconds before reading the register again. If the register
  79  * is not read after a certain timeout, this function will return
  80  * FALSE.
  81  */
  82 int rt2x00pci_regbusy_read(struct rt2x00_dev *rt2x00dev,
  83                            const unsigned int offset,
  84                            const struct rt2x00_field32 field,
  85                            u32 *reg);
  86
  87 /**
  88  * rt2x00pci_write_tx_data - Initialize data for TX operation
  89  * @entry: The entry where the frame is located
  90  *
  91  * This function will initialize the DMA and skb descriptor
  92  * to prepare the entry for the actual TX operation.
  93  */
  94 int rt2x00pci_write_tx_data(struct queue_entry *entry);
  95
  96 /**
  97  * struct queue_entry_priv_pci: Per entry PCI specific information
  98  *
  99  * @desc: Pointer to device descriptor
 100  * @desc_dma: DMA pointer to &desc.
 101  * @data: Pointer to device's entry memory.
 102  * @data_dma: DMA pointer to &data.
 103  */
 104 struct queue_entry_priv_pci {
 105         __le32 *desc;
 106         dma_addr_t desc_dma;
 107 };
 108
 109 /**
 110  * rt2x00pci_rxdone - Handle RX done events
 111  * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 112  */
 113 void rt2x00pci_rxdone(struct rt2x00_dev *rt2x00dev);
 114
 115 /*
 116  * Device initialization handlers.
 117  */
 118 int rt2x00pci_initialize(struct rt2x00_dev *rt2x00dev);
 119 void rt2x00pci_uninitialize(struct rt2x00_dev *rt2x00dev);
 120
 121 /*
 122  * PCI driver handlers.
 123  */
 124 int rt2x00pci_probe(struct pci_dev *pci_dev, const struct pci_device_id *id);
 125 void rt2x00pci_remove(struct pci_dev *pci_dev);
 126 #ifdef CONFIG_PM
 127 int rt2x00pci_suspend(struct pci_dev *pci_dev, pm_message_t state);
 128 int rt2x00pci_resume(struct pci_dev *pci_dev);
 129 #else
 130 #define rt2x00pci_suspend       NULL
 131 #define rt2x00pci_resume        NULL
 132 #endif /* CONFIG_PM */
 133
 134 #endif /* RT2X00PCI_H */