Merge pull request #171 from arduino-libraries/refactor-ota-storage-api

aentinger · web-flow · commit 593a5f50bf44 · 2020-07-16T11:23:50.000+02:00
Refactor OTA Storage API
diff --git a/src/utility/ota/OTALogic.cpp b/src/utility/ota/OTALogic.cpp
@@ -141,7 +141,7 @@ OTAState OTALogic::handle_Idle()
 
 OTAState OTALogic::handle_StartDownload()
 {
-  if(_ota_storage->open("UPDATE.BIN.TMP")) {
+  if(_ota_storage->open()) {
     return OTAState::WaitForHeader;
   } else {
     _ota_error = OTAError::StorageOpenFailed;
@@ -232,15 +232,15 @@ OTAState OTALogic::handle_Verify()
   if(_ota_bin_data.crc32 == _ota_bin_data.hdr_crc32) {
     return OTAState::Rename;
   } else {
-    _ota_storage->remove("UPDATE.BIN.TMP");
+    _ota_storage->remove();
     _ota_error = OTAError::ChecksumMismatch;
     return OTAState::Error;
   }
 }
 
 OTAState OTALogic::handle_Rename()
 {
-  if(_ota_storage->rename("UPDATE.BIN.TMP", "UPDATE.BIN")) {
+  if(_ota_storage->rename()) {
     _ota_storage->deinit();
     return OTAState::Reset;
   }
diff --git a/src/utility/ota/OTAStorage.h b/src/utility/ota/OTAStorage.h
@@ -38,11 +38,11 @@ class OTAStorage
 
 
   virtual bool   init  () = 0;
-  virtual bool   open  (char const * file_name) = 0;
+  virtual bool   open  () = 0;
   virtual size_t write (uint8_t const * const buf, size_t const num_bytes) = 0;
   virtual void   close () = 0;
-  virtual void   remove(char const * file_name) = 0;
-  virtual bool   rename(char const * old_file_name, char const * new_file_name) = 0;
+  virtual void   remove() = 0;
+  virtual bool   rename() = 0;
   virtual void   deinit() = 0;
 
 };
diff --git a/src/utility/ota/OTAStorage_SFU.cpp b/src/utility/ota/OTAStorage_SFU.cpp
@@ -26,6 +26,13 @@
 
 #include <Arduino_DebugUtils.h>
 
+/******************************************************************************
+ * CONSTANTS
+ ******************************************************************************/
+
+static char const SFU_UPDATE_FILENAME[]      = "UPDATE.BIN";
+static char const SFU_TEMP_UPDATE_FILENAME[] = "UPDATE.BIN.TMP";
+
 /******************************************************************************
  * CTOR/DTOR
  ******************************************************************************/
@@ -56,10 +63,10 @@ bool OTAStorage_SFU::init()
   return true;
 }
 
-bool OTAStorage_SFU::open(char const * file_name)
+bool OTAStorage_SFU::open()
 {
   filesystem.clearerr();
-  _file = new File(filesystem.open(file_name, CREATE | WRITE_ONLY| TRUNCATE));
+  _file = new File(filesystem.open(SFU_TEMP_UPDATE_FILENAME, CREATE | WRITE_ONLY| TRUNCATE));
   if(SPIFFS_OK != filesystem.err()) {
     DBG_ERROR("OTAStorage_SFU::open - open() failed with error code %d", filesystem.err());
     delete _file;
@@ -79,14 +86,14 @@ void OTAStorage_SFU::close()
   delete _file;
 }
 
-void OTAStorage_SFU::remove(char const * file_name)
+void OTAStorage_SFU::remove()
 {
-  filesystem.remove(file_name);
+  filesystem.remove(SFU_TEMP_UPDATE_FILENAME);
 }
 
-bool OTAStorage_SFU::rename(char const * old_file_name, char const * new_file_name)
+bool OTAStorage_SFU::rename()
 {
-  return (SPIFFS_OK == filesystem.rename(old_file_name, new_file_name));
+  return (SPIFFS_OK == filesystem.rename(SFU_TEMP_UPDATE_FILENAME, SFU_UPDATE_FILENAME));
 }
 
 void OTAStorage_SFU::deinit()
diff --git a/src/utility/ota/OTAStorage_SFU.h b/src/utility/ota/OTAStorage_SFU.h
@@ -44,11 +44,11 @@ class OTAStorage_SFU : public OTAStorage
 
 
   virtual bool   init  () override;
-  virtual bool   open  (char const * file_name) override;
+  virtual bool   open  () override;
   virtual size_t write (uint8_t const * const buf, size_t const num_bytes) override;
   virtual void   close () override;
-  virtual void   remove(char const * file_name) override;
-  virtual bool   rename(char const * old_file_name, char const * new_file_name) override;
+  virtual void   remove() override;
+  virtual bool   rename() override;
   virtual void   deinit() override;
 
 
diff --git a/src/utility/ota/OTAStorage_SNU.cpp b/src/utility/ota/OTAStorage_SNU.cpp
@@ -47,7 +47,7 @@ bool OTAStorage_SNU::init()
   return true;
 }
 
-bool OTAStorage_SNU::open(char const * /* file_name */)
+bool OTAStorage_SNU::open()
 {
   /* There's no need to explicitly open the file
    * because when writing to it the file will always
@@ -83,12 +83,12 @@ void OTAStorage_SNU::close()
   /* Files are closed after each file operation on the nina side. */
 }
 
-void OTAStorage_SNU::remove(char const * /* file_name */)
+void OTAStorage_SNU::remove()
 {
   WiFiStorage.remove(SNU_TEMP_UPDATE_FILENAME);
 }
 
-bool OTAStorage_SNU::rename(char const * /* old_file_name */, char const * /* new_file_name */)
+bool OTAStorage_SNU::rename()
 {
   return WiFiStorage.rename(SNU_TEMP_UPDATE_FILENAME, SNU_UPDATE_FILENAME);
 }
diff --git a/src/utility/ota/OTAStorage_SNU.h b/src/utility/ota/OTAStorage_SNU.h
@@ -41,11 +41,11 @@ class OTAStorage_SNU : public OTAStorage
 
 
   virtual bool   init  () override;
-  virtual bool   open  (char const * file_name) override;
+  virtual bool   open  () override;
   virtual size_t write (uint8_t const * const buf, size_t const num_bytes) override;
   virtual void   close () override;
-  virtual void   remove(char const * file_name) override;
-  virtual bool   rename(char const * old_file_name, char const * new_file_name) override;
+  virtual void   remove() override;
+  virtual bool   rename() override;
   virtual void   deinit() override;
 
 };
diff --git a/src/utility/ota/OTAStorage_SSU.cpp b/src/utility/ota/OTAStorage_SSU.cpp
@@ -49,7 +49,7 @@ bool OTAStorage_SSU::init()
       return false;
 }
 
-bool OTAStorage_SSU::open(char const * /* file_name */)
+bool OTAStorage_SSU::open()
 {
   return true;
 }
@@ -65,12 +65,12 @@ void OTAStorage_SSU::close()
   /* Nothing to do */
 }
 
-void OTAStorage_SSU::remove(char const * /* file_name */)
+void OTAStorage_SSU::remove()
 {
   _fileUtils.deleteFile(SSU_UPDATE_FILENAME);
 }
 
-bool OTAStorage_SSU::rename(char const * /* old_file_name */, char const * /* new_file_name */)
+bool OTAStorage_SSU::rename()
 {
   /* Create a file 'UPDATE.OK' which is used by the SSU
    * 2nd stage bootloader to recognise that the update
diff --git a/src/utility/ota/OTAStorage_SSU.h b/src/utility/ota/OTAStorage_SSU.h
@@ -43,11 +43,11 @@ class OTAStorage_SSU : public OTAStorage
 
 
   virtual bool   init  () override;
-  virtual bool   open  (char const * file_name) override;
+  virtual bool   open  () override;
   virtual size_t write (uint8_t const * const buf, size_t const num_bytes) override;
   virtual void   close () override;
-  virtual void   remove(char const * file_name) override;
-  virtual bool   rename(char const * old_file_name, char const * new_file_name) override;
+  virtual void   remove() override;
+  virtual bool   rename() override;
   virtual void   deinit() override;
 
 private:

Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ OTAState OTALogic::handle_Idle()`
`141`	`141`
`142`	`142`	`OTAState OTALogic::handle_StartDownload()`
`143`	`143`	`{`
`144`		`- if(_ota_storage->open("UPDATE.BIN.TMP")) {`
	`144`	`+ if(_ota_storage->open()) {`
`145`	`145`	`return OTAState::WaitForHeader;`
`146`	`146`	`} else {`
`147`	`147`	`_ota_error = OTAError::StorageOpenFailed;`
`@@ -232,15 +232,15 @@ OTAState OTALogic::handle_Verify()`
`232`	`232`	`if(_ota_bin_data.crc32 == _ota_bin_data.hdr_crc32) {`
`233`	`233`	`return OTAState::Rename;`
`234`	`234`	`} else {`
`235`		`- _ota_storage->remove("UPDATE.BIN.TMP");`
	`235`	`+ _ota_storage->remove();`
`236`	`236`	`_ota_error = OTAError::ChecksumMismatch;`
`237`	`237`	`return OTAState::Error;`
`238`	`238`	`}`
`239`	`239`	`}`
`240`	`240`
`241`	`241`	`OTAState OTALogic::handle_Rename()`
`242`	`242`	`{`
`243`		`- if(_ota_storage->rename("UPDATE.BIN.TMP", "UPDATE.BIN")) {`
	`243`	`+ if(_ota_storage->rename()) {`
`244`	`244`	`_ota_storage->deinit();`
`245`	`245`	`return OTAState::Reset;`
`246`	`246`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,13 @@`
`26`	`26`
`27`	`27`	`#include <Arduino_DebugUtils.h>`
`28`	`28`
	`29`	`+/******************************************************************************`
	`30`	`+ * CONSTANTS`
	`31`	`+ ******************************************************************************/`
	`32`	`+`
	`33`	`+static char const SFU_UPDATE_FILENAME[] = "UPDATE.BIN";`
	`34`	`+static char const SFU_TEMP_UPDATE_FILENAME[] = "UPDATE.BIN.TMP";`
	`35`	`+`
`29`	`36`	`/******************************************************************************`
`30`	`37`	`* CTOR/DTOR`
`31`	`38`	`******************************************************************************/`
`@@ -56,10 +63,10 @@ bool OTAStorage_SFU::init()`
`56`	`63`	`return true;`
`57`	`64`	`}`
`58`	`65`
`59`		`-bool OTAStorage_SFU::open(char const * file_name)`
	`66`	`+bool OTAStorage_SFU::open()`
`60`	`67`	`{`
`61`	`68`	`filesystem.clearerr();`
`62`		`- _file = new File(filesystem.open(file_name, CREATE \| WRITE_ONLY\| TRUNCATE));`
	`69`	`+ _file = new File(filesystem.open(SFU_TEMP_UPDATE_FILENAME, CREATE \| WRITE_ONLY\| TRUNCATE));`
`63`	`70`	`if(SPIFFS_OK != filesystem.err()) {`
`64`	`71`	`DBG_ERROR("OTAStorage_SFU::open - open() failed with error code %d", filesystem.err());`
`65`	`72`	`delete _file;`
`@@ -79,14 +86,14 @@ void OTAStorage_SFU::close()`
`79`	`86`	`delete _file;`
`80`	`87`	`}`
`81`	`88`
`82`		`-void OTAStorage_SFU::remove(char const * file_name)`
	`89`	`+void OTAStorage_SFU::remove()`
`83`	`90`	`{`
`84`		`- filesystem.remove(file_name);`
	`91`	`+ filesystem.remove(SFU_TEMP_UPDATE_FILENAME);`
`85`	`92`	`}`
`86`	`93`
`87`		`-bool OTAStorage_SFU::rename(char const * old_file_name, char const * new_file_name)`
	`94`	`+bool OTAStorage_SFU::rename()`
`88`	`95`	`{`
`89`		`- return (SPIFFS_OK == filesystem.rename(old_file_name, new_file_name));`
	`96`	`+ return (SPIFFS_OK == filesystem.rename(SFU_TEMP_UPDATE_FILENAME, SFU_UPDATE_FILENAME));`
`90`	`97`	`}`
`91`	`98`
`92`	`99`	`void OTAStorage_SFU::deinit()`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ bool OTAStorage_SNU::init()`
`47`	`47`	`return true;`
`48`	`48`	`}`
`49`	`49`
`50`		`-bool OTAStorage_SNU::open(char const * /* file_name */)`
	`50`	`+bool OTAStorage_SNU::open()`
`51`	`51`	`{`
`52`	`52`	`/* There's no need to explicitly open the file`
`53`	`53`	`* because when writing to it the file will always`
`@@ -83,12 +83,12 @@ void OTAStorage_SNU::close()`
`83`	`83`	`/* Files are closed after each file operation on the nina side. */`
`84`	`84`	`}`
`85`	`85`
`86`		`-void OTAStorage_SNU::remove(char const * /* file_name */)`
	`86`	`+void OTAStorage_SNU::remove()`
`87`	`87`	`{`
`88`	`88`	`WiFiStorage.remove(SNU_TEMP_UPDATE_FILENAME);`
`89`	`89`	`}`
`90`	`90`
`91`		`-bool OTAStorage_SNU::rename(char const * /* old_file_name /, char const /* new_file_name */)`
	`91`	`+bool OTAStorage_SNU::rename()`
`92`	`92`	`{`
`93`	`93`	`return WiFiStorage.rename(SNU_TEMP_UPDATE_FILENAME, SNU_UPDATE_FILENAME);`
`94`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ bool OTAStorage_SSU::init()`
`49`	`49`	`return false;`
`50`	`50`	`}`
`51`	`51`
`52`		`-bool OTAStorage_SSU::open(char const * /* file_name */)`
	`52`	`+bool OTAStorage_SSU::open()`
`53`	`53`	`{`
`54`	`54`	`return true;`
`55`	`55`	`}`
`@@ -65,12 +65,12 @@ void OTAStorage_SSU::close()`
`65`	`65`	`/* Nothing to do */`
`66`	`66`	`}`
`67`	`67`
`68`		`-void OTAStorage_SSU::remove(char const * /* file_name */)`
	`68`	`+void OTAStorage_SSU::remove()`
`69`	`69`	`{`
`70`	`70`	`_fileUtils.deleteFile(SSU_UPDATE_FILENAME);`
`71`	`71`	`}`
`72`	`72`
`73`		`-bool OTAStorage_SSU::rename(char const * /* old_file_name /, char const /* new_file_name */)`
	`73`	`+bool OTAStorage_SSU::rename()`
`74`	`74`	`{`
`75`	`75`	`/* Create a file 'UPDATE.OK' which is used by the SSU`
`76`	`76`	`* 2nd stage bootloader to recognise that the update`