/** * @file usbd_msc.c * @brief * * Copyright (c) 2022 sakumisu * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. The * ASF licenses this file to you 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. * */ #include "usbd_core.h" #include "usbd_msc.h" #include "usb_scsi.h" #ifdef CONFIG_USBDEV_MSC_THREAD #include "usb_osal.h" #endif /* max USB packet size */ #ifndef CONFIG_USB_HS #define MASS_STORAGE_BULK_EP_MPS 64 #else #define MASS_STORAGE_BULK_EP_MPS 512 #endif #define MSC_THREAD_OP_READ_MEM 1 #define MSC_THREAD_OP_WRITE_MEM 2 #define MSC_THREAD_OP_WRITE_DONE 3 #define MSD_OUT_EP_IDX 0 #define MSD_IN_EP_IDX 1 /* Describe EndPoints configuration */ static usbd_endpoint_t mass_ep_data[2]; /* MSC Bulk-only Stage */ enum Stage { MSC_READ_CBW = 0, /* Command Block Wrapper */ MSC_DATA_OUT = 1, /* Data Out Phase */ MSC_DATA_IN = 2, /* Data In Phase */ MSC_SEND_CSW = 3, /* Command Status Wrapper */ MSC_WAIT_CSW = 4, /* Command Status Wrapper */ }; /* Device data structure */ struct usbd_msc_cfg_priv { /* state of the bulk-only state machine */ enum Stage stage; USB_MEM_ALIGN32 struct CBW cbw; USB_MEM_ALIGN32 struct CSW csw; uint8_t sKey; /* Sense key */ uint8_t ASC; /* Additional Sense Code */ uint8_t ASQ; /* Additional Sense Qualifier */ uint8_t max_lun; uint16_t scsi_blk_size; uint32_t scsi_blk_nbr; uint32_t scsi_blk_addr; uint32_t scsi_blk_len; uint8_t *block_buffer; } usbd_msc_cfg; /*memory OK (after a usbd_msc_memory_verify)*/ static bool memOK; #ifdef CONFIG_USBDEV_MSC_THREAD static volatile uint8_t thread_op; static usb_osal_sem_t msc_sem; static usb_osal_thread_t msc_thread; static uint32_t current_byte_read; #endif static void usbd_msc_reset(void) { uint8_t *buf = NULL; buf = usbd_msc_cfg.block_buffer; memset((uint8_t *)&usbd_msc_cfg, 0, sizeof(struct usbd_msc_cfg_priv)); usbd_msc_get_cap(0, &usbd_msc_cfg.scsi_blk_nbr, &usbd_msc_cfg.scsi_blk_size); usbd_msc_cfg.block_buffer = buf; } /** * @brief Handler called for Class requests not handled by the USB stack. * * @param setup Information about the request to execute. * @param len Size of the buffer. * @param data Buffer containing the request result. * * @return 0 on success, negative errno code on fail. */ static int msc_storage_class_request_handler(struct usb_setup_packet *setup, uint8_t **data, uint32_t *len) { USB_LOG_DBG("MSC Class request: " "bRequest 0x%02x\r\n", setup->bRequest); switch (setup->bRequest) { case MSC_REQUEST_RESET: USB_LOG_DBG("MSC_REQUEST_RESET\r\n"); if (setup->wLength) { USB_LOG_WRN("Invalid length\r\n"); return -1; } usbd_msc_reset(); break; case MSC_REQUEST_GET_MAX_LUN: USB_LOG_DBG("MSC_REQUEST_GET_MAX_LUN\r\n"); if (setup->wLength != 1) { USB_LOG_WRN("Invalid length\r\n"); return -1; } *data = (uint8_t *)(&usbd_msc_cfg.max_lun); *len = 1; break; default: USB_LOG_WRN("Unhandled MSC Class bRequest 0x%02x\r\n", setup->bRequest); return -1; } return 0; } static void usbd_msc_bot_abort(void) { if ((usbd_msc_cfg.cbw.bmFlags == 0) && (usbd_msc_cfg.cbw.dDataLength != 0)) { usbd_ep_set_stall(mass_ep_data[MSD_OUT_EP_IDX].ep_addr); } usbd_ep_set_stall(mass_ep_data[MSD_IN_EP_IDX].ep_addr); } static void sendCSW(uint8_t CSW_Status) { usbd_msc_cfg.csw.dSignature = MSC_CSW_Signature; usbd_msc_cfg.csw.bStatus = CSW_Status; /* updating the State Machine , so that we wait CSW when this * transfer is complete, ie when we get a bulk in callback */ usbd_msc_cfg.stage = MSC_WAIT_CSW; if (usbd_ep_write(mass_ep_data[MSD_IN_EP_IDX].ep_addr, (uint8_t *)&usbd_msc_cfg.csw, sizeof(struct CSW), NULL) != 0) { USB_LOG_ERR("usb write failure\r\n"); } } static void sendLastData(uint8_t *buffer, uint8_t size) { size = MIN(size, usbd_msc_cfg.cbw.dDataLength); /* updating the State Machine , so that we send CSW when this * transfer is complete, ie when we get a bulk in callback */ usbd_msc_cfg.stage = MSC_SEND_CSW; if (usbd_ep_write(mass_ep_data[MSD_IN_EP_IDX].ep_addr, buffer, size, NULL) != 0) { USB_LOG_ERR("USB write failed\r\n"); } usbd_msc_cfg.csw.dDataResidue -= size; usbd_msc_cfg.csw.bStatus = CSW_STATUS_CMD_PASSED; } /** * @brief SCSI COMMAND */ static bool SCSI_testUnitReady(uint8_t **data, uint32_t *len); static bool SCSI_requestSense(uint8_t **data, uint32_t *len); static bool SCSI_inquiry(uint8_t **data, uint32_t *len); static bool SCSI_startStopUnit(uint8_t **data, uint32_t *len); static bool SCSI_preventAllowMediaRemoval(uint8_t **data, uint32_t *len); static bool SCSI_modeSense6(uint8_t **data, uint32_t *len); static bool SCSI_modeSense10(uint8_t **data, uint32_t *len); static bool SCSI_readFormatCapacity(uint8_t **data, uint32_t *len); static bool SCSI_readCapacity10(uint8_t **data, uint32_t *len); static bool SCSI_read10(uint8_t **data, uint32_t *len); static bool SCSI_read12(uint8_t **data, uint32_t *len); static bool SCSI_write10(uint8_t **data, uint32_t *len); static bool SCSI_write12(uint8_t **data, uint32_t *len); static bool SCSI_verify10(uint8_t **data, uint32_t *len); /** * @brief SCSI_SetSenseData * Load the last error code in the error list * @param sKey: Sense Key * @param ASC: Additional Sense Code * @retval none */ static void SCSI_SetSenseData(uint32_t KCQ) { usbd_msc_cfg.sKey = (uint8_t)(KCQ >> 16); usbd_msc_cfg.ASC = (uint8_t)(KCQ >> 8); usbd_msc_cfg.ASQ = (uint8_t)(KCQ); } #ifdef CONFIG_USBDEV_MSC_THREAD static void usbd_msc_thread_memory_read_done(void) { size_t flags; uint32_t transfer_len; uint32_t offset; USB_LOG_DBG("read addr:%d\r\n", usbd_msc_cfg.scsi_blk_addr); flags = usb_osal_enter_critical_section(); transfer_len = MIN(usbd_msc_cfg.scsi_blk_len, MASS_STORAGE_BULK_EP_MPS); offset = usbd_msc_cfg.scsi_blk_addr % usbd_msc_cfg.scsi_blk_size; usbd_msc_cfg.scsi_blk_addr += transfer_len; usbd_msc_cfg.scsi_blk_len -= transfer_len; usbd_msc_cfg.csw.dDataResidue -= transfer_len; if (usbd_msc_cfg.scsi_blk_len == 0) { usbd_msc_cfg.stage = MSC_SEND_CSW; } usb_osal_leave_critical_section(flags); usbd_ep_write(mass_ep_data[MSD_IN_EP_IDX].ep_addr, &usbd_msc_cfg.block_buffer[offset], transfer_len, NULL); } #endif static bool SCSI_processRead(void) { uint32_t transfer_len; USB_LOG_DBG("read addr:%d\r\n", usbd_msc_cfg.scsi_blk_addr); transfer_len = MIN(usbd_msc_cfg.scsi_blk_len, MASS_STORAGE_BULK_EP_MPS); /* we read an entire block */ if (!(usbd_msc_cfg.scsi_blk_addr % usbd_msc_cfg.scsi_blk_size)) { #ifdef CONFIG_USBDEV_MSC_THREAD thread_op = MSC_THREAD_OP_READ_MEM; usb_osal_sem_give(msc_sem); return true; #else if (usbd_msc_sector_read((usbd_msc_cfg.scsi_blk_addr / usbd_msc_cfg.scsi_blk_size), usbd_msc_cfg.block_buffer, usbd_msc_cfg.scsi_blk_size) != 0) { SCSI_SetSenseData(SCSI_KCQHE_UREINRESERVEDAREA); return false; } #endif } usbd_ep_write(mass_ep_data[MSD_IN_EP_IDX].ep_addr, &usbd_msc_cfg.block_buffer[usbd_msc_cfg.scsi_blk_addr % usbd_msc_cfg.scsi_blk_size], transfer_len, NULL); usbd_msc_cfg.scsi_blk_addr += transfer_len; usbd_msc_cfg.scsi_blk_len -= transfer_len; usbd_msc_cfg.csw.dDataResidue -= transfer_len; if (usbd_msc_cfg.scsi_blk_len == 0) { usbd_msc_cfg.stage = MSC_SEND_CSW; } return true; } #ifdef CONFIG_USBDEV_MSC_THREAD static void usbd_msc_thread_memory_write_done() { size_t flags; uint32_t bytes_read; USB_LOG_DBG("write addr:%d\r\n", usbd_msc_cfg.scsi_blk_addr); flags = usb_osal_enter_critical_section(); bytes_read = current_byte_read; usbd_msc_cfg.scsi_blk_addr += bytes_read; usbd_msc_cfg.scsi_blk_len -= bytes_read; usbd_msc_cfg.csw.dDataResidue -= bytes_read; usb_osal_leave_critical_section(flags); thread_op = MSC_THREAD_OP_WRITE_DONE; /*set ep ack to recv next data*/ usbd_ep_read(mass_ep_data[MSD_OUT_EP_IDX].ep_addr, NULL, 0, NULL); if (usbd_msc_cfg.scsi_blk_len == 0) { sendCSW(CSW_STATUS_CMD_PASSED); } } #endif static bool SCSI_processWrite() { uint32_t bytes_read; USB_LOG_DBG("write addr:%d\r\n", usbd_msc_cfg.scsi_blk_addr); /* we fill an array in RAM of 1 block before writing it in memory */ usbd_ep_read(mass_ep_data[MSD_OUT_EP_IDX].ep_addr, &usbd_msc_cfg.block_buffer[usbd_msc_cfg.scsi_blk_addr % usbd_msc_cfg.scsi_blk_size], MASS_STORAGE_BULK_EP_MPS, &bytes_read); /* if the array is filled, write it in memory */ if ((usbd_msc_cfg.scsi_blk_addr % usbd_msc_cfg.scsi_blk_size) + bytes_read >= usbd_msc_cfg.scsi_blk_size) { #ifdef CONFIG_USBDEV_MSC_THREAD thread_op = MSC_THREAD_OP_WRITE_MEM; current_byte_read = bytes_read; usb_osal_sem_give(msc_sem); return true; #else if (usbd_msc_sector_write((usbd_msc_cfg.scsi_blk_addr / usbd_msc_cfg.scsi_blk_size), usbd_msc_cfg.block_buffer, usbd_msc_cfg.scsi_blk_size) != 0) { SCSI_SetSenseData(SCSI_KCQHE_WRITEFAULT); return false; } #endif } usbd_msc_cfg.scsi_blk_addr += bytes_read; usbd_msc_cfg.scsi_blk_len -= bytes_read; usbd_msc_cfg.csw.dDataResidue -= bytes_read; if (usbd_msc_cfg.scsi_blk_len == 0) { sendCSW(CSW_STATUS_CMD_PASSED); } return true; } static bool SCSI_processVerify() { #if 0 uint32_t bytes_read; uint8_t out_buffer[MASS_STORAGE_BULK_EP_MPS]; USB_LOG_DBG("verify addr:%d\r\n", usbd_msc_cfg.scsi_blk_addr); /* we fill an array in RAM of 1 block before writing it in memory */ usbd_ep_read(mass_ep_data[MSD_OUT_EP_IDX].ep_addr, out_buffer, MASS_STORAGE_BULK_EP_MPS, &bytes_read); /* we read an entire block */ if (!(usbd_msc_cfg.scsi_blk_addr % usbd_msc_cfg.scsi_blk_size)) { if (usbd_msc_sector_read((usbd_msc_cfg.scsi_blk_addr / usbd_msc_cfg.scsi_blk_size), usbd_msc_cfg.block_buffer, usbd_msc_cfg.scsi_blk_size) != 0) { SCSI_SetSenseData(SCSI_KCQHE_UREINRESERVEDAREA); return false; } } /* info are in RAM -> no need to re-read memory */ for (uint16_t i = 0U; i < bytes_read; i++) { if (usbd_msc_cfg.block_buffer[usbd_msc_cfg.scsi_blk_addr % usbd_msc_cfg.scsi_blk_size + i] != out_buffer[i]) { USB_LOG_DBG("Mismatch sector %d offset %d", usbd_msc_cfg.scsi_blk_addr / usbd_msc_cfg.scsi_blk_size, i); memOK = false; break; } } usbd_msc_cfg.scsi_blk_addr += bytes_read; usbd_msc_cfg.scsi_blk_len -= bytes_read; usbd_msc_cfg.csw.dDataResidue -= bytes_read; if (usbd_msc_cfg.scsi_blk_len == 0) { sendCSW(CSW_STATUS_CMD_PASSED); } #endif return true; } static bool SCSI_CBWDecode() { uint8_t *buf2send = usbd_msc_cfg.block_buffer; uint32_t len2send = 0; uint32_t bytes_read; bool ret = false; usbd_ep_read(mass_ep_data[MSD_OUT_EP_IDX].ep_addr, (uint8_t *)&usbd_msc_cfg.cbw, USB_SIZEOF_MSC_CBW, &bytes_read); if (bytes_read != sizeof(struct CBW)) { USB_LOG_ERR("size != sizeof(cbw)\r\n"); SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } usbd_msc_cfg.csw.dTag = usbd_msc_cfg.cbw.dTag; usbd_msc_cfg.csw.dDataResidue = usbd_msc_cfg.cbw.dDataLength; if ((usbd_msc_cfg.cbw.bLUN > 1) || (usbd_msc_cfg.cbw.dSignature != MSC_CBW_Signature) || (usbd_msc_cfg.cbw.bCBLength < 1) || (usbd_msc_cfg.cbw.bCBLength > 16)) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } else { switch (usbd_msc_cfg.cbw.CB[0]) { case SCSI_CMD_TESTUNITREADY: ret = SCSI_testUnitReady(&buf2send, &len2send); break; case SCSI_CMD_REQUESTSENSE: ret = SCSI_requestSense(&buf2send, &len2send); break; case SCSI_CMD_INQUIRY: ret = SCSI_inquiry(&buf2send, &len2send); break; case SCSI_CMD_STARTSTOPUNIT: ret = SCSI_startStopUnit(&buf2send, &len2send); break; case SCSI_CMD_PREVENTMEDIAREMOVAL: ret = SCSI_preventAllowMediaRemoval(&buf2send, &len2send); break; case SCSI_CMD_MODESENSE6: ret = SCSI_modeSense6(&buf2send, &len2send); break; case SCSI_CMD_MODESENSE10: ret = SCSI_modeSense10(&buf2send, &len2send); break; case SCSI_CMD_READFORMATCAPACITIES: ret = SCSI_readFormatCapacity(&buf2send, &len2send); break; case SCSI_CMD_READCAPACITY10: ret = SCSI_readCapacity10(&buf2send, &len2send); break; case SCSI_CMD_READ10: ret = SCSI_read10(NULL, 0); break; case SCSI_CMD_READ12: ret = SCSI_read12(NULL, 0); break; case SCSI_CMD_WRITE10: ret = SCSI_write10(NULL, 0); break; case SCSI_CMD_WRITE12: ret = SCSI_write12(NULL, 0); break; case SCSI_CMD_VERIFY10: ret = SCSI_verify10(NULL, 0); break; default: SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); USB_LOG_WRN("unsupported cmd:0x%02x\r\n", usbd_msc_cfg.cbw.CB[0]); ret = false; break; } } if (ret) { if (usbd_msc_cfg.stage == MSC_READ_CBW) { if (len2send) { sendLastData(buf2send, len2send); } else { sendCSW(CSW_STATUS_CMD_PASSED); } } } return ret; } static bool SCSI_testUnitReady(uint8_t **data, uint32_t *len) { if (usbd_msc_cfg.cbw.dDataLength != 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } *data = NULL; *len = 0; return true; } static bool SCSI_requestSense(uint8_t **data, uint32_t *len) { uint8_t data_len = SCSIRESP_FIXEDSENSEDATA_SIZEOF; if (usbd_msc_cfg.cbw.dDataLength == 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } if (usbd_msc_cfg.cbw.CB[4] < SCSIRESP_FIXEDSENSEDATA_SIZEOF) { data_len = usbd_msc_cfg.cbw.CB[4]; } uint8_t request_sense[SCSIRESP_FIXEDSENSEDATA_SIZEOF] = { 0x70, 0x00, 0x00, /* Sense Key */ 0x00, 0x00, 0x00, 0x00, SCSIRESP_FIXEDSENSEDATA_SIZEOF - 8, 0x00, 0x00, 0x00, 0x00, 0x00, /* Additional Sense Code */ 0x00, /* Additional Sense Request */ 0x00, 0x00, 0x00, 0x00, }; request_sense[2] = usbd_msc_cfg.sKey; request_sense[12] = usbd_msc_cfg.ASC; request_sense[13] = usbd_msc_cfg.ASQ; #if 0 request_sense[ 2] = 0x06; /* UNIT ATTENTION */ request_sense[12] = 0x28; /* Additional Sense Code: Not ready to ready transition */ request_sense[13] = 0x00; /* Additional Sense Code Qualifier */ #endif #if 0 request_sense[ 2] = 0x02; /* NOT READY */ request_sense[12] = 0x3A; /* Additional Sense Code: Medium not present */ request_sense[13] = 0x00; /* Additional Sense Code Qualifier */ #endif #if 0 request_sense[ 2] = 0x05; /* ILLEGAL REQUEST */ request_sense[12] = 0x20; /* Additional Sense Code: Invalid command */ request_sense[13] = 0x00; /* Additional Sense Code Qualifier */ #endif #if 0 request_sense[ 2] = 0x00; /* NO SENSE */ request_sense[12] = 0x00; /* Additional Sense Code: No additional code */ request_sense[13] = 0x00; /* Additional Sense Code Qualifier */ #endif memcpy(*data, (uint8_t *)request_sense, data_len); *len = data_len; return true; } static bool SCSI_inquiry(uint8_t **data, uint32_t *len) { uint8_t data_len = SCSIRESP_INQUIRY_SIZEOF; uint8_t inquiry00[6] = { 0x00, 0x00, 0x00, (0x06 - 4U), 0x00, 0x80 }; /* USB Mass storage VPD Page 0x80 Inquiry Data for Unit Serial Number */ uint8_t inquiry80[8] = { 0x00, 0x80, 0x00, 0x08, 0x20, /* Put Product Serial number */ 0x20, 0x20, 0x20 }; uint8_t inquiry[SCSIRESP_INQUIRY_SIZEOF] = { /* 36 */ /* LUN 0 */ 0x00, 0x80, 0x02, 0x02, (SCSIRESP_INQUIRY_SIZEOF - 5), 0x00, 0x00, 0x00, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', /* Manufacturer : 8 bytes */ ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', /* Product : 16 Bytes */ ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' /* Version : 4 Bytes */ }; memcpy(&inquiry[8], CONFIG_USBDEV_MSC_MANUFACTURER_STRING, strlen(CONFIG_USBDEV_MSC_MANUFACTURER_STRING)); memcpy(&inquiry[16], CONFIG_USBDEV_MSC_PRODUCT_STRING, strlen(CONFIG_USBDEV_MSC_PRODUCT_STRING)); memcpy(&inquiry[32], CONFIG_USBDEV_MSC_VERSION_STRING, strlen(CONFIG_USBDEV_MSC_VERSION_STRING)); if (usbd_msc_cfg.cbw.dDataLength == 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } if ((usbd_msc_cfg.cbw.CB[1] & 0x01U) != 0U) { /* Evpd is set */ if (usbd_msc_cfg.cbw.CB[2] == 0U) { /* Request for Supported Vital Product Data Pages*/ data_len = 0x06; memcpy(*data, (uint8_t *)inquiry00, data_len); } else if (usbd_msc_cfg.cbw.CB[2] == 0x80U) { /* Request for VPD page 0x80 Unit Serial Number */ data_len = 0x08; memcpy(*data, (uint8_t *)inquiry80, data_len); } else { /* Request Not supported */ SCSI_SetSenseData(SCSI_KCQIR_INVALIDFIELDINCBA); return false; } } else { if (usbd_msc_cfg.cbw.CB[4] < SCSIRESP_INQUIRY_SIZEOF) { data_len = usbd_msc_cfg.cbw.CB[4]; } memcpy(*data, (uint8_t *)inquiry, data_len); } *len = data_len; return true; } static bool SCSI_startStopUnit(uint8_t **data, uint32_t *len) { if (usbd_msc_cfg.cbw.dDataLength != 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } if ((usbd_msc_cfg.cbw.CB[4] & 0x3U) == 0x1U) /* START=1 */ { //SCSI_MEDIUM_UNLOCKED; } else if ((usbd_msc_cfg.cbw.CB[4] & 0x3U) == 0x2U) /* START=0 and LOEJ Load Eject=1 */ { //SCSI_MEDIUM_EJECTED; } else if ((usbd_msc_cfg.cbw.CB[4] & 0x3U) == 0x3U) /* START=1 and LOEJ Load Eject=1 */ { //SCSI_MEDIUM_UNLOCKED; } else { } *data = NULL; *len = 0; return true; } static bool SCSI_preventAllowMediaRemoval(uint8_t **data, uint32_t *len) { if (usbd_msc_cfg.cbw.dDataLength != 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } if (usbd_msc_cfg.cbw.CB[4] == 0U) { //SCSI_MEDIUM_UNLOCKED; } else { //SCSI_MEDIUM_LOCKED; } *data = NULL; *len = 0; return true; } static bool SCSI_modeSense6(uint8_t **data, uint32_t *len) { uint8_t data_len = 4; if (usbd_msc_cfg.cbw.dDataLength == 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } if (usbd_msc_cfg.cbw.CB[4] < SCSIRESP_MODEPARAMETERHDR6_SIZEOF) { data_len = usbd_msc_cfg.cbw.CB[4]; } uint8_t sense6[SCSIRESP_MODEPARAMETERHDR6_SIZEOF] = { 0x03, 0x00, 0x00, 0x00 }; memcpy(*data, (uint8_t *)sense6, data_len); *len = data_len; return true; } static bool SCSI_modeSense10(uint8_t **data, uint32_t *len) { uint8_t data_len = 27; if (usbd_msc_cfg.cbw.dDataLength == 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } if (usbd_msc_cfg.cbw.CB[8] < 27) { data_len = usbd_msc_cfg.cbw.CB[8]; } uint8_t sense10[27] = { 0x00, 0x26, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x08, 0x12, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; memcpy(*data, (uint8_t *)sense10, data_len); *len = data_len; return true; } static bool SCSI_readFormatCapacity(uint8_t **data, uint32_t *len) { if (usbd_msc_cfg.cbw.dDataLength == 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } uint8_t format_capacity[SCSIRESP_READFORMATCAPACITIES_SIZEOF] = { 0x00, 0x00, 0x00, 0x08, /* Capacity List Length */ (uint8_t)((usbd_msc_cfg.scsi_blk_nbr >> 24) & 0xff), (uint8_t)((usbd_msc_cfg.scsi_blk_nbr >> 16) & 0xff), (uint8_t)((usbd_msc_cfg.scsi_blk_nbr >> 8) & 0xff), (uint8_t)((usbd_msc_cfg.scsi_blk_nbr >> 0) & 0xff), 0x02, /* Descriptor Code: Formatted Media */ 0x00, (uint8_t)((usbd_msc_cfg.scsi_blk_size >> 8) & 0xff), (uint8_t)((usbd_msc_cfg.scsi_blk_size >> 0) & 0xff), }; memcpy(*data, (uint8_t *)format_capacity, SCSIRESP_READFORMATCAPACITIES_SIZEOF); *len = SCSIRESP_READFORMATCAPACITIES_SIZEOF; return true; } static bool SCSI_readCapacity10(uint8_t **data, uint32_t *len) { if (usbd_msc_cfg.cbw.dDataLength == 0U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } uint8_t capacity10[SCSIRESP_READCAPACITY10_SIZEOF] = { (uint8_t)(((usbd_msc_cfg.scsi_blk_nbr - 1) >> 24) & 0xff), (uint8_t)(((usbd_msc_cfg.scsi_blk_nbr - 1) >> 16) & 0xff), (uint8_t)(((usbd_msc_cfg.scsi_blk_nbr - 1) >> 8) & 0xff), (uint8_t)(((usbd_msc_cfg.scsi_blk_nbr - 1) >> 0) & 0xff), (uint8_t)((usbd_msc_cfg.scsi_blk_size >> 24) & 0xff), (uint8_t)((usbd_msc_cfg.scsi_blk_size >> 16) & 0xff), (uint8_t)((usbd_msc_cfg.scsi_blk_size >> 8) & 0xff), (uint8_t)((usbd_msc_cfg.scsi_blk_size >> 0) & 0xff), }; memcpy(*data, (uint8_t *)capacity10, SCSIRESP_READCAPACITY10_SIZEOF); *len = SCSIRESP_READCAPACITY10_SIZEOF; return true; } static bool SCSI_read10(uint8_t **data, uint32_t *len) { /* Logical Block Address of First Block */ uint32_t lba = 0; uint32_t blk_num = 0; if (((usbd_msc_cfg.cbw.bmFlags & 0x80U) != 0x80U) || (usbd_msc_cfg.cbw.dDataLength == 0U)) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } lba = GET_BE32(&usbd_msc_cfg.cbw.CB[2]); USB_LOG_DBG("lba: 0x%x\r\n", lba); usbd_msc_cfg.scsi_blk_addr = lba * usbd_msc_cfg.scsi_blk_size; /* Number of Blocks to transfer */ blk_num = GET_BE16(&usbd_msc_cfg.cbw.CB[7]); usbd_msc_cfg.scsi_blk_len = blk_num * usbd_msc_cfg.scsi_blk_size; if ((lba + blk_num) > usbd_msc_cfg.scsi_blk_nbr) { SCSI_SetSenseData(SCSI_KCQIR_LBAOUTOFRANGE); USB_LOG_ERR("LBA out of range\r\n"); return false; } if (usbd_msc_cfg.cbw.dDataLength != usbd_msc_cfg.scsi_blk_len) { USB_LOG_ERR("scsi_blk_len does not match with dDataLength\r\n"); return false; } usbd_msc_cfg.stage = MSC_DATA_IN; return SCSI_processRead(); } static bool SCSI_read12(uint8_t **data, uint32_t *len) { /* Logical Block Address of First Block */ uint32_t lba = 0; uint32_t blk_num = 0; if (((usbd_msc_cfg.cbw.bmFlags & 0x80U) != 0x80U) || (usbd_msc_cfg.cbw.dDataLength == 0U)) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } lba = GET_BE32(&usbd_msc_cfg.cbw.CB[2]); USB_LOG_DBG("lba: 0x%x\r\n", lba); usbd_msc_cfg.scsi_blk_addr = lba * usbd_msc_cfg.scsi_blk_size; /* Number of Blocks to transfer */ blk_num = GET_BE32(&usbd_msc_cfg.cbw.CB[6]); USB_LOG_DBG("num (block) : 0x%x\r\n", blk_num); usbd_msc_cfg.scsi_blk_len = blk_num * usbd_msc_cfg.scsi_blk_size; if ((lba + blk_num) > usbd_msc_cfg.scsi_blk_nbr) { SCSI_SetSenseData(SCSI_KCQIR_LBAOUTOFRANGE); USB_LOG_ERR("LBA out of range\r\n"); return false; } if (usbd_msc_cfg.cbw.dDataLength != usbd_msc_cfg.scsi_blk_len) { USB_LOG_ERR("scsi_blk_len does not match with dDataLength\r\n"); return false; } usbd_msc_cfg.stage = MSC_DATA_IN; return SCSI_processRead(); } static bool SCSI_write10(uint8_t **data, uint32_t *len) { /* Logical Block Address of First Block */ uint32_t lba = 0; uint32_t blk_num = 0; if (((usbd_msc_cfg.cbw.bmFlags & 0x80U) != 0x00U) || (usbd_msc_cfg.cbw.dDataLength == 0U)) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } lba = GET_BE32(&usbd_msc_cfg.cbw.CB[2]); USB_LOG_DBG("lba: 0x%x\r\n", lba); usbd_msc_cfg.scsi_blk_addr = lba * usbd_msc_cfg.scsi_blk_size; /* Number of Blocks to transfer */ blk_num = GET_BE16(&usbd_msc_cfg.cbw.CB[7]); USB_LOG_DBG("num (block) : 0x%x\r\n", blk_num); usbd_msc_cfg.scsi_blk_len = blk_num * usbd_msc_cfg.scsi_blk_size; if ((lba + blk_num) > usbd_msc_cfg.scsi_blk_nbr) { USB_LOG_ERR("LBA out of range\r\n"); return false; } if (usbd_msc_cfg.cbw.dDataLength != usbd_msc_cfg.scsi_blk_len) { return false; } usbd_msc_cfg.stage = MSC_DATA_OUT; return true; } static bool SCSI_write12(uint8_t **data, uint32_t *len) { /* Logical Block Address of First Block */ uint32_t lba = 0; uint32_t blk_num = 0; if (((usbd_msc_cfg.cbw.bmFlags & 0x80U) != 0x00U) || (usbd_msc_cfg.cbw.dDataLength == 0U)) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } lba = GET_BE32(&usbd_msc_cfg.cbw.CB[2]); USB_LOG_DBG("lba: 0x%x\r\n", lba); usbd_msc_cfg.scsi_blk_addr = lba * usbd_msc_cfg.scsi_blk_size; /* Number of Blocks to transfer */ blk_num = GET_BE32(&usbd_msc_cfg.cbw.CB[6]); USB_LOG_DBG("num (block) : 0x%x\r\n", blk_num); usbd_msc_cfg.scsi_blk_len = blk_num * usbd_msc_cfg.scsi_blk_size; if ((lba + blk_num) > usbd_msc_cfg.scsi_blk_nbr) { USB_LOG_ERR("LBA out of range\r\n"); return false; } if (usbd_msc_cfg.cbw.dDataLength != usbd_msc_cfg.scsi_blk_len) { return false; } usbd_msc_cfg.stage = MSC_DATA_OUT; return true; } static bool SCSI_verify10(uint8_t **data, uint32_t *len) { /* Logical Block Address of First Block */ uint32_t lba = 0; uint32_t blk_num = 0; if ((usbd_msc_cfg.cbw.CB[1] & 0x02U) == 0x00U) { return true; } if (((usbd_msc_cfg.cbw.bmFlags & 0x80U) != 0x00U) || (usbd_msc_cfg.cbw.dDataLength == 0U)) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDCOMMAND); return false; } if ((usbd_msc_cfg.cbw.CB[1] & 0x02U) == 0x02U) { SCSI_SetSenseData(SCSI_KCQIR_INVALIDFIELDINCBA); return false; /* Error, Verify Mode Not supported*/ } lba = GET_BE32(&usbd_msc_cfg.cbw.CB[2]); USB_LOG_DBG("lba: 0x%x\r\n", lba); usbd_msc_cfg.scsi_blk_addr = lba * usbd_msc_cfg.scsi_blk_size; /* Number of Blocks to transfer */ blk_num = GET_BE16(&usbd_msc_cfg.cbw.CB[7]); USB_LOG_DBG("num (block) : 0x%x\r\n", blk_num); usbd_msc_cfg.scsi_blk_len = blk_num * usbd_msc_cfg.scsi_blk_size; if ((lba + blk_num) > usbd_msc_cfg.scsi_blk_nbr) { USB_LOG_ERR("LBA out of range\r\n"); return false; } if (usbd_msc_cfg.cbw.dDataLength != usbd_msc_cfg.scsi_blk_len) { return false; } memOK = true; usbd_msc_cfg.stage = MSC_DATA_OUT; return true; } static void mass_storage_bulk_out(uint8_t ep) { switch (usbd_msc_cfg.stage) { case MSC_READ_CBW: if (SCSI_CBWDecode() == false) { USB_LOG_ERR("Command:0x%02x decode err\r\n", usbd_msc_cfg.cbw.CB[0]); usbd_msc_bot_abort(); return; } break; /* last command is write10 or write12,and has caculated blk_addr and blk_len,so the device start reading data from host*/ case MSC_DATA_OUT: switch (usbd_msc_cfg.cbw.CB[0]) { case SCSI_CMD_WRITE10: case SCSI_CMD_WRITE12: if (SCSI_processWrite() == false) { sendCSW(CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/ //return; } break; case SCSI_CMD_VERIFY10: if (SCSI_processVerify() == false) { sendCSW(CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/ //return; } break; default: break; } break; default: break; } #ifdef CONFIG_USBDEV_MSC_THREAD if (thread_op != MSC_THREAD_OP_WRITE_MEM) { /*set ep ack to recv next data*/ usbd_ep_read(ep, NULL, 0, NULL); } #else /*set ep ack to recv next data*/ usbd_ep_read(ep, NULL, 0, NULL); #endif } /** * @brief EP Bulk IN handler, used to send data to the Host * * @param ep Endpoint address. * @param ep_status Endpoint status code. * * @return N/A. */ static void mass_storage_bulk_in(uint8_t ep) { switch (usbd_msc_cfg.stage) { /* last command is read10 or read12,and has caculated blk_addr and blk_len,so the device has to send remain data to host*/ case MSC_DATA_IN: switch (usbd_msc_cfg.cbw.CB[0]) { case SCSI_CMD_READ10: case SCSI_CMD_READ12: if (SCSI_processRead() == false) { sendCSW(CSW_STATUS_CMD_FAILED); /* send fail status to host,and the host will retry*/ return; } break; default: break; } break; /*the device has to send a CSW*/ case MSC_SEND_CSW: sendCSW(CSW_STATUS_CMD_PASSED); break; /*the host has received the CSW*/ case MSC_WAIT_CSW: usbd_msc_cfg.stage = MSC_READ_CBW; break; default: break; } } void msc_storage_notify_handler(uint8_t event, void *arg) { switch (event) { case USBD_EVENT_RESET: usbd_msc_reset(); break; default: break; } } #ifdef CONFIG_USBDEV_MSC_THREAD static void usbd_msc_thread(void *argument) { while (1) { usb_osal_sem_take(msc_sem, 0xffffffff); switch (thread_op) { case MSC_THREAD_OP_READ_MEM: if (usbd_msc_sector_read((usbd_msc_cfg.scsi_blk_addr / usbd_msc_cfg.scsi_blk_size), usbd_msc_cfg.block_buffer, usbd_msc_cfg.scsi_blk_size) != 0) { SCSI_SetSenseData(SCSI_KCQHE_UREINRESERVEDAREA); } usbd_msc_thread_memory_read_done(); break; case MSC_THREAD_OP_WRITE_MEM: if (usbd_msc_sector_write((usbd_msc_cfg.scsi_blk_addr / usbd_msc_cfg.scsi_blk_size), usbd_msc_cfg.block_buffer, usbd_msc_cfg.scsi_blk_size) != 0) { SCSI_SetSenseData(SCSI_KCQHE_WRITEFAULT); } usbd_msc_thread_memory_write_done(); break; default: break; } } } #endif static usbd_class_t msc_class; static usbd_interface_t msc_intf = { .class_handler = msc_storage_class_request_handler, .vendor_handler = NULL, .notify_handler = msc_storage_notify_handler, }; void usbd_msc_class_init(uint8_t out_ep, uint8_t in_ep) { msc_class.name = "usbd_msc"; usbd_class_register(&msc_class); usbd_class_add_interface(&msc_class, &msc_intf); mass_ep_data[0].ep_addr = out_ep; mass_ep_data[0].ep_cb = mass_storage_bulk_out; mass_ep_data[1].ep_addr = in_ep; mass_ep_data[1].ep_cb = mass_storage_bulk_in; usbd_interface_add_endpoint(&msc_intf, &mass_ep_data[0]); usbd_interface_add_endpoint(&msc_intf, &mass_ep_data[1]); memset((uint8_t *)&usbd_msc_cfg, 0, sizeof(struct usbd_msc_cfg_priv)); usbd_msc_get_cap(0, &usbd_msc_cfg.scsi_blk_nbr, &usbd_msc_cfg.scsi_blk_size); if (usbd_msc_cfg.block_buffer == NULL) { usbd_msc_cfg.block_buffer = usb_iomalloc(usbd_msc_cfg.scsi_blk_size * sizeof(uint8_t)); } #ifdef CONFIG_USBDEV_MSC_THREAD msc_sem = usb_osal_sem_create(1); msc_thread = usb_osal_thread_create("usbd_msc", CONFIG_USBDEV_MSC_STACKSIZE, CONFIG_USBDEV_MSC_PRIO, usbd_msc_thread, NULL); if (msc_thread == NULL) { return; } #endif }