[radio] Refactor CSL parameters connected functions

WIP Signed-off-by: Maciej Baczmanski <[email protected]>
maciejbaczmanski · Jan 15, 2024 · aefc2e4 · aefc2e4
1 parent 71aed82
commit aefc2e4
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 2 deletions.
diff --git a/examples/platforms/simulation/radio.c b/examples/platforms/simulation/radio.c
@@ -1338,6 +1338,17 @@ otError otPlatRadioEnableCsl(otInstance         *aInstance,
     return error;
 }
 
+otError otPlatRadioResetCslParameters(otInstance *aInstance)
+{
+    OT_UNUSED_VARIABLE(aInstance);
+
+    otError error = OT_ERROR_NONE;
+
+    sCslPeriod = 0;
+
+    return error;
+}
+
 void otPlatRadioUpdateCslSampleTime(otInstance *aInstance, uint32_t aCslSampleTime)
 {
     OT_UNUSED_VARIABLE(aInstance);

diff --git a/include/openthread/instance.h b/include/openthread/instance.h
@@ -53,7 +53,7 @@ extern "C" {
  * @note This number versions both OpenThread platform and user APIs.
  *
  */
-#define OPENTHREAD_API_VERSION (389)
+#define OPENTHREAD_API_VERSION (390)
 
 /**
  * @addtogroup api-instance

diff --git a/include/openthread/platform/radio.h b/include/openthread/platform/radio.h
@@ -1142,6 +1142,21 @@ otError otPlatRadioEnableCsl(otInstance         *aInstance,
                              otShortAddress      aShortAddr,
                              const otExtAddress *aExtAddr);
 
+
+/**
+ * Reset CSL receiver parameters to default values.
+ *
+ * @note Defaults to `otPlatRadioEnableCsl(aInstance,0, Mac::kShortAddrInvalid, nullptr);`
+ *
+ * @param[in]  aInstance     The OpenThread instance structure.
+ *
+ * @retval  kErrorNotImplemented Radio driver doesn't support CSL.
+ * @retval  kErrorFailed         Other platform specific errors.
+ * @retval  kErrorNone           Successfully enabled or disabled CSL.
+ *
+ */
+otError otPlatRadioResetCslParameters(otInstance *aInstance);
+
 /**
  * Update CSL sample time in radio driver.
  *

diff --git a/src/core/radio/radio.cpp b/src/core/radio/radio.cpp
@@ -53,7 +53,7 @@ void Radio::Init(void)
 {
 #if OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE
 #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
-    SuccessOrAssert(EnableCsl(0, Mac::kShortAddrInvalid, nullptr));
+    SuccessOrAssert(ResetCslParameters());
 #endif
 
     EnableSrcMatch(false);

diff --git a/src/core/radio/radio.hpp b/src/core/radio/radio.hpp
@@ -537,6 +537,15 @@ class Radio : public InstanceLocator, private NonCopyable
      *
      */
     Error EnableCsl(uint32_t aCslPeriod, otShortAddress aShortAddr, const otExtAddress *aExtAddr);
+
+    /** Resets CSL receiver parameters in radio to default values.
+     *
+     * @retval  kErrorNotImplemented Radio driver doesn't support CSL.
+     * @retval  kErrorFailed         Other platform specific errors.
+     * @retval  kErrorNone           Successfully enabled or disabled CSL.
+     *
+     */
+    Error ResetCslParameters(void);
 #endif // OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
 
 #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE || OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE
@@ -958,6 +967,11 @@ inline Error Radio::EnableCsl(uint32_t aCslPeriod, otShortAddress aShortAddr, co
 {
     return otPlatRadioEnableCsl(GetInstancePtr(), aCslPeriod, aShortAddr, aExtAddr);
 }
+
+inline Error Radio::ResetCslParameters(void)
+{
+    return otPlatRadioResetCslParameters(GetInstancePtr());
+}
 #endif
 
 #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE || OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE
@@ -1064,6 +1078,8 @@ inline Error Radio::EnableCsl(uint32_t, otShortAddress aShortAddr, const otExtAd
 {
     return kErrorNotImplemented;
 }
+
+inline Error Radio::ResetCslParameters(void) { return kErrorNotImplemented; }
 #endif
 
 #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE || OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE

diff --git a/src/core/radio/radio_platform.cpp b/src/core/radio/radio_platform.cpp
@@ -250,6 +250,13 @@ OT_TOOL_WEAK uint32_t otPlatRadioGetBusSpeed(otInstance *aInstance)
     return 0;
 }
 
+// #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
+OT_TOOL_WEAK otError otPlatRadioResetCslParameters(otInstance *aInstance)
+{
+    return otPlatRadioEnableCsl(aInstance,0, Mac::kShortAddrInvalid, nullptr);
+}
+// #endif
+
 OT_TOOL_WEAK uint8_t otPlatRadioGetCslAccuracy(otInstance *aInstance)
 {
     OT_UNUSED_VARIABLE(aInstance);

diff --git a/tests/unit/test_platform.cpp b/tests/unit/test_platform.cpp
@@ -404,6 +404,11 @@ OT_TOOL_WEAK otError otPlatRadioEnableCsl(otInstance *, uint32_t, otShortAddress
     return OT_ERROR_NONE;
 }
 
+OT_TOOL_WEAK otError otPlatRadioResetCslParameters(otInstance *)
+{
+    return OT_ERROR_NONE;
+}
+
 OT_TOOL_WEAK void otPlatRadioUpdateCslSampleTime(otInstance *, uint32_t) {}
 
 OT_TOOL_WEAK uint8_t otPlatRadioGetCslAccuracy(otInstance *)