msc.h

Go to the documentation of this file.

/**************************************************************************/
/**************************************************************************/

#ifndef _TUSB_MSC_H_
#define _TUSB_MSC_H_

#include "common/common.h"

#ifdef __cplusplus
 extern "C" {
#endif

//--------------------------------------------------------------------+
// Mass Storage Class Constant
//--------------------------------------------------------------------+
typedef enum {
  MSC_SUBCLASS_RBC = 1 , 
  MSC_SUBCLASS_SFF_MMC , 
  MSC_SUBCLASS_QIC     , 
  MSC_SUBCLASS_UFI     , 
  MSC_SUBCLASS_SFF     , 
  MSC_SUBCLASS_SCSI      
}msc_subclass_type_t;

enum {
  MSC_CBW_SIGNATURE = 0x43425355, 
  MSC_CSW_SIGNATURE = 0x53425355  
};

typedef enum {
  MSC_PROTOCOL_CBI              = 0 ,  
  MSC_PROTOCOL_CBI_NO_INTERRUPT = 1 ,  
  MSC_PROTOCOL_BOT              = 0x50 
}msc_protocol_type_t;

typedef enum {
  MSC_REQUEST_GET_MAX_LUN = 254, 
  MSC_REQUEST_RESET       = 255  
}msc_request_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   ; 
  uint32_t tag         ; 
  uint32_t xfer_bytes  ; 
  uint8_t  dir         ; 
  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    ; 
  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 Constant
//--------------------------------------------------------------------+

typedef enum {
  SCSI_CMD_TEST_UNIT_READY              = 0x00, 
  SCSI_CMD_INQUIRY                      = 0x12, 
  SCSI_CMD_MODE_SELECT_6                = 0x15, 
  SCSI_CMD_MODE_SENSE_6                 = 0x1A, 
  SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL = 0x1E,
  SCSI_CMD_READ_CAPACITY_10             = 0x25, 
  SCSI_CMD_REQUEST_SENSE                = 0x03, 
  SCSI_CMD_READ_FORMAT_CAPACITY         = 0x23, 
  SCSI_CMD_READ_10                      = 0x28, 
  SCSI_CMD_WRITE_10                     = 0x2A, 
}scsi_cmd_type_t;

typedef enum {
  SCSI_SENSEKEY_NONE            = 0x00, 
  SCSI_SENSEKEY_RECOVERED_ERROR = 0x01, 
  SCSI_SENSEKEY_NOT_READY       = 0x02, 
  SCSI_SENSEKEY_MEDIUM_ERROR    = 0x03, 
  SCSI_SENSEKEY_HARDWARE_ERROR  = 0x04, 
  SCSI_SENSEKEY_ILLEGLA_REQUEST = 0x05, 
  SCSI_SENSEKEY_UNIT_ATTENTION  = 0x06, 
  SCSI_SENSEKEY_DATA_PROTECT    = 0x07, 
  SCSI_SENSEKEY_FIRMWARE_ERROR  = 0x08, 
  SCSI_SENSEKEY_ABORTED_COMMAND = 0x0b, 
  SCSI_SENSEKEY_EQUAL           = 0x0c, 
  SCSI_SENSEKEY_VOLUME_OVERFLOW = 0x0d, 
  SCSI_SENSEKEY_MISCOMPARE      = 0x0e  
}scsi_sense_key_type_t;

//--------------------------------------------------------------------+
// 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");


typedef ATTR_PACKED_STRUCT(struct) {
  uint8_t response_code           : 7; 
  uint8_t valid                   : 1;

  uint8_t reserved; 

  uint8_t sense_key               : 4;
  uint8_t                         : 1;
  uint8_t incorrect_len_idicatior : 1;
  uint8_t end_of_medium           : 1;
  uint8_t filemark                : 1;

  uint32_t information;
  uint8_t  additional_sense_len;
  uint32_t command_specific_info;
  uint8_t additional_sense_code;
  uint8_t additional_sense_qualifier;
  uint8_t field_replaceable_unit_code;

  uint8_t sense_key_specific[3]; 

} scsi_sense_fixed_data_t;

STATIC_ASSERT(sizeof(scsi_sense_fixed_data_t) == 18, "size is not correct");

typedef ATTR_PACKED_STRUCT(struct) {
  uint8_t cmd_code     ; 

  uint8_t : 3;
  uint8_t disable_block_descriptor : 1;
  uint8_t : 0;

  uint8_t page_code : 6;
  uint8_t page_control : 2;

  uint8_t subpage_code;
  uint8_t alloc_length;
  uint8_t control;
} scsi_mode_sense_6_t;

STATIC_ASSERT( sizeof(scsi_mode_sense_6_t) == 6, "size is not correct");

typedef ATTR_PACKED_STRUCT(struct) {
  uint8_t mode_data_length;
  uint8_t medium_type;
  uint8_t device_specific_para;
  uint8_t block_descriptor_length;
} scsi_mode_parameters_t;

STATIC_ASSERT( sizeof(scsi_mode_parameters_t) == 4, "size is not correct");

typedef ATTR_PACKED_STRUCT(struct) {
  uint8_t cmd_code; 
  uint8_t reserved[3];
  uint8_t prohibit_removal;
  uint8_t control;
} scsi_prevent_allow_medium_removal_t;

STATIC_ASSERT( sizeof(scsi_prevent_allow_medium_removal_t) == 6, "size is not correct");

//--------------------------------------------------------------------+
// SCSI MMC
//--------------------------------------------------------------------+
typedef ATTR_PACKED_STRUCT(struct) {
  uint8_t cmd_code;
  uint8_t reserved[6];
  uint16_t alloc_length;
  uint8_t control;
} scsi_read_format_capacity_t;

STATIC_ASSERT( sizeof(scsi_read_format_capacity_t) == 10, "size is not correct");

typedef ATTR_PACKED_STRUCT(struct){
  uint8_t reserved[3];
  uint8_t list_length; 

  uint32_t block_num; 
  uint8_t  descriptor_type; // 00: reserved, 01 unformatted media , 10 Formatted media, 11 No media present

  uint8_t  reserved2;
  uint16_t block_size_u16;

} scsi_read_format_capacity_data_t;

STATIC_ASSERT( sizeof(scsi_read_format_capacity_data_t) == 12, "size is not correct");

//--------------------------------------------------------------------+
// 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_ */