rt2x00: Fix EIFS timing value
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / net / wireless / rt2x00 / rt2x00usb.h
CommitLineData
95ea3627 1/*
811aa9ca 2 Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
95ea3627
ID
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: rt2x00usb
23 Abstract: Data structures for the rt2x00usb module.
24 */
25
26#ifndef RT2X00USB_H
27#define RT2X00USB_H
28
c1d35dfa
ID
29#define to_usb_device_intf(d) \
30({ \
31 struct usb_interface *intf = to_usb_interface(d); \
32 interface_to_usbdev(intf); \
33})
34
95ea3627
ID
35/*
36 * This variable should be used with the
37 * usb_driver structure initialization.
38 */
39#define USB_DEVICE_DATA(__ops) .driver_info = (kernel_ulong_t)(__ops)
40
41/*
42 * Register defines.
43 * Some registers require multiple attempts before success,
44 * in those cases REGISTER_BUSY_COUNT attempts should be
45 * taken with a REGISTER_BUSY_DELAY interval.
46 * For USB vendor requests we need to pass a timeout
47 * time in ms, for this we use the REGISTER_TIMEOUT,
48 * however when loading firmware a higher value is
49 * required. In that case we use the REGISTER_TIMEOUT_FIRMWARE.
50 */
51#define REGISTER_BUSY_COUNT 5
52#define REGISTER_BUSY_DELAY 100
e9136550 53#define REGISTER_TIMEOUT 500
95ea3627
ID
54#define REGISTER_TIMEOUT_FIRMWARE 1000
55
bd394a74
ID
56/**
57 * REGISTER_TIMEOUT16 - Determine the timeout for 16bit register access
58 * @__datalen: Data length
59 */
60#define REGISTER_TIMEOUT16(__datalen) \
61 ( REGISTER_TIMEOUT * ((__datalen) / sizeof(u16)) )
62
63/**
64 * REGISTER_TIMEOUT32 - Determine the timeout for 32bit register access
65 * @__datalen: Data length
66 */
67#define REGISTER_TIMEOUT32(__datalen) \
68 ( REGISTER_TIMEOUT * ((__datalen) / sizeof(u32)) )
69
95ea3627
ID
70/*
71 * Cache size
72 */
73#define CSR_CACHE_SIZE 8
74#define CSR_CACHE_SIZE_FIRMWARE 64
75
76/*
77 * USB request types.
78 */
79#define USB_VENDOR_REQUEST ( USB_TYPE_VENDOR | USB_RECIP_DEVICE )
80#define USB_VENDOR_REQUEST_IN ( USB_DIR_IN | USB_VENDOR_REQUEST )
81#define USB_VENDOR_REQUEST_OUT ( USB_DIR_OUT | USB_VENDOR_REQUEST )
82
3b640f21
ID
83/**
84 * enum rt2x00usb_vendor_request: USB vendor commands.
95ea3627 85 */
3b640f21
ID
86enum rt2x00usb_vendor_request {
87 USB_DEVICE_MODE = 1,
88 USB_SINGLE_WRITE = 2,
89 USB_SINGLE_READ = 3,
90 USB_MULTI_WRITE = 6,
91 USB_MULTI_READ = 7,
92 USB_EEPROM_WRITE = 8,
93 USB_EEPROM_READ = 9,
94 USB_LED_CONTROL = 10, /* RT73USB */
95 USB_RX_CONTROL = 12,
96};
97
98/**
99 * enum rt2x00usb_mode_offset: Device modes offset.
100 */
101enum rt2x00usb_mode_offset {
102 USB_MODE_RESET = 1,
103 USB_MODE_UNPLUG = 2,
104 USB_MODE_FUNCTION = 3,
105 USB_MODE_TEST = 4,
106 USB_MODE_SLEEP = 7, /* RT73USB */
107 USB_MODE_FIRMWARE = 8, /* RT73USB */
108 USB_MODE_WAKEUP = 9, /* RT73USB */
109};
110
111/**
112 * rt2x00usb_vendor_request - Send register command to device
113 * @rt2x00dev: Pointer to &struct rt2x00_dev
114 * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
115 * @requesttype: Request type &USB_VENDOR_REQUEST_*
116 * @offset: Register offset to perform action on
117 * @value: Value to write to device
118 * @buffer: Buffer where information will be read/written to by device
119 * @buffer_length: Size of &buffer
120 * @timeout: Operation timeout
121 *
95ea3627 122 * This is the main function to communicate with the device,
3b640f21 123 * the &buffer argument _must_ either be NULL or point to
95ea3627
ID
124 * a buffer allocated by kmalloc. Failure to do so can lead
125 * to unexpected behavior depending on the architecture.
126 */
0e14f6d3 127int rt2x00usb_vendor_request(struct rt2x00_dev *rt2x00dev,
95ea3627
ID
128 const u8 request, const u8 requesttype,
129 const u16 offset, const u16 value,
130 void *buffer, const u16 buffer_length,
e9136550 131 const int timeout);
95ea3627 132
3b640f21
ID
133/**
134 * rt2x00usb_vendor_request_buff - Send register command to device (buffered)
135 * @rt2x00dev: Pointer to &struct rt2x00_dev
136 * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
137 * @requesttype: Request type &USB_VENDOR_REQUEST_*
138 * @offset: Register offset to perform action on
139 * @buffer: Buffer where information will be read/written to by device
140 * @buffer_length: Size of &buffer
141 * @timeout: Operation timeout
142 *
95ea3627
ID
143 * This function will use a previously with kmalloc allocated cache
144 * to communicate with the device. The contents of the buffer pointer
145 * will be copied to this cache when writing, or read from the cache
146 * when reading.
3b640f21 147 * Buffers send to &rt2x00usb_vendor_request _must_ be allocated with
95ea3627
ID
148 * kmalloc. Hence the reason for using a previously allocated cache
149 * which has been allocated properly.
150 */
0e14f6d3 151int rt2x00usb_vendor_request_buff(struct rt2x00_dev *rt2x00dev,
95ea3627
ID
152 const u8 request, const u8 requesttype,
153 const u16 offset, void *buffer,
e9136550 154 const u16 buffer_length, const int timeout);
95ea3627 155
3b640f21
ID
156/**
157 * rt2x00usb_vendor_request_buff - Send register command to device (buffered)
158 * @rt2x00dev: Pointer to &struct rt2x00_dev
159 * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
160 * @requesttype: Request type &USB_VENDOR_REQUEST_*
161 * @offset: Register offset to perform action on
162 * @buffer: Buffer where information will be read/written to by device
163 * @buffer_length: Size of &buffer
164 * @timeout: Operation timeout
165 *
166 * A version of &rt2x00usb_vendor_request_buff which must be called
167 * if the usb_cache_mutex is already held.
168 */
3d82346c
AB
169int rt2x00usb_vendor_req_buff_lock(struct rt2x00_dev *rt2x00dev,
170 const u8 request, const u8 requesttype,
171 const u16 offset, void *buffer,
172 const u16 buffer_length, const int timeout);
173
3b640f21
ID
174/**
175 * rt2x00usb_vendor_request_sw - Send single register command to device
176 * @rt2x00dev: Pointer to &struct rt2x00_dev
177 * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
178 * @offset: Register offset to perform action on
179 * @value: Value to write to device
180 * @timeout: Operation timeout
181 *
95ea3627
ID
182 * Simple wrapper around rt2x00usb_vendor_request to write a single
183 * command to the device. Since we don't use the buffer argument we
184 * don't have to worry about kmalloc here.
185 */
0e14f6d3 186static inline int rt2x00usb_vendor_request_sw(struct rt2x00_dev *rt2x00dev,
95ea3627
ID
187 const u8 request,
188 const u16 offset,
189 const u16 value,
e9136550 190 const int timeout)
95ea3627
ID
191{
192 return rt2x00usb_vendor_request(rt2x00dev, request,
193 USB_VENDOR_REQUEST_OUT, offset,
194 value, NULL, 0, timeout);
195}
196
3b640f21
ID
197/**
198 * rt2x00usb_eeprom_read - Read eeprom from device
199 * @rt2x00dev: Pointer to &struct rt2x00_dev
200 * @eeprom: Pointer to eeprom array to store the information in
201 * @length: Number of bytes to read from the eeprom
202 *
95ea3627
ID
203 * Simple wrapper around rt2x00usb_vendor_request to read the eeprom
204 * from the device. Note that the eeprom argument _must_ be allocated using
205 * kmalloc for correct handling inside the kernel USB layer.
206 */
0e14f6d3 207static inline int rt2x00usb_eeprom_read(struct rt2x00_dev *rt2x00dev,
9a46d44e 208 __le16 *eeprom, const u16 length)
95ea3627 209{
95ea3627 210 return rt2x00usb_vendor_request(rt2x00dev, USB_EEPROM_READ,
3b640f21 211 USB_VENDOR_REQUEST_IN, 0, 0,
9a46d44e
ID
212 eeprom, length,
213 REGISTER_TIMEOUT16(length));
95ea3627
ID
214}
215
216/*
217 * Radio handlers
218 */
95ea3627
ID
219void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev);
220
6db3786a
ID
221/**
222 * rt2x00usb_write_tx_data - Initialize URB for TX operation
223 * @entry: The entry where the frame is located
224 *
225 * This function will initialize the URB and skb descriptor
226 * to prepare the entry for the actual TX operation.
95ea3627 227 */
6db3786a 228int rt2x00usb_write_tx_data(struct queue_entry *entry);
95ea3627 229
181d6902 230/**
b8be63ff 231 * struct queue_entry_priv_usb: Per entry USB specific information
181d6902
ID
232 *
233 * @urb: Urb structure used for device communication.
181d6902 234 */
b8be63ff 235struct queue_entry_priv_usb {
181d6902 236 struct urb *urb;
181d6902
ID
237};
238
239/**
b8be63ff 240 * struct queue_entry_priv_usb_bcn: Per TX entry USB specific information
181d6902 241 *
b8be63ff 242 * The first section should match &struct queue_entry_priv_usb exactly.
181d6902
ID
243 * rt2500usb can use this structure to send a guardian byte when working
244 * with beacons.
245 *
246 * @urb: Urb structure used for device communication.
181d6902
ID
247 * @guardian_data: Set to 0, used for sending the guardian data.
248 * @guardian_urb: Urb structure used to send the guardian data.
249 */
250struct queue_entry_priv_usb_bcn {
251 struct urb *urb;
252
181d6902
ID
253 unsigned int guardian_data;
254 struct urb *guardian_urb;
255};
256
f019d514
ID
257/**
258 * rt2x00usb_kick_tx_queue - Kick data queue
259 * @rt2x00dev: Pointer to &struct rt2x00_dev
260 * @qid: Data queue to kick
261 *
262 * This will walk through all entries of the queue and push all pending
263 * frames to the hardware as a single burst.
264 */
265void rt2x00usb_kick_tx_queue(struct rt2x00_dev *rt2x00dev,
266 const enum data_queue_qid qid);
267
95ea3627
ID
268/*
269 * Device initialization handlers.
270 */
837e7f24 271void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
181d6902 272 struct queue_entry *entry);
837e7f24 273void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
181d6902 274 struct queue_entry *entry);
95ea3627
ID
275int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev);
276void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev);
277
278/*
279 * USB driver handlers.
280 */
281int rt2x00usb_probe(struct usb_interface *usb_intf,
282 const struct usb_device_id *id);
283void rt2x00usb_disconnect(struct usb_interface *usb_intf);
284#ifdef CONFIG_PM
285int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state);
286int rt2x00usb_resume(struct usb_interface *usb_intf);
287#else
288#define rt2x00usb_suspend NULL
289#define rt2x00usb_resume NULL
290#endif /* CONFIG_PM */
291
292#endif /* RT2X00USB_H */