Esta página foi traduzida pela API Cloud Translation.

Coprocessador de rede

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

Resumo

Typedefs
`otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount)`	typedef `bool(*` Define o tipo de delegado (apontador de função) para controlar o comportamento da operação de espiada/poke.
`otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength)`	typedef `int(*` O ponteiro é chamado para enviar dados NCP codificados em HDLC.

Funções
`otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)`	`void` Inicialize o NCP com base no enquadramento de HDLC.
`otNcpHdlcReceive(const uint8_t *aBuf, uint16_t aBufLength)`	`void` É chamado depois que os dados NCP codificados em HDLC são recebidos.
`otNcpHdlcSendDone(void)`	`void` É chamado depois que o envio do NCP é concluído.
`otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)`	`void` Grava o registro do OpenThread usando `otNcpStreamWrite`.
`otNcpRegisterPeekPokeDelegates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)`	`void` Registra as funções delegadas de visualização e cutucada com o módulo NCP.
`otNcpSpiInit(otInstance *aInstance)`	`void` Inicialize o NCP com base no enquadramento do SPI.
`otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)`	`otError` Envie dados ao host por meio de um fluxo específico.

Typedefs

OtNcpDelegateAllowPeekPoke

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

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

Esta função delegada é chamada para decidir se você quer permitir a visualização rápida ou parcial de uma região de memória específica. Ele será usado se a compatibilidade com NCP para comandos de exibição/poke estiver ativada.

Detalhes

Parâmetros

`[in] aAddress`	Endereço de início da região da memória.
`[in] aCount`	Número de bytes a serem exibidos ou cutucados.

Retorna

TRUE para permitir a visualização da região de memória fornecida. Caso contrário, FALSE.

OtNcpHdlcSendCallback

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

O ponteiro é chamado para enviar dados NCP codificados em HDLC.

Detalhes

Parâmetros

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

Retorna

Número de bytes processados pelo callback.

Funções

OtNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Inicialize o NCP com base no enquadramento de HDLC.

Detalhes

Parâmetros

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

otNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

É chamado depois que os dados NCP codificados em HDLC são recebidos.

Detalhes

Parâmetros

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

OnNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

É chamado depois que o envio do NCP é concluído.

OtNcpPlatLogv

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

Grava o registro do OpenThread usando otNcpStreamWrite.

Detalhes

Parâmetros

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

OtNcpRegisterPeekPokeDelegates

void otNcpRegisterPeekPokeDelegates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Registra as funções delegadas de visualização e cutucada com o módulo NCP.

As funções delegadas são chamadas pelo módulo NCP para decidir se permitem olhar ou cutucar uma região específica da memória. Se o ponteiro delegado for definido como NULL, ele permitirá a operação de abrir e fechar qualquer endereço.

Detalhes

Parâmetros

`[in] aAllowPeekDelegate`	Delegue o ponteiro da função para a operação de exibição.
`[in] aAllowPokeDelegate`	Delegue o ponteiro da função para a operação poke.

OtNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Inicialize o NCP com base no enquadramento do SPI.

Detalhes

Parâmetros

[in] aInstance

A estrutura da instância do OpenThread.

OtNcpStreamWrite

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

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

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, possivelmente, outros tipos de fluxo de dados.

A gravação é totalmente aceita ou rejeitada. Gravações parciais não são tentadas.

Detalhes

Parâmetros

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

Valores de retorno

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

Recursos

Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.