231 lines
7.0 KiB
C
231 lines
7.0 KiB
C
/**************************************************************************/
|
|
/*!
|
|
@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_ */
|
|
|
|
/// @}
|
|
/// @}
|