usb_host_msd.h

/*
 * Copyright (c) 2015, Freescale Semiconductor, Inc.
 * Copyright 2016 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _USB_HOST_MSD_H_
#define _USB_HOST_MSD_H_
 
/*******************************************************************************
 * MSD class private structure, enumeration, macro
 ******************************************************************************/
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
/* CBW and CSW Macros */
#define USB_HOST_MSD_CBW_FLAGS_DIRECTION_OUT (0x00U)
#define USB_HOST_MSD_CBW_FLAGS_DIRECTION_IN (0x80U)
#define USB_HOST_MSD_CBW_SIGNATURE (0x43425355U)
#define USB_HOST_MSD_CSW_SIGNATURE (0x53425355U)
 
/* UFI data bit macro */
#define USB_HOST_UFI_BLOCK_DATA_VALID_LENGTH (10U)
#define USB_HOST_UFI_LOGICAL_UNIT_POSITION (5U)
#define USB_HOST_UFI_CBW_LENGTH (31U)
#define USB_HOST_UFI_CSW_LENGTH (13U)
#define USB_HOST_UFI_MODE_SENSE_PAGE_CONTROL_SHIFT (6U)
#define USB_HOST_UFI_MODE_SENSE_PAGE_CODE_SHIFT (0U)
#define USB_HOST_UFI_START_STOP_UNIT_LOEJ_SHIFT (1U)
#define USB_HOST_UFI_START_STOP_UNIT_START_SHIFT (0U)
#define USB_HOST_UFI_SEND_DIAGNOSTIC_SELF_TEST_SHIFT (2U)
 
/*******************************************************************************
 * MSD class public structure, enumeration, macro, function
 ******************************************************************************/
#define USB_HOST_MSD_RETRY_MAX_TIME (1U)
#define USB_HOST_MSD_BLOCK_SIZE (512U)
 
#define USB_HOST_MSD_CLASS_CODE (8U)
#define USB_HOST_MSD_SUBCLASS_CODE_UFI (4U)
#define USB_HOST_MSD_SUBCLASS_CODE_SCSI (6U)
#define USB_HOST_MSD_PROTOCOL_BULK (0x50U)
 
#define USB_HOST_HID_MASS_STORAGE_RESET (0xFFU)
#define USB_HOST_HID_GET_MAX_LUN (0xFEU)
 
typedef enum _usb_host_msd_command_status
{
    kMSD_CommandIdle = 0,
    kMSD_CommandTransferCBW,
    kMSD_CommandTransferData,
    kMSD_CommandTransferCSW,
    kMSD_CommandDone,
    kMSD_CommandCancel,
    kMSD_CommandErrorDone,
} usb_host_msd_command_status_t;
 
typedef struct _usb_host_cbw
{
    uint32_t CBWSignature; 
    uint32_t CBWTag; 
    uint32_t CBWDataTransferLength; 
    uint8_t CBWFlags;               
    uint8_t CBWLun;      
    uint8_t CBWCBLength; 
    uint8_t CBWCB[16];   
} usb_host_cbw_t;
 
typedef struct _usb_host_csw
{
    uint32_t CSWSignature; 
    uint32_t CSWTag; 
    uint32_t CSWDataResidue; 
    uint8_t CSWStatus;       
} usb_host_csw_t;
 
typedef struct _usb_host_msd_command
{
    usb_host_cbw_t *cbwBlock;       
    usb_host_csw_t *cswBlock;       
    uint8_t *dataBuffer;           
    uint32_t dataLength;           
    uint32_t dataSofar;            
    usb_host_transfer_t *transfer; 
    uint8_t retryTime;     
    uint8_t dataDirection; 
} usb_host_msd_command_t;
 
typedef struct _usb_host_msd_instance
{
    usb_host_handle hostHandle;                
    usb_device_handle deviceHandle;            
    usb_host_interface_handle interfaceHandle; 
    usb_host_pipe_handle controlPipe;          
    usb_host_pipe_handle outPipe;              
    usb_host_pipe_handle inPipe;               
    transfer_callback_t commandCallbackFn;     
    void *commandCallbackParam;                
    transfer_callback_t controlCallbackFn;     
    void *controlCallbackParam;                
    usb_host_transfer_t *controlTransfer;      
    usb_host_msd_command_t msdCommand;         
    uint8_t commandStatus;                     
    uint8_t internalResetRecovery; 
} usb_host_msd_instance_t;
 
typedef struct _usb_host_ufi_sense_data
{
    uint8_t errorCode;      
    uint8_t reserved1;      
    uint8_t senseKey;       
    uint8_t information[4]; 
    uint8_t additionalSenseLength; 
    uint8_t reserved2[4];          
    uint8_t additionalSenseCode;   
    uint8_t additionalSenseCodeQualifier; 
    uint8_t reserved3[4];                 
} usb_host_ufi_sense_data_t;
 
typedef struct _usb_host_ufi_inquiry_data
{
    uint8_t peripheralDeviceType;      
    uint8_t removableMediaBit;         
    uint8_t version;                   
    uint8_t responseDataFormat;        
    uint8_t additionalLength;          
    uint8_t reserved1[3];              
    uint8_t vendorInformation[8];      
    uint8_t productIdentification[16]; 
    uint8_t productRevisionLevel[4];   
} usb_host_ufi_inquiry_data_t;
 
typedef struct _usb_host_ufi_read_capacity
{
    uint8_t lastLogicalBlockAddress[4]; 
    uint8_t blockLengthInBytes[4];      
} usb_host_ufi_read_capacity_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*******************************************************************************
 * API
 ******************************************************************************/
 
extern usb_status_t USB_HostMsdInit(usb_device_handle deviceHandle, usb_host_class_handle *classHandle);
 
extern usb_status_t USB_HostMsdSetInterface(usb_host_class_handle classHandle,
                                            usb_host_interface_handle interfaceHandle,
                                            uint8_t alternateSetting,
                                            transfer_callback_t callbackFn,
                                            void *callbackParam);
 
extern usb_status_t USB_HostMsdDeinit(usb_device_handle deviceHandle, usb_host_class_handle classHandle);
 
extern usb_status_t USB_HostMsdMassStorageReset(usb_host_class_handle classHandle,
                                                transfer_callback_t callbackFn,
                                                void *callbackParam);
 
extern usb_status_t USB_HostMsdGetMaxLun(usb_host_class_handle classHandle,
                                         uint8_t *logicalUnitNumber,
                                         transfer_callback_t callbackFn,
                                         void *callbackParam);
 
extern usb_status_t USB_HostMsdRead10(usb_host_class_handle classHandle,
                                      uint8_t logicalUnit,
                                      uint32_t blockAddress,
                                      uint8_t *buffer,
                                      uint32_t bufferLength,
                                      uint32_t blockNumber,
                                      transfer_callback_t callbackFn,
                                      void *callbackParam);
 
extern usb_status_t USB_HostMsdRead12(usb_host_class_handle classHandle,
                                      uint8_t logicalUnit,
                                      uint32_t blockAddress,
                                      uint8_t *buffer,
                                      uint32_t bufferLength,
                                      uint32_t blockNumber,
                                      transfer_callback_t callbackFn,
                                      void *callbackParam);
 
extern usb_status_t USB_HostMsdWrite10(usb_host_class_handle classHandle,
                                       uint8_t logicalUnit,
                                       uint32_t blockAddress,
                                       uint8_t *buffer,
                                       uint32_t bufferLength,
                                       uint32_t blockNumber,
                                       transfer_callback_t callbackFn,
                                       void *callbackParam);
 
extern usb_status_t USB_HostMsdWrite12(usb_host_class_handle classHandle,
                                       uint8_t logicalUnit,
                                       uint32_t blockAddress,
                                       uint8_t *buffer,
                                       uint32_t bufferLength,
                                       uint32_t blockNumber,
                                       transfer_callback_t callbackFn,
                                       void *callbackParam);
 
extern usb_status_t USB_HostMsdReadCapacity(usb_host_class_handle classHandle,
                                            uint8_t logicalUnit,
                                            uint8_t *buffer,
                                            uint32_t bufferLength,
                                            transfer_callback_t callbackFn,
                                            void *callbackParam);
 
extern usb_status_t USB_HostMsdTestUnitReady(usb_host_class_handle classHandle,
                                             uint8_t logicalUnit,
                                             transfer_callback_t callbackFn,
                                             void *callbackParam);
 
extern usb_status_t USB_HostMsdRequestSense(usb_host_class_handle classHandle,
                                            uint8_t logicalUnit,
                                            uint8_t *buffer,
                                            uint32_t bufferLength,
                                            transfer_callback_t callbackFn,
                                            void *callbackParam);
 
extern usb_status_t USB_HostMsdModeSelect(usb_host_class_handle classHandle,
                                          uint8_t logicalUnit,
                                          uint8_t *buffer,
                                          uint32_t bufferLength,
                                          transfer_callback_t callbackFn,
                                          void *callbackParam);
 
extern usb_status_t USB_HostMsdModeSense(usb_host_class_handle classHandle,
                                         uint8_t logicalUnit,
                                         uint8_t pageControl,
                                         uint8_t pageCode,
                                         uint8_t *buffer,
                                         uint32_t bufferLength,
                                         transfer_callback_t callbackFn,
                                         void *callbackParam);
 
extern usb_status_t USB_HostMsdInquiry(usb_host_class_handle classHandle,
                                       uint8_t logicalUnit,
                                       uint8_t *buffer,
                                       uint32_t bufferLength,
                                       transfer_callback_t callbackFn,
                                       void *callbackParam);
 
extern usb_status_t USB_HostMsdReadFormatCapacities(usb_host_class_handle classHandle,
                                                    uint8_t logicalUnit,
                                                    uint8_t *buffer,
                                                    uint32_t bufferLength,
                                                    transfer_callback_t callbackFn,
                                                    void *callbackParam);
 
extern usb_status_t USB_HostMsdFormatUnit(usb_host_class_handle classHandle,
                                          uint8_t logicalUnit,
                                          uint8_t trackNumber,
                                          uint16_t interLeave,
                                          uint8_t *buffer,
                                          uint32_t bufferLength,
                                          transfer_callback_t callbackFn,
                                          void *callbackParam);
 
extern usb_status_t USB_HostMsdPreventAllowRemoval(usb_host_class_handle classHandle,
                                                   uint8_t logicalUnit,
                                                   uint8_t prevent,
                                                   transfer_callback_t callbackFn,
                                                   void *callbackParam);
 
extern usb_status_t USB_HostMsdWriteAndVerify(usb_host_class_handle classHandle,
                                              uint8_t logicalUnit,
                                              uint32_t blockAddress,
                                              uint8_t *buffer,
                                              uint32_t bufferLength,
                                              uint32_t blockNumber,
                                              transfer_callback_t callbackFn,
                                              void *callbackParam);
 
extern usb_status_t USB_HostMsdStartStopUnit(usb_host_class_handle classHandle,
                                             uint8_t logicalUnit,
                                             uint8_t loadEject,
                                             uint8_t start,
                                             transfer_callback_t callbackFn,
                                             void *callbackParam);
 
extern usb_status_t USB_HostMsdVerify(usb_host_class_handle classHandle,
                                      uint8_t logicalUnit,
                                      uint32_t blockAddress,
                                      uint16_t verificationLength,
                                      transfer_callback_t callbackFn,
                                      void *callbackParam);
 
extern usb_status_t USB_HostMsdRezeroUnit(usb_host_class_handle classHandle,
                                          uint8_t logicalUnit,
                                          transfer_callback_t callbackFn,
                                          void *callbackParam);
 
extern usb_status_t USB_HostMsdSeek10(usb_host_class_handle classHandle,
                                      uint8_t logicalUnit,
                                      uint32_t blockAddress,
                                      transfer_callback_t callbackFn,
                                      void *callbackParam);
 
extern usb_status_t USB_HostMsdSendDiagnostic(usb_host_class_handle classHandle,
                                              uint8_t logicalUnit,
                                              uint8_t selfTest,
                                              transfer_callback_t callbackFn,
                                              void *callbackParam);
 
usb_status_t USB_HostMsdCommand(usb_host_class_handle classHandle,
                                uint8_t *buffer,
                                uint32_t bufferLength,
                                transfer_callback_t callbackFn,
                                void *callbackParam,
                                uint8_t direction,
                                uint8_t byteValues[10]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _USB_HOST_MSD_H_ */