Ajustes
Este módulo incluye la abstracción de la plataforma para el almacenamiento no volátil de configuraciones.
Resumen
Enumeraciones | |
---|---|
anonymous enum { | enumeración Esta enumeración define las claves de configuración. |
Funciones | |
---|---|
otPlatSettingsAdd ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength) | Agrega un valor a una configuración. |
otPlatSettingsDeinit ( otInstance *aInstance) | void Realiza cualquier desinicialización para el subsistema de configuración, si es necesario. |
otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex) | Elimina un ajuste del almacén de ajustes. |
otPlatSettingsGet ( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength) | Obtiene el valor de un ajuste. |
otPlatSettingsInit ( otInstance *aInstance) | void Realiza cualquier inicialización para el subsistema de configuración, si es necesario. |
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength) | Establece o reemplaza el valor de una configuración. |
otPlatSettingsSetCriticalKeys ( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength) | void Esta función establece las claves críticas que deben almacenarse en el área segura. |
otPlatSettingsWipe ( otInstance *aInstance) | void Elimina todos los ajustes del almacén de ajustes. |
Enumeraciones
enumeración anónima
anonymous enum
Esta enumeración define las claves de configuración.
Nota: Al agregar una nueva clave de configuración, si la configuración correspondiente a la clave contiene información confidencial de seguridad, el desarrollador DEBE agregar la clave a la matriz kCriticalKeys
.
Funciones
otPlatSettingsAdd
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Agrega un valor a una configuración.
Esta función agrega el valor a una configuración identificada por aKey, sin reemplazar ningún valor existente.
Tenga en cuenta que la implementación subyacente no es necesaria para mantener el orden de los elementos asociados con una clave específica. El valor agregado puede agregarse al final, al principio o incluso en algún punto intermedio. El orden de los valores preexistentes también puede cambiar.
Llamar a esta función con éxito puede hacer que se reordenen configuraciones no relacionadas con múltiples valores.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Valores devueltos |
|
otPlatSettingsDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
Realiza cualquier desinicialización para el subsistema de configuración, si es necesario.
Detalles | |||
---|---|---|---|
Parámetros |
|
otPlatSettingsDelete
otError otPlatSettingsDelete( otInstance *aInstance, uint16_t aKey, int aIndex )
Elimina un ajuste del almacén de ajustes.
Esta función elimina un valor específico de la configuración identificada por aKey del almacén de configuraciones.
Tenga en cuenta que la implementación subyacente no es necesaria para mantener el orden de los elementos asociados con una clave específica.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otPlatSettingsGet
otError otPlatSettingsGet( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength )
Obtiene el valor de un ajuste.
Esta función obtiene el valor del ajuste identificado por aKey y lo escribe en la memoria apuntada por aValue. A continuación, escribe la longitud en el número entero al que apunta aValueLength. El valor inicial de aValueLength es el número máximo de bytes que se escribirán en aValue.
Esta función se puede utilizar para comprobar la existencia de una clave sin obtener el valor estableciendo aValue y aValueLength en NULL. También puede verificar la longitud de la configuración sin obtenerla configurando solo aValue en NULL.
Tenga en cuenta que la implementación de almacenamiento subyacente no es necesaria para mantener el orden de la configuración con varios valores. El orden de dichos valores PUEDE cambiar después de CUALQUIER operación de escritura en la tienda.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||||
Valores devueltos |
|
otPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance )
Realiza cualquier inicialización para el subsistema de configuración, si es necesario.
Detalles | |||
---|---|---|---|
Parámetros |
|
otPlatSettingsSet
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Establece o reemplaza el valor de una configuración.
Esta función establece o reemplaza el valor de una configuración identificada por aKey. Si había más de un valor asociado previamente con una clave, todos se eliminan y se reemplazan con esta única entrada.
Llamar a esta función con éxito puede hacer que se reordenen configuraciones no relacionadas con múltiples valores.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Valores devueltos |
|
otPlatSettingsSetCriticalKeys
void otPlatSettingsSetCriticalKeys( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength )
Esta función establece las claves críticas que deben almacenarse en el área segura.
Tenga en cuenta que la memoria señalada por aKeys
no DEBE liberarse antes de que se destruya una aInstance
.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otPlatSettingsWipe
void otPlatSettingsWipe( otInstance *aInstance )
Elimina todos los ajustes del almacén de ajustes.
Esta función borra todos los ajustes del almacén de ajustes y los restablece a su estado inicial de fábrica.
Detalles | |||
---|---|---|---|
Parámetros |
|