document msc host

tinyusb/class/hid_host.h

@@ -173,7 +173,7 @@ void tusbh_hid_mouse_isr(uint8_t dev_addr, tusb_event_t event);
  */
 void tusbh_hid_mouse_mounted_cb(uint8_t dev_addr);
 
-/** \brief 			Callback function that will be invoked when a device with Mouse  interface is unmounted
+/** \brief 			Callback function that will be invoked when a device with Mouse interface is unmounted
  * \param[in] 	dev_addr Address of newly unmounted device
  * \note        This callback should be used by Application to tear-down interface-related data
  */

tinyusb/class/msc.h

@@ -1,229 +1,230 @@
-/**************************************************************************/
-/*!
-    @file     msc.h
-    @author   hathach (tinyusb.org)
-
-    @section LICENSE
-
-    Software License Agreement (BSD License)
-
-    Copyright (c) 2013, hathach (tinyusb.org)
-    All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions are met:
-    1. Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-    2. Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
-    3. Neither the name of the copyright holders nor the
-    names of its contributors may be used to endorse or promote products
-    derived from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
-    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
-    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-    This file is part of the tinyusb stack.
-*/
-/**************************************************************************/
-
-/** \ingroup TBD
- *  \defgroup TBD
- *  \brief TBD
- *
- *  @{
- */
-
-#ifndef _TUSB_MSC_H_
-#define _TUSB_MSC_H_
-
-#include "common/common.h"
-
-#ifdef __cplusplus
- extern "C" {
-#endif
-
-//--------------------------------------------------------------------+
-// USB Class Constant
-//--------------------------------------------------------------------+
-enum {
-  MSC_SUBCLASS_RBC = 1 ,
-  MSC_SUBCLASS_SFF_MMC ,
-  MSC_SUBCLASS_QIC     ,
-  MSC_SUBCLASS_UFI     ,
-  MSC_SUBCLASS_SFF     ,
-  MSC_SUBCLASS_SCSI
-};
-
-enum {
-  MSC_CBW_SIGNATURE = 0x43425355,
-};
-
-// CBI only approved to use with full-speed floopy disk & should not used with highspeed or device other than floopy
-enum {
-  MSC_PROTOCOL_CBI              = 0,
-  MSC_PROTOCOL_CBI_NO_INTERRUPT = 1,
-  MSC_PROTOCOL_BOT              = 0x50
-};
-
-enum {
-  MSC_REQUEST_GET_MAX_LUN = 254,
-  MSC_REQUEST_RESET       = 255
-};
-
-typedef enum {
-  SCSI_CMD_TEST_UNIT_READY  = 0x00,
-  SCSI_CMD_INQUIRY          = 0x12,
-  SCSI_CMD_READ_CAPACITY_10 = 0x25,
-  SCSI_CMD_REQUEST_SENSE    = 0x03,
-  SCSI_CMD_READ_10          = 0x28,
-  SCSI_CMD_WRITE_10         = 0x2A,
-}scsi_cmd_type_t;
-
-typedef enum {
-  MSC_CSW_STATUS_PASSED = 0,
-  MSC_CSW_STATUS_FAILED,
-  MSC_CSW_STATUS_PHASE_ERROR
-}msc_csw_status_t;
-
-typedef ATTR_PACKED_STRUCT(struct) {
-  uint32_t signature; // const 0x43425355
-  uint32_t tag;
-  uint32_t xfer_bytes;
-  uint8_t  flags; // bit7 : direction
-  uint8_t  lun;
-  uint8_t  cmd_len;
-  uint8_t  command[16];
-}msc_cmd_block_wrapper_t;
-
-STATIC_ASSERT(sizeof(msc_cmd_block_wrapper_t) == 31, "size is not correct");
-
-typedef ATTR_PACKED_STRUCT(struct) {
-  uint32_t signature; // const 0x53425355
-  uint32_t tag;
-  uint32_t data_residue;
-  uint8_t  status;
-}msc_cmd_status_wrapper_t;
-
-STATIC_ASSERT(sizeof(msc_cmd_status_wrapper_t) == 13, "size is not correct");
-
-//--------------------------------------------------------------------+
-// SCSI Primary Command (SPC-4)
-//--------------------------------------------------------------------+
-typedef ATTR_PACKED_STRUCT(struct) {
-  uint8_t cmd_code;
-  uint8_t lun;
-  uint8_t reserved[3];
-  uint8_t control;
-} scsi_test_unit_ready_t;
-
-STATIC_ASSERT(sizeof(scsi_test_unit_ready_t) == 6, "size is not correct");
-
-typedef ATTR_PACKED_STRUCT(struct) {
-  uint8_t cmd_code;
-  uint8_t reserved1;
-  uint8_t page_code;
-  uint8_t reserved2;
-  uint8_t alloc_length;
-  uint8_t control;
-} scsi_inquiry_t, scsi_request_sense_t;
-
-STATIC_ASSERT(sizeof(scsi_inquiry_t) == 6, "size is not correct");
-
-typedef ATTR_PACKED_STRUCT(struct)
-{
-  uint8_t peripheral_device_type     : 5;
-  uint8_t peripheral_qualifier       : 3;
-
-  uint8_t                            : 7;
-  uint8_t is_removable               : 1;
-
-  uint8_t version;
-
-  uint8_t response_data_format       : 4;
-  uint8_t hierarchical_support       : 1;
-  uint8_t normal_aca                 : 1;
-  uint8_t                            : 2;
-
-  uint8_t additional_length;
-
-  uint8_t protect                    : 1;
-  uint8_t                            : 2;
-  uint8_t third_party_copy           : 1;
-  uint8_t target_port_group_support  : 2;
-  uint8_t access_control_coordinator : 1;
-  uint8_t scc_support                : 1;
-
-  uint8_t addr16                     : 1;
-  uint8_t                            : 3;
-  uint8_t multi_port                 : 1;
-  uint8_t                            : 1; // vendor specific
-  uint8_t enclosure_service          : 1;
-  uint8_t                            : 1;
-
-  uint8_t                            : 1; // vendor specific
-  uint8_t cmd_que                    : 1;
-  uint8_t                            : 2;
-  uint8_t sync                       : 1;
-  uint8_t wbus16                     : 1;
-  uint8_t                            : 2;
-
-  uint8_t vendor_id[8];
-  uint8_t product_id[16];
-  uint8_t product_revision[4];
-} scsi_inquiry_data_t;
-
-STATIC_ASSERT(sizeof(scsi_inquiry_data_t) == 36, "size is not correct");
-
-// test unit ready
-
-//--------------------------------------------------------------------+
-// SCSI Block Command (SBC-3)
-// NOTE: All data in SCSI command are in Big Endian
-//--------------------------------------------------------------------+
-typedef ATTR_PACKED_STRUCT(struct) {
-  uint8_t  cmd_code;
-  uint8_t  reserved1;
-  uint32_t lba;
-  uint16_t reserved2;
-  uint8_t  partial_medium_indicator;
-  uint8_t  control;
-} scsi_read_capacity10_t;
-
-STATIC_ASSERT(sizeof(scsi_read_capacity10_t) == 10, "size is not correct");
-
-typedef struct {
-  uint32_t last_lba;
-  uint32_t block_size;
-} scsi_read_capacity10_data_t;
-
-STATIC_ASSERT(sizeof(scsi_read_capacity10_data_t) == 8, "size is not correct");
-
-typedef ATTR_PACKED_STRUCT(struct) {
-  uint8_t  cmd_code;
-  uint8_t  reserved; // has LUN according to wiki
-  uint32_t lba;
-  uint8_t  reserved2;
-  uint16_t block_count;
-  uint8_t  control;
-} scsi_read10_t, scsi_write10_t;
-
-STATIC_ASSERT(sizeof(scsi_read10_t) == 10, "size is not correct");
-STATIC_ASSERT(sizeof(scsi_write10_t) == 10, "size is not correct");
-
-#ifdef __cplusplus
- }
-#endif
-
-#endif /* _TUSB_MSC_H_ */
-
-/** @} */
+/**************************************************************************/
+/*!
+    @file     msc.h
+    @author   hathach (tinyusb.org)
+
+    @section LICENSE
+
+    Software License Agreement (BSD License)
+
+    Copyright (c) 2013, hathach (tinyusb.org)
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+    1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+    3. Neither the name of the copyright holders nor the
+    names of its contributors may be used to endorse or promote products
+    derived from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
+    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+    This file is part of the tinyusb stack.
+*/
+/**************************************************************************/
+
+/**
+ *  \addtogroup ClassDriver Class Driver
+ *  @{
+ *  \defgroup ClassDriver_MSC MassStorage (MSC)
+ *  @{
+ */
+
+#ifndef _TUSB_MSC_H_
+#define _TUSB_MSC_H_
+
+#include "common/common.h"
+
+#ifdef __cplusplus
+ extern "C" {
+#endif
+
+//--------------------------------------------------------------------+
+// USB Class Constant
+//--------------------------------------------------------------------+
+enum {
+  MSC_SUBCLASS_RBC = 1 ,
+  MSC_SUBCLASS_SFF_MMC ,
+  MSC_SUBCLASS_QIC     ,
+  MSC_SUBCLASS_UFI     ,
+  MSC_SUBCLASS_SFF     ,
+  MSC_SUBCLASS_SCSI
+};
+
+enum {
+  MSC_CBW_SIGNATURE = 0x43425355,
+};
+
+// CBI only approved to use with full-speed floopy disk & should not used with highspeed or device other than floopy
+enum {
+  MSC_PROTOCOL_CBI              = 0,
+  MSC_PROTOCOL_CBI_NO_INTERRUPT = 1,
+  MSC_PROTOCOL_BOT              = 0x50
+};
+
+enum {
+  MSC_REQUEST_GET_MAX_LUN = 254,
+  MSC_REQUEST_RESET       = 255
+};
+
+typedef enum {
+  SCSI_CMD_TEST_UNIT_READY  = 0x00,
+  SCSI_CMD_INQUIRY          = 0x12,
+  SCSI_CMD_READ_CAPACITY_10 = 0x25,
+  SCSI_CMD_REQUEST_SENSE    = 0x03,
+  SCSI_CMD_READ_10          = 0x28,
+  SCSI_CMD_WRITE_10         = 0x2A,
+}scsi_cmd_type_t;
+
+typedef enum {
+  MSC_CSW_STATUS_PASSED = 0,
+  MSC_CSW_STATUS_FAILED,
+  MSC_CSW_STATUS_PHASE_ERROR
+}msc_csw_status_t;
+
+typedef ATTR_PACKED_STRUCT(struct) {
+  uint32_t signature; // const 0x43425355
+  uint32_t tag;
+  uint32_t xfer_bytes;
+  uint8_t  flags; // bit7 : direction
+  uint8_t  lun;
+  uint8_t  cmd_len;
+  uint8_t  command[16];
+}msc_cmd_block_wrapper_t;
+
+STATIC_ASSERT(sizeof(msc_cmd_block_wrapper_t) == 31, "size is not correct");
+
+typedef ATTR_PACKED_STRUCT(struct) {
+  uint32_t signature; // const 0x53425355
+  uint32_t tag;
+  uint32_t data_residue;
+  uint8_t  status;
+}msc_cmd_status_wrapper_t;
+
+STATIC_ASSERT(sizeof(msc_cmd_status_wrapper_t) == 13, "size is not correct");
+
+//--------------------------------------------------------------------+
+// SCSI Primary Command (SPC-4)
+//--------------------------------------------------------------------+
+typedef ATTR_PACKED_STRUCT(struct) {
+  uint8_t cmd_code;
+  uint8_t lun;
+  uint8_t reserved[3];
+  uint8_t control;
+} scsi_test_unit_ready_t;
+
+STATIC_ASSERT(sizeof(scsi_test_unit_ready_t) == 6, "size is not correct");
+
+typedef ATTR_PACKED_STRUCT(struct) {
+  uint8_t cmd_code;
+  uint8_t reserved1;
+  uint8_t page_code;
+  uint8_t reserved2;
+  uint8_t alloc_length;
+  uint8_t control;
+} scsi_inquiry_t, scsi_request_sense_t;
+
+STATIC_ASSERT(sizeof(scsi_inquiry_t) == 6, "size is not correct");
+
+typedef ATTR_PACKED_STRUCT(struct)
+{
+  uint8_t peripheral_device_type     : 5;
+  uint8_t peripheral_qualifier       : 3;
+
+  uint8_t                            : 7;
+  uint8_t is_removable               : 1;
+
+  uint8_t version;
+
+  uint8_t response_data_format       : 4;
+  uint8_t hierarchical_support       : 1;
+  uint8_t normal_aca                 : 1;
+  uint8_t                            : 2;
+
+  uint8_t additional_length;
+
+  uint8_t protect                    : 1;
+  uint8_t                            : 2;
+  uint8_t third_party_copy           : 1;
+  uint8_t target_port_group_support  : 2;
+  uint8_t access_control_coordinator : 1;
+  uint8_t scc_support                : 1;
+
+  uint8_t addr16                     : 1;
+  uint8_t                            : 3;
+  uint8_t multi_port                 : 1;
+  uint8_t                            : 1; // vendor specific
+  uint8_t enclosure_service          : 1;
+  uint8_t                            : 1;
+
+  uint8_t                            : 1; // vendor specific
+  uint8_t cmd_que                    : 1;
+  uint8_t                            : 2;
+  uint8_t sync                       : 1;
+  uint8_t wbus16                     : 1;
+  uint8_t                            : 2;
+
+  uint8_t vendor_id[8];
+  uint8_t product_id[16];
+  uint8_t product_revision[4];
+} scsi_inquiry_data_t;
+
+STATIC_ASSERT(sizeof(scsi_inquiry_data_t) == 36, "size is not correct");
+
+// test unit ready
+
+//--------------------------------------------------------------------+
+// SCSI Block Command (SBC-3)
+// NOTE: All data in SCSI command are in Big Endian
+//--------------------------------------------------------------------+
+typedef ATTR_PACKED_STRUCT(struct) {
+  uint8_t  cmd_code;
+  uint8_t  reserved1;
+  uint32_t lba;
+  uint16_t reserved2;
+  uint8_t  partial_medium_indicator;
+  uint8_t  control;
+} scsi_read_capacity10_t;
+
+STATIC_ASSERT(sizeof(scsi_read_capacity10_t) == 10, "size is not correct");
+
+typedef struct {
+  uint32_t last_lba;
+  uint32_t block_size;
+} scsi_read_capacity10_data_t;
+
+STATIC_ASSERT(sizeof(scsi_read_capacity10_data_t) == 8, "size is not correct");
+
+typedef ATTR_PACKED_STRUCT(struct) {
+  uint8_t  cmd_code;
+  uint8_t  reserved; // has LUN according to wiki
+  uint32_t lba;
+  uint8_t  reserved2;
+  uint16_t block_count;
+  uint8_t  control;
+} scsi_read10_t, scsi_write10_t;
+
+STATIC_ASSERT(sizeof(scsi_read10_t) == 10, "size is not correct");
+STATIC_ASSERT(sizeof(scsi_write10_t) == 10, "size is not correct");
+
+#ifdef __cplusplus
+ }
+#endif
+
+#endif /* _TUSB_MSC_H_ */
+
+/// @}
+/// @}

tinyusb/class/msc_host.h

@@ -1,120 +1,220 @@
-/**************************************************************************/
-/*!
-    @file     msc_host.h
-    @author   hathach (tinyusb.org)
-
-    @section LICENSE
-
-    Software License Agreement (BSD License)
-
-    Copyright (c) 2013, hathach (tinyusb.org)
-    All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions are met:
-    1. Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-    2. Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
-    3. Neither the name of the copyright holders nor the
-    names of its contributors may be used to endorse or promote products
-    derived from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
-    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
-    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-    INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION HOWEVER CAUSED AND
-    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS
-    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-    This file is part of the tinyusb stack.
-*/
-/**************************************************************************/
-
-/** \ingroup TBD
- *  \defgroup TBD
- *  \brief TBD
- *
- *  @{
- */
-
-#ifndef _TUSB_MSC_HOST_H_
-#define _TUSB_MSC_HOST_H_
-
-#include "common/common.h"
-#include "host/usbh.h"
-#include "msc.h"
-
-#ifdef __cplusplus
- extern "C" {
-#endif
-
-
-//--------------------------------------------------------------------+
-// MASS STORAGE Application API
-//--------------------------------------------------------------------+
-bool          tusbh_msc_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
-bool          tusbh_msc_is_busy(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
-bool          tusbh_msc_is_failed(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
-
-uint8_t const* tusbh_msc_get_vendor_name(uint8_t dev_addr);
-uint8_t const* tusbh_msc_get_product_name(uint8_t dev_addr);
-tusb_error_t tusbh_msc_get_capacity(uint8_t dev_addr, uint32_t* p_last_lba, uint32_t* p_block_size);
-
-tusb_error_t tusbh_msc_read10 (uint8_t dev_addr, uint8_t lun, void * p_buffer, uint32_t lba, uint16_t block_count) ATTR_WARN_UNUSED_RESULT;
-tusb_error_t tusbh_msc_write10(uint8_t dev_addr, uint8_t lun, void const * p_buffer, uint32_t lba, uint16_t block_count) ATTR_WARN_UNUSED_RESULT;
-tusb_error_t tusbh_msc_request_sense(uint8_t dev_addr, uint8_t lun, uint8_t *p_data) ATTR_WARN_UNUSED_RESULT;
-tusb_error_t tusbh_msc_test_unit_ready(uint8_t dev_addr, uint8_t lun, msc_cmd_status_wrapper_t * p_csw) ATTR_WARN_UNUSED_RESULT; // TODO to be refractor
-
-//tusb_error_t  tusbh_msc_inquiry(uint8_t dev_addr, scsi_inquiry_data_t * p_inquiry_data) ATTR_WARN_UNUSED_RESULT;
-//tusb_error_t  tusbh_msc_read_capacity10(uint8_t dev_addr, scsi_read_capacity10_t * p_buffer) ATTR_WARN_UNUSED_RESULT;
-
-//tusb_error_t  tusbh_msc_scsi_send(uint8_t dev_addr, uint8_t lun, bool is_direction_in,
-//                                  uint8_t const * p_command, uint8_t cmd_len,
-//                                  uint8_t * p_response, uint32_t resp_len) ATTR_WARN_UNUSED_RESULT;
-
-//------------- Application Callback -------------//
-void tusbh_msc_mounted_cb(uint8_t dev_addr);
-void tusbh_msc_unmounted_cb(uint8_t dev_addr);
-void tusbh_msc_isr(uint8_t dev_addr, tusb_event_t event, uint32_t xferred_bytes);
-
-
-//--------------------------------------------------------------------+
-// USBH-CLASS DRIVER API
-//--------------------------------------------------------------------+
-#ifdef _TINY_USB_SOURCE_FILE_
-
-typedef struct {
-  pipe_handle_t bulk_in, bulk_out;
-  uint8_t  interface_number;
-
-  uint8_t  max_lun;
-  uint16_t block_size;
-  uint32_t last_lba; // last logical block address
-
-  volatile bool is_initialized;
-  uint8_t vendor_id[8];
-  uint8_t product_id[16];
-
-  msc_cmd_block_wrapper_t cbw;
-  msc_cmd_status_wrapper_t csw;
-}msch_interface_t;
-
-void         msch_init(void);
-tusb_error_t msch_open_subtask(uint8_t dev_addr, tusb_descriptor_interface_t const *p_interface_desc, uint16_t *p_length) ATTR_WARN_UNUSED_RESULT;
-void         msch_isr(pipe_handle_t pipe_hdl, tusb_event_t event, uint32_t xferred_bytes);
-void         msch_close(uint8_t dev_addr);
-#endif
-
-#ifdef __cplusplus
- }
-#endif
-
-#endif /* _TUSB_MSC_HOST_H_ */
-
-/** @} */
+/**************************************************************************/
+/*!
+    @file     msc_host.h
+    @author   hathach (tinyusb.org)
+
+    @section LICENSE
+
+    Software License Agreement (BSD License)
+
+    Copyright (c) 2013, hathach (tinyusb.org)
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+    1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+    3. Neither the name of the copyright holders nor the
+    names of its contributors may be used to endorse or promote products
+    derived from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
+    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+    INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION HOWEVER CAUSED AND
+    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS
+    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+    This file is part of the tinyusb stack.
+*/
+/**************************************************************************/
+
+/** \addtogroup ClassDriver_MSC
+ *  @{ */
+
+#ifndef _TUSB_MSC_HOST_H_
+#define _TUSB_MSC_HOST_H_
+
+#include "common/common.h"
+#include "host/usbh.h"
+#include "msc.h"
+
+#ifdef __cplusplus
+ extern "C" {
+#endif
+
+/** \defgroup MSC_Host Host
+ *  The interface API includes status checking function, data transferring function and callback functions
+ *  @{ */
+//--------------------------------------------------------------------+
+// MASS STORAGE Application API
+//--------------------------------------------------------------------+
+/** \brief      Check if device supports MassStorage interface or not
+ * \param[in]   dev_addr    device address
+ * \retval      true if device supports
+ * \retval      false if device does not support or is not mounted
+ */
+bool          tusbh_msc_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
+
+/** \brief      Check if the interface is currently busy or not
+ * \param[in]   dev_addr device address
+ * \retval      true if the interface is busy meaning the stack is still transferring/waiting data from/to device
+ * \retval      false if the interface is not busy meaning the stack successfully transferred data from/to device
+ * \note        This function is primarily used for polling/waiting result after transferring API.
+ *              Alternatively, asynchronous event API can be used
+ */
+bool          tusbh_msc_is_busy(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
+
+bool          tusbh_msc_is_failed(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
+
+/** \brief      Get SCSI vendor's name of MassStorage device
+ * \param[in]   dev_addr device address
+ * \return      pointer to vendor's name or NULL if specified device does not support MassStorage
+ * \note        SCSI vendor's name is 8-byte length field in \ref scsi_inquiry_data_t. During enumeration, the stack has already
+ *              retrieved (via SCSI INQUIRY) and store this information internally. There is no need for application to re-send SCSI INQUIRY
+ *              command or allocate buffer for this.
+ */
+uint8_t const* tusbh_msc_get_vendor_name(uint8_t dev_addr);
+
+/** \brief      Get SCSI product's name of MassStorage device
+ * \param[in]   dev_addr device address
+ * \return      pointer to product's name or NULL if specified device does not support MassStorage
+ * \note        SCSI product's name is 16-byte length field in \ref scsi_inquiry_data_t. During enumeration, the stack has already
+ *              retrieved (via SCSI INQUIRY) and store this information internally. There is no need for application to re-send SCSI INQUIRY
+ *              command or allocate buffer for this.
+ */
+uint8_t const* tusbh_msc_get_product_name(uint8_t dev_addr);
+
+/** \brief      Get SCSI Capacity of MassStorage device
+ * \param[in]   dev_addr device address
+ * \param[out]  p_last_lba Last Logical Block Address of device
+ * \param[out]  p_block_size Block Size of device in bytes
+ * \retval      pointer to product's name or NULL if specified device does not support MassStorage
+ * \note        MassStorage's capacity can be computed by last LBA x block size (in bytes). During enumeration, the stack has already
+ *              retrieved (via SCSI READ CAPACITY 10) and store this information internally. There is no need for application
+ *              to re-send SCSI READ CAPACITY 10 command
+ */
+tusb_error_t tusbh_msc_get_capacity(uint8_t dev_addr, uint32_t* p_last_lba, uint32_t* p_block_size);
+
+/** \brief 			Perform SCSI READ 10 command to read data from MassStorage device
+ * \param[in]		dev_addr	device address
+ * \param[in]		lun       Targeted Logical Unit
+ * \param[out]	p_buffer  Buffer used to store data read from device. Must be accessible by USB controller (see \ref TUSB_CFG_ATTR_USBRAM)
+ * \param[in]		lba       Starting Logical Block Address to be read
+ * \param[in]		block_count Number of Block to be read
+ * \retval      TUSB_ERROR_NONE on success
+ * \retval      TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
+ * \retval      TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
+ * \retval      TUSB_ERROR_INVALID_PARA if inputs parameter are not correct
+ * \note        This function is non-blocking and returns immediately. The result of USB transfer will be reported by the interface's callback function
+ */
+tusb_error_t tusbh_msc_read10 (uint8_t dev_addr, uint8_t lun, void * p_buffer, uint32_t lba, uint16_t block_count) ATTR_WARN_UNUSED_RESULT;
+
+/** \brief 			Perform SCSI WRITE 10 command to write data to MassStorage device
+ * \param[in]		dev_addr	device address
+ * \param[in]		lun       Targeted Logical Unit
+ * \param[in]	  p_buffer  Buffer containing data. Must be accessible by USB controller (see \ref TUSB_CFG_ATTR_USBRAM)
+ * \param[in]		lba       Starting Logical Block Address to be written
+ * \param[in]		block_count Number of Block to be written
+ * \retval      TUSB_ERROR_NONE on success
+ * \retval      TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
+ * \retval      TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
+ * \retval      TUSB_ERROR_INVALID_PARA if inputs parameter are not correct
+ * \note        This function is non-blocking and returns immediately. The result of USB transfer will be reported by the interface's callback function
+ */
+tusb_error_t tusbh_msc_write10(uint8_t dev_addr, uint8_t lun, void const * p_buffer, uint32_t lba, uint16_t block_count) ATTR_WARN_UNUSED_RESULT;
+
+/** \brief 			Perform SCSI REQUEST SENSE command, used to retrieve sense data from MassStorage device
+ * \param[in]		dev_addr	device address
+ * \param[in]		lun       Targeted Logical Unit
+ * \param[in]	  p_data    Buffer to store response's data from device. Must be accessible by USB controller (see \ref TUSB_CFG_ATTR_USBRAM)
+ * \retval      TUSB_ERROR_NONE on success
+ * \retval      TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
+ * \retval      TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
+ * \retval      TUSB_ERROR_INVALID_PARA if inputs parameter are not correct
+ * \note        This function is non-blocking and returns immediately. The result of USB transfer will be reported by the interface's callback function
+ */
+tusb_error_t tusbh_msc_request_sense(uint8_t dev_addr, uint8_t lun, uint8_t *p_data) ATTR_WARN_UNUSED_RESULT;
+
+/** \brief 			Perform SCSI TEST UNIT READY command to test if MassStorage device is ready
+ * \param[in]		dev_addr	device address
+ * \param[in]		lun       Targeted Logical Unit
+ * \retval      TUSB_ERROR_NONE on success
+ * \retval      TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
+ * \retval      TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
+ * \retval      TUSB_ERROR_INVALID_PARA if inputs parameter are not correct
+ * \note        This function is non-blocking and returns immediately. The result of USB transfer will be reported by the interface's callback function
+ */
+tusb_error_t tusbh_msc_test_unit_ready(uint8_t dev_addr, uint8_t lun, msc_cmd_status_wrapper_t * p_csw) ATTR_WARN_UNUSED_RESULT; // TODO to be refractor
+
+//tusb_error_t  tusbh_msc_scsi_send(uint8_t dev_addr, uint8_t lun, bool is_direction_in,
+//                                  uint8_t const * p_command, uint8_t cmd_len,
+//                                  uint8_t * p_response, uint32_t resp_len) ATTR_WARN_UNUSED_RESULT;
+
+//------------- Application Callback -------------//
+/** \brief 			Callback function that will be invoked when a device with MassStorage interface is mounted
+ * \param[in]	  dev_addr Address of newly mounted device
+ * \note        This callback should be used by Application to set-up interface-related data
+ */
+void tusbh_msc_mounted_cb(uint8_t dev_addr);
+
+/** \brief 			Callback function that will be invoked when a device with MassStorage interface is unmounted
+ * \param[in] 	dev_addr Address of newly unmounted device
+ * \note        This callback should be used by Application to tear-down interface-related data
+ */
+void tusbh_msc_unmounted_cb(uint8_t dev_addr);
+
+/** \brief      Callback function that is invoked when an transferring event occurred
+ * \param[in]		dev_addr	Address of device
+ * \param[in]   event an value from \ref tusb_event_t
+ * \note        event can be one of following
+ *              - TUSB_EVENT_XFER_COMPLETE : previously scheduled transfer completes successfully.
+ *              - TUSB_EVENT_XFER_ERROR   : previously scheduled transfer encountered a transaction error.
+ *              - TUSB_EVENT_XFER_STALLED : previously scheduled transfer is stalled by device.
+ * \note
+ */
+void tusbh_msc_isr(uint8_t dev_addr, tusb_event_t event, uint32_t xferred_bytes);
+
+
+//--------------------------------------------------------------------+
+// USBH-CLASS DRIVER API
+//--------------------------------------------------------------------+
+#ifdef _TINY_USB_SOURCE_FILE_
+
+typedef struct {
+  pipe_handle_t bulk_in, bulk_out;
+  uint8_t  interface_number;
+
+  uint8_t  max_lun;
+  uint16_t block_size;
+  uint32_t last_lba; // last logical block address
+
+  volatile bool is_initialized;
+  uint8_t vendor_id[8];
+  uint8_t product_id[16];
+
+  msc_cmd_block_wrapper_t cbw;
+  msc_cmd_status_wrapper_t csw;
+}msch_interface_t;
+
+void         msch_init(void);
+tusb_error_t msch_open_subtask(uint8_t dev_addr, tusb_descriptor_interface_t const *p_interface_desc, uint16_t *p_length) ATTR_WARN_UNUSED_RESULT;
+void         msch_isr(pipe_handle_t pipe_hdl, tusb_event_t event, uint32_t xferred_bytes);
+void         msch_close(uint8_t dev_addr);
+#endif
+
+#ifdef __cplusplus
+ }
+#endif
+
+#endif /* _TUSB_MSC_HOST_H_ */
+
+/// @}
+/// @}