[deliverable/linux.git] / drivers / net / wireless / rt2x00 / rt2x00usb.h

/*
	Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
	<http://rt2x00.serialmonkey.com>

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

/*
	Module: rt2x00usb
	Abstract: Data structures for the rt2x00usb module.
 */

#ifndef RT2X00USB_H
#define RT2X00USB_H

#include <linux/usb.h>

#define to_usb_device_intf(d) \
({ \
	struct usb_interface *intf = to_usb_interface(d); \
	interface_to_usbdev(intf); \
})

/*
 * For USB vendor requests we need to pass a timeout time in ms, for this we
 * use the REGISTER_TIMEOUT, however when loading firmware or read EEPROM
 * a higher value is required. In that case we use the REGISTER_TIMEOUT_FIRMWARE
 * and EEPROM_TIMEOUT.
 */
#define REGISTER_TIMEOUT		100
#define REGISTER_TIMEOUT_FIRMWARE	1000
#define EEPROM_TIMEOUT			2000

/*
 * Cache size
 */
#define CSR_CACHE_SIZE			64

/*
 * USB request types.
 */
#define USB_VENDOR_REQUEST	( USB_TYPE_VENDOR | USB_RECIP_DEVICE )
#define USB_VENDOR_REQUEST_IN	( USB_DIR_IN | USB_VENDOR_REQUEST )
#define USB_VENDOR_REQUEST_OUT	( USB_DIR_OUT | USB_VENDOR_REQUEST )

/**
 * enum rt2x00usb_vendor_request: USB vendor commands.
 */
enum rt2x00usb_vendor_request {
	USB_DEVICE_MODE = 1,
	USB_SINGLE_WRITE = 2,
	USB_SINGLE_READ = 3,
	USB_MULTI_WRITE = 6,
	USB_MULTI_READ = 7,
	USB_EEPROM_WRITE = 8,
	USB_EEPROM_READ = 9,
	USB_LED_CONTROL = 10, /* RT73USB */
	USB_RX_CONTROL = 12,
};

/**
 * enum rt2x00usb_mode_offset: Device modes offset.
 */
enum rt2x00usb_mode_offset {
	USB_MODE_RESET = 1,
	USB_MODE_UNPLUG = 2,
	USB_MODE_FUNCTION = 3,
	USB_MODE_TEST = 4,
	USB_MODE_SLEEP = 7,	/* RT73USB */
	USB_MODE_FIRMWARE = 8,	/* RT73USB */
	USB_MODE_WAKEUP = 9,	/* RT73USB */
	USB_MODE_AUTORUN = 17, /* RT2800USB */
};

/**
 * rt2x00usb_vendor_request - Send register command to device
 * @rt2x00dev: Pointer to &struct rt2x00_dev
 * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
 * @requesttype: Request type &USB_VENDOR_REQUEST_*
 * @offset: Register offset to perform action on
 * @value: Value to write to device
 * @buffer: Buffer where information will be read/written to by device
 * @buffer_length: Size of &buffer
 * @timeout: Operation timeout
 *
 * This is the main function to communicate with the device,
 * the &buffer argument _must_ either be NULL or point to
 * a buffer allocated by kmalloc. Failure to do so can lead
 * to unexpected behavior depending on the architecture.
 */
int rt2x00usb_vendor_request(struct rt2x00_dev *rt2x00dev,
			     const u8 request, const u8 requesttype,
			     const u16 offset, const u16 value,
			     void *buffer, const u16 buffer_length,
			     const int timeout);

/**
 * rt2x00usb_vendor_request_buff - Send register command to device (buffered)
 * @rt2x00dev: Pointer to &struct rt2x00_dev
 * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
 * @requesttype: Request type &USB_VENDOR_REQUEST_*
 * @offset: Register offset to perform action on
 * @buffer: Buffer where information will be read/written to by device
 * @buffer_length: Size of &buffer
 *
 * This function will use a previously with kmalloc allocated cache
 * to communicate with the device. The contents of the buffer pointer
 * will be copied to this cache when writing, or read from the cache
 * when reading.
 * Buffers send to &rt2x00usb_vendor_request _must_ be allocated with
 * kmalloc. Hence the reason for using a previously allocated cache
 * which has been allocated properly.
 */
int rt2x00usb_vendor_request_buff(struct rt2x00_dev *rt2x00dev,
				  const u8 request, const u8 requesttype,
				  const u16 offset, void *buffer,
				  const u16 buffer_length);

/**
 * rt2x00usb_vendor_request_buff - Send register command to device (buffered)
 * @rt2x00dev: Pointer to &struct rt2x00_dev
 * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
 * @requesttype: Request type &USB_VENDOR_REQUEST_*
 * @offset: Register offset to perform action on
 * @buffer: Buffer where information will be read/written to by device
 * @buffer_length: Size of &buffer
 * @timeout: Operation timeout
 *
 * A version of &rt2x00usb_vendor_request_buff which must be called
 * if the usb_cache_mutex is already held.
 */
int rt2x00usb_vendor_req_buff_lock(struct rt2x00_dev *rt2x00dev,
				   const u8 request, const u8 requesttype,
				   const u16 offset, void *buffer,
				   const u16 buffer_length, const int timeout);

/**
 * rt2x00usb_vendor_request_sw - Send single register command to device
 * @rt2x00dev: Pointer to &struct rt2x00_dev
 * @request: USB vendor command (See &enum rt2x00usb_vendor_request)
 * @offset: Register offset to perform action on
 * @value: Value to write to device
 * @timeout: Operation timeout
 *
 * Simple wrapper around rt2x00usb_vendor_request to write a single
 * command to the device. Since we don't use the buffer argument we
 * don't have to worry about kmalloc here.
 */
static inline int rt2x00usb_vendor_request_sw(struct rt2x00_dev *rt2x00dev,
					      const u8 request,
					      const u16 offset,
					      const u16 value,
					      const int timeout)
{
	return rt2x00usb_vendor_request(rt2x00dev, request,
					USB_VENDOR_REQUEST_OUT, offset,
					value, NULL, 0, timeout);
}

/**
 * rt2x00usb_eeprom_read - Read eeprom from device
 * @rt2x00dev: Pointer to &struct rt2x00_dev
 * @eeprom: Pointer to eeprom array to store the information in
 * @length: Number of bytes to read from the eeprom
 *
 * Simple wrapper around rt2x00usb_vendor_request to read the eeprom
 * from the device. Note that the eeprom argument _must_ be allocated using
 * kmalloc for correct handling inside the kernel USB layer.
 */
static inline int rt2x00usb_eeprom_read(struct rt2x00_dev *rt2x00dev,
					__le16 *eeprom, const u16 length)
{
	return rt2x00usb_vendor_request(rt2x00dev, USB_EEPROM_READ,
					USB_VENDOR_REQUEST_IN, 0, 0,
					eeprom, length, EEPROM_TIMEOUT);
}

/**
 * rt2x00usb_register_read - Read 32bit register word
 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 * @offset: Register offset
 * @value: Pointer to where register contents should be stored
 *
 * This function is a simple wrapper for 32bit register access
 * through rt2x00usb_vendor_request_buff().
 */
static inline void rt2x00usb_register_read(struct rt2x00_dev *rt2x00dev,
					   const unsigned int offset,
					   u32 *value)
{
	__le32 reg = 0;
	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_READ,
				      USB_VENDOR_REQUEST_IN, offset,
				      &reg, sizeof(reg));
	*value = le32_to_cpu(reg);
}

/**
 * rt2x00usb_register_read_lock - Read 32bit register word
 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 * @offset: Register offset
 * @value: Pointer to where register contents should be stored
 *
 * This function is a simple wrapper for 32bit register access
 * through rt2x00usb_vendor_req_buff_lock().
 */
static inline void rt2x00usb_register_read_lock(struct rt2x00_dev *rt2x00dev,
						const unsigned int offset,
						u32 *value)
{
	__le32 reg = 0;
	rt2x00usb_vendor_req_buff_lock(rt2x00dev, USB_MULTI_READ,
				       USB_VENDOR_REQUEST_IN, offset,
				       &reg, sizeof(reg), REGISTER_TIMEOUT);
	*value = le32_to_cpu(reg);
}

/**
 * rt2x00usb_register_multiread - Read 32bit register words
 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 * @offset: Register offset
 * @value: Pointer to where register contents should be stored
 * @length: Length of the data
 *
 * This function is a simple wrapper for 32bit register access
 * through rt2x00usb_vendor_request_buff().
 */
static inline void rt2x00usb_register_multiread(struct rt2x00_dev *rt2x00dev,
						const unsigned int offset,
						void *value, const u32 length)
{
	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_READ,
				      USB_VENDOR_REQUEST_IN, offset,
				      value, length);
}

/**
 * rt2x00usb_register_write - Write 32bit register word
 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 * @offset: Register offset
 * @value: Data which should be written
 *
 * This function is a simple wrapper for 32bit register access
 * through rt2x00usb_vendor_request_buff().
 */
static inline void rt2x00usb_register_write(struct rt2x00_dev *rt2x00dev,
					    const unsigned int offset,
					    u32 value)
{
	__le32 reg = cpu_to_le32(value);
	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_WRITE,
				      USB_VENDOR_REQUEST_OUT, offset,
				      &reg, sizeof(reg));
}

/**
 * rt2x00usb_register_write_lock - Write 32bit register word
 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 * @offset: Register offset
 * @value: Data which should be written
 *
 * This function is a simple wrapper for 32bit register access
 * through rt2x00usb_vendor_req_buff_lock().
 */
static inline void rt2x00usb_register_write_lock(struct rt2x00_dev *rt2x00dev,
						 const unsigned int offset,
						 u32 value)
{
	__le32 reg = cpu_to_le32(value);
	rt2x00usb_vendor_req_buff_lock(rt2x00dev, USB_MULTI_WRITE,
				       USB_VENDOR_REQUEST_OUT, offset,
				       &reg, sizeof(reg), REGISTER_TIMEOUT);
}

/**
 * rt2x00usb_register_multiwrite - Write 32bit register words
 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 * @offset: Register offset
 * @value: Data which should be written
 * @length: Length of the data
 *
 * This function is a simple wrapper for 32bit register access
 * through rt2x00usb_vendor_request_buff().
 */
static inline void rt2x00usb_register_multiwrite(struct rt2x00_dev *rt2x00dev,
						 const unsigned int offset,
						 const void *value,
						 const u32 length)
{
	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_WRITE,
				      USB_VENDOR_REQUEST_OUT, offset,
				      (void *)value, length);
}

/**
 * rt2x00usb_regbusy_read - Read from register with busy check
 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 * @offset: Register offset
 * @field: Field to check if register is busy
 * @reg: Pointer to where register contents should be stored
 *
 * This function will read the given register, and checks if the
 * register is busy. If it is, it will sleep for a couple of
 * microseconds before reading the register again. If the register
 * is not read after a certain timeout, this function will return
 * FALSE.
 */
int rt2x00usb_regbusy_read(struct rt2x00_dev *rt2x00dev,
			   const unsigned int offset,
			   const struct rt2x00_field32 field,
			   u32 *reg);

/**
 * rt2x00usb_register_read_async - Asynchronously read 32bit register word
 * @rt2x00dev: Device pointer, see &struct rt2x00_dev.
 * @offset: Register offset
 * @callback: Functon to call when read completes.
 *
 * Submit a control URB to read a 32bit register. This safe to
 * be called from atomic context.  The callback will be called
 * when the URB completes. Otherwise the function is similar
 * to rt2x00usb_register_read().
 * When the callback function returns false, the memory will be cleaned up,
 * when it returns true, the urb will be fired again.
 */
void rt2x00usb_register_read_async(struct rt2x00_dev *rt2x00dev,
				   const unsigned int offset,
				   bool (*callback)(struct rt2x00_dev*, int, u32));

/*
 * Radio handlers
 */
void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev);

/**
 * struct queue_entry_priv_usb: Per entry USB specific information
 *
 * @urb: Urb structure used for device communication.
 */
struct queue_entry_priv_usb {
	struct urb *urb;
};

/**
 * struct queue_entry_priv_usb_bcn: Per TX entry USB specific information
 *
 * The first section should match &struct queue_entry_priv_usb exactly.
 * rt2500usb can use this structure to send a guardian byte when working
 * with beacons.
 *
 * @urb: Urb structure used for device communication.
 * @guardian_data: Set to 0, used for sending the guardian data.
 * @guardian_urb: Urb structure used to send the guardian data.
 */
struct queue_entry_priv_usb_bcn {
	struct urb *urb;

	unsigned int guardian_data;
	struct urb *guardian_urb;
};

/**
 * rt2x00usb_kick_queue - Kick data queue
 * @queue: Data queue to kick
 *
 * This will walk through all entries of the queue and push all pending
 * frames to the hardware as a single burst.
 */
void rt2x00usb_kick_queue(struct data_queue *queue);

/**
 * rt2x00usb_flush_queue - Flush data queue
 * @queue: Data queue to stop
 * @drop: True to drop all pending frames.
 *
 * This will walk through all entries of the queue and will optionally
 * kill all URB's which were send to the device, or at least wait until
 * they have been returned from the device..
 */
void rt2x00usb_flush_queue(struct data_queue *queue, bool drop);

/**
 * rt2x00usb_watchdog - Watchdog for USB communication
 * @rt2x00dev: Pointer to &struct rt2x00_dev
 *
 * Check the health of the USB communication and determine
 * if timeouts have occurred. If this is the case, this function
 * will reset all communication to restore functionality again.
 */
void rt2x00usb_watchdog(struct rt2x00_dev *rt2x00dev);

/*
 * Device initialization handlers.
 */
void rt2x00usb_clear_entry(struct queue_entry *entry);
int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev);
void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev);

/*
 * USB driver handlers.
 */
int rt2x00usb_probe(struct usb_interface *usb_intf,
		    const struct rt2x00_ops *ops);
void rt2x00usb_disconnect(struct usb_interface *usb_intf);
#ifdef CONFIG_PM
int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state);
int rt2x00usb_resume(struct usb_interface *usb_intf);
#else
#define rt2x00usb_suspend	NULL
#define rt2x00usb_resume	NULL
#endif /* CONFIG_PM */

#endif /* RT2X00USB_H */
Commit	Line	Data
95ea3627	1	/*
9c9a0d14	2	Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
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
a05b8c58	16	along with this program; if not, see <http://www.gnu.org/licenses/>.
95ea3627 ID	17	*/
	18
	19	/*
	20	Module: rt2x00usb
	21	Abstract: Data structures for the rt2x00usb module.
	22	*/
	23
	24	#ifndef RT2X00USB_H
	25	#define RT2X00USB_H
	26
ac9d1a7b GW	27	#include <linux/usb.h>
ac9d1a7b GW	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	35	/*
e9dc51aa SG	36	* For USB vendor requests we need to pass a timeout time in ms, for this we
	37	* use the REGISTER_TIMEOUT, however when loading firmware or read EEPROM
	38	* a higher value is required. In that case we use the REGISTER_TIMEOUT_FIRMWARE
	39	* and EEPROM_TIMEOUT.
95ea3627	40	*/
14bc8bde	41	#define REGISTER_TIMEOUT 100
95ea3627	42	#define REGISTER_TIMEOUT_FIRMWARE 1000
e9dc51aa	43	#define EEPROM_TIMEOUT 2000
bd394a74	44
95ea3627 ID	45	/*
	46	* Cache size
	47	*/
ed0dbeeb	48	#define CSR_CACHE_SIZE 64
95ea3627 ID	49
	50	/*
	51	* USB request types.
	52	*/
	53	#define USB_VENDOR_REQUEST ( USB_TYPE_VENDOR \| USB_RECIP_DEVICE )
	54	#define USB_VENDOR_REQUEST_IN ( USB_DIR_IN \| USB_VENDOR_REQUEST )
	55	#define USB_VENDOR_REQUEST_OUT ( USB_DIR_OUT \| USB_VENDOR_REQUEST )
	56
3b640f21 ID	57	/**
3b640f21 ID	58	* enum rt2x00usb_vendor_request: USB vendor commands.
95ea3627	59	*/
3b640f21 ID	60	enum rt2x00usb_vendor_request {
	61	USB_DEVICE_MODE = 1,
	62	USB_SINGLE_WRITE = 2,
	63	USB_SINGLE_READ = 3,
	64	USB_MULTI_WRITE = 6,
	65	USB_MULTI_READ = 7,
	66	USB_EEPROM_WRITE = 8,
	67	USB_EEPROM_READ = 9,
	68	USB_LED_CONTROL = 10, /* RT73USB */
	69	USB_RX_CONTROL = 12,
	70	};
	71
	72	/**
	73	* enum rt2x00usb_mode_offset: Device modes offset.
	74	*/
	75	enum rt2x00usb_mode_offset {
	76	USB_MODE_RESET = 1,
	77	USB_MODE_UNPLUG = 2,
	78	USB_MODE_FUNCTION = 3,
	79	USB_MODE_TEST = 4,
	80	USB_MODE_SLEEP = 7, /* RT73USB */
	81	USB_MODE_FIRMWARE = 8, /* RT73USB */
	82	USB_MODE_WAKEUP = 9, /* RT73USB */
de51b35d	83	USB_MODE_AUTORUN = 17, /* RT2800USB */
3b640f21 ID	84	};
	85
	86	/**
	87	* rt2x00usb_vendor_request - Send register command to device
	88	* @rt2x00dev: Pointer to &struct rt2x00_dev
	89	* @request: USB vendor command (See &enum rt2x00usb_vendor_request)
	90	* @requesttype: Request type &USB_VENDOR_REQUEST_*
	91	* @offset: Register offset to perform action on
	92	* @value: Value to write to device
	93	* @buffer: Buffer where information will be read/written to by device
	94	* @buffer_length: Size of &buffer
	95	* @timeout: Operation timeout
	96	*
95ea3627	97	* This is the main function to communicate with the device,
3b640f21	98	* the &buffer argument _must_ either be NULL or point to
95ea3627 ID	99	* a buffer allocated by kmalloc. Failure to do so can lead
	100	* to unexpected behavior depending on the architecture.
	101	*/
0e14f6d3	102	int rt2x00usb_vendor_request(struct rt2x00_dev *rt2x00dev,
95ea3627 ID	103	const u8 request, const u8 requesttype,
	104	const u16 offset, const u16 value,
	105	void *buffer, const u16 buffer_length,
e9136550	106	const int timeout);
95ea3627	107
3b640f21 ID	108	/**
	109	* rt2x00usb_vendor_request_buff - Send register command to device (buffered)
	110	* @rt2x00dev: Pointer to &struct rt2x00_dev
	111	* @request: USB vendor command (See &enum rt2x00usb_vendor_request)
	112	* @requesttype: Request type &USB_VENDOR_REQUEST_*
	113	* @offset: Register offset to perform action on
	114	* @buffer: Buffer where information will be read/written to by device
	115	* @buffer_length: Size of &buffer
3b640f21	116	*
95ea3627 ID	117	* This function will use a previously with kmalloc allocated cache
	118	* to communicate with the device. The contents of the buffer pointer
	119	* will be copied to this cache when writing, or read from the cache
	120	* when reading.
3b640f21	121	* Buffers send to &rt2x00usb_vendor_request _must_ be allocated with
95ea3627 ID	122	* kmalloc. Hence the reason for using a previously allocated cache
	123	* which has been allocated properly.
	124	*/
0e14f6d3	125	int rt2x00usb_vendor_request_buff(struct rt2x00_dev *rt2x00dev,
95ea3627 ID	126	const u8 request, const u8 requesttype,
95ea3627 ID	127	const u16 offset, void *buffer,
e9dc51aa	128	const u16 buffer_length);
95ea3627	129
3b640f21 ID	130	/**
	131	* rt2x00usb_vendor_request_buff - Send register command to device (buffered)
	132	* @rt2x00dev: Pointer to &struct rt2x00_dev
	133	* @request: USB vendor command (See &enum rt2x00usb_vendor_request)
	134	* @requesttype: Request type &USB_VENDOR_REQUEST_*
	135	* @offset: Register offset to perform action on
	136	* @buffer: Buffer where information will be read/written to by device
	137	* @buffer_length: Size of &buffer
	138	* @timeout: Operation timeout
	139	*
	140	* A version of &rt2x00usb_vendor_request_buff which must be called
	141	* if the usb_cache_mutex is already held.
	142	*/
3d82346c AB	143	int rt2x00usb_vendor_req_buff_lock(struct rt2x00_dev *rt2x00dev,
	144	const u8 request, const u8 requesttype,
	145	const u16 offset, void *buffer,
	146	const u16 buffer_length, const int timeout);
	147
3b640f21 ID	148	/**
	149	* rt2x00usb_vendor_request_sw - Send single register command to device
	150	* @rt2x00dev: Pointer to &struct rt2x00_dev
	151	* @request: USB vendor command (See &enum rt2x00usb_vendor_request)
	152	* @offset: Register offset to perform action on
	153	* @value: Value to write to device
	154	* @timeout: Operation timeout
	155	*
95ea3627 ID	156	* Simple wrapper around rt2x00usb_vendor_request to write a single
	157	* command to the device. Since we don't use the buffer argument we
	158	* don't have to worry about kmalloc here.
	159	*/
0e14f6d3	160	static inline int rt2x00usb_vendor_request_sw(struct rt2x00_dev *rt2x00dev,
95ea3627 ID	161	const u8 request,
	162	const u16 offset,
	163	const u16 value,
e9136550	164	const int timeout)
95ea3627 ID	165	{
	166	return rt2x00usb_vendor_request(rt2x00dev, request,
	167	USB_VENDOR_REQUEST_OUT, offset,
	168	value, NULL, 0, timeout);
	169	}
	170
3b640f21 ID	171	/**
	172	* rt2x00usb_eeprom_read - Read eeprom from device
	173	* @rt2x00dev: Pointer to &struct rt2x00_dev
	174	* @eeprom: Pointer to eeprom array to store the information in
	175	* @length: Number of bytes to read from the eeprom
	176	*
95ea3627 ID	177	* Simple wrapper around rt2x00usb_vendor_request to read the eeprom
	178	* from the device. Note that the eeprom argument _must_ be allocated using
	179	* kmalloc for correct handling inside the kernel USB layer.
	180	*/
0e14f6d3	181	static inline int rt2x00usb_eeprom_read(struct rt2x00_dev *rt2x00dev,
9a46d44e	182	__le16 *eeprom, const u16 length)
95ea3627	183	{
95ea3627	184	return rt2x00usb_vendor_request(rt2x00dev, USB_EEPROM_READ,
3b640f21	185	USB_VENDOR_REQUEST_IN, 0, 0,
e9dc51aa	186	eeprom, length, EEPROM_TIMEOUT);
95ea3627 ID	187	}
95ea3627 ID	188
0f829b1d	189	/**
02a39c20	190	* rt2x00usb_register_read - Read 32bit register word
0f829b1d ID	191	* @rt2x00dev: Device pointer, see &struct rt2x00_dev.
	192	* @offset: Register offset
	193	* @value: Pointer to where register contents should be stored
	194	*
	195	* This function is a simple wrapper for 32bit register access
	196	* through rt2x00usb_vendor_request_buff().
	197	*/
	198	static inline void rt2x00usb_register_read(struct rt2x00_dev *rt2x00dev,
	199	const unsigned int offset,
	200	u32 *value)
	201	{
e4fcfaf8	202	__le32 reg = 0;
0f829b1d ID	203	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_READ,
0f829b1d ID	204	USB_VENDOR_REQUEST_IN, offset,
e9dc51aa	205	&reg, sizeof(reg));
0f829b1d ID	206	*value = le32_to_cpu(reg);
	207	}
	208
	209	/**
	210	* rt2x00usb_register_read_lock - Read 32bit register word
	211	* @rt2x00dev: Device pointer, see &struct rt2x00_dev.
	212	* @offset: Register offset
	213	* @value: Pointer to where register contents should be stored
	214	*
	215	* This function is a simple wrapper for 32bit register access
	216	* through rt2x00usb_vendor_req_buff_lock().
	217	*/
	218	static inline void rt2x00usb_register_read_lock(struct rt2x00_dev *rt2x00dev,
	219	const unsigned int offset,
	220	u32 *value)
	221	{
e4fcfaf8	222	__le32 reg = 0;
0f829b1d ID	223	rt2x00usb_vendor_req_buff_lock(rt2x00dev, USB_MULTI_READ,
	224	USB_VENDOR_REQUEST_IN, offset,
	225	&reg, sizeof(reg), REGISTER_TIMEOUT);
	226	*value = le32_to_cpu(reg);
	227	}
	228
	229	/**
	230	* rt2x00usb_register_multiread - Read 32bit register words
	231	* @rt2x00dev: Device pointer, see &struct rt2x00_dev.
	232	* @offset: Register offset
	233	* @value: Pointer to where register contents should be stored
	234	* @length: Length of the data
	235	*
	236	* This function is a simple wrapper for 32bit register access
	237	* through rt2x00usb_vendor_request_buff().
	238	*/
	239	static inline void rt2x00usb_register_multiread(struct rt2x00_dev *rt2x00dev,
	240	const unsigned int offset,
	241	void *value, const u32 length)
	242	{
	243	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_READ,
	244	USB_VENDOR_REQUEST_IN, offset,
e9dc51aa	245	value, length);
0f829b1d ID	246	}
	247
	248	/**
	249	* rt2x00usb_register_write - Write 32bit register word
	250	* @rt2x00dev: Device pointer, see &struct rt2x00_dev.
	251	* @offset: Register offset
	252	* @value: Data which should be written
	253	*
	254	* This function is a simple wrapper for 32bit register access
	255	* through rt2x00usb_vendor_request_buff().
	256	*/
	257	static inline void rt2x00usb_register_write(struct rt2x00_dev *rt2x00dev,
	258	const unsigned int offset,
	259	u32 value)
	260	{
	261	__le32 reg = cpu_to_le32(value);
	262	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_WRITE,
	263	USB_VENDOR_REQUEST_OUT, offset,
e9dc51aa	264	&reg, sizeof(reg));
0f829b1d ID	265	}
	266
	267	/**
	268	* rt2x00usb_register_write_lock - Write 32bit register word
	269	* @rt2x00dev: Device pointer, see &struct rt2x00_dev.
	270	* @offset: Register offset
	271	* @value: Data which should be written
	272	*
	273	* This function is a simple wrapper for 32bit register access
	274	* through rt2x00usb_vendor_req_buff_lock().
	275	*/
	276	static inline void rt2x00usb_register_write_lock(struct rt2x00_dev *rt2x00dev,
	277	const unsigned int offset,
	278	u32 value)
	279	{
	280	__le32 reg = cpu_to_le32(value);
	281	rt2x00usb_vendor_req_buff_lock(rt2x00dev, USB_MULTI_WRITE,
	282	USB_VENDOR_REQUEST_OUT, offset,
	283	&reg, sizeof(reg), REGISTER_TIMEOUT);
	284	}
	285
	286	/**
	287	* rt2x00usb_register_multiwrite - Write 32bit register words
	288	* @rt2x00dev: Device pointer, see &struct rt2x00_dev.
	289	* @offset: Register offset
	290	* @value: Data which should be written
	291	* @length: Length of the data
	292	*
	293	* This function is a simple wrapper for 32bit register access
	294	* through rt2x00usb_vendor_request_buff().
	295	*/
	296	static inline void rt2x00usb_register_multiwrite(struct rt2x00_dev *rt2x00dev,
5b10b098 BZ	297	const unsigned int offset,
	298	const void *value,
	299	const u32 length)
0f829b1d ID	300	{
	301	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_WRITE,
	302	USB_VENDOR_REQUEST_OUT, offset,
e9dc51aa	303	(void *)value, length);
0f829b1d ID	304	}
	305
	306	/**
	307	* rt2x00usb_regbusy_read - Read from register with busy check
	308	* @rt2x00dev: Device pointer, see &struct rt2x00_dev.
	309	* @offset: Register offset
	310	* @field: Field to check if register is busy
	311	* @reg: Pointer to where register contents should be stored
	312	*
	313	* This function will read the given register, and checks if the
	314	* register is busy. If it is, it will sleep for a couple of
	315	* microseconds before reading the register again. If the register
	316	* is not read after a certain timeout, this function will return
	317	* FALSE.
	318	*/
	319	int rt2x00usb_regbusy_read(struct rt2x00_dev *rt2x00dev,
	320	const unsigned int offset,
f255b92b	321	const struct rt2x00_field32 field,
0f829b1d ID	322	u32 *reg);
0f829b1d ID	323
0e0d39e5 JS	324	/**
	325	* rt2x00usb_register_read_async - Asynchronously read 32bit register word
	326	* @rt2x00dev: Device pointer, see &struct rt2x00_dev.
	327	* @offset: Register offset
	328	* @callback: Functon to call when read completes.
	329	*
	330	* Submit a control URB to read a 32bit register. This safe to
	331	* be called from atomic context. The callback will be called
	332	* when the URB completes. Otherwise the function is similar
	333	* to rt2x00usb_register_read().
a073fdef ID	334	* When the callback function returns false, the memory will be cleaned up,
a073fdef ID	335	* when it returns true, the urb will be fired again.
0e0d39e5 JS	336	*/
	337	void rt2x00usb_register_read_async(struct rt2x00_dev *rt2x00dev,
	338	const unsigned int offset,
a073fdef	339	bool (callback)(struct rt2x00_dev, int, u32));
0e0d39e5	340
95ea3627 ID	341	/*
	342	* Radio handlers
	343	*/
95ea3627 ID	344	void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev);
95ea3627 ID	345
181d6902	346	/**
b8be63ff	347	* struct queue_entry_priv_usb: Per entry USB specific information
181d6902 ID	348	*
181d6902 ID	349	* @urb: Urb structure used for device communication.
181d6902	350	*/
b8be63ff	351	struct queue_entry_priv_usb {
181d6902	352	struct urb *urb;
181d6902 ID	353	};
	354
	355	/**
b8be63ff	356	* struct queue_entry_priv_usb_bcn: Per TX entry USB specific information
181d6902	357	*
b8be63ff	358	* The first section should match &struct queue_entry_priv_usb exactly.
181d6902 ID	359	* rt2500usb can use this structure to send a guardian byte when working
	360	* with beacons.
	361	*
	362	* @urb: Urb structure used for device communication.
181d6902 ID	363	* @guardian_data: Set to 0, used for sending the guardian data.
	364	* @guardian_urb: Urb structure used to send the guardian data.
	365	*/
	366	struct queue_entry_priv_usb_bcn {
	367	struct urb *urb;
	368
181d6902 ID	369	unsigned int guardian_data;
	370	struct urb *guardian_urb;
	371	};
	372
f019d514	373	/**
dbba306f	374	* rt2x00usb_kick_queue - Kick data queue
93331458	375	* @queue: Data queue to kick
f019d514 ID	376	*
	377	* This will walk through all entries of the queue and push all pending
	378	* frames to the hardware as a single burst.
	379	*/
dbba306f	380	void rt2x00usb_kick_queue(struct data_queue *queue);
f019d514	381
a2c9b652	382	/**
5be65609	383	* rt2x00usb_flush_queue - Flush data queue
5450b7e2	384	* @queue: Data queue to stop
152a5992	385	* @drop: True to drop all pending frames.
a2c9b652	386	*
152a5992 ID	387	* This will walk through all entries of the queue and will optionally
	388	* kill all URB's which were send to the device, or at least wait until
	389	* they have been returned from the device..
a2c9b652	390	*/
152a5992	391	void rt2x00usb_flush_queue(struct data_queue *queue, bool drop);
a2c9b652	392
c965c74b ID	393	/**
	394	* rt2x00usb_watchdog - Watchdog for USB communication
	395	* @rt2x00dev: Pointer to &struct rt2x00_dev
	396	*
	397	* Check the health of the USB communication and determine
25985edc	398	* if timeouts have occurred. If this is the case, this function
c965c74b ID	399	* will reset all communication to restore functionality again.
	400	*/
	401	void rt2x00usb_watchdog(struct rt2x00_dev *rt2x00dev);
	402
95ea3627 ID	403	/*
	404	* Device initialization handlers.
	405	*/
798b7adb	406	void rt2x00usb_clear_entry(struct queue_entry *entry);
95ea3627 ID	407	int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev);
	408	void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev);
	409
	410	/*
	411	* USB driver handlers.
	412	*/
	413	int rt2x00usb_probe(struct usb_interface *usb_intf,
e01ae27f	414	const struct rt2x00_ops *ops);
95ea3627 ID	415	void rt2x00usb_disconnect(struct usb_interface *usb_intf);
	416	#ifdef CONFIG_PM
	417	int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state);
	418	int rt2x00usb_resume(struct usb_interface *usb_intf);
	419	#else
	420	#define rt2x00usb_suspend NULL
	421	#define rt2x00usb_resume NULL
	422	#endif /* CONFIG_PM */
	423
	424	#endif /* RT2X00USB_H */