vsf_scsi.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_SCSI_H__
#define __VSF_SCSI_H__
 
/*============================ INCLUDES ======================================*/
 
#include "./vsf_scsi_cfg.h"
 
#if VSF_USE_SCSI == ENABLED
 
#include "kernel/vsf_kernel.h"
 
#if     defined(__VSF_SCSI_CLASS_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#elif   defined(__VSF_SCSI_CLASS_INHERIT__)
#   define __VSF_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
vsf_dcl_class(vk_scsi_t)
vsf_dcl_class(vk_scsi_drv_t)
 
typedef enum scsi_sensekey_t {
    SCSI_SENSEKEY_NO_SENSE                      = 0,
    SCSI_SENSEKEY_RECOVERED_ERROR               = 1,
    SCSI_SENSEKEY_NOT_READY                     = 2,
    SCSI_SENSEKEY_MEDIUM_ERROR                  = 3,
    SCSI_SENSEKEY_HARDWARE_ERROR                = 4,
    SCSI_SENSEKEY_ILLEGAL_REQUEST               = 5,
    SCSI_SENSEKEY_UNIT_ATTENTION                = 6,
    SCSI_SENSEKEY_DATA_PROTECT                  = 7,
    SCSI_SENSEKEY_BLANK_CHECK                   = 8,
    SCSI_SENSEKEY_VENDOR_SPECIFIC               = 9,
    SCSI_SENSEKEY_COPY_ABORTED                  = 10,
    SCSI_SENSEKEY_ABORTED_COMMAND               = 11,
    SCSI_SENSEKEY_VOLUME_OVERFLOW               = 13,
    SCSI_SENSEKEY_MISCOMPARE                    = 14,
} scsi_sensekey_t;
 
typedef enum scsi_asc_t {
    SCSI_ASC_NONE                               = 0x00,
    SCSI_ASC_PARAMETER_LIST_LENGTH_ERROR        = 0x1A,
    SCSI_ASC_INVALID_COMMAND                    = 0x20,
    SCSI_ASC_INVALID_FIELD_IN_COMMAND           = 0x24,
    SCSI_ASC_INVALID_FIELD_IN_PARAMETER_LIST    = 0x26,
    SCSI_ASC_MEDIUM_HAVE_CHANGED                = 0x28,
    SCSI_ASC_ADDRESS_OUT_OF_RANGE               = 0x21,
    SCSI_ASC_MEDIUM_NOT_PRESENT                 = 0x3A,
} scsi_asc_t;
 
typedef enum scsi_group_code_t {
    SCSI_GROUPCODE6                             = 0x00,
    SCSI_GROUPCODE10_1                          = 0x20,
    SCSI_GROUPCODE10_2                          = 0x40,
    SCSI_GROUPCODE16                            = 0x80,
    SCSI_GROUPCODE12                            = 0xA0,
} scsi_group_code_t;
 
typedef enum scsi_cmd_code_t {
    SCSI_CMDCODE_TEST_UNIT_READY                = 0x00,
    SCSI_CMDCODE_ATA_COMMAND_PASS_THROUGH12     = 0x01, // SCSI_GROUPCODE12
    SCSI_CMDCODE_REQUEST_SENSE                  = 0x03, // SCSI_GROUPCODE6
    SCSI_CMDCODE_READ_FORMAT_CAPACITIES         = 0x03, // SCSI_GROUPCODE10_1
    SCSI_CMDCODE_READ_TOC                       = 0x03, // SCSI_GROUPCODE10_2
    SCSI_CMDCODE_REPORT_ID_INFO                 = 0x03, // SCSI_GROUPCODE12
    SCSI_CMDCODE_FORMAT_UNIT                    = 0x04,
    SCSI_CMDCODE_READ_CAPACITY                  = 0x05,
    SCSI_CMDCODE_ATA_COMMAND_PASS_THROUGH16     = 0x05, // SCSI_GROUPCODE16
    SCSI_CMDCODE_READ                           = 0x08,
    SCSI_CMDCODE_SERVICE_ACTION_OUT12           = 0x09, // SCSI_GROUPCODE12
    SCSI_CMDCODE_WRITE                          = 0x0A,
    SCSI_CMDCODE_GET_EVENT_STATUS_NOTIFY        = 0x0A, // SCSI_GROUPCODE10_2
    SCSI_CMDCODE_SERVICE_ACTION_IN12            = 0x0B, // SCSI_GROUPCODE12
    SCSI_CMDCODE_SERVICE_ACTION_IN16            = 0x0E, // SCSI_GROUPCODE16
    SCSI_CMDCODE_VERIFY                         = 0x0F,
    SCSI_CMDCODE_SYNC_CACHE16                   = 0x11, // SCSI_GROUPCODE16
    SCSI_CMDCODE_INQUIRY                        = 0x12,
    SCSI_CMDCODE_MODE_SELECT                    = 0x15, // SCSI_GROUPCODE6 & SCSI_GROUPCODE10_2
    SCSI_CMDCODE_SYNC_CACHE10                   = 0x15, // SCSI_GROUPCODE10_1
    SCSI_CMDCODE_MODE_SENSE                     = 0x1A,
    SCSI_CMDCODE_START_STOP_UNIT                = 0x1B,
    SCSI_CMDCODE_SEND_DIAGNOSTIC                = 0x1D,
    SCSI_CMDCODE_ALLOW_MEDIUM_REMOVAL           = 0x1E,
    SCSI_CMDCODE_SERVICE_ACTION_OUT16           = 0x1F, // SCSI_GROUPCODE16
} scsi_cmd_code_t;
 
typedef struct scsi_inquiry_t {
    uint8_t type;
    uint8_t removable;
    uint8_t version;
    uint8_t data_format;
    uint8_t additional_length;
    uint8_t reserved[3];
    uint8_t vendor[8];
    uint8_t product[16];
    uint8_t revision[4];
} VSF_CAL_PACKED scsi_inquiry_t;
 
vsf_class(vk_scsi_drv_t) {
    protected_member(
        vsf_peda_evthandler_t init;
        vsf_peda_evthandler_t fini;
        vsf_peda_evthandler_t execute;
#if VSF_USE_SIMPLE_STREAM == ENABLED
        vsf_peda_evthandler_t execute_stream;
#endif
        bool (*buffer)(vk_scsi_t *pthis, uint8_t *cbd, vsf_mem_t *mem);
    )
};
 
 
vsf_class(vk_scsi_t) {
    public_member(
        const vk_scsi_drv_t *drv;
        void *param;
    )
};
 
#if defined(__VSF_SCSI_CLASS_IMPLEMENT) || defined(__VSF_SCSI_CLASS_INHERIT__)
__vsf_component_peda_ifs(vk_scsi_init)
__vsf_component_peda_ifs(vk_scsi_fini)
__vsf_component_peda_ifs(vk_scsi_execute,
    uint8_t *cbd;
    vsf_mem_t mem;
#   if VSF_USE_SIMPLE_STREAM == ENABLED
    vsf_stream_t *stream;
#   endif
)
#   if VSF_USE_SIMPLE_STREAM == ENABLED
__vsf_component_peda_ifs(vk_scsi_execute_stream,
    uint8_t *cbd;
    vsf_stream_t *stream;
)
#   endif
#endif
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vk_scsi_init(vk_scsi_t *pthis);
extern vsf_err_t vk_scsi_fini(vk_scsi_t *pthis);
// used to get mem from driver, if supported
extern bool vk_scsi_prepare_buffer(vk_scsi_t *pthis, uint8_t *cbd, vsf_mem_t *mem);
extern vsf_err_t vk_scsi_execute(vk_scsi_t *pthis, uint8_t *cbd, vsf_mem_t *mem);
#if VSF_USE_SIMPLE_STREAM == ENABLED
extern vsf_err_t vk_scsi_execute_stream(vk_scsi_t *pthis, uint8_t *cbd, vsf_stream_t *stream);
#endif
 
#ifdef __VSF_SCSI_CLASS_INHERIT__
extern bool vk_scsi_get_rw_param(uint8_t *scsi_cmd, uint64_t *addr, uint32_t *size);
extern uint_fast8_t vk_scsi_get_command_len(uint8_t *cbd);
#endif
 
#ifdef __cplusplus
}
#endif
 
/*============================ INCLUDES ======================================*/
 
#include "./driver/virtual_scsi/vsf_virtual_scsi.h"
#include "./driver/mal_scsi/vsf_mal_scsi.h"
 
#undef __VSF_SCSI_CLASS_IMPLEMENT
#undef __VSF_SCSI_CLASS_INHERIT__
 
#endif      // VSF_USE_SCSI
#endif      // __VSF_SCSI_H__