[net-next-2.6.git] / include / linux / usb_usual.h

/*
 * Interface to the libusual.
 *
 * Copyright (c) 2005 Pete Zaitcev <zaitcev@redhat.com>
 * Copyright (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
 * Copyright (c) 1999 Michael Gee (michael@linuxspecific.com)
 */

#ifndef __LINUX_USB_USUAL_H
#define __LINUX_USB_USUAL_H


/* We should do this for cleanliness... But other usb_foo.h do not do this. */
/* #include <linux/usb.h> */

/*
 * The flags field, which we store in usb_device_id.driver_info.
 * It is compatible with the old usb-storage flags in lower 24 bits.
 */

/*
 * Static flag definitions.  We use this roundabout technique so that the
 * proc_info() routine can automatically display a message for each flag.
 */
#define US_DO_ALL_FLAGS						\
	US_FLAG(SINGLE_LUN,	0x00000001)			\
		/* allow access to only LUN 0 */		\
	US_FLAG(NEED_OVERRIDE,	0x00000002)			\
		/* unusual_devs entry is necessary */		\
	US_FLAG(SCM_MULT_TARG,	0x00000004)			\
		/* supports multiple targets */			\
	US_FLAG(FIX_INQUIRY,	0x00000008)			\
		/* INQUIRY response needs faking */		\
	US_FLAG(FIX_CAPACITY,	0x00000010)			\
		/* READ CAPACITY response too big */		\
	US_FLAG(IGNORE_RESIDUE,	0x00000020)			\
		/* reported residue is wrong */			\
	US_FLAG(BULK32,		0x00000040)			\
		/* Uses 32-byte CBW length */			\
	US_FLAG(NOT_LOCKABLE,	0x00000080)			\
		/* PREVENT/ALLOW not supported */		\
	US_FLAG(GO_SLOW,	0x00000100)			\
		/* Need delay after Command phase */		\
	US_FLAG(NO_WP_DETECT,	0x00000200)			\
		/* Don't check for write-protect */		\
	US_FLAG(MAX_SECTORS_64,	0x00000400)			\
		/* Sets max_sectors to 64    */			\
	US_FLAG(IGNORE_DEVICE,	0x00000800)			\
		/* Don't claim device */			\
	US_FLAG(CAPACITY_HEURISTICS,	0x00001000)		\
		/* sometimes sizes is too big */		\
	US_FLAG(MAX_SECTORS_MIN,0x00002000)			\
		/* Sets max_sectors to arch min */		\
	US_FLAG(BULK_IGNORE_TAG,0x00004000)			\
		/* Ignore tag mismatch in bulk operations */    \
	US_FLAG(SANE_SENSE,     0x00008000)			\
		/* Sane Sense (> 18 bytes) */			\
	US_FLAG(CAPACITY_OK,	0x00010000)			\
		/* READ CAPACITY response is correct */		\
	US_FLAG(BAD_SENSE,	0x00020000)			\
		/* Bad Sense (never more than 18 bytes) */

#define US_FLAG(name, value)	US_FL_##name = value ,
enum { US_DO_ALL_FLAGS };
#undef US_FLAG

/*
 * The bias field for libusual and friends.
 */
#define USB_US_TYPE_NONE   0
#define USB_US_TYPE_STOR   1		/* usb-storage */
#define USB_US_TYPE_UB     2		/* ub */

#define USB_US_TYPE(flags) 		(((flags) >> 24) & 0xFF)
#define USB_US_ORIG_FLAGS(flags)	((flags) & 0x00FFFFFF)

/*
 * This is probably not the best place to keep these constants, conceptually.
 * But it's the only header included into all places which need them.
 */

/* Sub Classes */

#define US_SC_RBC	0x01		/* Typically, flash devices */
#define US_SC_8020	0x02		/* CD-ROM */
#define US_SC_QIC	0x03		/* QIC-157 Tapes */
#define US_SC_UFI	0x04		/* Floppy */
#define US_SC_8070	0x05		/* Removable media */
#define US_SC_SCSI	0x06		/* Transparent */
#define US_SC_LOCKABLE	0x07		/* Password-protected */

#define US_SC_ISD200    0xf0		/* ISD200 ATA */
#define US_SC_CYP_ATACB 0xf1		/* Cypress ATACB */
#define US_SC_DEVICE	0xff		/* Use device's value */

/* Protocols */

#define US_PR_CBI	0x00		/* Control/Bulk/Interrupt */
#define US_PR_CB	0x01		/* Control/Bulk w/o interrupt */
#define US_PR_BULK	0x50		/* bulk only */

#define US_PR_USBAT	0x80		/* SCM-ATAPI bridge */
#define US_PR_EUSB_SDDR09	0x81	/* SCM-SCSI bridge for SDDR-09 */
#define US_PR_SDDR55	0x82		/* SDDR-55 (made up) */
#define US_PR_DPCM_USB  0xf0		/* Combination CB/SDDR09 */
#define US_PR_FREECOM   0xf1		/* Freecom */
#define US_PR_DATAFAB   0xf2		/* Datafab chipsets */
#define US_PR_JUMPSHOT  0xf3		/* Lexar Jumpshot */
#define US_PR_ALAUDA    0xf4		/* Alauda chipsets */
#define US_PR_KARMA     0xf5		/* Rio Karma */

#define US_PR_DEVICE	0xff		/* Use device's value */

/*
 */
extern int usb_usual_ignore_device(struct usb_interface *intf);
extern struct usb_device_id usb_storage_usb_ids[];

#ifdef CONFIG_USB_LIBUSUAL

extern void usb_usual_set_present(int type);
extern void usb_usual_clear_present(int type);
extern int usb_usual_check_type(const struct usb_device_id *, int type);
#else

#define usb_usual_set_present(t)	do { } while(0)
#define usb_usual_clear_present(t)	do { } while(0)
#define usb_usual_check_type(id, t)	(0)
#endif /* CONFIG_USB_LIBUSUAL */

#endif /* __LINUX_USB_USUAL_H */
Commit	Line	Data
a00828e9 PZ	1	/*
	2	* Interface to the libusual.
	3	*
	4	* Copyright (c) 2005 Pete Zaitcev <zaitcev@redhat.com>
	5	* Copyright (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
	6	* Copyright (c) 1999 Michael Gee (michael@linuxspecific.com)
	7	*/
	8
	9	#ifndef __LINUX_USB_USUAL_H
	10	#define __LINUX_USB_USUAL_H
	11
a00828e9 PZ	12
	13	/* We should do this for cleanliness... But other usb_foo.h do not do this. */
	14	/* #include <linux/usb.h> */
	15
	16	/*
	17	* The flags field, which we store in usb_device_id.driver_info.
	18	* It is compatible with the old usb-storage flags in lower 24 bits.
	19	*/
	20
	21	/*
	22	* Static flag definitions. We use this roundabout technique so that the
	23	* proc_info() routine can automatically display a message for each flag.
	24	*/
	25	#define US_DO_ALL_FLAGS \
	26	US_FLAG(SINGLE_LUN, 0x00000001) \
	27	/* allow access to only LUN 0 */ \
	28	US_FLAG(NEED_OVERRIDE, 0x00000002) \
	29	/* unusual_devs entry is necessary */ \
	30	US_FLAG(SCM_MULT_TARG, 0x00000004) \
	31	/* supports multiple targets */ \
	32	US_FLAG(FIX_INQUIRY, 0x00000008) \
	33	/* INQUIRY response needs faking */ \
	34	US_FLAG(FIX_CAPACITY, 0x00000010) \
	35	/* READ CAPACITY response too big */ \
	36	US_FLAG(IGNORE_RESIDUE, 0x00000020) \
	37	/* reported residue is wrong */ \
	38	US_FLAG(BULK32, 0x00000040) \
	39	/* Uses 32-byte CBW length */ \
	40	US_FLAG(NOT_LOCKABLE, 0x00000080) \
	41	/* PREVENT/ALLOW not supported */ \
	42	US_FLAG(GO_SLOW, 0x00000100) \
	43	/* Need delay after Command phase */ \
	44	US_FLAG(NO_WP_DETECT, 0x00000200) \
	45	/* Don't check for write-protect */ \
883d989a	46	US_FLAG(MAX_SECTORS_64, 0x00000400) \
3c332422 DD	47	/* Sets max_sectors to 64 */ \
3c332422 DD	48	US_FLAG(IGNORE_DEVICE, 0x00000800) \
61bf54b7 ON	49	/* Don't claim device */ \
61bf54b7 ON	50	US_FLAG(CAPACITY_HEURISTICS, 0x00001000) \
33abc04f DM	51	/* sometimes sizes is too big */ \
33abc04f DM	52	US_FLAG(MAX_SECTORS_MIN,0x00002000) \
cc36bdd4 CB	53	/* Sets max_sectors to arch min */ \
cc36bdd4 CB	54	US_FLAG(BULK_IGNORE_TAG,0x00004000) \
1537e0ad	55	/* Ignore tag mismatch in bulk operations */ \
25ff1c31 AS	56	US_FLAG(SANE_SENSE, 0x00008000) \
	57	/* Sane Sense (> 18 bytes) */ \
	58	US_FLAG(CAPACITY_OK, 0x00010000) \
a0bb1081 AS	59	/* READ CAPACITY response is correct */ \
	60	US_FLAG(BAD_SENSE, 0x00020000) \
	61	/* Bad Sense (never more than 18 bytes) */
a00828e9 PZ	62
	63	#define US_FLAG(name, value) US_FL_##name = value ,
	64	enum { US_DO_ALL_FLAGS };
	65	#undef US_FLAG
	66
	67	/*
	68	* The bias field for libusual and friends.
	69	*/
	70	#define USB_US_TYPE_NONE 0
	71	#define USB_US_TYPE_STOR 1 /* usb-storage */
	72	#define USB_US_TYPE_UB 2 /* ub */
	73
	74	#define USB_US_TYPE(flags) (((flags) >> 24) & 0xFF)
	75	#define USB_US_ORIG_FLAGS(flags) ((flags) & 0x00FFFFFF)
	76
	77	/*
	78	* This is probably not the best place to keep these constants, conceptually.
	79	* But it's the only header included into all places which need them.
	80	*/
	81
	82	/* Sub Classes */
	83
	84	#define US_SC_RBC 0x01 /* Typically, flash devices */
	85	#define US_SC_8020 0x02 /* CD-ROM */
	86	#define US_SC_QIC 0x03 /* QIC-157 Tapes */
	87	#define US_SC_UFI 0x04 /* Floppy */
	88	#define US_SC_8070 0x05 /* Removable media */
	89	#define US_SC_SCSI 0x06 /* Transparent */
676d3aa1	90	#define US_SC_LOCKABLE 0x07 /* Password-protected */
a00828e9	91
676d3aa1	92	#define US_SC_ISD200 0xf0 /* ISD200 ATA */
d277064e	93	#define US_SC_CYP_ATACB 0xf1 /* Cypress ATACB */
a00828e9 PZ	94	#define US_SC_DEVICE 0xff /* Use device's value */
	95
	96	/* Protocols */
	97
	98	#define US_PR_CBI 0x00 /* Control/Bulk/Interrupt */
	99	#define US_PR_CB 0x01 /* Control/Bulk w/o interrupt */
	100	#define US_PR_BULK 0x50 /* bulk only */
e6e244b6	101
a00828e9	102	#define US_PR_USBAT 0x80 /* SCM-ATAPI bridge */
a00828e9	103	#define US_PR_EUSB_SDDR09 0x81 /* SCM-SCSI bridge for SDDR-09 */
a00828e9	104	#define US_PR_SDDR55 0x82 /* SDDR-55 (made up) */
a00828e9	105	#define US_PR_DPCM_USB 0xf0 /* Combination CB/SDDR09 */
a00828e9	106	#define US_PR_FREECOM 0xf1 /* Freecom */
a00828e9	107	#define US_PR_DATAFAB 0xf2 /* Datafab chipsets */
a00828e9	108	#define US_PR_JUMPSHOT 0xf3 /* Lexar Jumpshot */
e80b0fad	109	#define US_PR_ALAUDA 0xf4 /* Alauda chipsets */
dfe0d3ba	110	#define US_PR_KARMA 0xf5 /* Rio Karma */
a00828e9 PZ	111
	112	#define US_PR_DEVICE 0xff /* Use device's value */
	113
	114	/*
	115	*/
e6e244b6 AS	116	extern int usb_usual_ignore_device(struct usb_interface *intf);
	117	extern struct usb_device_id usb_storage_usb_ids[];
	118
a00828e9 PZ	119	#ifdef CONFIG_USB_LIBUSUAL
a00828e9 PZ	120
a00828e9 PZ	121	extern void usb_usual_set_present(int type);
	122	extern void usb_usual_clear_present(int type);
	123	extern int usb_usual_check_type(const struct usb_device_id *, int type);
	124	#else
	125
	126	#define usb_usual_set_present(t) do { } while(0)
	127	#define usb_usual_clear_present(t) do { } while(0)
	128	#define usb_usual_check_type(id, t) (0)
	129	#endif /* CONFIG_USB_LIBUSUAL */
	130
	131	#endif /* __LINUX_USB_USUAL_H */