[net-next-2.6.git] / drivers / usb / storage / usb.h

/* Driver for USB Mass Storage compliant devices
 * Main Header File
 *
 * Current development and maintenance by:
 *   (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
 *
 * Initial work by:
 *   (c) 1999 Michael Gee (michael@linuxspecific.com)
 *
 * This driver is based on the 'USB Mass Storage Class' document. This
 * describes in detail the protocol used to communicate with such
 * devices.  Clearly, the designers had SCSI and ATAPI commands in
 * mind when they created this document.  The commands are all very
 * similar to commands in the SCSI-II and ATAPI specifications.
 *
 * It is important to note that in a number of cases this class
 * exhibits class-specific exemptions from the USB specification.
 * Notably the usage of NAK, STALL and ACK differs from the norm, in
 * that they are used to communicate wait, failed and OK on commands.
 *
 * Also, for certain devices, the interrupt endpoint is used to convey
 * status of a command.
 *
 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
 * information about this driver.
 *
 * 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, 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.,
 * 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef _USB_H_
#define _USB_H_

#include <linux/usb.h>
#include <linux/usb_usual.h>
#include <linux/blkdev.h>
#include <linux/completion.h>
#include <linux/mutex.h>
#include <scsi/scsi_host.h>

struct us_data;
struct scsi_cmnd;

/*
 * Unusual device list definitions 
 */

struct us_unusual_dev {
	const char* vendorName;
	const char* productName;
	__u8  useProtocol;
	__u8  useTransport;
	int (*initFunction)(struct us_data *);
};


/* Dynamic bitflag definitions (us->dflags): used in set_bit() etc. */
#define US_FLIDX_URB_ACTIVE	0	/* current_urb is in use    */
#define US_FLIDX_SG_ACTIVE	1	/* current_sg is in use     */
#define US_FLIDX_ABORTING	2	/* abort is in progress     */
#define US_FLIDX_DISCONNECTING	3	/* disconnect in progress   */
#define US_FLIDX_RESETTING	4	/* device reset in progress */
#define US_FLIDX_TIMED_OUT	5	/* SCSI midlayer timed out  */
#define US_FLIDX_DONT_SCAN	6	/* don't scan (disconnect)  */

#define USB_STOR_STRING_LEN 32

/*
 * We provide a DMA-mapped I/O buffer for use with small USB transfers.
 * It turns out that CB[I] needs a 12-byte buffer and Bulk-only needs a
 * 31-byte buffer.  But Freecom needs a 64-byte buffer, so that's the
 * size we'll allocate.
 */

#define US_IOBUF_SIZE		64	/* Size of the DMA-mapped I/O buffer */
#define US_SENSE_SIZE		18	/* Size of the autosense data buffer */

typedef int (*trans_cmnd)(struct scsi_cmnd *, struct us_data*);
typedef int (*trans_reset)(struct us_data*);
typedef void (*proto_cmnd)(struct scsi_cmnd*, struct us_data*);
typedef void (*extra_data_destructor)(void *);	/* extra data destructor */
typedef void (*pm_hook)(struct us_data *, int);	/* power management hook */

#define US_SUSPEND	0
#define US_RESUME	1

/* we allocate one of these for every device that we remember */
struct us_data {
	/* The device we're working with
	 * It's important to note:
	 *    (o) you must hold dev_mutex to change pusb_dev
	 */
	struct mutex		dev_mutex;	 /* protect pusb_dev */
	struct usb_device	*pusb_dev;	 /* this usb_device */
	struct usb_interface	*pusb_intf;	 /* this interface */
	struct us_unusual_dev   *unusual_dev;	 /* device-filter entry     */
	unsigned long		fflags;		 /* fixed flags from filter */
	unsigned long		dflags;		 /* dynamic atomic bitflags */
	unsigned int		send_bulk_pipe;	 /* cached pipe values */
	unsigned int		recv_bulk_pipe;
	unsigned int		send_ctrl_pipe;
	unsigned int		recv_ctrl_pipe;
	unsigned int		recv_intr_pipe;

	/* information about the device */
	char			*transport_name;
	char			*protocol_name;
	__le32			bcs_signature;
	u8			subclass;
	u8			protocol;
	u8			max_lun;

	u8			ifnum;		 /* interface number   */
	u8			ep_bInterval;	 /* interrupt interval */ 

	/* function pointers for this device */
	trans_cmnd		transport;	 /* transport function	   */
	trans_reset		transport_reset; /* transport device reset */
	proto_cmnd		proto_handler;	 /* protocol handler	   */

	/* SCSI interfaces */
	struct scsi_cmnd	*srb;		 /* current srb		*/
	unsigned int		tag;		 /* current dCBWTag	*/
	char			scsi_name[32];	 /* scsi_host name	*/

	/* control and bulk communications data */
	struct urb		*current_urb;	 /* USB requests	 */
	struct usb_ctrlrequest	*cr;		 /* control requests	 */
	struct usb_sg_request	current_sg;	 /* scatter-gather req.  */
	unsigned char		*iobuf;		 /* I/O buffer		 */
	dma_addr_t		cr_dma;		 /* buffer DMA addresses */
	dma_addr_t		iobuf_dma;
	struct task_struct	*ctl_thread;	 /* the control thread   */

	/* mutual exclusion and synchronization structures */
	struct completion	cmnd_ready;	 /* to sleep thread on	    */
	struct completion	notify;		 /* thread begin/end	    */
	wait_queue_head_t	delay_wait;	 /* wait during scan, reset */
	struct completion	scanning_done;	 /* wait for scan thread    */

	/* subdriver information */
	void			*extra;		 /* Any extra data          */
	extra_data_destructor	extra_destructor;/* extra data destructor   */
#ifdef CONFIG_PM
	pm_hook			suspend_resume_hook;
#endif

	/* hacks for READ CAPACITY bug handling */
	int			use_last_sector_hacks;
	int			last_sector_retries;
};

/* Convert between us_data and the corresponding Scsi_Host */
static inline struct Scsi_Host *us_to_host(struct us_data *us) {
	return container_of((void *) us, struct Scsi_Host, hostdata);
}
static inline struct us_data *host_to_us(struct Scsi_Host *host) {
	return (struct us_data *) host->hostdata;
}

/* Function to fill an inquiry response. See usb.c for details */
extern void fill_inquiry_response(struct us_data *us,
	unsigned char *data, unsigned int data_len);

/* The scsi_lock() and scsi_unlock() macros protect the sm_state and the
 * single queue element srb for write access */
#define scsi_unlock(host)	spin_unlock_irq(host->host_lock)
#define scsi_lock(host)		spin_lock_irq(host->host_lock)

/* General routines provided by the usb-storage standard core */
#ifdef CONFIG_PM
extern int usb_stor_suspend(struct usb_interface *iface, pm_message_t message);
extern int usb_stor_resume(struct usb_interface *iface);
extern int usb_stor_reset_resume(struct usb_interface *iface);
#else
#define usb_stor_suspend	NULL
#define usb_stor_resume		NULL
#define usb_stor_reset_resume	NULL
#endif

extern int usb_stor_pre_reset(struct usb_interface *iface);
extern int usb_stor_post_reset(struct usb_interface *iface);

extern int usb_stor_probe1(struct us_data **pus,
		struct usb_interface *intf,
		const struct usb_device_id *id,
		struct us_unusual_dev *unusual_dev);
extern int usb_stor_probe2(struct us_data *us);
extern void usb_stor_disconnect(struct usb_interface *intf);

#endif
Commit	Line	Data
1da177e4 LT	1	/* Driver for USB Mass Storage compliant devices
	2	* Main Header File
	3	*
1da177e4 LT	4	* Current development and maintenance by:
	5	* (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
	6	*
	7	* Initial work by:
	8	* (c) 1999 Michael Gee (michael@linuxspecific.com)
	9	*
	10	* This driver is based on the 'USB Mass Storage Class' document. This
	11	* describes in detail the protocol used to communicate with such
	12	* devices. Clearly, the designers had SCSI and ATAPI commands in
	13	* mind when they created this document. The commands are all very
	14	* similar to commands in the SCSI-II and ATAPI specifications.
	15	*
	16	* It is important to note that in a number of cases this class
	17	* exhibits class-specific exemptions from the USB specification.
	18	* Notably the usage of NAK, STALL and ACK differs from the norm, in
	19	* that they are used to communicate wait, failed and OK on commands.
	20	*
	21	* Also, for certain devices, the interrupt endpoint is used to convey
	22	* status of a command.
	23	*
	24	* Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
	25	* information about this driver.
	26	*
	27	* This program is free software; you can redistribute it and/or modify it
	28	* under the terms of the GNU General Public License as published by the
	29	* Free Software Foundation; either version 2, or (at your option) any
	30	* later version.
	31	*
	32	* This program is distributed in the hope that it will be useful, but
	33	* WITHOUT ANY WARRANTY; without even the implied warranty of
	34	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	35	* General Public License for more details.
	36	*
	37	* You should have received a copy of the GNU General Public License along
	38	* with this program; if not, write to the Free Software Foundation, Inc.,
	39	* 675 Mass Ave, Cambridge, MA 02139, USA.
	40	*/
	41
	42	#ifndef _USB_H_
	43	#define _USB_H_
	44
	45	#include <linux/usb.h>
a00828e9	46	#include <linux/usb_usual.h>
1da177e4	47	#include <linux/blkdev.h>
1da177e4	48	#include <linux/completion.h>
4186ecf8	49	#include <linux/mutex.h>
1da177e4 LT	50	#include <scsi/scsi_host.h>
	51
	52	struct us_data;
	53	struct scsi_cmnd;
	54
	55	/*
	56	* Unusual device list definitions
	57	*/
	58
	59	struct us_unusual_dev {
	60	const char* vendorName;
	61	const char* productName;
	62	__u8 useProtocol;
	63	__u8 useTransport;
	64	int (initFunction)(struct us_data );
1da177e4 LT	65	};
1da177e4 LT	66
1da177e4	67
7e4d6c38 AS	68	/* Dynamic bitflag definitions (us->dflags): used in set_bit() etc. */
	69	#define US_FLIDX_URB_ACTIVE 0 /* current_urb is in use */
	70	#define US_FLIDX_SG_ACTIVE 1 /* current_sg is in use */
	71	#define US_FLIDX_ABORTING 2 /* abort is in progress */
	72	#define US_FLIDX_DISCONNECTING 3 /* disconnect in progress */
7e4d6c38 AS	73	#define US_FLIDX_RESETTING 4 /* device reset in progress */
7e4d6c38 AS	74	#define US_FLIDX_TIMED_OUT 5 /* SCSI midlayer timed out */
543f7810	75	#define US_FLIDX_DONT_SCAN 6 /* don't scan (disconnect) */
1da177e4 LT	76
	77	#define USB_STOR_STRING_LEN 32
	78
	79	/*
	80	* We provide a DMA-mapped I/O buffer for use with small USB transfers.
	81	* It turns out that CB[I] needs a 12-byte buffer and Bulk-only needs a
	82	* 31-byte buffer. But Freecom needs a 64-byte buffer, so that's the
	83	* size we'll allocate.
	84	*/
	85
	86	#define US_IOBUF_SIZE 64 /* Size of the DMA-mapped I/O buffer */
bbafa466	87	#define US_SENSE_SIZE 18 /* Size of the autosense data buffer */
1da177e4 LT	88
	89	typedef int (trans_cmnd)(struct scsi_cmnd , struct us_data*);
	90	typedef int (trans_reset)(struct us_data);
	91	typedef void (proto_cmnd)(struct scsi_cmnd, struct us_data*);
7931e1c6 MD	92	typedef void (extra_data_destructor)(void ); /* extra data destructor */
	93	typedef void (pm_hook)(struct us_data , int); /* power management hook */
	94
	95	#define US_SUSPEND 0
	96	#define US_RESUME 1
1da177e4 LT	97
	98	/* we allocate one of these for every device that we remember */
	99	struct us_data {
	100	/* The device we're working with
	101	* It's important to note:
4186ecf8	102	* (o) you must hold dev_mutex to change pusb_dev
1da177e4	103	*/
4186ecf8	104	struct mutex dev_mutex; /* protect pusb_dev */
1da177e4 LT	105	struct usb_device pusb_dev; / this usb_device */
	106	struct usb_interface pusb_intf; / this interface */
	107	struct us_unusual_dev unusual_dev; / device-filter entry */
7e4d6c38 AS	108	unsigned long fflags; /* fixed flags from filter */
7e4d6c38 AS	109	unsigned long dflags; /* dynamic atomic bitflags */
1da177e4 LT	110	unsigned int send_bulk_pipe; /* cached pipe values */
	111	unsigned int recv_bulk_pipe;
	112	unsigned int send_ctrl_pipe;
	113	unsigned int recv_ctrl_pipe;
	114	unsigned int recv_intr_pipe;
	115
	116	/* information about the device */
	117	char *transport_name;
	118	char *protocol_name;
	119	__le32 bcs_signature;
	120	u8 subclass;
	121	u8 protocol;
	122	u8 max_lun;
	123
	124	u8 ifnum; /* interface number */
	125	u8 ep_bInterval; /* interrupt interval */
	126
	127	/* function pointers for this device */
	128	trans_cmnd transport; /* transport function */
	129	trans_reset transport_reset; /* transport device reset */
	130	proto_cmnd proto_handler; /* protocol handler */
	131
	132	/* SCSI interfaces */
	133	struct scsi_cmnd srb; / current srb */
0f64e078	134	unsigned int tag; /* current dCBWTag */
00fa43ef	135	char scsi_name[32]; /* scsi_host name */
1da177e4	136
1da177e4 LT	137	/* control and bulk communications data */
	138	struct urb current_urb; / USB requests */
	139	struct usb_ctrlrequest cr; / control requests */
	140	struct usb_sg_request current_sg; /* scatter-gather req. */
	141	unsigned char iobuf; / I/O buffer */
	142	dma_addr_t cr_dma; /* buffer DMA addresses */
	143	dma_addr_t iobuf_dma;
ed76cacb	144	struct task_struct ctl_thread; / the control thread */
1da177e4 LT	145
1da177e4 LT	146	/* mutual exclusion and synchronization structures */
7119e3c3	147	struct completion cmnd_ready; /* to sleep thread on */
1da177e4 LT	148	struct completion notify; /* thread begin/end */
1da177e4 LT	149	wait_queue_head_t delay_wait; /* wait during scan, reset */
2f67cd5b	150	struct completion scanning_done; /* wait for scan thread */
1da177e4 LT	151
	152	/* subdriver information */
	153	void extra; / Any extra data */
	154	extra_data_destructor extra_destructor;/* extra data destructor */
7931e1c6 MD	155	#ifdef CONFIG_PM
	156	pm_hook suspend_resume_hook;
	157	#endif
25ff1c31 AS	158
	159	/* hacks for READ CAPACITY bug handling */
	160	int use_last_sector_hacks;
	161	int last_sector_retries;
1da177e4 LT	162	};
	163
	164	/* Convert between us_data and the corresponding Scsi_Host */
f274afc9	165	static inline struct Scsi_Host us_to_host(struct us_data us) {
1da177e4 LT	166	return container_of((void *) us, struct Scsi_Host, hostdata);
1da177e4 LT	167	}
f274afc9	168	static inline struct us_data host_to_us(struct Scsi_Host host) {
1da177e4 LT	169	return (struct us_data *) host->hostdata;
	170	}
	171
	172	/* Function to fill an inquiry response. See usb.c for details */
	173	extern void fill_inquiry_response(struct us_data *us,
	174	unsigned char *data, unsigned int data_len);
	175
	176	/* The scsi_lock() and scsi_unlock() macros protect the sm_state and the
	177	* single queue element srb for write access */
	178	#define scsi_unlock(host) spin_unlock_irq(host->host_lock)
	179	#define scsi_lock(host) spin_lock_irq(host->host_lock)
	180
e6e244b6 AS	181	/* General routines provided by the usb-storage standard core */
	182	#ifdef CONFIG_PM
	183	extern int usb_stor_suspend(struct usb_interface *iface, pm_message_t message);
	184	extern int usb_stor_resume(struct usb_interface *iface);
	185	extern int usb_stor_reset_resume(struct usb_interface *iface);
	186	#else
	187	#define usb_stor_suspend NULL
	188	#define usb_stor_resume NULL
	189	#define usb_stor_reset_resume NULL
	190	#endif
	191
	192	extern int usb_stor_pre_reset(struct usb_interface *iface);
	193	extern int usb_stor_post_reset(struct usb_interface *iface);
	194
	195	extern int usb_stor_probe1(struct us_data **pus,
	196	struct usb_interface *intf,
	197	const struct usb_device_id *id,
	198	struct us_unusual_dev *unusual_dev);
	199	extern int usb_stor_probe2(struct us_data *us);
	200	extern void usb_stor_disconnect(struct usb_interface *intf);
	201
1da177e4	202	#endif