blob: 15a12487e04b024cfde0400d407d11b67fa95a27 [file] [log] [blame]
Ivo van Doorn95ea3622007-09-25 17:57:13 -07001/*
Ivo van Doorn4e54c712009-01-17 20:42:32 +01002 Copyright (C) 2004 - 2009 rt2x00 SourceForge Project
Ivo van Doorn95ea3622007-09-25 17:57:13 -07003 <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/*
Ivo van Doorn95ea3622007-09-25 17:57:13 -070047 * Register access.
48 */
Adam Baker0e14f6d2007-10-27 13:41:25 +020049static inline void rt2x00pci_register_read(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn743b97c2008-10-29 19:41:03 +010050 const unsigned int offset,
Ivo van Doorn95ea3622007-09-25 17:57:13 -070051 u32 *value)
52{
Ivo van Doorn21795092008-02-10 22:49:13 +010053 *value = readl(rt2x00dev->csr.base + offset);
Ivo van Doorn95ea3622007-09-25 17:57:13 -070054}
55
56static inline void
Adam Baker0e14f6d2007-10-27 13:41:25 +020057rt2x00pci_register_multiread(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn743b97c2008-10-29 19:41:03 +010058 const unsigned int offset,
Ivo van Doorn95ea3622007-09-25 17:57:13 -070059 void *value, const u16 length)
60{
Ivo van Doorn21795092008-02-10 22:49:13 +010061 memcpy_fromio(value, rt2x00dev->csr.base + offset, length);
Ivo van Doorn95ea3622007-09-25 17:57:13 -070062}
63
Adam Baker0e14f6d2007-10-27 13:41:25 +020064static inline void rt2x00pci_register_write(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn743b97c2008-10-29 19:41:03 +010065 const unsigned int offset,
Ivo van Doorn95ea3622007-09-25 17:57:13 -070066 u32 value)
67{
Ivo van Doorn21795092008-02-10 22:49:13 +010068 writel(value, rt2x00dev->csr.base + offset);
Ivo van Doorn95ea3622007-09-25 17:57:13 -070069}
70
71static inline void
Adam Baker0e14f6d2007-10-27 13:41:25 +020072rt2x00pci_register_multiwrite(struct rt2x00_dev *rt2x00dev,
Ivo van Doorn743b97c2008-10-29 19:41:03 +010073 const unsigned int offset,
David Woodhousef160ebc2008-05-24 00:08:39 +010074 const void *value, const u16 length)
Ivo van Doorn95ea3622007-09-25 17:57:13 -070075{
Ivo van Doorn21795092008-02-10 22:49:13 +010076 memcpy_toio(rt2x00dev->csr.base + offset, value, length);
Ivo van Doorn95ea3622007-09-25 17:57:13 -070077}
78
Ivo van Doorn6db37862008-06-06 22:50:28 +020079/**
Ivo van Doornc9c3b1a2008-11-10 19:41:40 +010080 * 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 */
92int rt2x00pci_regbusy_read(struct rt2x00_dev *rt2x00dev,
93 const unsigned int offset,
94 const struct rt2x00_field32 field,
95 u32 *reg);
96
97/**
Ivo van Doorn6db37862008-06-06 22:50:28 +020098 * 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.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700103 */
Ivo van Doorn6db37862008-06-06 22:50:28 +0200104int rt2x00pci_write_tx_data(struct queue_entry *entry);
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700105
Ivo van Doorn181d6902008-02-05 16:42:23 -0500106/**
Ivo van Doornb8be63f2008-05-10 13:46:03 +0200107 * struct queue_entry_priv_pci: Per entry PCI specific information
Ivo van Doorn181d6902008-02-05 16:42:23 -0500108 *
109 * @desc: Pointer to device descriptor
Ivo van Doornb8be63f2008-05-10 13:46:03 +0200110 * @desc_dma: DMA pointer to &desc.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500111 * @data: Pointer to device's entry memory.
Ivo van Doorn9a46d442008-04-21 19:02:17 +0200112 * @data_dma: DMA pointer to &data.
Ivo van Doorn181d6902008-02-05 16:42:23 -0500113 */
Ivo van Doornb8be63f2008-05-10 13:46:03 +0200114struct queue_entry_priv_pci {
Ivo van Doorn181d6902008-02-05 16:42:23 -0500115 __le32 *desc;
Ivo van Doorn30b3a232008-02-17 17:33:24 +0100116 dma_addr_t desc_dma;
Ivo van Doorn181d6902008-02-05 16:42:23 -0500117};
118
119/**
120 * rt2x00pci_rxdone - Handle RX done events
121 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700122 */
123void rt2x00pci_rxdone(struct rt2x00_dev *rt2x00dev);
Ivo van Doorn181d6902008-02-05 16:42:23 -0500124
Ivo van Doorn95ea3622007-09-25 17:57:13 -0700125/*
126 * Device initialization handlers.
127 */
128int rt2x00pci_initialize(struct rt2x00_dev *rt2x00dev);
129void rt2x00pci_uninitialize(struct rt2x00_dev *rt2x00dev);
130
131/*
132 * PCI driver handlers.
133 */
134int rt2x00pci_probe(struct pci_dev *pci_dev, const struct pci_device_id *id);
135void rt2x00pci_remove(struct pci_dev *pci_dev);
136#ifdef CONFIG_PM
137int rt2x00pci_suspend(struct pci_dev *pci_dev, pm_message_t state);
138int 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 */