[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 a higher value is
 * required. In that case we use the REGISTER_TIMEOUT_FIRMWARE.
 */
#define REGISTER_TIMEOUT		500
#define REGISTER_TIMEOUT_FIRMWARE	1000

/**
 * REGISTER_TIMEOUT16 - Determine the timeout for 16bit register access
 * @__datalen: Data length
 */
#define REGISTER_TIMEOUT16(__datalen)	\
	( REGISTER_TIMEOUT * ((__datalen) / sizeof(u16)) )

/**
 * REGISTER_TIMEOUT32 - Determine the timeout for 32bit register access
 * @__datalen: Data length
 */
#define REGISTER_TIMEOUT32(__datalen)	\
	( REGISTER_TIMEOUT * ((__datalen) / sizeof(u32)) )

/*
 * 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
 * @timeout: Operation timeout
 *
 * 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, 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
 * @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,
					REGISTER_TIMEOUT16(length));
}

/**
 * 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;
	rt2x00usb_vendor_request_buff(rt2x00dev, USB_MULTI_READ,
				      USB_VENDOR_REQUEST_IN, offset,
				      &reg, sizeof(reg), REGISTER_TIMEOUT);
	*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;
	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,
				      REGISTER_TIMEOUT32(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), REGISTER_TIMEOUT);
}

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