Fixed certification protocol handling when an answer gets delayed by duty-cycle restrictions

Author: mluis1

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

@@ -137,6 +137,14 @@ static LoRaMacHandlerBeaconParams_t BeaconParams =
  */
 static bool IsClassBSwitchPending = false;
 
+/*!
+ * Stores the time to wait before next transmission
+ *
+ * TODO: Create a new structure to store the current handler states/status
+ *       and add the below variable to it.
+ */
+static TimerTime_t DutyCycleWaitTime = 0;
+
 /*!
  * \brief   MCPS-Confirm event function
  *
@@ -241,19 +249,6 @@ LmHandlerErrorStatus_t LmHandlerInit( LmHandlerCallbacks_t *handlerCallbacks,
     }
     else
     {
-        // Read secure-element DEV_EUI, JOI_EUI and SE_PIN values.
-        mibReq.Type = MIB_DEV_EUI;
-        LoRaMacMibGetRequestConfirm( &mibReq );
-        memcpy1( CommissioningParams.DevEui, mibReq.Param.DevEui, 8 );
-
-        mibReq.Type = MIB_JOIN_EUI;
-        LoRaMacMibGetRequestConfirm( &mibReq );
-        memcpy1( CommissioningParams.JoinEui, mibReq.Param.JoinEui, 8 );
-
-        mibReq.Type = MIB_SE_PIN;
-        LoRaMacMibGetRequestConfirm( &mibReq );
-        memcpy1( CommissioningParams.SePin, mibReq.Param.SePin, 4 );
-
 #if( OVER_THE_AIR_ACTIVATION == 0 )
         // Tell the MAC layer which network server version are we connecting too.
         mibReq.Type = MIB_ABP_LORAWAN_VERSION;
@@ -276,6 +271,20 @@ LmHandlerErrorStatus_t LmHandlerInit( LmHandlerCallbacks_t *handlerCallbacks,
         LoRaMacMibSetRequestConfirm( &mibReq );
 #endif // #if( OVER_THE_AIR_ACTIVATION == 0 )
     }
+
+    // Read secure-element DEV_EUI, JOI_EUI and SE_PIN values.
+    mibReq.Type = MIB_DEV_EUI;
+    LoRaMacMibGetRequestConfirm( &mibReq );
+    memcpy1( CommissioningParams.DevEui, mibReq.Param.DevEui, 8 );
+
+    mibReq.Type = MIB_JOIN_EUI;
+    LoRaMacMibGetRequestConfirm( &mibReq );
+    memcpy1( CommissioningParams.JoinEui, mibReq.Param.JoinEui, 8 );
+
+    mibReq.Type = MIB_SE_PIN;
+    LoRaMacMibGetRequestConfirm( &mibReq );
+    memcpy1( CommissioningParams.SePin, mibReq.Param.SePin, 4 );
+
     mibReq.Type = MIB_PUBLIC_NETWORK;
     mibReq.Param.EnablePublicNetwork = LmHandlerParams->PublicNetworkEnable;
     LoRaMacMibSetRequestConfirm( &mibReq );
@@ -312,6 +321,17 @@ bool LmHandlerIsBusy( void )
         return true;
     }
 
+    for( int8_t i = 0; i < PKG_MAX_NUMBER; i++ )
+    {
+        if( LmHandlerPackages[i] != NULL )
+        {
+            if( LmHandlerPackages[i]->IsTxPending( ) == true )
+            {
+                return true;
+            }
+        }
+    }
+
     return false;
 }
 
@@ -335,6 +355,11 @@ void LmHandlerProcess( void )
     LmHandlerPackagesProcess( );
 }
 
+TimerTime_t LmHandlerGetDutyCycleWaitTime( void )
+{
+    return DutyCycleWaitTime;
+}
+
 /*!
  * Join a LoRa Network in classA
  *
@@ -355,6 +380,7 @@ static void LmHandlerJoinRequest( bool isOtaa )
 
         // Starts the OTAA join procedure
         LmHandlerCallbacks->OnMacMlmeRequest( LoRaMacMlmeRequest( &mlmeReq ), &mlmeReq, mlmeReq.ReqReturn.DutyCycleWaitTime );
+        DutyCycleWaitTime = mlmeReq.ReqReturn.DutyCycleWaitTime;
     }
     else
     {
@@ -440,6 +466,7 @@ LmHandlerErrorStatus_t LmHandlerSend( LmHandlerAppData_t *appData, LmHandlerMsgT
 
     status = LoRaMacMcpsRequest( &mcpsReq );
     LmHandlerCallbacks->OnMacMcpsRequest( status, &mcpsReq, mcpsReq.ReqReturn.DutyCycleWaitTime );
+    DutyCycleWaitTime = mcpsReq.ReqReturn.DutyCycleWaitTime;
 
     if( status == LORAMAC_STATUS_OK )
     {
@@ -460,6 +487,7 @@ static LmHandlerErrorStatus_t LmHandlerDeviceTimeReq( void )
 
     status = LoRaMacMlmeRequest( &mlmeReq );
     LmHandlerCallbacks->OnMacMlmeRequest( status, &mlmeReq, mlmeReq.ReqReturn.DutyCycleWaitTime );
+    DutyCycleWaitTime = mlmeReq.ReqReturn.DutyCycleWaitTime;
 
     if( status == LORAMAC_STATUS_OK )
     {
@@ -480,6 +508,7 @@ static LmHandlerErrorStatus_t LmHandlerBeaconReq( void )
 
     status = LoRaMacMlmeRequest( &mlmeReq );
     LmHandlerCallbacks->OnMacMlmeRequest( status, &mlmeReq, mlmeReq.ReqReturn.DutyCycleWaitTime );
+    DutyCycleWaitTime = mlmeReq.ReqReturn.DutyCycleWaitTime;
 
     if( status == LORAMAC_STATUS_OK )
     {
@@ -502,6 +531,7 @@ LmHandlerErrorStatus_t LmHandlerPingSlotReq( uint8_t periodicity )
 
     status = LoRaMacMlmeRequest( &mlmeReq );
     LmHandlerCallbacks->OnMacMlmeRequest( status, &mlmeReq, mlmeReq.ReqReturn.DutyCycleWaitTime );
+    DutyCycleWaitTime = mlmeReq.ReqReturn.DutyCycleWaitTime;
 
     if( status == LORAMAC_STATUS_OK )
     {
@@ -894,7 +924,6 @@ LmHandlerErrorStatus_t LmHandlerPackageRegister( uint8_t id, void *params )
         LmHandlerPackages[id]->OnMacMcpsRequest = LmHandlerCallbacks->OnMacMcpsRequest;
         LmHandlerPackages[id]->OnMacMlmeRequest = LmHandlerCallbacks->OnMacMlmeRequest;
         LmHandlerPackages[id]->OnJoinRequest = LmHandlerJoinRequest;
-        LmHandlerPackages[id]->OnSendRequest = LmHandlerSend;
         LmHandlerPackages[id]->OnDeviceTimeRequest = LmHandlerDeviceTimeReq;
         LmHandlerPackages[id]->OnSysTimeUpdate = LmHandlerCallbacks->OnSysTimeUpdate;
         LmHandlerPackages[id]->Init( params, LmHandlerParams->DataBuffer, LmHandlerParams->DataBufferMaxSize );

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

@@ -31,7 +31,6 @@ extern "C"
 #endif
 
 #include "LmHandlerTypes.h"
-#include "LmhpCompliance.h"
 
 typedef struct LmHandlerJoinParams_s
 {
@@ -244,6 +243,13 @@ bool LmHandlerIsBusy( void );
  */
 void LmHandlerProcess( void );
 
+/*!
+ * Gets current duty-cycle wait time
+ *
+ * \retval time to wait in ms
+ */
+TimerTime_t LmHandlerGetDutyCycleWaitTime( void );
+
 /*!
  * Instructs the MAC layer to send a ClassA uplink
  *

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

@@ -55,12 +55,12 @@ typedef struct LmhPackage_s
      */
     bool ( *IsInitialized )( void );
     /*!
-     * Returns the package operation status.
+     * Returns if a package transmission is pending or not.
      *
-     * \retval status Package operation status
-     *                [true: Running, false: Not running]
+     * \retval status Package transmission status
+     *                [true: pending, false: Not pending]
      */
-    bool ( *IsRunning )( void );
+    bool ( *IsTxPending )( void );
     /*!
      * Processes the internal package events.
      */
@@ -121,16 +121,6 @@ typedef struct LmhPackage_s
     * \param [IN] isOtaa Indicates which activation mode must be used
     */
     void ( *OnJoinRequest )( bool isOtaa );
-    /*!
-     * Instructs the MAC layer to send a ClassA uplink
-     *
-     * \param [IN] appData Data to be sent
-     * \param [IN] isTxConfirmed Indicates if the uplink requires an acknowledgement
-     *
-     * \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if request has been
-     *                processed else \ref LORAMAC_HANDLER_ERROR
-     */
-    LmHandlerErrorStatus_t ( *OnSendRequest )( LmHandlerAppData_t *appData, LmHandlerMsgTypes_t isTxConfirmed );
     /*!
     * Requests network server time update
     *

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

@@ -19,7 +19,6 @@
  *
  * \author    Miguel Luis ( Semtech )
  */
-#include "systime.h"
 #include "LmHandler.h"
 #include "LmhpClockSync.h"
 
@@ -37,6 +36,7 @@
 typedef struct LmhpClockSyncState_s
 {
     bool Initialized;
+    bool IsTxPending;
     uint8_t DataBufferMaxSize;
     uint8_t *DataBuffer;
     union
@@ -89,6 +89,14 @@ static void LmhpClockSyncInit( void *params, uint8_t *dataBuffer, uint8_t dataBu
  */
 static bool LmhpClockSyncIsInitialized( void );
 
+/*!
+ * Returns if a package transmission is pending or not.
+ *
+ * \retval status Package transmission status
+ *                [true: pending, false: Not pending]
+ */
+static bool LmhpClockSyncIsTxPending( void );
+
 /*!
  * Processes the internal package events.
  */
@@ -111,6 +119,7 @@ static void LmhpClockSyncOnMcpsIndication( McpsIndication_t *mcpsIndication );
 static LmhpClockSyncState_t LmhpClockSyncState =
 {
     .Initialized = false,
+    .IsTxPending = false,
     .TimeReqParam.Value = 0,
     .AppTimeReqPending = false,
     .AdrEnabledPrev = false,
@@ -123,6 +132,7 @@ static LmhPackage_t LmhpClockSyncPackage =
     .Port = CLOCK_SYNC_PORT,
     .Init = LmhpClockSyncInit,
     .IsInitialized = LmhpClockSyncIsInitialized,
+    .IsTxPending = LmhpClockSyncIsTxPending,
     .Process = LmhpClockSyncProcess,
     .OnMcpsConfirmProcess = LmhpClockSyncOnMcpsConfirm,
     .OnMcpsIndicationProcess = LmhpClockSyncOnMcpsIndication,
@@ -131,7 +141,6 @@ static LmhPackage_t LmhpClockSyncPackage =
     .OnMacMcpsRequest = NULL,                                  // To be initialized by LmHandler
     .OnMacMlmeRequest = NULL,                                  // To be initialized by LmHandler
     .OnJoinRequest = NULL,                                     // To be initialized by LmHandler
-    .OnSendRequest = NULL,                                     // To be initialized by LmHandler
     .OnDeviceTimeRequest = NULL,                               // To be initialized by LmHandler
     .OnSysTimeUpdate = NULL,                                   // To be initialized by LmHandler
 };
@@ -153,13 +162,19 @@ static void LmhpClockSyncInit( void * params, uint8_t *dataBuffer, uint8_t dataB
     {
         LmhpClockSyncState.Initialized = false;
     }
+    LmhpClockSyncState.IsTxPending = false;
 }
 
 static bool LmhpClockSyncIsInitialized( void )
 {
     return LmhpClockSyncState.Initialized;
 }
 
+static bool LmhpClockSyncIsTxPending( void )
+{
+    return LmhpClockSyncState.IsTxPending;
+}
+
 static void LmhpClockSyncProcess( void )
 {
     if( LmhpClockSyncState.NbTransmissions > 0 )
@@ -291,7 +306,7 @@ static void LmhpClockSyncOnMcpsIndication( McpsIndication_t *mcpsIndication )
             .BufferSize = dataBufferIndex,
             .Port = CLOCK_SYNC_PORT
         };
-        LmhpClockSyncPackage.OnSendRequest( &appData, LORAMAC_HANDLER_UNCONFIRMED_MSG );
+        LmHandlerSend( &appData, LORAMAC_HANDLER_UNCONFIRMED_MSG );
     }
 }
 
@@ -353,5 +368,5 @@ LmHandlerErrorStatus_t LmhpClockSyncAppTimeReq( void )
         .Port = CLOCK_SYNC_PORT
     };
     LmhpClockSyncState.AppTimeReqPending = true;
-    return LmhpClockSyncPackage.OnSendRequest( &appData, LORAMAC_HANDLER_UNCONFIRMED_MSG );
+    return LmHandlerSend( &appData, LORAMAC_HANDLER_UNCONFIRMED_MSG );
 }