scsi.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2019-2021 Mesotic SAS
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "byteorder.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef USBUS_MSC_VENDOR_ID
#define USBUS_MSC_VENDOR_ID "RIOT-OS"
#endif /* USBUS_MSC_VENDOR_ID */
 
#ifndef USBUS_MSC_PRODUCT_ID
#define USBUS_MSC_PRODUCT_ID "RIOT_MSC_DISK  "
#endif /* USBUS_MSC_PRODUCT_ID */
 
#ifndef USBUS_MSC_PRODUCT_REV
#define USBUS_MSC_PRODUCT_REV " 1.0"
#endif /* USBUS_MSC_PRODUCT_REV */

#define SCSI_TEST_UNIT_READY            0x00    
#define SCSI_REQUEST_SENSE              0x03    
#define SCSI_FORMAT_UNIT                0x04    
#define SCSI_INQUIRY                    0x12    
#define SCSI_MODE_SELECT6               0x15    
#define SCSI_MODE_SENSE6                0x1A    
#define SCSI_START_STOP_UNIT            0x1B    
#define SCSI_MEDIA_REMOVAL              0x1E    
#define SCSI_READ_FORMAT_CAPACITIES     0x23    
#define SCSI_READ_CAPACITY              0x25    
#define SCSI_READ10                     0x28    
#define SCCI_READ12                     0xA8    
#define SCSI_WRITE10                    0x2A    
#define SCSI_WRITE12                    0xAA    
#define SCSI_SEEK                       0x2B    
#define SCSI_WRITE_AND_VERIFY           0x2E    
#define SCSI_VERIFY10                   0x2F    
#define SCSI_MODE_SELECT10              0x55    
#define SCSI_MODE_SENSE10               0x5A    

#define SCSI_CBW_SIGNATURE              0x43425355

#define SCSI_CSW_SIGNATURE              0x53425355

#define SCSI_VERSION_NONE               0x0000
#define SCSI_VERSION_SCSI1              0x0001
#define SCSI_VERSION_SCSI2              0x0002

#define SCSI_READ_FMT_CAPA_TYPE_RESERVED    0x00
#define SCSI_READ_FMT_CAPA_TYPE_UNFORMATTED 0x01
#define SCSI_READ_FMT_CAPA_TYPE_FORMATTED   0x02
#define SCSI_READ_FMT_CAPA_TYPE_NO_MEDIA    0x03

#define SCSI_REQUEST_SENSE_ERROR              0x70

#define SCSI_SENSE_KEY_NO_SENSE             0x00
#define SCSI_SENSE_KEY_RECOVERED_ERROR      0x01
#define SCSI_SENSE_KEY_NOT_READY            0x02
#define SCSI_SENSE_KEY_MEDIUM_ERROR         0x03
#define SCSI_SENSE_KEY_HARDWARE_ERROR       0x04
#define SCSI_SENSE_KEY_ILLEGAL_REQUEST      0x05
#define SCSI_SENSE_KEY_UNIT_ATTENTION       0x06
#define SCSI_SENSE_KEY_DATA_PROTECT         0x07
#define SCSI_SENSE_KEY_BLANK_CHECK          0x08
#define SCSI_SENSE_KEY_VENDOR_SPECIFIC      0x09
#define SCSI_SENSE_KEY_ABORTED_COMMAND      0x0B
#define SCSI_SENSE_KEY_VOLUME_OVERFLOW      0x0D
#define SCSI_SENSE_KEY_MISCOMPARE           0x0E

typedef struct __attribute__((packed)) {
    uint8_t type;           
    uint8_t logical_unit;   
    uint8_t reserved[10];   
} msc_test_unit_pkt_t;

typedef struct __attribute__((packed)) {
    uint8_t mode_data_len;      
    uint8_t medium_type;        
    uint8_t flags;              
    uint8_t block_desc_len;     
} msc_mode_parameter_pkt_t;

typedef struct __attribute__((packed)) {
    uint8_t opcode;         
    uint8_t flags;          
    be_uint32_t blk_addr;   
    uint8_t group_number;   
    be_uint16_t xfer_len;   
} msc_cbw_rw10_pkt_t;

typedef struct __attribute__((packed)) {
    uint8_t type;                   
    uint8_t reserved1 : 7;          
    uint8_t removable : 1;          
    uint8_t version;                
    uint8_t response_format : 4;    
    uint8_t reserved3 : 4;          
    uint8_t length;                 
    uint8_t flags[3];               
    uint8_t vendor_id[8];           
    uint8_t product_id[16];         
    uint8_t product_rev[4];         
} msc_inquiry_pkt_t;

typedef struct __attribute__((packed)) {
    uint8_t reserved1[3];       
    uint8_t list_length;        
    be_uint32_t blk_nb;            
    uint8_t type;               
    uint8_t blk_len[3];         
} msc_read_fmt_capa_pkt_t;

typedef struct __attribute__((packed)) {
    uint8_t error_code;         
    uint8_t reserved1;          
    uint8_t sense_key;          
    uint8_t reserved2[4];       
    uint8_t add_len;            
    uint8_t reserved3[4];       
    uint8_t asc;                
    uint8_t ascq;               
    uint8_t fruc;               
    uint16_t sk_spec;           
} msc_request_sense_pkt_t;

typedef struct __attribute__((packed)) {
    be_uint32_t last_blk;  
    be_uint32_t blk_len;   
} msc_read_capa_pkt_t;

typedef struct __attribute__((packed)) {
    uint32_t signature; 
    uint32_t tag;       
    uint32_t data_len;  
    uint8_t flags;      
    uint8_t lun;        
    uint8_t cb_len;     
    uint8_t cb[16];     
} msc_cbw_buf_t;

typedef struct __attribute__((packed)) {
    uint32_t signature; 
    uint32_t tag;       
    uint32_t data_left; 
    uint8_t status;     
} msc_csw_buf_t;

typedef struct {
    uint32_t tag;   
    size_t len;     
    uint8_t status; 
    uint8_t lun;    
} cbw_info_t;

void usbus_msc_scsi_process_cmd(usbus_t *usbus, usbus_handler_t *handler, usbdev_ep_t *ep,
                                size_t len);

void scsi_gen_csw(usbus_handler_t *handler, cbw_info_t *cmd);
 
#ifdef __cplusplus
}
#endif