ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include "esp_err.h"
#include "esp_openthread_types.h"
#include "openthread/error.h"
#include "openthread/instance.h"
#define WORKFLOW_MAX_NAMELEN
esp_openthread_process_func
esp_openthread_platform_workflow
esp_openthread_platform_workflow_register(esp_openthread_update_func, esp_openthread_process_func, const char *);
esp_openthread_platform_workflow_unregister(const char *);
esp_openthread_platform_init(const esp_openthread_platform_config_t *);
esp_openthread_platform_deinit();
esp_openthread_platform_update(esp_openthread_mainloop_context_t *);
esp_openthread_platform_process(otInstance *, const esp_openthread_mainloop_context_t *);
esp_openthread_set_storage_name(const char *);
esp_openthread_get_alloc_caps();
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/openthread/private_include/esp_openthread_platform.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include "esp_err.h" #include "esp_openthread_types.h" #include "openthread/error.h" #include "openthread/instance.h" #ifdef __cplusplus extern "C" { #endif #define WORKFLOW_MAX_NAMELEN 16 /** * @brief update function declaration * * @param[inout] mainloop The main loop context. * *//* ... */ typedef void (*esp_openthread_update_func)(esp_openthread_mainloop_context_t *mainloop); /** * @brief process function declaration * * @param[in] instance The OpenThread instance. * @param[in] mainloop The main loop context. * * @return * - ESP_OK * - ESP_FAIL * *//* ... */ typedef esp_err_t (*esp_openthread_process_func)(otInstance *instance, const esp_openthread_mainloop_context_t *mainloop); /** * @brief This struct contains a platform update function, a platform process function * and the workflow name * * @note The structs will form a list, and the update functions and process functions in the list * will be called in esp_openthread_platform_update and esp_openthread_platform_process. * *//* ... */ typedef struct esp_openthread_platform_workflow { char name[WORKFLOW_MAX_NAMELEN]; esp_openthread_update_func update_func; esp_openthread_process_func process_func; struct esp_openthread_platform_workflow *next; }{ ... } esp_openthread_platform_workflow_t; /** * @brief This function adds a esp_openthread_platform_workflow to the workflow list * * * @param[in] updatefcn The update function of the workflow added to the list. * @param[in] processfcn The process function of the workflow added to the list. * @param[in] name The name of the added workflow * * @return * - ESP_OK on success * - ESP_ERR_NO_MEM on allocation failure * - ESP_FAIL on other failures * *//* ... */ esp_err_t esp_openthread_platform_workflow_register(esp_openthread_update_func update_func, esp_openthread_process_func process_func, const char *name); /** * @brief This function removes a esp_openthread_platform_workflow according the input name * from the workflow list * * @param[in] name The name of the removed workflow * *//* ... */ void esp_openthread_platform_workflow_unregister(const char *name); /** * @brief Initializes the platform-specific support for the OpenThread stack. * * @note This function is not called by and will not call the OpenThread library. * The user needs to call otInstanceInitSingle to initialize the OpenThread * stack after calling this function. * * @param[in] init_config The initialization configuration. * * @return * - ESP_OK on success * - ESP_ERR_NO_MEM if allocation has failed * - ESP_ERR_INVALID_ARG if radio or host connection mode not supported * - ESP_ERR_INVALID_STATE if already initialized * *//* ... */ esp_err_t esp_openthread_platform_init(const esp_openthread_platform_config_t *init_config); /** * This function performs all platform-specific deinitialization for OpenThread's drivers. * * @note This function is not called by the OpenThread library. Instead, the user should * call this function when deinitialization of OpenThread's drivers is most appropriate. * * @return * - ESP_OK on success * - ESP_ERR_INVALID_STATE if not initialized * *//* ... */ esp_err_t esp_openthread_platform_deinit(void); /** * @brief This function updates the platform fds and timeouts * * @note This function will not update the OpenThread core stack pending events. * The users need to call `otTaskletsArePending` to check whether there being * pending OpenThread tasks. * * @param[inout] mainloop The main loop context. * *//* ... */ void esp_openthread_platform_update(esp_openthread_mainloop_context_t *mainloop); /** * @brief This function performs the OpenThread related platform process (radio, uart, alarm etc.) * * @note This function will call the OpenThread core stack process functions. * The users need to call `otTaskletsProcess` by self. * * @param[in] instance The OpenThread instance. * @param[in] mainloop The main loop context. * * @return * - ESP_OK on success * - ESP_FAIL on failure * *//* ... */ esp_err_t esp_openthread_platform_process(otInstance *instance, const esp_openthread_mainloop_context_t *mainloop); /** * @brief This function set the OpenThread storage name * * @param[in] name The OpenThread storage name. * *//* ... */ void esp_openthread_set_storage_name(const char *name); /** * @brief Gets the caps of memory allocation. * * @return * - The caps of the memory. *//* ... */ uint32_t esp_openthread_get_alloc_caps(void); #ifdef __cplusplus }{...} // end of extern "C" #endif
Details
Show:
from
Types: Columns: