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