Merge pull request #93 from zyp/master
[fw/stlink] / example / stm32f4 / STM32_USB_HOST_Library / Class / MSC / inc / usbh_msc_scsi.h
1 /**
2   ******************************************************************************
3   * @file    usbh_msc_scsi.h
4   * @author  MCD Application Team
5   * @version V2.0.0
6   * @date    22-July-2011
7   * @brief   Header file for usbh_msc_scsi.c
8   ******************************************************************************
9   * @attention
10   *
11   * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
12   * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
13   * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
14   * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
15   * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
16   * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
17   *
18   * <h2><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h2>
19   ******************************************************************************
20   */ 
21
22 /* Define to prevent recursive  ----------------------------------------------*/
23 #ifndef __USBH_MSC_SCSI_H__
24 #define __USBH_MSC_SCSI_H__
25
26 /* Includes ------------------------------------------------------------------*/
27 #include "usbh_stdreq.h"
28
29
30 /** @addtogroup USBH_LIB
31   * @{
32   */
33
34 /** @addtogroup USBH_CLASS
35   * @{
36   */
37
38 /** @addtogroup USBH_MSC_CLASS
39   * @{
40   */
41   
42 /** @defgroup USBH_MSC_SCSI
43   * @brief This file is the Header file for usbh_msc_scsi.c
44   * @{
45   */ 
46
47
48 /** @defgroup USBH_MSC_SCSI_Exported_Types
49   * @{
50   */ 
51 typedef enum {
52   USBH_MSC_OK = 0,
53   USBH_MSC_FAIL = 1,
54   USBH_MSC_PHASE_ERROR = 2,
55   USBH_MSC_BUSY = 3
56 }USBH_MSC_Status_TypeDef;
57
58 typedef enum {
59   CMD_UNINITIALIZED_STATE =0,
60   CMD_SEND_STATE,
61   CMD_WAIT_STATUS
62 } CMD_STATES_TypeDef;  
63
64
65
66 typedef struct __MassStorageParameter
67 {
68   uint32_t MSCapacity;
69   uint32_t MSSenseKey; 
70   uint16_t MSPageLength;
71   uint8_t MSBulkOutEp;
72   uint8_t MSBulkInEp;
73   uint8_t MSWriteProtect;
74 } MassStorageParameter_TypeDef;
75 /**
76   * @}
77   */ 
78
79
80
81 /** @defgroup USBH_MSC_SCSI_Exported_Defines
82   * @{
83   */ 
84
85
86
87 #define OPCODE_TEST_UNIT_READY            0X00
88 #define OPCODE_READ_CAPACITY10            0x25
89 #define OPCODE_MODE_SENSE6                0x1A
90 #define OPCODE_READ10                     0x28
91 #define OPCODE_WRITE10                    0x2A
92 #define OPCODE_REQUEST_SENSE              0x03
93
94 #define DESC_REQUEST_SENSE                0X00
95 #define ALLOCATION_LENGTH_REQUEST_SENSE   63 
96 #define XFER_LEN_READ_CAPACITY10           8
97 #define XFER_LEN_MODE_SENSE6              63
98
99 #define MASK_MODE_SENSE_WRITE_PROTECT     0x80
100 #define MODE_SENSE_PAGE_CONTROL_FIELD     0x00
101 #define MODE_SENSE_PAGE_CODE              0x3F
102 #define DISK_WRITE_PROTECTED              0x01
103 /**
104   * @}
105   */ 
106
107 /** @defgroup USBH_MSC_SCSI_Exported_Macros
108   * @{
109   */ 
110 /**
111   * @}
112   */ 
113
114 /** @defgroup _Exported_Variables
115   * @{
116   */ 
117 extern MassStorageParameter_TypeDef USBH_MSC_Param;
118 /**
119   * @}
120   */ 
121
122 /** @defgroup USBH_MSC_SCSI_Exported_FunctionsPrototype
123   * @{
124   */ 
125 uint8_t USBH_MSC_TestUnitReady(USB_OTG_CORE_HANDLE *pdev);
126 uint8_t USBH_MSC_ReadCapacity10(USB_OTG_CORE_HANDLE *pdev);
127 uint8_t USBH_MSC_ModeSense6(USB_OTG_CORE_HANDLE *pdev);
128 uint8_t USBH_MSC_RequestSense(USB_OTG_CORE_HANDLE *pdev);
129 uint8_t USBH_MSC_Write10(USB_OTG_CORE_HANDLE *pdev,
130                          uint8_t *,
131                          uint32_t ,
132                          uint32_t );
133 uint8_t USBH_MSC_Read10(USB_OTG_CORE_HANDLE *pdev,
134                         uint8_t *,
135                         uint32_t ,
136                         uint32_t );
137 void USBH_MSC_StateMachine(USB_OTG_CORE_HANDLE *pdev);
138
139 /**
140   * @}
141   */ 
142
143 #endif  //__USBH_MSC_SCSI_H__
144
145
146 /**
147   * @}
148   */ 
149
150 /**
151   * @}
152   */ 
153
154 /**
155   * @}
156   */ 
157
158 /**
159   * @}
160   */
161
162 /******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/
163