xref: /linux-6.15/include/linux/usb_usual.h (revision 87c2ce3b)
1 /*
2  * Interface to the libusual.
3  *
4  * Copyright (c) 2005 Pete Zaitcev <[email protected]>
5  * Copyright (c) 1999-2002 Matthew Dharm ([email protected])
6  * Copyright (c) 1999 Michael Gee ([email protected])
7  */
8 
9 #ifndef __LINUX_USB_USUAL_H
10 #define __LINUX_USB_USUAL_H
11 
12 #include <linux/config.h>
13 
14 /* We should do this for cleanliness... But other usb_foo.h do not do this. */
15 /* #include <linux/usb.h> */
16 
17 /*
18  * The flags field, which we store in usb_device_id.driver_info.
19  * It is compatible with the old usb-storage flags in lower 24 bits.
20  */
21 
22 /*
23  * Static flag definitions.  We use this roundabout technique so that the
24  * proc_info() routine can automatically display a message for each flag.
25  */
26 #define US_DO_ALL_FLAGS						\
27 	US_FLAG(SINGLE_LUN,	0x00000001)			\
28 		/* allow access to only LUN 0 */		\
29 	US_FLAG(NEED_OVERRIDE,	0x00000002)			\
30 		/* unusual_devs entry is necessary */		\
31 	US_FLAG(SCM_MULT_TARG,	0x00000004)			\
32 		/* supports multiple targets */			\
33 	US_FLAG(FIX_INQUIRY,	0x00000008)			\
34 		/* INQUIRY response needs faking */		\
35 	US_FLAG(FIX_CAPACITY,	0x00000010)			\
36 		/* READ CAPACITY response too big */		\
37 	US_FLAG(IGNORE_RESIDUE,	0x00000020)			\
38 		/* reported residue is wrong */			\
39 	US_FLAG(BULK32,		0x00000040)			\
40 		/* Uses 32-byte CBW length */			\
41 	US_FLAG(NOT_LOCKABLE,	0x00000080)			\
42 		/* PREVENT/ALLOW not supported */		\
43 	US_FLAG(GO_SLOW,	0x00000100)			\
44 		/* Need delay after Command phase */		\
45 	US_FLAG(NO_WP_DETECT,	0x00000200)			\
46 		/* Don't check for write-protect */		\
47 
48 #define US_FLAG(name, value)	US_FL_##name = value ,
49 enum { US_DO_ALL_FLAGS };
50 #undef US_FLAG
51 
52 /*
53  * The bias field for libusual and friends.
54  */
55 #define USB_US_TYPE_NONE   0
56 #define USB_US_TYPE_STOR   1		/* usb-storage */
57 #define USB_US_TYPE_UB     2		/* ub */
58 
59 #define USB_US_TYPE(flags) 		(((flags) >> 24) & 0xFF)
60 #define USB_US_ORIG_FLAGS(flags)	((flags) & 0x00FFFFFF)
61 
62 /*
63  * This is probably not the best place to keep these constants, conceptually.
64  * But it's the only header included into all places which need them.
65  */
66 
67 /* Sub Classes */
68 
69 #define US_SC_RBC	0x01		/* Typically, flash devices */
70 #define US_SC_8020	0x02		/* CD-ROM */
71 #define US_SC_QIC	0x03		/* QIC-157 Tapes */
72 #define US_SC_UFI	0x04		/* Floppy */
73 #define US_SC_8070	0x05		/* Removable media */
74 #define US_SC_SCSI	0x06		/* Transparent */
75 #define US_SC_ISD200    0x07		/* ISD200 ATA */
76 #define US_SC_MIN	US_SC_RBC
77 #define US_SC_MAX	US_SC_ISD200
78 
79 #define US_SC_DEVICE	0xff		/* Use device's value */
80 
81 /* Protocols */
82 
83 #define US_PR_CBI	0x00		/* Control/Bulk/Interrupt */
84 #define US_PR_CB	0x01		/* Control/Bulk w/o interrupt */
85 #define US_PR_BULK	0x50		/* bulk only */
86 #ifdef CONFIG_USB_STORAGE_USBAT
87 #define US_PR_USBAT	0x80		/* SCM-ATAPI bridge */
88 #endif
89 #ifdef CONFIG_USB_STORAGE_SDDR09
90 #define US_PR_EUSB_SDDR09	0x81	/* SCM-SCSI bridge for SDDR-09 */
91 #endif
92 #ifdef CONFIG_USB_STORAGE_SDDR55
93 #define US_PR_SDDR55	0x82		/* SDDR-55 (made up) */
94 #endif
95 #define US_PR_DPCM_USB  0xf0		/* Combination CB/SDDR09 */
96 #ifdef CONFIG_USB_STORAGE_FREECOM
97 #define US_PR_FREECOM   0xf1		/* Freecom */
98 #endif
99 #ifdef CONFIG_USB_STORAGE_DATAFAB
100 #define US_PR_DATAFAB   0xf2		/* Datafab chipsets */
101 #endif
102 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
103 #define US_PR_JUMPSHOT  0xf3		/* Lexar Jumpshot */
104 #endif
105 #ifdef CONFIG_USB_STORAGE_ALAUDA
106 #define US_PR_ALAUDA    0xf4		/* Alauda chipsets */
107 #endif
108 
109 #define US_PR_DEVICE	0xff		/* Use device's value */
110 
111 /*
112  */
113 #ifdef CONFIG_USB_LIBUSUAL
114 
115 extern struct usb_device_id storage_usb_ids[];
116 extern void usb_usual_set_present(int type);
117 extern void usb_usual_clear_present(int type);
118 extern int usb_usual_check_type(const struct usb_device_id *, int type);
119 #else
120 
121 #define usb_usual_set_present(t)	do { } while(0)
122 #define usb_usual_clear_present(t)	do { } while(0)
123 #define usb_usual_check_type(id, t)	(0)
124 #endif /* CONFIG_USB_LIBUSUAL */
125 
126 #endif /* __LINUX_USB_USUAL_H */
127