[to be squashed] Ensure deprecation period for all net functions

The new functions in module/openthread will be called with
`_platform_` to ensure the backward compatibility of functions
defined in subsys/net/l2/openthread

Signed-off-by: Arkadiusz Balys <[email protected]>

Author: ArekBalysNordic

include/zephyr/net/openthread.h

@@ -60,8 +60,13 @@ struct openthread_context {
 	struct pkt_list_elem pkt_list[CONFIG_OPENTHREAD_PKT_LIST_SIZE];
 
 	/** @deprecated A list for state change callbacks */
-	sys_slist_t ot_state_change_cbs;
+	sys_slist_t state_change_cbs;
 };
+/**
+ * INTERNAL_HIDDEN @endcond
+ */
+
+/** OpenThread state change callback  */
 
 /**
  * @brief OpenThread state change callback structure
@@ -94,17 +99,11 @@ struct openthread_state_changed_cb {
 };
 
 /**
- * INTERNAL_HIDDEN @endcond
- */
-
-/** OpenThread state change callback  */
-
-/**
- * @deprecated use @ref openthread_state_changed_callback_register from modules/openthread
+ * @deprecated use @ref openthread_platform_state_changed_cb_register from modules/openthread
  * instead.
  *
  * @brief Registers callbacks which will be called when certain configuration
- * or state changes occur within OpenThread.`
+ * or state changes occur within OpenThread.
  *
  * @param ot_context the OpenThread context to register the callback with.
  * @param cb callback struct to register.
@@ -113,7 +112,7 @@ __deprecated int openthread_state_changed_cb_register(struct openthread_context
 						      struct openthread_state_changed_cb *cb);
 
 /**
- * @deprecated use @ref openthread_state_changed_callback_unregister from modules/openthread
+ * @deprecated use @ref openthread_platform_state_changed_cb_unregister from modules/openthread
  * instead.
  *
  * @brief Unregisters OpenThread configuration or state changed callbacks.
@@ -124,6 +123,13 @@ __deprecated int openthread_state_changed_cb_register(struct openthread_context
 __deprecated int openthread_state_changed_cb_unregister(struct openthread_context *ot_context,
 							struct openthread_state_changed_cb *cb);
 
+/**
+ * @deprecated use @ref openthread_platform_thread_id_get from modules/openthread instead.
+ *
+ * @brief Get OpenThread thread identification.
+ */
+__deprecated k_tid_t openthread_thread_id_get(void);
+
 /**
  * @brief Get pointer to default OpenThread context.
  *
@@ -133,7 +139,31 @@ __deprecated int openthread_state_changed_cb_unregister(struct openthread_contex
 struct openthread_context *openthread_get_default_context(void);
 
 /**
- * @deprecated use @ref openthread_mutex_lock from modules/openthread instead.
+ * @deprecated use @ref openthread_platform_get_default_instance from modules/openthread
+ * instead.
+ *
+ * @brief Get pointer to default OpenThread instance.
+ *
+ * @retval !NULL On success.
+ * @retval NULL  On failure.
+ */
+__deprecated struct otInstance *openthread_get_default_instance(void);
+
+/**
+ * @deprecated use @ref openthread_platform_start from modules/openthread instead.
+ *
+ * @brief Starts the OpenThread network.
+ *
+ * @details Depends on active settings: it uses stored network configuration,
+ * start joining procedure or uses default network configuration. Additionally
+ * when the device is MTD, it sets the SED mode to properly attach the network.
+ *
+ * @param ot_context
+ */
+__deprecated int openthread_start(struct openthread_context *ot_context);
+
+/**
+ * @deprecated use @ref openthread_platform_mutex_lock from modules/openthread instead.
  *
  * @brief Lock internal mutex before accessing OT API.
  *
@@ -146,7 +176,7 @@ struct openthread_context *openthread_get_default_context(void);
 __deprecated void openthread_api_mutex_lock(struct openthread_context *ot_context);
 
 /**
- * @deprecated use @ref openthread_mutex_try_lock from modules/openthread instead.
+ * @deprecated use @ref openthread_platform_mutex_try_lock from modules/openthread instead.
  *
  * @brief Try to lock internal mutex before accessing OT API.
  *
@@ -161,7 +191,7 @@ __deprecated void openthread_api_mutex_lock(struct openthread_context *ot_contex
 __deprecated int openthread_api_mutex_try_lock(struct openthread_context *ot_context);
 
 /**
- * @deprecated use @ref openthread_mutex_unlock from modules/openthread instead.
+ * @deprecated use @ref openthread_platform_mutex_unlock from modules/openthread instead.
  *
  * @brief Unlock internal mutex after accessing OT API.
  *

modules/openthread/platform/openthread.c

@@ -18,8 +18,8 @@ LOG_MODULE_REGISTER(module_openthread, CONFIG_OPENTHREAD_PLATFORM_LOG_LEVEL);
 #include <zephyr/version.h>
 #include <zephyr/sys/check.h>
 
-#include "platform/platform-zephyr.h"
-#include "openthread_module.h"
+#include "platform-zephyr.h"
+#include "openthread.h"
 
 #include <openthread/child_supervision.h>
 #include <openthread/cli.h>
@@ -108,7 +108,7 @@ static sys_slist_t openthread_state_change_cbs;
 
 K_KERNEL_STACK_DEFINE(ot_stack_area, OT_STACK_SIZE);
 
-k_tid_t openthread_thread_id_get(void)
+k_tid_t openthread_platform_thread_id_get(void)
 {
 	return (k_tid_t)&openthread_work_q.thread;
 }
@@ -127,15 +127,15 @@ static int ncp_hdlc_send(const uint8_t *buf, uint16_t len)
 
 static void openthread_process(struct k_work *work)
 {
-	openthread_mutex_lock();
+	openthread_platform_mutex_lock();
 
 	while (otTaskletsArePending(openthread_instance)) {
 		otTaskletsProcess(openthread_instance);
 	}
 
 	otSysProcessDrivers(openthread_instance);
 
-	openthread_mutex_unlock();
+	openthread_platform_mutex_unlock();
 }
 
 static void ot_joiner_start_handler(otError error, void *context)
@@ -172,15 +172,15 @@ static void ot_state_changed_handler(uint32_t flags, void *context)
 	}
 }
 
-int openthread_state_changed_callback_register(struct openthread_state_changed_callback *cb)
+int openthread_platform_state_changed_cb_register(struct openthread_state_changed_callback *cb)
 {
 	CHECKIF(cb == NULL || cb->state_changed_cb == NULL) {
 		return -EINVAL;
 	}
 
-	openthread_mutex_lock();
+	openthread_platform_mutex_lock();
 	sys_slist_append(&openthread_state_change_cbs, &cb->node);
-	openthread_mutex_unlock();
+	openthread_platform_mutex_unlock();
 
 	return 0;
 }
@@ -197,17 +197,17 @@ void otSysEventSignalPending(void)
 	otTaskletsSignalPending(NULL);
 }
 
-int openthread_state_changed_callback_unregister(struct openthread_state_changed_callback *cb)
+int openthread_platform_state_changed_cb_unregister(struct openthread_state_changed_callback *cb)
 {
 	bool removed;
 
 	CHECKIF(cb == NULL) {
 		return -EINVAL;
 	}
 
-	openthread_mutex_lock();
+	openthread_platform_mutex_lock();
 	removed = sys_slist_find_and_remove(&openthread_state_change_cbs, &cb->node);
-	openthread_mutex_unlock();
+	openthread_platform_mutex_unlock();
 
 	if (!removed) {
 		return -EALREADY;
@@ -216,13 +216,13 @@ int openthread_state_changed_callback_unregister(struct openthread_state_changed
 	return 0;
 }
 
-struct otInstance *openthread_get_default_instance()
+struct otInstance *openthread_platform_get_default_instance()
 {
 	__ASSERT(openthread_instance, "OT instance is not initialized");
 	return openthread_instance;
 }
 
-bool openthread_init(receiveCallback rx_handler, void *context)
+bool openthread_platform_init(receiveCallback rx_handler, void *context)
 {
 	struct k_work_queue_config q_cfg = {
 		.name = "openthread",
@@ -238,7 +238,7 @@ bool openthread_init(receiveCallback rx_handler, void *context)
 	k_mutex_init(&openthread_lock);
 	k_work_init(&openthread_work, openthread_process);
 
-	openthread_mutex_lock();
+	openthread_platform_mutex_lock();
 
 	otSysInit(0, NULL);
 	openthread_instance = otInstanceInitSingle();
@@ -290,7 +290,7 @@ bool openthread_init(receiveCallback rx_handler, void *context)
 		}
 	}
 
-	openthread_mutex_unlock();
+	openthread_platform_mutex_unlock();
 
 	/* Start work queue for the OpenThread module */
 	k_work_queue_start(&openthread_work_q, ot_stack_area, K_KERNEL_STACK_SIZEOF(ot_stack_area),
@@ -301,9 +301,9 @@ bool openthread_init(receiveCallback rx_handler, void *context)
 	return true;
 }
 
-int openthread_start()
+int openthread_platform_start()
 {
-	openthread_mutex_lock();
+	openthread_platform_mutex_lock();
 	otError error = OT_ERROR_NONE;
 
 	if (otDatasetIsCommissioned(openthread_instance)) {
@@ -377,42 +377,42 @@ int openthread_start()
 
 exit:
 
-	openthread_mutex_unlock();
+	openthread_platform_mutex_unlock();
 
 	return error == OT_ERROR_NONE ? 0 : -EIO;
 }
 
-int openthread_stop()
+int openthread_platform_stop()
 {
 	otError error;
 
 	if (IS_ENABLED(CONFIG_OPENTHREAD_COPROCESSOR)) {
 		return 0;
 	}
 
-	openthread_mutex_lock();
+	openthread_platform_mutex_lock();
 
 	error = otThreadSetEnabled(openthread_instance, false);
 	if (error == OT_ERROR_INVALID_STATE) {
 		LOG_DBG("Openthread interface was not up [%d]", error);
 	}
 
-	openthread_mutex_unlock();
+	openthread_platform_mutex_unlock();
 
 	return 0;
 }
 
-void openthread_mutex_lock()
+void openthread_platform_mutex_lock()
 {
 	(void)k_mutex_lock(&openthread_lock, K_FOREVER);
 }
 
-int openthread_mutex_try_lock()
+int openthread_platform_mutex_try_lock()
 {
 	return k_mutex_lock(&openthread_lock, K_NO_WAIT);
 }
 
-void openthread_mutex_unlock()
+void openthread_platform_mutex_unlock()
 {
 	(void)k_mutex_unlock(&openthread_lock);
 }

modules/openthread/platform/openthread.h

@@ -69,17 +69,22 @@ typedef void (*receiveCallback)(otMessage *aMessage, void *aContext);
  *
  * @param cb callback struct to register.
  */
-int openthread_state_changed_callback_register(struct openthread_state_changed_callback *cb);
+int openthread_platform_state_changed_cb_register(struct openthread_state_changed_callback *cb);
 
 /**
  * @brief Unregisters OpenThread configuration or state changed callbacks.
  *
  * @param cb callback struct to unregister.
  */
-int openthread_state_changed_callback_unregister(struct openthread_state_changed_callback *cb);
+int openthread_platform_state_changed_cb_unregister(struct openthread_state_changed_callback *cb);
 
-struct openthread_context *openthread_get_default_context(void);
-struct otInstance *openthread_get_default_instance(void);
+/**
+ * @brief Get pointer to default OpenThread instance.
+ *
+ * @retval !NULL On success.
+ * @retval NULL  On failure.
+ */
+struct otInstance *openthread_platform_get_default_context(void);
 
 /**
  * @brief Initialize the OpenThread module.
@@ -102,20 +107,20 @@ struct otInstance *openthread_get_default_instance(void);
  * @param context The context to pass to the callback.
  * @return true if initialization succeeded, false otherwise.
  */
-bool openthread_init(receiveCallback rx_handler, void *context);
+bool openthread_platform_init(receiveCallback rx_handler, void *context);
 
 /**
  * @brief Get OpenThread thread identification.
  */
-k_tid_t openthread_thread_id_get(void);
+k_tid_t openthread_platform_thread_id_get(void);
 
 /**
  * @brief Get pointer to default OpenThread instance.
  *
  * @retval !NULL On success.
  * @retval NULL  On failure.
  */
-struct otInstance *openthread_get_default_instance(void);
+struct otInstance *openthread_platform_get_default_instance(void);
 
 /**
  * @brief Starts the OpenThread network.
@@ -124,12 +129,12 @@ struct otInstance *openthread_get_default_instance(void);
  * start joining procedure or uses default network configuration. Additionally
  * when the device is MTD, it sets the SED mode to properly attach the network.
  */
-int openthread_start(void);
+int openthread_platform_start(void);
 
 /**
  * @brief Stops the OpenThread network.
  */
-int openthread_stop(void);
+int openthread_platform_stop(void);
 
 /**
  * @brief Lock internal mutex before accessing OT API.
@@ -140,7 +145,7 @@ int openthread_stop(void);
  *
  * @param ot_context Context to lock.
  */
-void openthread_mutex_lock(void);
+void openthread_platform_mutex_lock(void);
 
 /**
  * @brief Try to lock internal mutex before accessing OT API.
@@ -149,14 +154,14 @@ void openthread_mutex_lock(void);
  * the internal mutex is unlocked. Otherwise, it exists immediately and returns
  * a negative value.
  */
-int openthread_mutex_try_lock(void);
+int openthread_platform_mutex_try_lock(void);
 
 /**
  * @brief Unlock internal mutex after accessing OT API.
  *
  * @param ot_context Context to unlock.
  */
-void openthread_mutex_unlock(void);
+void openthread_platform_mutex_unlock(void);
 
 #ifdef __cplusplus
 }

modules/openthread/platform/shell.c

@@ -75,9 +75,9 @@ static int ot_cmd(const struct shell *sh, size_t argc, char *argv[])
 
 	shell_p = sh;
 
-	openthread_mutex_lock();
+	openthread_platform_mutex_lock();
 	otCliInputLine(rx_buffer);
-	openthread_mutex_unlock();
+	openthread_platform_mutex_unlock();
 
 	return 0;
 }