235 lines
12 KiB
C
235 lines
12 KiB
C
/*
|
|
* Copyright (c) 2015 - 2016, Freescale Semiconductor, Inc.
|
|
* Copyright 2016 - 2017 NXP
|
|
* All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef _USB_DEVICE_MSC_H_
|
|
#define _USB_DEVICE_MSC_H_ 1
|
|
|
|
#include "usb_device_msc_ufi.h"
|
|
/*******************************************************************************
|
|
* Definitions
|
|
******************************************************************************/
|
|
#define USB_DEVICE_CONFIG_MSC_MAX_INSTANCE (1U)
|
|
/*! @brief prevent media removal flag */
|
|
#define USB_DEVICE_CONFIG_MSC_SUPPORT_DISK_LOCKING_MECHANISM (0U)
|
|
#define USB_DEVICE_CONFIG_MSC_IMPLEMENTING_DISK_DRIVE (0U)
|
|
/*! @brief The class code of the MSC class */
|
|
#define USB_DEVICE_CONFIG_MSC_CLASS_CODE (0x08U)
|
|
|
|
/*! @brief Bulk-Only Mass Storage Reset (class-specific request) */
|
|
#define USB_DEVICE_MSC_BULK_ONLY_MASS_STORAGE_RESET (0xFFU)
|
|
/*! @brief Get Max LUN (class-specific request) */
|
|
#define USB_DEVICE_MSC_GET_MAX_LUN (0xFEU)
|
|
|
|
/*! @brief CBW dCBWSignature*/
|
|
#define USB_DEVICE_MSC_DCBWSIGNATURE USB_LONG_TO_BIG_ENDIAN(0x55534243U)
|
|
/*! @brief CSW dCSSWSignature*/
|
|
#define USB_DEVICE_MSC_DCSWSIGNATURE USB_LONG_TO_BIG_ENDIAN(0x55534253U)
|
|
/*! @brief CSW bmCBWFlags bit7 */
|
|
#define USB_DEVICE_MSC_CBW_DIRECTION_BIT (0x80U)
|
|
#define USB_DEVICE_MSC_CBW_DIRECTION_SHIFT (7U)
|
|
/*! @brief CBW command length*/
|
|
#define USB_DEVICE_MSC_CBW_LENGTH (31U)
|
|
/*! @brief CSW command length*/
|
|
#define USB_DEVICE_MSC_CSW_LENGTH (13U)
|
|
/*! @brief Command Block Status Values*/
|
|
#define USB_DEVICE_MSC_COMMAND_PASSED (0x00U)
|
|
#define USB_DEVICE_MSC_COMMAND_FAILED (0x01U)
|
|
#define USB_DEVICE_MSC_PHASE_ERROR (0x02U)
|
|
/*! @brief UFI Commands code*/
|
|
#define USB_DEVICE_MSC_INQUIRY_COMMAND (0x12U)
|
|
#define USB_DEVICE_MSC_READ_10_COMMAND (0x28U)
|
|
#define USB_DEVICE_MSC_READ_12_COMMAND (0xA8U)
|
|
#define USB_DEVICE_MSC_REQUEST_SENSE_COMMAND (0x03U)
|
|
#define USB_DEVICE_MSC_TEST_UNIT_READY_COMMAND (0x00U)
|
|
#define USB_DEVICE_MSC_WRITE_10_COMMAND (0x2AU)
|
|
#define USB_DEVICE_MSC_WRITE_12_COMMAND (0xAAU)
|
|
#define USB_DEVICE_MSC_PREVENT_ALLOW_MEDIUM_REM_COMMAND (0x1EU)
|
|
#define USB_DEVICE_MSC_FORMAT_UNIT_COMMAND (0x04U)
|
|
#define USB_DEVICE_MSC_READ_CAPACITY_10_COMMAND (0x25U)
|
|
#define USB_DEVICE_MSC_READ_CAPACITY_16_COMMAND (0x9EU)
|
|
#define USB_DEVICE_MSC_READ_FORMAT_CAPACITIES_COMMAND (0x23U)
|
|
#define USB_DEVICE_MSC_MODE_SENSE_10_COMMAND (0x5AU)
|
|
#define USB_DEVICE_MSC_MODE_SENSE_6_COMMAND (0x1AU)
|
|
#define USB_DEVICE_MSC_MODE_SELECT_10_COMMAND (0x55U)
|
|
#define USB_DEVICE_MSC_MODE_SELECT_6_COMMAND (0x15U)
|
|
#define USB_DEVICE_MSC_SEND_DIAGNOSTIC_COMMAND (0x1DU)
|
|
#define USB_DEVICE_MSC_VERIFY_COMMAND (0x2FU)
|
|
#define USB_DEVICE_MSC_START_STOP_UNIT_COMMAND (0x1BU)
|
|
|
|
/*Max transfer length */
|
|
#define USB_DEVICE_MSC_MAX_RECV_TRANSFER_LENGTH (65536U)
|
|
#define USB_DEVICE_MSC_MAX_SEND_TRANSFER_LENGTH (65536U)
|
|
|
|
/*! @brief Command Block Wrapper(CBW) */
|
|
typedef struct _usb_device_msc_cbw
|
|
{
|
|
uint32_t signature; /*!< Byte 0-3 dCBWSignature*/
|
|
uint32_t tag; /*!< Byte 4-7 dCBWTag*/
|
|
uint32_t dataTransferLength; /*!< Byte 8-11 dCBWDataTransferLength*/
|
|
uint8_t flags; /*!< Byte 12 bmCBWFlags*/
|
|
uint8_t logicalUnitNumber; /*!< Byte 13 bCBWLUN*/
|
|
uint8_t cbLength; /*!< Byte 14 bCBWCBLength*/
|
|
uint8_t cbwcb[16]; /*!< Byte 15-30 CBWCB, CBWCB is used to store ufi command*/
|
|
} usb_device_msc_cbw_t;
|
|
/*! @brief Command Status Wrapper(CSW) */
|
|
typedef struct _usb_device_msc_csw
|
|
{
|
|
uint32_t signature; /*!< Byte 0-3 dCSWSignature*/
|
|
uint32_t tag; /*!< Byte 4-7 dCSWTag*/
|
|
uint32_t dataResidue; /*!< Byte 8-11 dCSWDataResidue*/
|
|
uint8_t cswStatus; /*!< Byte 12 bCSWStatus*/
|
|
} usb_device_msc_csw_t;
|
|
/*! @brief read/write information */
|
|
typedef struct _usb_lba_transfer_information_struct
|
|
{
|
|
uint32_t startingLogicalBlockAddress; /*!< The logical block at which the read/write operation shall begin*/
|
|
uint32_t transferNumber; /*!< The number of contiguous logical blocks of data that shall be transferred*/
|
|
} usb_lba_transfer_information_struct_t;
|
|
/*! @brief device information */
|
|
typedef struct _usb_device_lba_information_struct
|
|
{
|
|
uint32_t totalLbaNumberSupports; /*!< Total blocks number supported*/
|
|
uint32_t lengthOfEachLba; /*!< Length of each block*/
|
|
uint32_t bulkInBufferSize; /*!< Bulk in buffer size*/
|
|
uint32_t bulkOutBufferSize; /*!< Bulk out buffer size*/
|
|
uint8_t logicalUnitNumberSupported; /*!< Number of LUN*/
|
|
} usb_device_lba_information_struct_t;
|
|
|
|
/*! @brief data transfer information */
|
|
typedef struct _usb_device_lba_app_struct
|
|
{
|
|
uint32_t offset; /*!< Offset of the block need to access*/
|
|
uint32_t size; /*!< Size of the transferd data*/
|
|
uint8_t *buffer; /*!< Buffer address of the transferd data*/
|
|
} usb_device_lba_app_struct_t;
|
|
/*! @brief the thirteen possible cases of host expectations and device intent in the absence of
|
|
overriding error conditions. */
|
|
typedef struct _usb_device_msc_thirteen_case_struct
|
|
{
|
|
uint32_t hostExpectedDataLength; /*!< The number of bytes of data that the host expects to transfer */
|
|
uint32_t deviceExpectedDataLength; /*!< The number of bytes of data that the device expects to transfer */
|
|
uint8_t *buffer; /*!< Data buffer*/
|
|
usb_lba_transfer_information_struct_t lbaInformation; /*!< Read/write information*/
|
|
uint8_t lbaSendRecvSelect; /*!< Whether the command is read or write command*/
|
|
uint8_t hostExpectedDirection; /*!< host excepted data direction*/
|
|
uint8_t deviceExpectedDirection; /*!< deivce excepted data direction*/
|
|
} usb_device_msc_thirteen_case_struct_t;
|
|
/*! @brief stall flag */
|
|
typedef enum _usb_device_msc_stall_type_t
|
|
{
|
|
USB_DEVICE_MSC_STALL_IN_CBW = 1U, /*!< Stall in cbw*/
|
|
USB_DEVICE_MSC_STALL_IN_DATA, /*!< Stall in data transfer*/
|
|
USB_DEVICE_MSC_STALL_IN_CSW, /*!< Stall in csw*/
|
|
} usb_device_msc_stall_type_t;
|
|
/*! @brief Available common EVENT types in msc class callback */
|
|
typedef enum _usb_device_msc_event
|
|
{
|
|
kUSB_DeviceMscEventReadResponse = 0x01U, /*!< Send data completed */
|
|
kUSB_DeviceMscEventWriteResponse, /*!< Data received */
|
|
kUSB_DeviceMscEventWriteRequest, /*!< Host write data*/
|
|
kUSB_DeviceMscEventReadRequest, /*!< Host read data*/
|
|
kUSB_DeviceMscEventGetlbaInformation, /*!< Get device information */
|
|
kUSB_DeviceMscEventFormatComplete, /*!< Format complete */
|
|
kUSB_DeviceMscEventRemovalRequest, /*!< PreventAllowMediumCommand */
|
|
kUSB_DeviceMscEventStopEjectMedia, /*!< StartStopUnitCommand */
|
|
|
|
} usb_device_msc_event_t;
|
|
/*! @brief The MSC device ufi command status structure */
|
|
typedef struct _usb_device_msc_ufi_struct
|
|
{
|
|
usb_device_request_sense_data_struct_t *requestSense; /*!< Request Sense Standard Data*/
|
|
usb_device_msc_thirteen_case_struct_t thirteenCase; /*!< Thirteen possible cases*/
|
|
usb_device_read_capacity_struct_t *readCapacity; /*!< READ CAPACITY Data*/
|
|
usb_device_read_capacity16_data_struct_t *readCapacity16; /*!< READ CAPACITY Data*/
|
|
uint8_t formattedDisk; /*!< *Formated or unformated media*/
|
|
uint8_t *formatCapacityData;
|
|
/*!< Capacity List*/
|
|
} usb_device_msc_ufi_struct_t;
|
|
/*! @brief The MSC device structure */
|
|
typedef struct _usb_device_msc_struct
|
|
{
|
|
usb_device_handle handle; /*!< The device handle */
|
|
uint32_t transferRemaining; /*!< Transfer remaining data */
|
|
uint32_t currentOffset; /*!< Current address offset */
|
|
uint32_t totalLogicalBlockNumber; /*!< Total logical block number of device */
|
|
uint32_t lengthOfEachLba; /*!< Length of logical block */
|
|
uint32_t implementingDiskDrive; /*!< Disk drive*/
|
|
uint32_t bulkInBufferSize; /*!< Bulk in buffer size*/
|
|
uint32_t bulkOutBufferSize; /*!< Bulk out buffer size*/
|
|
|
|
usb_device_msc_cbw_t *g_mscCbw; /*!< CBW structure */
|
|
usb_device_msc_csw_t *g_mscCsw; /*!< CSW structure */
|
|
|
|
usb_device_msc_ufi_struct_t g_mscUfi; /*!< UFI command information structure*/
|
|
|
|
uint8_t dataOutFlag; /*!< CBW incidating bulk out transfer, clear this flag when data transfer done*/
|
|
uint8_t dataInFlag; /*!< CBW incidating bulk in transfer, clear this flag when data transfer done*/
|
|
uint8_t inEndpointStallFlag; /*!< In endpoint stall flag*/
|
|
uint8_t outEndpointStallFlag; /*!< Out endpoint stall flag*/
|
|
uint8_t cbwValidFlag; /*!< The CBW was received after the device had sent a CSW or after a reset ,or else it is
|
|
invalid*/
|
|
uint8_t performResetRecover; /*!< Device need reset command from host*/
|
|
uint8_t performResetDoneFlag; /*!< Device has perform reset command */
|
|
uint8_t needInStallFlag; /*!< In endpoint shoud be stalled*/
|
|
uint8_t needOutStallFlag; /*!< Out endpoint shoud be stalled*/
|
|
uint8_t cbwPrimeFlag; /*!< CBW prime flag, prime means device msc has been ready to receive cbw, the bulk out
|
|
endpoint has got the prepared buffer*/
|
|
uint8_t cswPrimeFlag; /*!< CSW prime flag, prime means device msc has been ready to receive csw, the bulk in
|
|
endpoint has got the prepared buffer*/
|
|
uint8_t stallStatus; /*!< Stall status*/
|
|
|
|
uint8_t logicalUnitNumber; /*!< supported logical units number of device ,referance bulk only spec 3.2 Get Max LUN
|
|
(class-specific request)*/
|
|
uint8_t bulkInEndpoint; /*!< bulk in endpoint number*/
|
|
uint8_t bulkOutEndpoint; /*!< bulk out endpoint number*/
|
|
uint8_t alternate; /*!< Current alternate setting of the interface */
|
|
uint8_t configuration; /*!< Current configuration */
|
|
uint8_t interfaceNumber; /*!< The interface number of the class */
|
|
uint8_t inEndpointCswCancelFlag; /*!< the state when calcel function happens, and need send the csw after cancel*/
|
|
} usb_device_msc_struct_t;
|
|
|
|
/*******************************************************************************
|
|
* API
|
|
******************************************************************************/
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
extern usb_status_t USB_DeviceMscBulkIn(usb_device_handle deviceHandle,
|
|
usb_device_endpoint_callback_message_struct_t *event,
|
|
void *arg);
|
|
extern usb_status_t USB_DeviceMscBulkOut(usb_device_handle deviceHandle,
|
|
usb_device_endpoint_callback_message_struct_t *event,
|
|
void *arg);
|
|
extern usb_status_t USB_DeviceMscEvent(void *deviceHandle, uint32_t event, void *param);
|
|
|
|
extern usb_status_t USB_DeviceMscLbaTransfer(usb_device_msc_struct_t *mscHandle,
|
|
uint8_t direction,
|
|
usb_lba_transfer_information_struct_t *lbaInformation);
|
|
|
|
extern usb_status_t USB_DeviceMscUfiThirteenCasesCheck(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiRequestSenseCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiInquiryCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiReadCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiWriteCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiTestUnitReadyCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiVerifyCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiModeSenseCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiModeSelectCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiReadCapacityCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiReadFormatCapacityCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiFormatUnitCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiPreventAllowMediumCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiSendDiagnosticCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiStartStopUnitCommand(usb_device_msc_struct_t *mscHandle);
|
|
extern usb_status_t USB_DeviceMscUfiUnsupportCommand(usb_device_msc_struct_t *mscHandle);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* _USB_DEVICE_DESCRIPTOR_H_ */
|