Co-Processador de Rede

Este módulo inclui funções que controlam a execução da pilha de Threads.

Resumo

Typedefs
`otNcpDelegateAllowPeekPoke )(uint32_t aAddress, uint16_t aCount)`	typedef `bool(*` Define o tipo de delegado (ponteiro de função) para controlar o comportamento da operação peek / poke.
`otNcpHandlerJoinLegacyNode )(const otExtAddress *aExtAddress)`	typedef `void(*` Define o tipo de manipulador (ponteiro de função) para iniciar o processo de adesão.
`otNcpHandlerSetLegacyUlaPrefix )(const uint8_t *aUlaPrefix)`	typedef `void(*` Define o tipo de manipulador (ponteiro de função) para definir o prefixo ULA legado.
`otNcpHandlerStartLegacy )(void)`	typedef `void(*` Define o tipo de manipulador (ponteiro de função) para iniciar a rede legada.
`otNcpHandlerStopLegacy )(void)`	typedef `void(*` Define o tipo de manipulador (ponteiro de função) para interromper a rede legada.
`otNcpHdlcSendCallback )(const uint8_t *aBuf, uint16_t aBufLength)`	typedef `int(*` Este ponteiro de função é chamado para enviar dados NCP codificados em HDLC.
`otNcpLegacyHandlers`	typedef `struct otNcpLegacyHandlers` Define uma estrutura contendo todos os manipuladores legados (ponteiros de função).

Funções
`otNcpHandleDidReceiveNewLegacyUlaPrefix (const uint8_t *aUlaPrefix)`	`void` Esse retorno de chamada é invocado pela pilha legada para notificar que o prefixo ULA legado foi alterado.
`otNcpHandleLegacyNodeDidJoin (const otExtAddress *aExtAddr)`	`void` Este retorno de chamada é invocado pela pilha legada para notificar que um novo nó legado se juntou à rede.
`otNcpHdlcInit ( otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)`	`void` Inicialize o NCP com base no enquadramento HDLC.
`otNcpHdlcReceive (const uint8_t *aBuf, uint16_t aBufLength)`	`void` Esta função é chamada após o recebimento dos dados NCP codificados em HDLC.
`otNcpHdlcSendDone (void)`	`void` Esta função é chamada após o término do envio do NCP.
`otNcpPlatLogv ( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)`	`void` Grava OpenThread Log usando `otNcpStreamWrite` .
`otNcpRegisterLegacyHandlers (const otNcpLegacyHandlers *aHandlers)`	`void` Este método registra um conjunto de manipuladores legados com o NCP.
`otNcpRegisterPeekPokeDelagates ( otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)`	`void` Este método registra funções de delegado peek / poke com o módulo NCP.
`otNcpSpiInit ( otInstance *aInstance)`	`void` Inicialize o NCP com base no enquadramento SPI.
`otNcpStreamWrite (int aStreamId, const uint8_t *aDataPtr, int aDataLen)`	`otError` Envie dados para o host por meio de um fluxo específico.

Structs
otNcpLegacyHandlers	Define uma estrutura contendo todos os manipuladores legados (ponteiros de função).

Typedefs

otNcpDelegateAllowPeekPoke

bool(* otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount)

Define o tipo de delegado (ponteiro de função) para controlar o comportamento da operação peek / poke.

Esta função delegada é chamada para decidir se permite peek ou poke de uma região de memória específica. É usado se o suporte NCP para comandos peek / poke estiver habilitado.

Detalhes

Parâmetros

`[in] aAddress`	Endereço inicial da região da memória.
`[in] aCount`	Número de bytes para peek ou cutucar.

Devoluções

TRUE para permitir peek / poke da região de memória fornecida, FALSE caso contrário.

otNcpHandlerJoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

Define o tipo de manipulador (ponteiro de função) para iniciar o processo de adesão.

Chamado para iniciar um procedimento de junção de legado para qualquer um ou um nó específico.

Detalhes

Parâmetros

[in] aExtAddress

Um ponteiro para o endereço estendido para o nó se juntar ou NULL se desejar se juntar a qualquer nó vizinho.

otNcpHandlerSetLegacyUlaPrefix

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

Define o tipo de manipulador (ponteiro de função) para definir o prefixo ULA legado.

Chamado para definir o prefixo ULA legado.

Detalhes

Parâmetros

[in] aUlaPrefix

Um ponteiro para o buffer contendo o prefixo ULA legado.

otNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

Define o tipo de manipulador (ponteiro de função) para iniciar a rede legada.

Chamado para iniciar a rede legada.

otNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

Define o tipo de manipulador (ponteiro de função) para interromper a rede legada.

Chamado para parar a rede legada.

otNcpHdlcSendCallback

int(* otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength)

Este ponteiro de função é chamado para enviar dados NCP codificados em HDLC.

Detalhes

Parâmetros

`[in] aBuf`	Um ponteiro para um buffer com uma saída.
`[in] aBufLength`	Um comprimento dos dados de saída armazenados no buffer.

Devoluções

Número de bytes processados pelo retorno de chamada.

otNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

Define uma estrutura contendo todos os manipuladores legados (ponteiros de função).

Funções

otNcpHandleDidReceiveNewLegacyUlaPrefix

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

Esse retorno de chamada é invocado pela pilha legada para notificar que o prefixo ULA legado foi alterado.

Detalhes

Parâmetros

[in] aUlaPrefix

Um ponteiro para o prefixo ULA recebido.

otNcpHandleLegacyNodeDidJoin

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

Este retorno de chamada é invocado pela pilha legada para notificar que um novo nó legado ingressou na rede.

Detalhes

Parâmetros

[in] aExtAddr

Um ponteiro para o endereço estendido do nó associado.

otNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Inicialize o NCP com base no enquadramento HDLC.

Detalhes

Parâmetros

`[in] aInstance`	A estrutura da instância OpenThread.
`[in] aSendCallback`	O ponteiro de função usado para enviar dados NCP.

otNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Esta função é chamada após o recebimento dos dados NCP codificados em HDLC.

Detalhes

Parâmetros

`[in] aBuf`	Um ponteiro para um buffer.
`[in] aBufLength`	O comprimento dos dados armazenados no buffer.

otNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

Esta função é chamada após o término do envio do NCP.

otNcpPlatLogv

void otNcpPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list aArgs
)

Grava OpenThread Log usando otNcpStreamWrite .

Detalhes

Parâmetros

`[in] aLogLevel`	O nível de log.
`[in] aLogRegion`	A região do log.
`[in] aFormat`	Um ponteiro para a string de formato.
`[in] aArgs`	va_list correspondente a aFormat.

otNcpRegisterLegacyHandlers

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

Este método registra um conjunto de manipuladores legados com o NCP.

O conjunto de manipuladores fornecidos pela struct aHandlers são usados pelo código NCP para iniciar / parar a rede legada. Os aHandlers podem ser NULL para desabilitar o suporte legado no NCP. Manipuladores individuais na estrutura de manipuladores fornecida também podem ser NULL.

Detalhes

Parâmetros

[in] aHandlers

Um ponteiro para uma estrutura de manipulador.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Este método registra funções de delegado peek / poke com o módulo NCP.

As funções de delegado são chamadas pelo módulo NCP para decidir se permite peek ou poke de uma região de memória específica. Se o ponteiro do delegado for definido como NULL, ele permitirá a operação peek / poke para qualquer endereço.

Detalhes

Parâmetros

`[in] aAllowPeekDelegate`	Delegar ponteiro de função para operação de espiada.
`[in] aAllowPokeDelegate`	Delegar ponteiro de função para operação de puxar.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Inicialize o NCP com base no enquadramento SPI.

Detalhes

Parâmetros

[in] aInstance

A estrutura da instância OpenThread.

otNcpStreamWrite

otError otNcpStreamWrite(
  int aStreamId,
  const uint8_t *aDataPtr,
  int aDataLen
)

Envie dados para o host por meio de um fluxo específico.

Esta função tenta enviar os dados fornecidos ao host usando o aStreamId fornecido. Isso é útil para relatar mensagens de erro, implementar consoles de depuração / diagnóstico e, potencialmente, outros tipos de fluxos de dados.

A gravação é aceita em sua totalidade ou rejeitada. As gravações parciais não são tentadas.

Detalhes

Parâmetros

`[in] aStreamId`	Um identificador numérico para o fluxo gravar. Se definido como '0', o padrão será o fluxo de depuração.
`[in] aDataPtr`	Um ponteiro para os dados a serem enviados no fluxo. Se aDataLen for diferente de zero, este parâmetro NÃO DEVE ser NULL.
`[in] aDataLen`	O número de bytes de dados de aDataPtr a serem enviados.

Valores Retornados

`OT_ERROR_NONE`	Os dados foram enfileirados para entrega ao host.
`OT_ERROR_BUSY`	Não há recursos suficientes para concluir esta solicitação. Geralmente é uma condição temporária.
`OT_ERROR_INVALID_ARGS`	O aStreamId fornecido era inválido.

Macros

OT_NCP_LEGACY_ULA_PREFIX_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

Tamanho do ULA legado (em bytes)

Co-Processador de Rede

Resumo

Typedefs

Funções

Structs

Typedefs

otNcpDelegateAllowPeekPoke

otNcpHandlerJoinLegacyNode

otNcpHandlerSetLegacyUlaPrefix

otNcpHandlerStartLegacy

otNcpHandlerStopLegacy

otNcpHdlcSendCallback

otNcpLegacyHandlers

Funções

otNcpHandleDidReceiveNewLegacyUlaPrefix

otNcpHandleLegacyNodeDidJoin

otNcpHdlcInit

otNcpHdlcReceive

otNcpHdlcSendDone

otNcpPlatLogv

otNcpRegisterLegacyHandlers

otNcpRegisterPeekPokeDelagates

otNcpSpiInit

otNcpStreamWrite

Macros

OT_NCP_LEGACY_ULA_PREFIX_LENGTH