nvm: add flash log implementation (#179)

* nvm: nvm flash log based implementation

it can be used when the write granularity is too big to be used with the
current wh_nvm_flash implementation.

* test: generalize whTest_NvmFlashCfg

* test: test nvm flash log backend

* test: use nvm_flash_log to do test if compiled it

* test: generalize tests to use both NVM backends

* nvm_flash_log: fix and refactor List callback

* nvm_flash_log: rename and add arg checking to local functions

* nvm_flash_log: check context is initialized in public functions

* nvm_flash_log: fix mem clean on obj destroy + minors

* nvm_flash_log: allow NULL metadata in GetMetadata

* nvm_flash_log: read-back current partition if update fails

* nvm_flash_log: add performance consideration in header

* nvm_flash_log: verify program and erase

* nvm_flash_log: fix from cppcheck

* widetree: fix clang-format error

* nvm_flash_log: move configuration define in test/config/wolfhsm_cfg.h

* nvm_flash_log: better naming for test structure and functions

* nvm_flash_log: erase inactive partition on partition commit

* nvm_flash_log: fix object limit in addObject

* git-clang-format fixes

* nvm_flash_log: test: remove useless assert

* nvm_flash_log: test: rename nvm backend enums

Author: rizlik

src/wh_nvm.c

@@ -192,7 +192,7 @@ int wh_Nvm_DestroyObjects(whNvmContext* context, whNvmId list_count,
 
 
 int wh_Nvm_Read(whNvmContext* context, whNvmId id, whNvmSize offset,
-        whNvmSize data_len, uint8_t* data)
+                whNvmSize data_len, uint8_t* data)
 {
     if (    (context == NULL) ||
             (context->cb == NULL) ) {

src/wh_nvm_flash.c

@@ -133,8 +133,8 @@ static int nfObject_Program(whNvmFlashContext* context, int partition,
         int object_index, uint32_t epoch, whNvmMetadata* meta, uint32_t start,
         const uint8_t* data);
 static int nfObject_ReadDataBytes(whNvmFlashContext* context, int partition,
-        int object_index, uint32_t byte_offset, uint32_t byte_count,
-        uint8_t* out_data);
+                                  int object_index, uint32_t byte_offset,
+                                  uint32_t byte_count, uint8_t* out_data);
 static int nfObject_Copy(whNvmFlashContext* context, int object_index,
         int partition, uint32_t *inout_next_object, uint32_t *inout_next_data);
 
@@ -652,8 +652,8 @@ static int nfObject_Program(whNvmFlashContext* context, int partition,
 }
 
 static int nfObject_ReadDataBytes(whNvmFlashContext* context, int partition,
-        int object_index,
-        uint32_t byte_offset, uint32_t byte_count, uint8_t* out_data)
+                                  int object_index, uint32_t byte_offset,
+                                  uint32_t byte_count, uint8_t* out_data)
 {
     int start = 0;
     uint32_t startOffset = 0;
@@ -676,18 +676,16 @@ static int nfObject_ReadDataBytes(whNvmFlashContext* context, int partition,
     }
 
     /* Ensure we don't read off the end of the active partition */
-    if (WH_ERROR_OK != nfPartition_CheckDataRange(context, partition,
-                                    startOffset * WHFU_BYTES_PER_UNIT + byte_offset,
-                                   byte_count)) {
+    if (WH_ERROR_OK != nfPartition_CheckDataRange(
+                           context, partition,
+                           startOffset * WHFU_BYTES_PER_UNIT + byte_offset,
+                           byte_count)) {
         return WH_ERROR_BADARGS;
     }
 
     return wh_FlashUnit_ReadBytes(
-            context->cb,
-            context->flash,
-            startOffset * WHFU_BYTES_PER_UNIT + byte_offset,
-            byte_count,
-            out_data);
+        context->cb, context->flash,
+        startOffset * WHFU_BYTES_PER_UNIT + byte_offset, byte_count, out_data);
 }
 
 static int nfObject_Copy(whNvmFlashContext* context, int object_index,
@@ -728,13 +726,8 @@ static int nfObject_Copy(whNvmFlashContext* context, int object_index,
         }
 
         /* Read the data from the old object. */
-        ret = nfObject_ReadDataBytes(
-                context,
-                context->active,
-                object_index,
-                data_offset,
-                this_len,
-                buffer);
+        ret = nfObject_ReadDataBytes(context, context->active, object_index,
+                                     data_offset, this_len, buffer);
         if (ret != 0) return ret;
 
         /* Write the data to the new object. */
@@ -1243,30 +1236,23 @@ int wh_NvmFlash_DestroyObjects(void* c, whNvmId list_count,
 }
 
 /* Read the data of the object starting at the byte offset */
-int wh_NvmFlash_Read(void* c, whNvmId id, whNvmSize offset,
-        whNvmSize data_len, uint8_t* data)
+int wh_NvmFlash_Read(void* c, whNvmId id, whNvmSize offset, whNvmSize data_len,
+                     uint8_t* data)
 {
     whNvmFlashContext* context = c;
     int ret = 0;
-    int object_index = -1;
+    int                object_index = -1;
 
     if (    (context == NULL) ||
             ((data_len > 0) && (data == NULL)) ){
         return WH_ERROR_BADARGS;
     }
 
-    ret = nfMemDirectory_FindObjectIndexById(
-            &context->directory,
-            id,
-            &object_index);
+    ret = nfMemDirectory_FindObjectIndexById(&context->directory, id,
+                                             &object_index);
     if (ret == 0) {
-        ret = nfObject_ReadDataBytes(
-                context,
-                context->active,
-                object_index,
-                offset,
-                data_len,
-                data);
+        ret = nfObject_ReadDataBytes(context, context->active, object_index,
+                                     offset, data_len, data);
     }
     return ret;
 }