Outline ![]()
Files ![]()
loading...
SourceVu![]()
ESP-IDF Framework and Examples![]()
ESP-IDF![]()
components/openthread/src/port/esp_openthread_settings.c
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "nvs.h"
#include "esp_check.h"
#include "esp_openthread_common_macro.h"
#include "openthread/instance.h"
#include "openthread/platform/settings.h"
#define OT_NAMESPACE "openthread"
#define OT_PART_NAME s_storage_name
#define OT_KEY_PATTERN "OT%02x"
#define OT_KEY_INDEX_PATTERN "OT%02x%02x"
#define OT_KEY_PATTERN_LEN 5
#define OT_KEY_INDEX_PATTERN_LEN 7
static nvs_handle_t s_ot_nvs_handle;
static const char *s_storage_name;
void esp_openthread_set_storage_name(const char *name)
{
s_storage_name = name;
}
static esp_err_t get_next_empty_index(uint16_t aKey, uint8_t *index)
{
ESP_RETURN_ON_FALSE((s_ot_nvs_handle != 0), ESP_ERR_INVALID_STATE, OT_PLAT_LOG_TAG, "OT NVS handle is invalid.");
esp_err_t ret = ESP_OK;
static volatile uint8_t s_unused_pos = 0;
char ot_nvs_key[OT_KEY_INDEX_PATTERN_LEN] = { 0 };
nvs_iterator_t nvs_it = NULL;
bool found = false;
for (uint8_t i = 0; i != UINT8_MAX; i++) {
s_unused_pos++;
found = false;
snprintf(ot_nvs_key, sizeof(ot_nvs_key), OT_KEY_INDEX_PATTERN, (uint8_t)aKey, s_unused_pos);
ret = nvs_entry_find(OT_PART_NAME, OT_NAMESPACE, NVS_TYPE_BLOB, &nvs_it);
while (ret == ESP_OK) {
nvs_entry_info_t info;
nvs_entry_info(nvs_it, &info);
if (memcmp(ot_nvs_key, info.key, OT_KEY_INDEX_PATTERN_LEN - 1) == 0) {
found = true;
break;
}
ret = nvs_entry_next(&nvs_it);
}
nvs_release_iterator(nvs_it);
if (!found) {
// find an empty position, return ESP_OK
*index = s_unused_pos;
return ESP_OK;
}
}
// all index was used, no memory for current data, return ESP_ERR_NOT_FOUND.
return ESP_ERR_NOT_FOUND;
}
static esp_err_t find_target_key_using_index(uint16_t aKey, int aIndex, char *key, size_t key_len)
{
ESP_RETURN_ON_FALSE((s_ot_nvs_handle != 0), ESP_ERR_INVALID_STATE, OT_PLAT_LOG_TAG, "OT NVS handle is invalid.");
esp_err_t ret = ESP_OK;
nvs_iterator_t nvs_it = NULL;
int cur_index = 0;
char ot_nvs_key[OT_KEY_PATTERN_LEN] = { 0 };
ret = nvs_entry_find(OT_PART_NAME, OT_NAMESPACE, NVS_TYPE_BLOB, &nvs_it);
if (ret != ESP_OK) {
return ret;
}
snprintf(ot_nvs_key, sizeof(ot_nvs_key), OT_KEY_PATTERN, (uint8_t)aKey);
while (ret == ESP_OK) {
nvs_entry_info_t info;
nvs_entry_info(nvs_it, &info);
if (memcmp(ot_nvs_key, info.key, OT_KEY_PATTERN_LEN - 1) == 0) {
if (cur_index == aIndex) {
memcpy(key, info.key, key_len);
break;
} else {
cur_index++;
}
}
ret = nvs_entry_next(&nvs_it);
}
nvs_release_iterator(nvs_it);
if ((cur_index != aIndex) || (ret != ESP_OK)) {
return ESP_FAIL;
}
return ESP_OK;
}
static esp_err_t erase_all_key(uint16_t aKey)
{
ESP_RETURN_ON_FALSE((s_ot_nvs_handle != 0), ESP_ERR_INVALID_STATE, OT_PLAT_LOG_TAG, "OT NVS handle is invalid.");
esp_err_t ret = ESP_OK;
nvs_iterator_t nvs_it = NULL;
char ot_nvs_key[OT_KEY_PATTERN_LEN] = { 0 };
ret = nvs_entry_find(OT_PART_NAME, OT_NAMESPACE, NVS_TYPE_BLOB, &nvs_it);
if (ret == ESP_ERR_NVS_NOT_FOUND) {
return ESP_OK;
}
ESP_RETURN_ON_FALSE((ret == ESP_OK && nvs_it != NULL), ESP_FAIL, OT_PLAT_LOG_TAG, "Can not find any data in nvs flash, err: %d", ret);
while (ret == ESP_OK) {
snprintf(ot_nvs_key, sizeof(ot_nvs_key), OT_KEY_PATTERN, (uint8_t)aKey);
nvs_entry_info_t info;
nvs_entry_info(nvs_it, &info);
if (memcmp(ot_nvs_key, info.key, OT_KEY_PATTERN_LEN - 1) == 0) {
ret = nvs_erase_key(s_ot_nvs_handle, info.key);
if (ret != ESP_OK) {
break;
}
}
ret = nvs_entry_next(&nvs_it);
}
nvs_release_iterator(nvs_it);
ret = nvs_commit(s_ot_nvs_handle);
if (ret != ESP_OK) {
return ESP_FAIL;
}
return ESP_OK;
}
void otPlatSettingsInit(otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength)
{
esp_err_t err = nvs_open(OT_NAMESPACE, NVS_READWRITE, &s_ot_nvs_handle);
if (err != ESP_OK) {
ESP_LOGE(OT_PLAT_LOG_TAG, "Failed to open NVS namespace (0x%x)", err);
assert(0);
}
}
void otPlatSettingsDeinit(otInstance *aInstance)
{
if (s_ot_nvs_handle != 0) {
nvs_close(s_ot_nvs_handle);
}
}
otError otPlatSettingsGet(otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
{
ESP_RETURN_ON_FALSE((s_ot_nvs_handle != 0), OT_ERROR_NOT_FOUND, OT_PLAT_LOG_TAG, "OT NVS handle is invalid.");
esp_err_t ret = ESP_OK;
char ot_nvs_key[OT_KEY_INDEX_PATTERN_LEN] = { 0 };
ret = find_target_key_using_index(aKey, aIndex, ot_nvs_key, OT_KEY_INDEX_PATTERN_LEN);
if (ret != ESP_OK) {
return OT_ERROR_NOT_FOUND;
}
size_t length = *aValueLength;
ret = nvs_get_blob(s_ot_nvs_handle, ot_nvs_key, aValue, &length);
*aValueLength = (uint16_t) length;
ESP_RETURN_ON_FALSE((ret == ESP_OK), OT_ERROR_NOT_FOUND, OT_PLAT_LOG_TAG, "Data not found, err: %d", ret);
return OT_ERROR_NONE;
}
otError otPlatSettingsSet(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
{
ESP_RETURN_ON_FALSE((s_ot_nvs_handle != 0), OT_ERROR_NOT_FOUND, OT_PLAT_LOG_TAG, "OT NVS handle is invalid.");
esp_err_t ret = ESP_OK;
char ot_nvs_key[OT_KEY_INDEX_PATTERN_LEN]= { 0 };
snprintf(ot_nvs_key, sizeof(ot_nvs_key), OT_KEY_INDEX_PATTERN, (uint8_t)aKey, 0);
ret = nvs_set_blob(s_ot_nvs_handle, ot_nvs_key, aValue, aValueLength);
ESP_RETURN_ON_FALSE((ret == ESP_OK), OT_ERROR_NO_BUFS, OT_PLAT_LOG_TAG, "No buffers, err: %d", ret);
ret = nvs_commit(s_ot_nvs_handle);
ESP_RETURN_ON_FALSE((ret == ESP_OK), OT_ERROR_NO_BUFS, OT_PLAT_LOG_TAG, "OT NVS handle shut down, err: %d", ret);
return OT_ERROR_NONE;
}
otError otPlatSettingsAdd(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
{
ESP_RETURN_ON_FALSE((s_ot_nvs_handle != 0), OT_ERROR_NOT_FOUND, OT_PLAT_LOG_TAG, "OT NVS handle is invalid.");
esp_err_t ret = ESP_OK;
uint8_t unused_pos;
char ot_nvs_key[OT_KEY_INDEX_PATTERN_LEN] = { 0 };
ret = get_next_empty_index(aKey, &unused_pos);
ESP_RETURN_ON_FALSE((ret == ESP_OK), OT_ERROR_NO_BUFS, OT_PLAT_LOG_TAG, "No buffers, err: %d", ret);
snprintf(ot_nvs_key, sizeof(ot_nvs_key), OT_KEY_INDEX_PATTERN, (uint8_t)aKey, unused_pos);
ret = nvs_set_blob(s_ot_nvs_handle, ot_nvs_key, aValue, aValueLength);
ESP_RETURN_ON_FALSE((ret == ESP_OK), OT_ERROR_NO_BUFS, OT_PLAT_LOG_TAG, "No buffers, err: %d", ret);
ret = nvs_commit(s_ot_nvs_handle);
ESP_RETURN_ON_FALSE((ret == ESP_OK), OT_ERROR_NO_BUFS, OT_PLAT_LOG_TAG, "OT NVS handle shut down, err: %d", ret);
return OT_ERROR_NONE;
}
otError otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex)
{
ESP_RETURN_ON_FALSE((s_ot_nvs_handle != 0), OT_ERROR_NOT_FOUND, OT_PLAT_LOG_TAG, "OT NVS handle is invalid.");
esp_err_t ret = ESP_OK;
if (aIndex == -1) {
ret = erase_all_key(aKey);
} else {
char ot_nvs_key[OT_KEY_INDEX_PATTERN_LEN] = { 0 };
ret = find_target_key_using_index(aKey, aIndex, ot_nvs_key, OT_KEY_INDEX_PATTERN_LEN);
if (ret != ESP_OK) {
return OT_ERROR_NOT_FOUND;
}
ret = nvs_erase_key(s_ot_nvs_handle, ot_nvs_key);
nvs_commit(s_ot_nvs_handle);
}
return OT_ERROR_NONE;
}
void otPlatSettingsWipe(otInstance *aInstance)
{
nvs_erase_all(s_ot_nvs_handle);
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.