Cleanup lzss libraries and rename to lzssEncode inside SBU_LoadLZSS

Author: giulcioffi

libraries/SBU/examples/SBU_LoadLZSS/SBU_LoadLZSS.ino

@@ -1,10 +1,7 @@
 #include <MKRNB.h>
 #include <SBU.h>
-#include <FlashStorage.h>
 
-#include "lzss.h"
-
-FlashClass mcu_flash;
+#include "lzssEncode.h"
 
 static char const BINARY[] =
 {
@@ -17,7 +14,7 @@ static char const CHECK_FILE[] =
 };
 
 static constexpr char CHECK_FILE_NAME[] = "UPDATE.OK";
-constexpr char UPDATE_FILE_NAME[] = "UPDATE.BIN.LZSS";
+const char * UPDATE_FILE_NAME_LZSS = "UPDATE.BIN.LZSS";
 
 NBFileUtils fileUtils;
 bool update_available = false;
@@ -42,13 +39,6 @@ void setup() {
   Serial.println(bytes_to_write);
 
   Serial.print("Encoding \"BINARY.H\" into \"UPDATE.BIN.LZSS\" and writing it into the Sara-R410M module ... ");
-
-  /*
-   * Set the lzss parameter in the following way:
-   * - 0, false          : you want to perform a LZSS encoding (.H -> .LZSS)
-   * - SKETCH_START, true: you want to perform a LZSS decoding (.LZSS -> .H)
-   */
-  lzss_init(0, false);
 
   //Encode into .lzss and write to the Sara modem
   int bytes_written = lzss_encode(BINARY, bytes_to_write);

libraries/SBU/examples/SBU_LoadLZSS/lzss.cpp libraries/SBU/examples/SBU_LoadLZSS/lzssEncode.cpp

@@ -2,13 +2,12 @@
    INCLUDE
  **************************************************************************************/
 
-#include "lzss.h"
+#include "lzssEncode.h"
 
 #include <stdlib.h>
 #include <stdint.h>
 
 #include <MKRNB.h>
-#include <FlashStorage.h>
 
 /**************************************************************************************
    DEFINE
@@ -30,58 +29,30 @@
  **************************************************************************************/
 
 extern NBFileUtils fileUtils;
-extern FlashClass mcu_flash;
 extern const char * UPDATE_FILE_NAME_LZSS;
 
-static uint32_t SKETCH_START = 0;
-static uint32_t LZSS_FILE_SIZE = 0;
-
 int bit_buffer = 0, bit_mask = 128;
-unsigned long codecount = 0, textcount = 0;
+unsigned long textcount = 0;
 unsigned char buffer[N * 2];
 
 static char write_buf[FPUTC_BUF_SIZE];
 static size_t write_buf_num_bytes = 0;
 static size_t bytes_written_fputc = 0;
-static size_t bytes_written_flash = 0;
-static uint32_t flash_addr = 0;
 
-bool fromLZSStoBIN = true;
 bool append = false;
 bool endOfFile = false;
 
 /**************************************************************************************
    PUBLIC FUNCTIONS
  **************************************************************************************/
 
-void lzss_init(uint32_t const sketch_start, bool LZSStoBIN)
-{
-    fromLZSStoBIN = LZSStoBIN;
-    if (LZSStoBIN) {
-        SKETCH_START = sketch_start;
-        flash_addr = sketch_start;
-        LZSS_FILE_SIZE = fileUtils.listFile("UPDATE.BIN.LZSS");
-    }
-}
-
 void lzss_flush()
 {
   bytes_written_fputc += write_buf_num_bytes;
 
-    if (fromLZSStoBIN) {
-        /* Only write to the flash once we've surpassed
-        * the SBU in the update binary.
-        */
-        if (bytes_written_fputc > (SKETCH_START - 0x2000))
-        {
-            mcu_flash.write((void*)flash_addr, write_buf, write_buf_num_bytes);
-            flash_addr += write_buf_num_bytes;
-        }
-    } else {
-        fileUtils.downloadFile("UPDATE.BIN.LZSS", write_buf, write_buf_num_bytes, append);
-        append = true;
-    }
-  
+  fileUtils.downloadFile(UPDATE_FILE_NAME_LZSS, write_buf, write_buf_num_bytes, append);        //UPDATE.BIN.LZSS
+  append = true;
+
   write_buf_num_bytes = 0;
 }
 
@@ -91,16 +62,15 @@ void lzss_flush()
 
 void lzss_fputc(int const c)
 {
-  /* Buffer the decompressed data into a buffer so
+  /* Buffer the compressed data into a buffer so
    * we can perform block writes and don't need to
-   * write every byte singly on the flash (which 
-   * wouldn't be possible anyway).
+   * write every byte singly on the modem
    */
   write_buf[write_buf_num_bytes] = static_cast<char>(c);
   write_buf_num_bytes++;
 
-  /* The write buffer is full of decompressed
-   * data, write it to the flash now.
+  /* The write buffer is full of compressed
+   * data, write it to the modem now.
    */
   if (write_buf_num_bytes == FPUTC_BUF_SIZE || endOfFile)
     lzss_flush();
@@ -130,9 +100,7 @@ void putbit0(void)
 void flush_bit_buffer(void)
 {
     if (bit_mask != 128) {
-        //if (fputc(bit_buffer, outfile) == EOF) error();
         lzss_fputc(bit_buffer);
-        codecount++;
     }
 }
 

libraries/SBU/examples/SBU_LoadLZSS/lzss.h libraries/SBU/examples/SBU_LoadLZSS/lzssEncode.h

@@ -11,7 +11,6 @@
    FUNCTION DEFINITION
  **************************************************************************************/
 
-void lzss_init(uint32_t const sketch_start, bool LZSStoBIN);
 void lzss_flush();
 int lzss_encode(const char buf_in[], uint32_t size);
 

libraries/SBU/extras/SBUBoot/SBUBoot.ino

@@ -65,7 +65,7 @@ int main()
       /* Initialize the lzss module with the data which
        * it requires.
        */
-      lzss_init((uint32_t)SKETCH_START, true);
+      lzss_init((uint32_t)SKETCH_START);
       /* During the process of decoding UPDATE.BIN.LZSS
        * is decompressed and stored as UPDATE.BIN.
        */

libraries/SBU/extras/SBUBoot/lzss.cpp

@@ -37,7 +37,6 @@ static uint32_t SKETCH_START = 0;
 static uint32_t LZSS_FILE_SIZE = 0;
 
 int bit_buffer = 0, bit_mask = 128;
-unsigned long codecount = 0, textcount = 0;
 unsigned char buffer[N * 2];
 
 static char write_buf[FPUTC_BUF_SIZE];
@@ -46,40 +45,29 @@ static size_t bytes_written_fputc = 0;
 static size_t bytes_written_flash = 0;
 static uint32_t flash_addr = 0;
 
-bool fromLZSStoBIN = true;
-bool append = false;
-
 /**************************************************************************************
    PUBLIC FUNCTIONS
  **************************************************************************************/
 
-void lzss_init(uint32_t const sketch_start, bool LZSStoBIN)
+void lzss_init(uint32_t const sketch_start)
 {
-    fromLZSStoBIN = LZSStoBIN;
-    if (LZSStoBIN) {
-        SKETCH_START = sketch_start;
-        flash_addr = sketch_start;
-        LZSS_FILE_SIZE = fileUtils.listFile("UPDATE.BIN.LZSS");
-    }
+  SKETCH_START = sketch_start;
+  flash_addr = sketch_start;
+  LZSS_FILE_SIZE = fileUtils.listFile(UPDATE_FILE_NAME_LZSS);
 }
 
 void lzss_flush()
 {
   bytes_written_fputc += write_buf_num_bytes;
 
-    if (fromLZSStoBIN) {
-        /* Only write to the flash once we've surpassed
-        * the SBU in the update binary.
-        */
-        if (bytes_written_fputc > (SKETCH_START - 0x2000))
-        {
-            mcu_flash.write((void*)flash_addr, write_buf, write_buf_num_bytes);
-            flash_addr += write_buf_num_bytes;
-        }
-    } else {
-        fileUtils.downloadFile("UPDATE.BIN.LZSS", write_buf, write_buf_num_bytes, append);
-        append = true;
-    }
+  /* Only write to the flash once we've surpassed
+   * the SBU in the update binary.
+   */
+  if (bytes_written_fputc > (SKETCH_START - 0x2000))
+  {
+    mcu_flash.write((void*)flash_addr, write_buf, write_buf_num_bytes);
+    flash_addr += write_buf_num_bytes;
+  }
 
   write_buf_num_bytes = 0;
 }
@@ -228,4 +216,4 @@ void lzss_decode(void)
             }
         }
     }
-}
+}

libraries/SBU/extras/SBUBoot/lzss.h

@@ -11,7 +11,7 @@
    FUNCTION DEFINITION
  **************************************************************************************/
 
-void lzss_init(uint32_t const sketch_start, bool LZSStoBIN);
+void lzss_init(uint32_t const sketch_start);
 void lzss_decode();
 void lzss_flush();