Outline ![]()
Files ![]()
loading...
SourceVu![]()
ESP-IDF Framework and Examples![]()
ESP-IDF![]()
components/openthread/openthread/include/openthread/platform/settings.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
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
/*
* Copyright (c) 2016, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* @brief
* This file includes platform abstraction for non-volatile storage of settings.
*/
#ifndef OPENTHREAD_PLATFORM_SETTINGS_H_
#define OPENTHREAD_PLATFORM_SETTINGS_H_
#include <openthread/instance.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup plat-settings
*
* @brief
* This module includes the platform abstraction for non-volatile storage of settings.
*
* @{
*/
/**
* Defines the keys of settings.
*
* Note: When adding a new settings key, if the settings corresponding to the key contains security sensitive
* information, the developer MUST add the key to the array `aSensitiveKeys` which is passed in
* `otPlatSettingsInit()`.
*/
enum
{
OT_SETTINGS_KEY_ACTIVE_DATASET = 0x0001, ///< Active Operational Dataset.
OT_SETTINGS_KEY_PENDING_DATASET = 0x0002, ///< Pending Operational Dataset.
OT_SETTINGS_KEY_NETWORK_INFO = 0x0003, ///< Thread network information.
OT_SETTINGS_KEY_PARENT_INFO = 0x0004, ///< Parent information.
OT_SETTINGS_KEY_CHILD_INFO = 0x0005, ///< Child information.
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007, ///< SLAAC key to generate semantically opaque IID.
OT_SETTINGS_KEY_DAD_INFO = 0x0008, ///< Duplicate Address Detection (DAD) information.
OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b, ///< SRP client ECDSA public/private key pair.
OT_SETTINGS_KEY_SRP_CLIENT_INFO = 0x000c, ///< The SRP client info (selected SRP server address).
OT_SETTINGS_KEY_SRP_SERVER_INFO = 0x000d, ///< The SRP server info (UDP port).
OT_SETTINGS_KEY_BR_ULA_PREFIX = 0x000f, ///< BR ULA prefix.
OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES = 0x0010, ///< BR local on-link prefixes.
OT_SETTINGS_KEY_BORDER_AGENT_ID = 0x0011, ///< Unique Border Agent/Router ID.
// Deprecated and reserved key values:
//
// 0x0006 previously auto-start.
// 0x0009 previously OMR prefix.
// 0x000a previously on-link prefix.
// 0x000e previously NAT64 prefix.
// Keys in range 0x8000-0xffff are reserved for vendor-specific use.
OT_SETTINGS_KEY_VENDOR_RESERVED_MIN = 0x8000,
OT_SETTINGS_KEY_VENDOR_RESERVED_MAX = 0xffff,
};
/**
* Performs any initialization for the settings subsystem, if necessary.
*
* Also sets the sensitive keys that should be stored in the secure area.
*
* Note that the memory pointed by @p aSensitiveKeys MUST not be released before @p aInstance is destroyed.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aSensitiveKeys A pointer to an array containing the list of sensitive keys. May be NULL only if
* @p aSensitiveKeysLength is 0, which means that there is no sensitive keys.
* @param[in] aSensitiveKeysLength The number of entries in the @p aSensitiveKeys array.
*/
void otPlatSettingsInit(otInstance *aInstance, const uint16_t *aSensitiveKeys, uint16_t aSensitiveKeysLength);
/**
* Performs any de-initialization for the settings subsystem, if necessary.
*
* @param[in] aInstance The OpenThread instance structure.
*/
void otPlatSettingsDeinit(otInstance *aInstance);
/**
* Fetches the value of a setting.
*
* Fetches the value of the setting identified
* by @p aKey and write it to the memory pointed to by aValue.
* It then writes the length to the integer pointed to by
* @p aValueLength. The initial value of @p aValueLength is the
* maximum number of bytes to be written to @p aValue.
*
* Can be used to check for the existence of
* a key without fetching the value by setting @p aValue and
* @p aValueLength to NULL. You can also check the length of
* the setting without fetching it by setting only aValue
* to NULL.
*
* Note that the underlying storage implementation is not
* required to maintain the order of settings with multiple
* values. The order of such values MAY change after ANY
* write operation to the store.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aKey The key associated with the requested setting.
* @param[in] aIndex The index of the specific item to get.
* @param[out] aValue A pointer to where the value of the setting should be written. May be set to NULL if
* just testing for the presence or length of a setting.
* @param[in,out] aValueLength A pointer to the length of the value. When called, this pointer should point to an
* integer containing the maximum value size that can be written to @p aValue. At return,
* the actual length of the setting is written. This may be set to NULL if performing
* a presence check.
*
* @retval OT_ERROR_NONE The given setting was found and fetched successfully.
* @retval OT_ERROR_NOT_FOUND The given setting was not found in the setting store.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on this platform.
*/
otError otPlatSettingsGet(otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength);
/**
* Sets or replaces the value of a setting.
*
* Sets or replaces the value of a setting
* identified by @p aKey.
*
* Calling this function successfully may cause unrelated
* settings with multiple values to be reordered.
*
* OpenThread stack guarantees to use `otPlatSettingsSet()`
* method for a @p aKey that was either previously set using
* `otPlatSettingsSet()` (i.e., contains a single value) or
* is empty and/or fully deleted (contains no value).
*
* Platform layer can rely and use this fact for optimizing
* its implementation.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aKey The key associated with the setting to change.
* @param[in] aValue A pointer to where the new value of the setting should be read from. MUST NOT be NULL if
* @p aValueLength is non-zero.
* @param[in] aValueLength The length of the data pointed to by aValue. May be zero.
*
* @retval OT_ERROR_NONE The given setting was changed or staged.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on this platform.
* @retval OT_ERROR_NO_BUFS No space remaining to store the given setting.
*/
otError otPlatSettingsSet(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength);
/**
* Adds a value to a setting.
*
* Adds the value to a setting
* identified by @p aKey, without replacing any existing
* values.
*
* Note that the underlying implementation is not required
* to maintain the order of the items associated with a
* specific key. The added value may be added to the end,
* the beginning, or even somewhere in the middle. The order
* of any pre-existing values may also change.
*
* Calling this function successfully may cause unrelated
* settings with multiple values to be reordered.
*
* OpenThread stack guarantees to use `otPlatSettingsAdd()`
* method for a @p aKey that was either previously managed by
* `otPlatSettingsAdd()` (i.e., contains one or more items) or
* is empty and/or fully deleted (contains no value).
*
* Platform layer can rely and use this fact for optimizing
* its implementation.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aKey The key associated with the setting to change.
* @param[in] aValue A pointer to where the new value of the setting should be read from. MUST NOT be NULL
* if @p aValueLength is non-zero.
* @param[in] aValueLength The length of the data pointed to by @p aValue. May be zero.
*
* @retval OT_ERROR_NONE The given setting was added or staged to be added.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on this platform.
* @retval OT_ERROR_NO_BUFS No space remaining to store the given setting.
*/
otError otPlatSettingsAdd(otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength);
/**
* Removes a setting from the setting store.
*
* Deletes a specific value from the
* setting identified by aKey from the settings store.
*
* Note that the underlying implementation is not required
* to maintain the order of the items associated with a
* specific key.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aKey The key associated with the requested setting.
* @param[in] aIndex The index of the value to be removed. If set to -1, all values for this @p aKey will be
* removed.
*
* @retval OT_ERROR_NONE The given key and index was found and removed successfully.
* @retval OT_ERROR_NOT_FOUND The given key or index was not found in the setting store.
* @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on this platform.
*/
otError otPlatSettingsDelete(otInstance *aInstance, uint16_t aKey, int aIndex);
/**
* Removes all settings from the setting store.
*
* Deletes all settings from the settings
* store, resetting it to its initial factory state.
*
* @param[in] aInstance The OpenThread instance structure.
*/
void otPlatSettingsWipe(otInstance *aInstance);
/**
* @}
*/
#ifdef __cplusplus
} // extern "C"
#endif
#endif // OPENTHREAD_PLATFORM_SETTINGS_H_
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.