Refactored Non Volatile Memory management (Big update)

Author: Daniel Jaeckle

src/apps/LoRaMac/CMakeLists.txt

@@ -49,8 +49,9 @@ if(SUB_PROJECT STREQUAL periodic-uplink-lpp)
     #---------------------------------------------------------------------------------------
     list(APPEND ${PROJECT_NAME}_COMMON
         "${CMAKE_CURRENT_LIST_DIR}/common/CayenneLpp.c"
+        "${CMAKE_CURRENT_LIST_DIR}/common/cli.c"
         "${CMAKE_CURRENT_LIST_DIR}/common/LmHandlerMsgDisplay.c"
-        "${CMAKE_CURRENT_LIST_DIR}/common/NvmCtxMgmt.c"
+        "${CMAKE_CURRENT_LIST_DIR}/common/NvmDataMgmt.c"
     )
 
     #---------------------------------------------------------------------------------------
@@ -78,7 +79,7 @@ elseif(SUB_PROJECT STREQUAL fuota-test-01)
     #---------------------------------------------------------------------------------------
     list(APPEND ${PROJECT_NAME}_COMMON
         "${CMAKE_CURRENT_LIST_DIR}/common/LmHandlerMsgDisplay.c"
-        "${CMAKE_CURRENT_LIST_DIR}/common/NvmCtxMgmt.c"
+        "${CMAKE_CURRENT_LIST_DIR}/common/NvmDataMgmt.c"
     )
 
     #---------------------------------------------------------------------------------------
@@ -125,6 +126,9 @@ target_compile_definitions(${PROJECT_NAME}-${SUB_PROJECT} PRIVATE ACTIVE_REGION=
 if(${SECURE_ELEMENT_PRE_PROVISIONED} MATCHES ON)
     target_compile_definitions(${PROJECT_NAME}-${SUB_PROJECT} PRIVATE -DSECURE_ELEMENT_PRE_PROVISIONED)
 endif()
+if(${SECURE_ELEMENT} MATCHES SOFT_SE)
+    target_compile_definitions(${PROJECT_NAME}-${SUB_PROJECT} PRIVATE -DSOFT_SE)
+endif()
 target_compile_definitions(${PROJECT_NAME}-${SUB_PROJECT}  PUBLIC
     $<BUILD_INTERFACE:$<TARGET_PROPERTY:mac,INTERFACE_COMPILE_DEFINITIONS>>
 )

src/apps/LoRaMac/common/LmHandler/LmHandler.c

@@ -28,7 +28,8 @@
 #include "utilities.h"
 #include "timer.h"
 #include "Commissioning.h"
-#include "NvmCtxMgmt.h"
+#include "NvmDataMgmt.h"
+#include "radio.h"
 #include "LmHandler.h"
 #include "LmhPackage.h"
 #include "LmhpCompliance.h"
@@ -214,6 +215,7 @@ LmHandlerErrorStatus_t LmHandlerInit( LmHandlerCallbacks_t *handlerCallbacks,
                                       LmHandlerParams_t *handlerParams )
 {
     //
+    uint16_t nbNvmData = 0;
     MibRequestConfirm_t mibReq;
     LmHandlerParams = handlerParams;
     LmHandlerCallbacks = handlerCallbacks;
@@ -224,7 +226,7 @@ LmHandlerErrorStatus_t LmHandlerInit( LmHandlerCallbacks_t *handlerCallbacks,
     LoRaMacPrimitives.MacMlmeIndication = MlmeIndication;
     LoRaMacCallbacks.GetBatteryLevel = LmHandlerCallbacks->GetBatteryLevel;
     LoRaMacCallbacks.GetTemperatureLevel = LmHandlerCallbacks->GetTemperature;
-    LoRaMacCallbacks.NvmContextChange = NvmCtxMgmtEvent;
+    LoRaMacCallbacks.NvmDataChange  = NvmDataMgmtEvent;
     LoRaMacCallbacks.MacProcessNotify = LmHandlerCallbacks->OnMacProcess;
 
     IsClassBSwitchPending = false;
@@ -234,10 +236,13 @@ LmHandlerErrorStatus_t LmHandlerInit( LmHandlerCallbacks_t *handlerCallbacks,
         return LORAMAC_HANDLER_ERROR;
     }
 
+    // Restore data if required
+    nbNvmData = NvmDataMgmtRestore( );
+
     // Try to restore from NVM and query the mac if possible.
-    if( NvmCtxMgmtRestore( ) == NVMCTXMGMT_STATUS_SUCCESS )
+    if( nbNvmData > 0 )
     {
-        LmHandlerCallbacks->OnNvmContextChange( LORAMAC_HANDLER_NVM_RESTORE );
+        LmHandlerCallbacks->OnNvmDataChange( LORAMAC_HANDLER_NVM_RESTORE, nbNvmData );
     }
     else
     {
@@ -321,6 +326,8 @@ bool LmHandlerIsBusy( void )
 
 void LmHandlerProcess( void )
 {
+    uint16_t size = 0;
+
     // Process Radio IRQ
     if( Radio.IrqProcess != NULL )
     {
@@ -333,9 +340,12 @@ void LmHandlerProcess( void )
     // Call all packages process functions
     LmHandlerPackagesProcess( );
 
-    if( NvmCtxMgmtStore( ) == NVMCTXMGMT_STATUS_SUCCESS )
+    // Store to NVM if required
+    size = NvmDataMgmtStore( );
+
+    if( size > 0 )
     {
-        LmHandlerCallbacks->OnNvmContextChange( LORAMAC_HANDLER_NVM_STORE );
+        LmHandlerCallbacks->OnNvmDataChange( LORAMAC_HANDLER_NVM_STORE, size );
     }
 }
 

src/apps/LoRaMac/common/LmHandler/LmHandler.h

@@ -131,17 +131,19 @@ typedef struct LmHandlerCallbacks_s
     /*!
      *\brief    Will be called each time a Radio IRQ is handled by the MAC
      *          layer.
-     * 
+     *
      *\warning  Runs in a IRQ context. Should only change variables state.
      */
     void ( *OnMacProcess )( void );
     /*!
      * Notifies the upper layer that the NVM context has changed
      *
-     * \param [IN] stored Indicates if we are storing (true) or
-     *                    restoring (false) the NVM context
+     * \param [IN] state Indicates if we are storing (true) or
+     *                   restoring (false) the NVM context
+     *
+     * \param [IN] size Number of data bytes which were stored or restored.
      */
-    void ( *OnNvmContextChange )( LmHandlerNvmContextStates_t state );
+    void ( *OnNvmDataChange )( LmHandlerNvmContextStates_t state, uint16_t size );
     /*!
      * Notifies the upper layer that a network parameters have been set
      *

src/apps/LoRaMac/common/LmHandlerMsgDisplay.c

@@ -111,16 +111,18 @@ void PrintHexBuffer( uint8_t *buffer, uint8_t size )
     printf( "\n" );
 }
 
-void DisplayNvmContextChange( LmHandlerNvmContextStates_t state )
+void DisplayNvmDataChange( LmHandlerNvmContextStates_t state, uint16_t size )
 {
     if( state == LORAMAC_HANDLER_NVM_STORE )
     {
-        printf( "\n###### ============ CTXS STORED ============ ######\n\n" );
+        printf( "\n###### ============ CTXS STORED ============ ######\n" );
+
     }
     else
     {
-        printf( "\n###### =========== CTXS RESTORED =========== ######\n\n" );
+        printf( "\n###### =========== CTXS RESTORED =========== ######\n" );
     }
+    printf( "Size        : %i\n\n", size );
 }
 
 void DisplayNetworkParametersUpdate( CommissioningParams_t *commissioningParams )

src/apps/LoRaMac/common/LmHandlerMsgDisplay.h

@@ -30,8 +30,10 @@
  *
  * \param [IN] state Indicates if we are storing (true) or
  *                    restoring (false) the NVM context
+ *
+ * \param [IN] size Number of data bytes which were stored or restored.
  */
-void DisplayNvmContextChange( LmHandlerNvmContextStates_t state );
+void DisplayNvmDataChange( LmHandlerNvmContextStates_t state, uint16_t size );
 
 /*!
  * \brief Displays updated network parameters