wrapping msc flash write

lib/tinyusb

@@ -1 +1 @@
-Subproject commit ba223b2a05d88901f3255a218329b7ff4c7d6128
+Subproject commit 14471f31545b006cde01d7317518eb440942532f

src/main.c

@@ -61,6 +61,8 @@
 #include "tusb.h"
 #include "tusb_descriptors.h"
 
+#include "msc/msc_flash.h"
+
 
 #define BOOTLOADER_VERSION_REGISTER         NRF_TIMER2->CC[0]
 
@@ -340,8 +342,9 @@ int main(void)
   /* Initialize a blinky timer to show that we're in bootloader */
   (void) app_timer_create(&blinky_timer_id, APP_TIMER_MODE_REPEATED, blinky_handler);
 
-  // Init bootloader and SD
+  // Init bootloader
   (void) bootloader_init();
+  msc_flash_init(); // init flash, must be after bootloader_init();
 
   if (bootloader_dfu_sd_in_progress())
   {

src/msc/msc_flash.c

@@ -38,13 +38,27 @@
 
 #if CFG_TUD_MSC
 
+#include "pstorage.h"
+
 /*------------------------------------------------------------------*/
 /* MACRO TYPEDEF CONSTANT ENUM
  *------------------------------------------------------------------*/
+enum
+{
+  WRITE10_IDLE,
+  WRITE10_ERASING,
+  WRITE10_ERASED,
+  WRITE10_WRITING,
+  WRITE10_WRITTEN,
+  WRITE10_FAILED
+};
 
 /*------------------------------------------------------------------*/
-/* VARIABLE DECLARATION
+/* VARIABLES
  *------------------------------------------------------------------*/
+static uint8_t _wr10_state;
+static pstorage_handle_t _fat_psh = { .module_id = 0, .block_id = MSC_FLASH_ADDR_START } ;
+
 
 static scsi_inquiry_data_t const mscd_inquiry_data =
 {
@@ -85,12 +99,39 @@ static scsi_mode_parameters_t const msc_dev_mode_para =
     .block_descriptor_length = 0
 };
 
-//--------------------------------------------------------------------+
+/*------------------------------------------------------------------*/
-// tinyusb callbacks
+/*
-//--------------------------------------------------------------------+
+ *------------------------------------------------------------------*/
+static void fat_pstorage_cb(pstorage_handle_t * p_handle, uint8_t op_code, uint32_t result, uint8_t  * p_data, uint32_t  data_len)
+{
+  if ( result != NRF_SUCCESS )
+  {
+    _wr10_state = WRITE10_FAILED;
+    TU_ASSERT(false, );
+  }
+
+  if ( PSTORAGE_CLEAR_OP_CODE == op_code)
+  {
+    if ( WRITE10_ERASING == _wr10_state) _wr10_state = WRITE10_ERASED;
+  }
+  else if ( PSTORAGE_STORE_OP_CODE ==  op_code)
+  {
+    if ( WRITE10_WRITING == _wr10_state) _wr10_state = WRITE10_WRITTEN;
+  }
+}
+
+/*------------------------------------------------------------------*/
+/* API
+ *------------------------------------------------------------------*/
+void msc_flash_init(void)
+{
+  pstorage_module_param_t  fat_psp = { .cb = fat_pstorage_cb};
+  pstorage_register(&fat_psp, &_fat_psh);
+}
+
 void msc_flash_mount(void)
 {
-
+  _wr10_state = WRITE10_IDLE;
 }
 
 void msc_flash_umount(void)
@@ -98,12 +139,15 @@ void msc_flash_umount(void)
 
 }
 
-bool tud_msc_scsi_cb (uint8_t rhport, uint8_t lun, uint8_t scsi_cmd[16], void* buffer, uint16_t* p_len)
+//--------------------------------------------------------------------+
+// tinyusb callbacks
+//--------------------------------------------------------------------+
+int32_t tud_msc_scsi_cb (uint8_t rhport, uint8_t lun, uint8_t scsi_cmd[16], void* buffer, uint16_t bufsize)
 {
   // read10 & write10 has their own callback and MUST not be handled here
 
-  void const* bufptr = NULL;
+  void const* ptr = NULL;
-  uint16_t buflen = 0;
+  uint16_t len = 0;
 
   // most scsi handled is input
   bool in_xfer = true;
@@ -111,52 +155,57 @@ bool tud_msc_scsi_cb (uint8_t rhport, uint8_t lun, uint8_t scsi_cmd[16], void* b
   switch (scsi_cmd[0])
   {
     case SCSI_CMD_INQUIRY:
-      bufptr = &mscd_inquiry_data;
+      ptr = &mscd_inquiry_data;
-      buflen = sizeof(scsi_inquiry_data_t);
+      len = sizeof(scsi_inquiry_data_t);
     break;
 
     case SCSI_CMD_READ_CAPACITY_10:
-      bufptr = &mscd_read_capacity10_data;
+      ptr = &mscd_read_capacity10_data;
-      buflen = sizeof(scsi_read_capacity10_data_t);
+      len = sizeof(scsi_read_capacity10_data_t);
     break;
 
     case SCSI_CMD_REQUEST_SENSE:
-      bufptr = &mscd_sense_data;
+      ptr = &mscd_sense_data;
-      buflen = sizeof(scsi_sense_fixed_data_t);
+      len = sizeof(scsi_sense_fixed_data_t);
     break;
 
     case SCSI_CMD_READ_FORMAT_CAPACITY:
-      bufptr = &mscd_format_capacity_data;
+      ptr = &mscd_format_capacity_data;
-      buflen = sizeof(scsi_read_format_capacity_data_t);
+      len = sizeof(scsi_read_format_capacity_data_t);
     break;
 
     case SCSI_CMD_MODE_SENSE_6:
-      bufptr = &msc_dev_mode_para;
+      ptr = &msc_dev_mode_para;
-      buflen = sizeof(msc_dev_mode_para);
+      len = sizeof(msc_dev_mode_para);
     break;
 
     case SCSI_CMD_TEST_UNIT_READY:
-      bufptr = NULL;
+      ptr = NULL;
-      buflen= 0;
+      len = 0;
     break;
 
     case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:
-      bufptr = NULL;
+      ptr = NULL;
-      buflen= 0;
+      len = 0;
     break;
 
     default:
-      (*p_len) = 0;
+      // negative is error -> Data stage is STALL, status = failed
-      return false;
+      return -1;
   }
 
-  if ( bufptr && buflen && in_xfer)
+  // return len must not larger than bufsize
-  {
+  TU_ASSERT( bufsize >= len );
-    // Response len must not larger than expected from host
-    TU_ASSERT( (*p_len) >= buflen );
 
-    memcpy(buffer, bufptr, buflen);
+  if ( ptr && len )
-    (*p_len) = buflen;
+  {
+    if(in_xfer)
+    {
+      memcpy(buffer, ptr, len);
+    }else
+    {
+      // SCSI output
+    }
   }
 
   //------------- clear sense data if it is not request sense command -------------//
@@ -167,23 +216,106 @@ bool tud_msc_scsi_cb (uint8_t rhport, uint8_t lun, uint8_t scsi_cmd[16], void* b
     mscd_sense_data.additional_sense_qualifier = 0;
   }
 
-  return true;
+  return len;
 }
 
-
+/*------------------------------------------------------------------*/
-uint32_t tud_msc_read10_cb (uint8_t rhport, uint8_t lun, uint32_t lba, uint32_t offset, void* buffer, uint32_t bufsize)
+/* Tinyusb Flash READ10 & WRITE10
+ *------------------------------------------------------------------*/
+int32_t tud_msc_read10_cb (uint8_t rhport, uint8_t lun, uint32_t lba, uint32_t offset, void* buffer, uint32_t bufsize)
 {
-//  uint8_t* addr = msc_device_ramdisk[lba] + offset;
+  (void) rhport; (void) lun;
-//  memcpy(buffer, addr, bufsize);
+
+  uint32_t addr = MSC_FLASH_ADDR_START + lba*MSC_FLASH_BLOCK_SIZE + offset;
+  memcpy(buffer, (uint8_t*) addr, bufsize);
 
   return bufsize;
 }
-uint32_t tud_msc_write10_cb (uint8_t rhport, uint8_t lun, uint32_t lba, uint32_t offset, void* buffer, uint32_t bufsize)
-{
-//  uint8_t* addr = msc_device_ramdisk[lba] + offset;
-//  memcpy(addr, buffer, bufsize);
 
-  return bufsize;
+int32_t tud_msc_write10_cb (uint8_t rhport, uint8_t lun, uint32_t lba, uint32_t offset, void* buffer, uint32_t bufsize)
+{
+  (void) rhport; (void) lun;
+
+  enum { PAGE_SIZE = 4096 };
+
+  static uint8_t page_cached[PAGE_SIZE];
+
+  uint32_t addr = MSC_FLASH_ADDR_START + lba*MSC_FLASH_BLOCK_SIZE + offset;
+
+  /* 1. queue flash erase pstorage_clear(), return 0 until erasing is done
+   * 2. queue flash writing, return 0 until writing is complete
+   * 3. return written bytes.
+   *
+   * Note since CFG_TUD_MSC_BUFSIZE is 4KB, bufsize is cap at 4KB
+   */
+
+  switch(_wr10_state)
+  {
+    case WRITE10_IDLE:
+    {
+      uint32_t page_addr = align4k(addr);
+      uint32_t off4k     = offset4k(addr);
+
+      // Cache contents from start of page to current address
+      if ( off4k )
+      {
+        memcpy(page_cached, (uint8_t*) page_addr, off4k);
+      }
+
+      // Copy new data
+      memcpy(page_cached+off4k, buffer, bufsize);
+
+      // Cache contents after data to end of page
+      if ( off4k + bufsize < PAGE_SIZE)
+      {
+        memcpy(page_cached+off4k+bufsize, (uint8_t*) (addr+bufsize), PAGE_SIZE - (off4k + bufsize ) );
+      }
+
+      // Start erasing
+      _fat_psh.block_id = align4k(addr);
+      TU_ASSERT( NRF_SUCCESS == pstorage_clear(&_fat_psh, PAGE_SIZE), -1);
+
+      _wr10_state = WRITE10_ERASING;
+
+      // Tell tinyusb that we are not ready to consume its data
+      // The stack will keep the data and call again
+      return 0;
+    }
+    break;
+
+    case WRITE10_ERASING:
+      // still erasing, nothing else to do
+      return 0;
+    break;
+
+    case WRITE10_ERASED:
+      // Start writing
+      _fat_psh.block_id = align4k(addr);
+
+      TU_ASSERT( NRF_SUCCESS == pstorage_store(&_fat_psh, page_cached, PAGE_SIZE, 0), -1);
+
+      _wr10_state = WRITE10_WRITING;
+      return 0;
+    break;
+
+    case WRITE10_WRITING:
+      return 0;
+    break;
+
+    case WRITE10_WRITTEN:
+      _wr10_state = WRITE10_IDLE; // back to idle
+
+      // positive return means we complete the operation, tinyusb can receiving next write10
+      return bufsize;
+    break;
+
+    case WRITE10_FAILED:
+      _wr10_state = WRITE10_IDLE;
+      return -1;
+    break;
+
+    default: return -1; break;
+  }
 }
 
 #endif

src/msc/msc_flash.h

@@ -58,9 +58,10 @@
 VERIFY_STATIC( MSC_FLASH_ADDR_START+MSC_FLASH_SIZE == BOOTLOADER_REGION_START-DFU_APP_DATA_RESERVED, );
 
 /*------------------------------------------------------------------*/
-/*
+/* Note ATTR_WEAK is used when CFG_TUD_MSC = 0
  *------------------------------------------------------------------*/
 
+ATTR_WEAK void msc_flash_init(void);
 ATTR_WEAK void msc_flash_mount(void);
 ATTR_WEAK void msc_flash_umount(void);
 

src/tusb_config.h

@@ -80,10 +80,10 @@
 #define CFG_TUD_CDC_FLUSH_ON_SOF    1
 
 // Number of supported Logical Unit Number
-#define CFG_TUD_MSC_MAXLUN        1
+#define CFG_TUD_MSC_MAXLUN          1
 
 // Buffer size of Device Mass storage
-#define CFG_TUD_MSC_BUFSIZE       512
+#define CFG_TUD_MSC_BUFSIZE         (4*1024)
 
 //--------------------------------------------------------------------+
 // USB RAM PLACEMENT