O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

Definições

Este módulo inclui a abstração da plataforma para armazenamento não volátil de configurações.

Resumo

Enumerações

anonymous enum {
OT_SETTINGS_KEY_ACTIVE_DATASET = 0x0001,
OT_SETTINGS_KEY_PENDING_DATASET = 0x0002,
OT_SETTINGS_KEY_NETWORK_INFO = 0x0003,
OT_SETTINGS_KEY_PARENT_INFO = 0x0004,
OT_SETTINGS_KEY_CHILD_INFO = 0x0005,
OT_SETTINGS_KEY_RESERVED = 0x0006,
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007,
OT_SETTINGS_KEY_DAD_INFO = 0x0008,
OT_SETTINGS_KEY_OMR_PREFIX = 0x0009,
OT_SETTINGS_KEY_ON_LINK_PREFIX = 0x000a,
OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b
}
enum
Essa enumeração define as chaves das configurações.

Funções

otPlatSettingsAdd ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
Adiciona um valor a uma configuração.
otPlatSettingsDeinit ( otInstance *aInstance)
void
Executa qualquer inicialização do subsistema de configurações, se necessário.
otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)
Remove uma configuração do armazenamento de configurações.
otPlatSettingsGet ( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength)
Busca o valor de uma configuração.
otPlatSettingsInit ( otInstance *aInstance)
void
Executa qualquer inicialização para o subsistema de configurações, se necessário.
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength)
Define ou substitui o valor de uma configuração.
otPlatSettingsSetCriticalKeys ( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength)
void
Esta função define as chaves críticas que devem ser armazenadas na área segura.
otPlatSettingsWipe ( otInstance *aInstance)
void
Remove todas as configurações do armazenamento de configurações.

Enumerações

enum anônimo

 anonymous enum

Essa enumeração define as chaves das configurações.

Nota: Ao adicionar uma nova chave de configurações, se as configurações correspondentes à chave contiverem informações confidenciais de segurança, o desenvolvedor DEVE adicionar a chave à matriz kCriticalKeys .

Propriedades
OT_SETTINGS_KEY_ACTIVE_DATASET

Conjunto de dados operacionais ativos.

OT_SETTINGS_KEY_CHILD_INFO

Informações da criança.

OT_SETTINGS_KEY_DAD_INFO

Informações de detecção de endereço duplicado (DAD).

OT_SETTINGS_KEY_NETWORK_INFO

Informações de rede de thread.

OT_SETTINGS_KEY_OMR_PREFIX

Prefixo fora da malha roteável (OMR).

OT_SETTINGS_KEY_ON_LINK_PREFIX

Prefixo no link para link de infraestrutura.

OT_SETTINGS_KEY_PARENT_INFO

Informações dos pais.

OT_SETTINGS_KEY_PENDING_DATASET

Conjunto de dados operacionais pendentes.

OT_SETTINGS_KEY_RESERVED

Reservado (anteriormente início automático).

OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY

Chave SLAAC para gerar IID semanticamente opaco.

OT_SETTINGS_KEY_SRP_ECDSA_KEY

Par de chaves públicas / privadas ECDSA do cliente SRP.

Funções

otPlatSettingsAdd

otError otPlatSettingsAdd(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Adiciona um valor a uma configuração.

Esta função adiciona o valor a uma configuração identificada por aKey, sem substituir nenhum valor existente.

Observe que a implementação subjacente não é necessária para manter a ordem dos itens associados a uma chave específica. O valor agregado pode ser adicionado ao final, ao início ou mesmo em algum lugar no meio. A ordem de quaisquer valores pré-existentes também pode mudar.

Chamar essa função com êxito pode fazer com que configurações não relacionadas com vários valores sejam reordenadas.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância OpenThread.
[in] aKey
A chave associada à configuração a ser alterada.
[in] aValue
Um ponteiro para onde o novo valor da configuração deve ser lido. NÃO DEVE ser NULL se aValueLength for diferente de zero.
[in] aValueLength
O comprimento dos dados apontados por aValue. Pode ser zero.
Valores Retornados
OT_ERROR_NONE
A configuração fornecida foi adicionada ou preparada para ser adicionada.
OT_ERROR_NOT_IMPLEMENTED
Esta função não está implementada nesta plataforma.
OT_ERROR_NO_BUFS
Nenhum espaço restante para armazenar a configuração fornecida.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Executa qualquer inicialização do subsistema de configurações, se necessário.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância OpenThread.

otPlatSettingsDelete

otError otPlatSettingsDelete(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex
)

Remove uma configuração do armazenamento de configurações.

Esta função exclui um valor específico da configuração identificada por aKey do armazenamento de configurações.

Observe que a implementação subjacente não é necessária para manter a ordem dos itens associados a uma chave específica.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância OpenThread.
[in] aKey
A chave associada à configuração solicitada.
[in] aIndex
O índice do valor a ser removido. Se definido como -1, todos os valores para esta aKey serão removidos.
Valores Retornados
OT_ERROR_NONE
A chave e o índice fornecidos foram encontrados e removidos com sucesso.
OT_ERROR_NOT_FOUND
A chave ou índice fornecido não foi encontrado no armazenamento de configurações.
OT_ERROR_NOT_IMPLEMENTED
Esta função não está implementada nesta plataforma.

otPlatSettingsGet

otError otPlatSettingsGet(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex,
  uint8_t *aValue,
  uint16_t *aValueLength
)

Busca o valor de uma configuração.

Esta função busca o valor da configuração identificada por aKey e o grava na memória apontada por aValue. Em seguida, ele grava o comprimento no número inteiro apontado por aValueLength. O valor inicial de aValueLength é o número máximo de bytes a serem gravados em aValue.

Esta função pode ser usada para verificar a existência de uma chave sem buscar o valor, definindo aValue e aValueLength como NULL. Você também pode verificar o comprimento da configuração sem buscá-la, definindo apenas aValue como NULL.

Observe que a implementação de armazenamento subjacente não é necessária para manter a ordem das configurações com vários valores. A ordem de tais valores PODE mudar após QUALQUER operação de gravação na loja.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância OpenThread.
[in] aKey
A chave associada à configuração solicitada.
[in] aIndex
O índice do item específico a ser obtido.
[out] aValue
Um ponteiro para onde o valor da configuração deve ser escrito. Pode ser definido como NULL se estiver apenas testando a presença ou a duração de uma configuração.
[in,out] aValueLength
Um ponteiro para o comprimento do valor. Quando chamado, este ponteiro deve apontar para um inteiro contendo o tamanho máximo do valor que pode ser escrito em aValue. No retorno, a duração real da configuração é gravada. Isso pode ser definido como NULL se estiver executando uma verificação de presença.
Valores Retornados
OT_ERROR_NONE
A configuração fornecida foi encontrada e obtida com sucesso.
OT_ERROR_NOT_FOUND
A configuração fornecida não foi encontrada no armazenamento de configurações.
OT_ERROR_NOT_IMPLEMENTED
Esta função não está implementada nesta plataforma.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

Executa qualquer inicialização para o subsistema de configurações, se necessário.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância OpenThread.

otPlatSettingsSet

otError otPlatSettingsSet(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Define ou substitui o valor de uma configuração.

Esta função define ou substitui o valor de uma configuração identificada por aKey. Se houver mais de um valor associado anteriormente a aKey, todos serão excluídos e substituídos por esta única entrada.

Chamar essa função com êxito pode fazer com que configurações não relacionadas com vários valores sejam reordenadas.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância OpenThread.
[in] aKey
A chave associada à configuração a ser alterada.
[in] aValue
Um ponteiro para onde o novo valor da configuração deve ser lido. NÃO DEVE ser NULL se aValueLength for diferente de zero.
[in] aValueLength
O comprimento dos dados apontados por aValue. Pode ser zero.
Valores Retornados
OT_ERROR_NONE
A configuração fornecida foi alterada ou preparada.
OT_ERROR_NOT_IMPLEMENTED
Esta função não está implementada nesta plataforma.
OT_ERROR_NO_BUFS
Nenhum espaço restante para armazenar a configuração fornecida.

otPlatSettingsSetCriticalKeys

void otPlatSettingsSetCriticalKeys(
  otInstance *aInstance,
  const uint16_t *aKeys,
  uint16_t aKeysLength
)

Esta função define as chaves críticas que devem ser armazenadas na área segura.

Observe que a memória apontada por aKeys não DEVE ser liberada antes que a aInstance seja destruída.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância OpenThread.
[in] aKeys
Um ponteiro para uma matriz que contém a lista de chaves críticas.
[in] aKeysLength
O número de entradas na matriz aKeys .

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Remove todas as configurações do armazenamento de configurações.

Esta função exclui todas as configurações do armazenamento de configurações, redefinindo-o para seu estado inicial de fábrica.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância OpenThread.