Bangle.js2_iflash: If we can't write a JS file to internal flash, attempt to write to external instead

+            Bangle.js2_iflash: require("Storage").getStats() now sums both Storage pools by default

Author: gfwilliams

ChangeLog

@@ -49,6 +49,8 @@
             nRF52: Ensure that if enabled the HID service gets added to the main advertising packet (#2631)
             nRF52: Fix unreliable internal flash writes when writing >2k (big issue for compaction) (fix #2509)
             nRF52: Don't break out of flash erase/writes if interrupted (Ctrl-C) - these shouldn't take too long and can corrupt data if interruptable
+            Bangle.js2_iflash: If we can't write a JS file to internal flash, attempt to write to external instead
+            Bangle.js2_iflash: require("Storage").getStats() now sums both Storage pools by default
 
      2v25 : ESP32C3: Get analogRead working correctly
             Graphics: Adjust image alignment when rotating images to avoid cropping (fix #2535)

src/jsflash.c

@@ -647,14 +647,26 @@ bool jsfCompact(bool showMessage) {
   return compacted;
 }
 
+static bool jsvIsDriveNameExplicit(JsfFileName *name) {
+  return name->c[1]==':';
+}
+
+static bool jsvIsDriveC(char drive) {
+#ifdef JSF_BANK2_START_ADDRESS
+  return (drive&(~0x20)) == 'C'; // make drive case insensitive
+#else
+  return false;
+#endif
+}
+
 /* If we have a filename like "C:foo", take the 'C:' bit
  * off it and return the drive. If explicitOnly==false,
  * we also return the drive name if we think a file should
  * go somewhere (eg it's *.js or .boot0 it should go in internal flash)
  */
-char jsfStripDriveFromName(JsfFileName *name, bool explicitOnly){
+static char jsfStripDriveFromName(JsfFileName *name, bool explicitOnly){
 #ifndef SAVE_ON_FLASH
-  if (name->c[1]==':') { // if a 'drive' is specified like "C:foobar.js"
+  if (jsvIsDriveNameExplicit(name)) { // if a 'drive' is specified like "C:foobar.js"
     char drive = name->c[0];
     memmove(name->c, name->c+2, sizeof(JsfFileName)-2); // shift back and clear the rest
     name->c[sizeof(JsfFileName)-2]=0;name->c[sizeof(JsfFileName)-1]=0;
@@ -675,7 +687,7 @@ char jsfStripDriveFromName(JsfFileName *name, bool explicitOnly){
 void jsfGetDriveBankAddress(char drive, uint32_t *bankStartAddr, uint32_t *bankEndAddr){
 #ifdef JSF_BANK2_START_ADDRESS
   if (drive){
-    if ((drive&(~0x20)) == 'C'){ // make drive case insensitive
+    if (jsvIsDriveC(drive)){
       *bankStartAddr=JSF_START_ADDRESS;
       *bankEndAddr=JSF_END_ADDRESS;
     } else {
@@ -688,10 +700,11 @@ void jsfGetDriveBankAddress(char drive, uint32_t *bankStartAddr, uint32_t *bankE
   *bankStartAddr=JSF_DEFAULT_START_ADDRESS;
   *bankEndAddr=JSF_DEFAULT_END_ADDRESS;
 }
-/// Create a new 'file' in the memory store - DOES NOT remove existing files with same name. Return the address of data start, or 0 on error
-static uint32_t jsfCreateFile(JsfFileName name, uint32_t size, JsfFileFlags flags, JsfFileHeader *returnedHeader) {
+static uint32_t _jsfCreateFile(JsfFileName name, uint32_t size, JsfFileFlags flags, JsfFileHeader *returnedHeader, bool explicitOnly) {
+  // explicitOnly -> only put in the non-default storage while filename explicitly starts with 'C:' (default=false)
   jsDebug(DBG_INFO,"CreateFile (%d bytes)\n", size);
-  char drive = jsfStripDriveFromName(&name, false/* ensure .js/etc go in C */);
+  bool explicitDriveName = jsvIsDriveNameExplicit(&name);
+  char drive = jsfStripDriveFromName(&name, explicitOnly/* ensure .js/etc go in C */);
   jsfCacheClearFile(name);
   uint32_t bankStartAddress,bankEndAddress;
   jsfGetDriveBankAddress(drive,&bankStartAddress,&bankEndAddress);
@@ -724,6 +737,14 @@ static uint32_t jsfCreateFile(JsfFileName name, uint32_t size, JsfFileFlags flag
     } while (addr && !freeAddr);
     // If we don't have space, compact
     if (!freeAddr) {
+#ifdef JSF_BANK2_START_ADDRESS
+      if (!explicitOnly && !explicitDriveName && bankStartAddress!=JSF_DEFAULT_START_ADDRESS) {
+        /* Drive name wasn't explicit but we're not in the default area (eg maybe file ends in .js)
+        so let's try again with explicitOnly=true to force file into the default area where maybe
+        there's space */
+        return _jsfCreateFile(name, size, flags, returnedHeader, true);
+      }
+#endif
       //jsiConsolePrintf("%d Free, %d Trash -> need %d\n", freeSpace, trashSpace, requiredSize);
       if (!compacted && (requiredSize < (freeSpace+trashSpace))) {
         // only try and compact if we're sure there would be enough space - it's better to fail fast!
@@ -756,6 +777,10 @@ static uint32_t jsfCreateFile(JsfFileName name, uint32_t size, JsfFileFlags flag
   jsfCachePut(&header, addr);
   return addr;
 }
+/** Create a new 'file' in the memory store - DOES NOT remove existing files with same name. Return the address of data start, or 0 on error */
+static uint32_t jsfCreateFile(JsfFileName name, uint32_t size, JsfFileFlags flags, JsfFileHeader *returnedHeader) {
+  return _jsfCreateFile(name, size, flags, returnedHeader, false);
+}
 
 static uint32_t jsfBankFindFile(uint32_t bankAddress, uint32_t bankEndAddress, JsfFileName name, JsfFileHeader *returnedHeader) {
   uint32_t addr = bankAddress;
@@ -1066,7 +1091,7 @@ bool jsfWriteFile(JsfFileName name, JsVar *data, JsfFileFlags flags, JsVarInt of
   JsfFileHeader header;
   uint32_t addr = jsfFindFile(name, &header);
 #ifdef JSF_BANK2_START_ADDRESS
-  if (!addr && name.c[1]==':'){
+  if (!addr && jsvIsDriveNameExplicit(&name)){
     // if not found where it should be, try another bank to not end with two files
     JsfFileName shortname = name;
     jsfStripDriveFromName(&shortname, true/* we're not using the return value - we just want the ':' bit stripped off */);

src/jswrap_storage.c

@@ -461,7 +461,7 @@ int jswrap_storage_getFree(bool checkInternalFlash) {
   "class" : "Storage",
   "name" : "getStats",
   "params" : [
-    ["checkInternalFlash","bool","Check the internal flash (rather than external SPI flash).  Default false, so will check external storage"]
+    ["checkInternalFlash","JsVar","`true` = Check internal flash, `false` = external SPI flash. Default `undefined`, so will check both"]
   ],
   "generate" : "jswrap_storage_getStats",
   "return" : ["JsVar","An object containing info about the current Storage system"]
@@ -479,17 +479,31 @@ int jswrap_storage_getFree(bool checkInternalFlash) {
 }
 ```
 
-**NOTE:** `checkInternalFlash` is only useful on DICKENS devices - other devices don't use two different flash banks
+**NOTE:** `checkInternalFlash` is only useful on DICKENS/BANGLEJS2_IFLASH devices - other devices don't use two different flash banks
  */
-JsVar *jswrap_storage_getStats(bool checkInternalFlash) {
+JsVar *jswrap_storage_getStats(JsVar *checkInternalFlash) {
   JsVar *o = jsvNewObject();
   if (!o) return NULL;
-  uint32_t addr = 0;
-#ifdef FLASH_SAVED_CODE2_START
-  addr = checkInternalFlash ? FLASH_SAVED_CODE_START : FLASH_SAVED_CODE2_START;
 
+#ifdef FLASH_SAVED_CODE2_START
+  uint32_t addr = FLASH_SAVED_CODE2_START;
+  if (checkInternalFlash && jsvGetBool(checkInternalFlash))
+    addr = FLASH_SAVED_CODE_START;
+#else
+  uint32_t addr = FLASH_SAVED_CODE_START;
 #endif
   JsfStorageStats stats = jsfGetStorageStats(addr, true);
+#ifdef FLASH_SAVED_CODE2_START
+  if (!checkInternalFlash) { // the default - scan both and sum
+    JsfStorageStats stats2 = jsfGetStorageStats(FLASH_SAVED_CODE_START, true);
+    stats.total += stats2.total;
+    stats.free += stats2.free;
+    stats.fileBytes += stats2.fileBytes;
+    stats.fileCount += stats2.fileCount;
+    stats.trashBytes += stats2.trashBytes;
+    stats.trashCount += stats2.trashCount;
+  }
+#endif
   jsvObjectSetChildAndUnLock(o, "totalBytes", jsvNewFromInteger((JsVarInt)stats.total));
   jsvObjectSetChildAndUnLock(o, "freeBytes", jsvNewFromInteger((JsVarInt)stats.free));
   jsvObjectSetChildAndUnLock(o, "fileBytes", jsvNewFromInteger((JsVarInt)stats.fileBytes));

src/jswrap_storage.h

@@ -30,7 +30,7 @@ JsVar *jswrap_storage_list(JsVar *regex, JsVar *filter);
 JsVarInt jswrap_storage_hash(JsVar *regex);
 void jswrap_storage_debug();
 int jswrap_storage_getFree(bool checkInternalFlash);
-JsVar *jswrap_storage_getStats(bool checkInternalFlash);
+JsVar *jswrap_storage_getStats(JsVar *checkInternalFlash);
 void jswrap_storage_optimise();
 
 JsVar *jswrap_storage_open(JsVar *name, JsVar *mode);