1// SPDX-License-Identifier: GPL-2.0
2#ifndef __LINUX_USB_STORAGE_H
3#define __LINUX_USB_STORAGE_H
4
5/*
6 * linux/usb/storage.h
7 *
8 * Copyright Matthew Wilcox for Intel Corp, 2010
9 *
10 * This file contains definitions taken from the
11 * USB Mass Storage Class Specification Overview
12 */
13
14/* Storage subclass codes */
15
16#define USB_SC_RBC 0x01 /* Typically, flash devices */
17#define USB_SC_8020 0x02 /* CD-ROM */
18#define USB_SC_QIC 0x03 /* QIC-157 Tapes */
19#define USB_SC_UFI 0x04 /* Floppy */
20#define USB_SC_8070 0x05 /* Removable media */
21#define USB_SC_SCSI 0x06 /* Transparent */
22#define USB_SC_LOCKABLE 0x07 /* Password-protected */
23
24#define USB_SC_ISD200 0xf0 /* ISD200 ATA */
25#define USB_SC_CYP_ATACB 0xf1 /* Cypress ATACB */
26#define USB_SC_DEVICE 0xff /* Use device's value */
27
28/* Storage protocol codes */
29
30#define USB_PR_CBI 0x00 /* Control/Bulk/Interrupt */
31#define USB_PR_CB 0x01 /* Control/Bulk w/o interrupt */
32#define USB_PR_BULK 0x50 /* bulk only */
33#define USB_PR_UAS 0x62 /* USB Attached SCSI */
34
35#define USB_PR_USBAT 0x80 /* SCM-ATAPI bridge */
36#define USB_PR_EUSB_SDDR09 0x81 /* SCM-SCSI bridge for SDDR-09 */
37#define USB_PR_SDDR55 0x82 /* SDDR-55 (made up) */
38#define USB_PR_DPCM_USB 0xf0 /* Combination CB/SDDR09 */
39#define USB_PR_FREECOM 0xf1 /* Freecom */
40#define USB_PR_DATAFAB 0xf2 /* Datafab chipsets */
41#define USB_PR_JUMPSHOT 0xf3 /* Lexar Jumpshot */
42#define USB_PR_ALAUDA 0xf4 /* Alauda chipsets */
43#define USB_PR_KARMA 0xf5 /* Rio Karma */
44
45#define USB_PR_DEVICE 0xff /* Use device's value */
46
47/*
48 * Bulk only data structures
49 */
50
51/* command block wrapper */
52struct bulk_cb_wrap {
53 __le32 Signature; /* contains 'USBC' */
54 __u32 Tag; /* unique per command id */
55 __le32 DataTransferLength; /* size of data */
56 __u8 Flags; /* direction in bit 7 */
57 __u8 Lun; /* LUN normally 0 */
58 __u8 Length; /* length of the CDB */
59 __u8 CDB[16]; /* max command */
60};
61
62#define US_BULK_CB_WRAP_LEN 31
63#define US_BULK_CB_SIGN 0x43425355 /* spells out 'USBC' */
64#define US_BULK_FLAG_IN (1 << 7)
65#define US_BULK_FLAG_OUT 0
66
67/* command status wrapper */
68struct bulk_cs_wrap {
69 __le32 Signature; /* contains 'USBS' */
70 __u32 Tag; /* same as original command */
71 __le32 Residue; /* amount not transferred */
72 __u8 Status; /* see below */
73};
74
75#define US_BULK_CS_WRAP_LEN 13
76#define US_BULK_CS_SIGN 0x53425355 /* spells out 'USBS' */
77#define US_BULK_STAT_OK 0
78#define US_BULK_STAT_FAIL 1
79#define US_BULK_STAT_PHASE 2
80
81/* bulk-only class specific requests */
82#define US_BULK_RESET_REQUEST 0xff
83#define US_BULK_GET_MAX_LUN 0xfe
84
85/*
86 * If 4 LUNs are supported then the LUNs would be
87 * numbered from 0 to 3, and the return value for
88 * US_BULK_GET_MAX_LUN request would be 3. The valid
89 * LUN field is 4 bits wide, the upper limit is 0x0f.
90 */
91#define US_BULK_MAX_LUN_LIMIT 0x0f
92
93#endif
94