msdscsi.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef __MSDSCSI_H
#define __MSDSCSI_H

/***************************************************************************/
/***************************************************************************/
#ifdef __cplusplus
extern "C" {
#endif

#define SCSI_TESTUNIT_READY          0x00 
#define SCSI_REQUESTSENSE            0x03 
#define SCSI_INQUIRY                 0x12 
#define SCSI_STARTSTOP_UNIT          0x1B 
#define SCSI_READCAPACITY            0x25 
#define SCSI_READ10                  0x28 
#define SCSI_WRITE10                 0x2A 
#define SCSI_VERIFY10                0x2F 
#define SCSI_READ10_LEN              10U  
#define SCSI_WRITE10_LEN             10U  
#define SCSI_VERIFY10_LEN            10U  
#define SCSI_INQUIRYDATA_LEN         36U  
#define SCSI_STARTSTOPUNIT_LEN       6U   
#define SCSI_REQUESTSENSE_LEN        6U   
#define SCSI_REQUESTSENSEDATA_LEN    18U  
#define SCSI_READCAPACITY_LEN        10U  
#define SCSI_READCAPACITYDATA_LEN    8U   
/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  uint8_t  OpCode;                
  struct
  {
    uint8_t Evpd     : 1;         
    uint8_t Obsolete : 1;         
    uint8_t Reserved : 6;         
  };
  uint8_t  PageCode;              
  uint16_t AllocationLength;      
  uint8_t  Control;               
} SL_ATTRIBUTE_PACKED MSDSCSI_Inquiry_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  struct
  {
    uint8_t PeripheralDeviceType : 5; 
    uint8_t PeripheralQualifier  : 3; 
  };
  struct
  {
    uint8_t Reserved1 : 7;        
    uint8_t Removable : 1;        
  };
  uint8_t Version;                
  struct
  {
    uint8_t ResponseDataFormat : 4; 
    uint8_t HiSup              : 1; 
    uint8_t NormACA            : 1; 
    uint8_t Obsolete1          : 2; 
  };
  uint8_t AdditionalLength;         
  struct
  {
    uint8_t Protect        : 1;     
    uint8_t Reserved2      : 2;     
    uint8_t ThirdPartyCode : 1;     
    uint8_t Tpgs           : 2;     
    uint8_t Acc            : 1;     
    uint8_t Sccs           : 1;     
  };
  struct
  {
    uint8_t Addr16    : 1;          
    uint8_t Obsolete2 : 2;          
    uint8_t MChngr    : 1;          
    uint8_t MultiP    : 1;          
    uint8_t Vs1       : 1;          
    uint8_t EncServ   : 1;          
    uint8_t BQue      : 1;          
  };
  struct
  {
    uint8_t Vs2       : 1;          
    uint8_t CmdQue    : 1;          
    uint8_t Obsolete3 : 1;          
    uint8_t Linked    : 1;          
    uint8_t Sync      : 1;          
    uint8_t Wbus16    : 1;          
    uint8_t Obsolete4 : 2;          
  };
  uint8_t T10VendorId[ 8 ];         
  uint8_t ProductId[ 16 ];          
  uint8_t ProductRevisionLevel[ 4 ]; 
} SL_ATTRIBUTE_PACKED MSDSCSI_InquiryData_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  uint8_t OpCode;                 
  struct
  {
    uint8_t Desc      : 1;        
    uint8_t Reserved1 : 7;        
  };
  uint8_t Reserved2;              
  uint8_t Reserved3;              
  uint8_t AllocationLength;       
  uint8_t Control;                
} SL_ATTRIBUTE_PACKED MSDSCSI_RequestSense_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  struct
  {
    uint8_t ResponseCode : 7;     
    uint8_t Valid        : 1;     
  };
  uint8_t  Obsolete;              
  struct
  {
    uint8_t SenseKey : 4;         
    uint8_t Reserved : 1;         
    uint8_t Ili      : 1;         
    uint8_t Eom      : 1;         
    uint8_t FileMark : 1;         
  };
  uint32_t Information;           
  uint8_t  AdditionalLength;      
  uint32_t CmdSpecificInfo;       
  uint8_t  Asc;                   
  uint8_t  Ascq;                  
  uint8_t  Fruc;                  
  struct
  {
    uint8_t SenseKeySpecific1 : 7;  
    uint8_t Sksv              : 1;  
  };
  uint8_t  SenseKeySpecific2;       
  uint8_t  SenseKeySpecific3;       
} SL_ATTRIBUTE_PACKED MSDSCSI_RequestSenseData_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  uint8_t  OpCode;                
  struct
  {
    uint8_t Obsolete  : 1;        
    uint8_t Reserved1 : 7;        
  };
  uint32_t Lba;                   
  uint16_t Reserved2;             
  struct
  {
    uint8_t Pmi       : 1;        
    uint8_t Reserved3 : 7;        
  };
  uint8_t  Control;               
} SL_ATTRIBUTE_PACKED MSDSCSI_ReadCapacity_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  uint32_t LogicalBlockAddress; 
  uint32_t LogicalBlockLength;  
} SL_ATTRIBUTE_PACKED MSDSCSI_ReadCapacityData_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  uint8_t  OpCode;                
  struct
  {
    uint8_t Obsolete  : 1;        
    uint8_t FuaNv     : 1;        
    uint8_t Reserved1 : 1;        
    uint8_t Fua       : 1;        
    uint8_t Dpo       : 1;        
    uint8_t RdProtect : 3;        
  };
  uint32_t Lba;                   
  struct
  {
    uint8_t GroupNumber : 5;      
    uint8_t Reserved2   : 3;      
  };
  uint16_t TransferLength;        
  uint8_t  Control;               
} SL_ATTRIBUTE_PACKED MSDSCSI_Read10_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  uint8_t  OpCode;                
  struct
  {
    uint8_t Obsolete  : 1;        
    uint8_t FuaNv     : 1;        
    uint8_t Reserved1 : 1;        
    uint8_t Fua       : 1;        
    uint8_t Dpo       : 1;        
    uint8_t WrProtect : 3;        
  };
  uint32_t Lba;                   
  struct
  {
    uint8_t GroupNumber : 5;      
    uint8_t Reserved2   : 3;      
  };
  uint16_t TransferLength;        
  uint8_t  Control;               
} SL_ATTRIBUTE_PACKED MSDSCSI_Write10_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  uint8_t  OpCode;                
  struct
  {
    uint8_t Obsolete  : 1;        
    uint8_t BytChk    : 1;        
    uint8_t Reserved1 : 2;        
    uint8_t Dpo       : 1;        
    uint8_t VrProtect : 3;        
  };
  uint32_t Lba;                   
  struct
  {
    uint8_t GroupNumber : 5;      
    uint8_t Reserved2   : 2;      
    uint8_t Restricted  : 1;      
  };
  uint16_t Verification;          
  uint8_t  Control;               
} SL_ATTRIBUTE_PACKED MSDSCSI_Verify10_TypeDef;
SL_PACK_END()

/**************************************************************************/
SL_PACK_START(1)
typedef struct
{
  uint8_t  OpCode;                
  struct
  {
    uint8_t Immed     : 1;        
    uint8_t Reserved1 : 7;        
  };
  uint8_t Reserved2;              
  struct
  {
    uint8_t PowerConditionModifier : 4; 
    uint8_t Reserved3      : 4;   
  };
  struct
  {
    uint8_t Start          : 1;   
    uint8_t LoEj           : 1;   
    uint8_t No_Flush       : 1;   
    uint8_t Reserved4      : 1;   
    uint8_t PowerCondition : 4;   
  };
  uint8_t Control;                
} SL_ATTRIBUTE_PACKED MSDSCSI_StartStopUnit_TypeDef;
SL_PACK_END()

/*** MSDSCSI Function prototypes ***/

#if defined(USB_HOST)

bool MSDSCSI_Init(USBH_Ep_TypeDef *out, USBH_Ep_TypeDef *in);
bool MSDSCSI_Inquiry(MSDSCSI_InquiryData_TypeDef *data);
bool MSDSCSI_Read10(uint32_t lba, uint16_t sectors, void *data);
bool MSDSCSI_ReadCapacity(MSDSCSI_ReadCapacityData_TypeDef *data);
bool MSDSCSI_RequestSense(MSDSCSI_RequestSenseData_TypeDef *data);
bool MSDSCSI_TestUnitReady(void);
bool MSDSCSI_Write10(uint32_t lba, uint16_t sectors, const void *data);

#endif

#ifdef __cplusplus
}
#endif

#endif /* __MSDSCSI_H */