Debian Codegraph @

ports/stm32/usbhost/Class/MSC/Inc/usbh_msc_scsi.h

raw
1 /**
2 ******************************************************************************
3 * @file usbh_msc_scsi.h
4 * @author MCD Application Team
5 * @version V3.0.0
6 * @date 18-February-2014
7 * @brief Header file for usbh_msc_scsi.c
8 ******************************************************************************
9 * @attention
10 *
11 * <h2><center>&copy; COPYRIGHT 2014 STMicroelectronics</center></h2>
12 *
13 * Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
14 * You may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at:
16 *
17 * http://www.st.com/software_license_agreement_liberty_v2
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 ******************************************************************************
26 */
27
28 /* Define to prevent recursive ----------------------------------------------*/
29 #ifndef __USBH_MSC_SCSI_H__
30 #define __USBH_MSC_SCSI_H__
31
32 /* Includes ------------------------------------------------------------------*/
33 #include "usbh_core.h"
34
35
36 /** @addtogroup USBH_LIB
37 * @{
38 */
39
40 /** @addtogroup USBH_CLASS
41 * @{
42 */
43
44 /** @addtogroup USBH_MSC_CLASS
45 * @{
46 */
47
48 /** @defgroup USBH_MSC_SCSI
49 * @brief This file is the Header file for usbh_msc_scsi.c
50 * @{
51 */
52
53
54 // Capacity data.
55 typedef struct
56 {
57 uint32_t block_nbr;
58 uint16_t block_size;
59 } SCSI_CapacityTypeDef;
60
61
62 // Sense data.
63 typedef struct
64 {
65 uint8_t key;
66 uint8_t asc;
67 uint8_t ascq;
68 } SCSI_SenseTypeDef;
69
70 // INQUIRY data.
71 typedef struct
72 {
73 uint8_t PeripheralQualifier;
74 uint8_t DeviceType;
75 uint8_t RemovableMedia;
76 uint8_t vendor_id[9];
77 uint8_t product_id[17];
78 uint8_t revision_id[5];
79 }SCSI_StdInquiryDataTypeDef;
80
81 /** @defgroup USBH_MSC_SCSI_Exported_Defines
82 * @{
83 */
84 #define OPCODE_TEST_UNIT_READY 0x00
85 #define OPCODE_READ_CAPACITY10 0x25
86 #define OPCODE_READ10 0x28
87 #define OPCODE_WRITE10 0x2A
88 #define OPCODE_REQUEST_SENSE 0x03
89 #define OPCODE_INQUIRY 0x12
90
91 #define DATA_LEN_MODE_TEST_UNIT_READY 0
92 #define DATA_LEN_READ_CAPACITY10 8
93 #define DATA_LEN_INQUIRY 36
94 #define DATA_LEN_REQUEST_SENSE 14
95
96 #define CBW_CB_LENGTH 16
97 #define CBW_LENGTH 10
98
99 /** @defgroup USBH_MSC_SCSI_Exported_Defines
100 * @{
101 */
102 #define SCSI_SENSE_KEY_NO_SENSE 0x00
103 #define SCSI_SENSE_KEY_RECOVERED_ERROR 0x01
104 #define SCSI_SENSE_KEY_NOT_READY 0x02
105 #define SCSI_SENSE_KEY_MEDIUM_ERROR 0x03
106 #define SCSI_SENSE_KEY_HARDWARE_ERROR 0x04
107 #define SCSI_SENSE_KEY_ILLEGAL_REQUEST 0x05
108 #define SCSI_SENSE_KEY_UNIT_ATTENTION 0x06
109 #define SCSI_SENSE_KEY_DATA_PROTECT 0x07
110 #define SCSI_SENSE_KEY_BLANK_CHECK 0x08
111 #define SCSI_SENSE_KEY_VENDOR_SPECIFIC 0x09
112 #define SCSI_SENSE_KEY_COPY_ABORTED 0x0A
113 #define SCSI_SENSE_KEY_ABORTED_COMMAND 0x0B
114 #define SCSI_SENSE_KEY_VOLUME_OVERFLOW 0x0D
115 #define SCSI_SENSE_KEY_MISCOMPARE 0x0E
116 /**
117 * @}
118 */
119
120
121 /** @defgroup USBH_MSC_SCSI_Exported_Defines
122 * @{
123 */
124 #define SCSI_ASC_NO_ADDITIONAL_SENSE_INFORMATION 0x00
125 #define SCSI_ASC_LOGICAL_UNIT_NOT_READY 0x04
126 #define SCSI_ASC_INVALID_FIELD_IN_CDB 0x24
127 #define SCSI_ASC_WRITE_PROTECTED 0x27
128 #define SCSI_ASC_FORMAT_ERROR 0x31
129 #define SCSI_ASC_INVALID_COMMAND_OPERATION_CODE 0x20
130 #define SCSI_ASC_NOT_READY_TO_READY_CHANGE 0x28
131 #define SCSI_ASC_MEDIUM_NOT_PRESENT 0x3A
132 /**
133 * @}
134 */
135
136
137 /** @defgroup USBH_MSC_SCSI_Exported_Defines
138 * @{
139 */
140 #define SCSI_ASCQ_FORMAT_COMMAND_FAILED 0x01
141 #define SCSI_ASCQ_INITIALIZING_COMMAND_REQUIRED 0x02
142 #define SCSI_ASCQ_OPERATION_IN_PROGRESS 0x07
143
144 /**
145 * @}
146 */
147
148 /** @defgroup USBH_MSC_SCSI_Exported_Macros
149 * @{
150 */
151 /**
152 * @}
153 */
154
155 /** @defgroup _Exported_Variables
156 * @{
157 */
158
159 /**
160 * @}
161 */
162
163 /** @defgroup USBH_MSC_SCSI_Exported_FunctionsPrototype
164 * @{
165 */
166 USBH_StatusTypeDef USBH_MSC_SCSI_TestUnitReady (USBH_HandleTypeDef *phost,
167 uint8_t lun);
168
169 USBH_StatusTypeDef USBH_MSC_SCSI_ReadCapacity (USBH_HandleTypeDef *phost,
170 uint8_t lun,
171 SCSI_CapacityTypeDef *capacity);
172
173 USBH_StatusTypeDef USBH_MSC_SCSI_Inquiry (USBH_HandleTypeDef *phost,
174 uint8_t lun,
175 SCSI_StdInquiryDataTypeDef *inquiry);
176
177 USBH_StatusTypeDef USBH_MSC_SCSI_RequestSense (USBH_HandleTypeDef *phost,
178 uint8_t lun,
179 SCSI_SenseTypeDef *sense_data);
180
181 USBH_StatusTypeDef USBH_MSC_SCSI_Write(USBH_HandleTypeDef *phost,
182 uint8_t lun,
183 uint32_t address,
184 uint8_t *pbuf,
185 uint32_t length);
186
187 USBH_StatusTypeDef USBH_MSC_SCSI_Read(USBH_HandleTypeDef *phost,
188 uint8_t lun,
189 uint32_t address,
190 uint8_t *pbuf,
191 uint32_t length);
192
193
194 /**
195 * @}
196 */
197
198 #endif //__USBH_MSC_SCSI_H__
199
200
201 /**
202 * @}
203 */
204
205 /**
206 * @}
207 */
208
209 /**
210 * @}
211 */
212
213 /**
214 * @}
215 */
216
217 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
218