drivers/net/wireless/rt2x00/rt2x00usb.h - maze/linux - Git at Google

 /*
 	Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
 	<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, write to the
 	Free Software Foundation, Inc.,
 	59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */

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

 #ifndef RT2X00USB_H
 #define RT2X00USB_H

 /*
  * This variable should be used with the
  * usb_driver structure initialization.
  */
 #define USB_DEVICE_DATA(__ops)	.driver_info = (kernel_ulong_t)(__ops)

 /*
  * Register defines.
  * Some registers require multiple attempts before success,
  * in those cases REGISTER_BUSY_COUNT attempts should be
  * taken with a REGISTER_BUSY_DELAY interval.
  * 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_BUSY_COUNT		5
 #define REGISTER_BUSY_DELAY		100
 #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			8
 #define CSR_CACHE_SIZE_FIRMWARE		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 */
 };

 /**
  * 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));
 }

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

 /*
  * TX data handlers.
  */
 int rt2x00usb_write_tx_data(struct rt2x00_dev *rt2x00dev,
 			    struct data_queue *queue, struct sk_buff *skb,
 			    struct ieee80211_tx_control *control);

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

 /**
  * struct queue_entry_priv_usb_tx: Per TX entry USB specific information
  *
  * @urb: Urb structure used for device communication.
  * @control: mac80211 control structure used to transmit data.
  */
 struct queue_entry_priv_usb_tx {
 	struct urb *urb;

 	struct ieee80211_tx_control control;
 };

 /**
  * struct queue_entry_priv_usb_tx: Per TX entry USB specific information
  *
  * The first section should match &struct queue_entry_priv_usb_tx exactly.
  * rt2500usb can use this structure to send a guardian byte when working
  * with beacons.
  *
  * @urb: Urb structure used for device communication.
  * @control: mac80211 control structure used to transmit data.
  * @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;

 	struct ieee80211_tx_control control;

 	unsigned int guardian_data;
 	struct urb *guardian_urb;
 };

 /*
  * Device initialization handlers.
  */
 void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
 			    struct queue_entry *entry);
 void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
 			    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 usb_device_id *id);
 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 */
	/*
	Copyright (C) 2004 - 2008 rt2x00 SourceForge Project
	<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, write to the
	Free Software Foundation, Inc.,
	59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	*/

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

	#ifndef RT2X00USB_H
	#define RT2X00USB_H

	/*
	* This variable should be used with the
	* usb_driver structure initialization.
	*/
	#define USB_DEVICE_DATA(__ops) .driver_info = (kernel_ulong_t)(__ops)

	/*
	* Register defines.
	* Some registers require multiple attempts before success,
	* in those cases REGISTER_BUSY_COUNT attempts should be
	* taken with a REGISTER_BUSY_DELAY interval.
	* 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_BUSY_COUNT 5
	#define REGISTER_BUSY_DELAY 100
	#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 8
	#define CSR_CACHE_SIZE_FIRMWARE 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 */
	};

	/**
	* 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));
	}

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

	/*
	* TX data handlers.
	*/
	int rt2x00usb_write_tx_data(struct rt2x00_dev *rt2x00dev,
	struct data_queue queue, struct sk_buff skb,
	struct ieee80211_tx_control *control);

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

	/**
	* struct queue_entry_priv_usb_tx: Per TX entry USB specific information
	*
	* @urb: Urb structure used for device communication.
	* @control: mac80211 control structure used to transmit data.
	*/
	struct queue_entry_priv_usb_tx {
	struct urb *urb;

	struct ieee80211_tx_control control;
	};

	/**
	* struct queue_entry_priv_usb_tx: Per TX entry USB specific information
	*
	* The first section should match &struct queue_entry_priv_usb_tx exactly.
	* rt2500usb can use this structure to send a guardian byte when working
	* with beacons.
	*
	* @urb: Urb structure used for device communication.
	* @control: mac80211 control structure used to transmit data.
	* @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;

	struct ieee80211_tx_control control;

	unsigned int guardian_data;
	struct urb *guardian_urb;
	};

	/*
	* Device initialization handlers.
	*/
	void rt2x00usb_init_rxentry(struct rt2x00_dev *rt2x00dev,
	struct queue_entry *entry);
	void rt2x00usb_init_txentry(struct rt2x00_dev *rt2x00dev,
	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 usb_device_id *id);
	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 */