Coprocessador de rede

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

Resumo

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

remotas
otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Inicialize o NCP com base no enquadramento HDLC.
otNcpHdlcInitMulti(otInstance **aInstance, uint8_t aCount, otNcpHdlcSendCallback aSendCallback)
void
Inicialize o NCP com base no enquadramento HDLC.
otNcpHdlcReceive(const uint8_t *aBuf, uint16_t aBufLength)
void
É chamado após os dados NCP codificados em HDLC serem recebidos.
otNcpHdlcSendDone(void)
void
É chamado após a conclusão do envio do NCP.
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 exibição/poke com o módulo NCP.
otNcpSpiInit(otInstance *aInstance)
void
Inicialize o NCP com base no enquadramento de SPI.
otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Enviar dados para o host por meio de um fluxo específico.

Typedefs

otNcpDelegateAllowPeekPoke

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

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

Essa função delegada é chamada para decidir se uma região de memória específica pode ser mostrada ou cutucada. Ela será usada se o suporte do NCP para comandos "pequeno" ou "poke" estiver ativado.

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 exibição/procuração da região de memória especificada; 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
O tamanho dos dados de saída armazenados no buffer.
Retorna
Número de bytes processados pelo callback.

remotas

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 do OpenThread.
[in] aSendCallback
O ponteiro de função usado para enviar dados do NCP.

otNcpHdlcInitMulti

void otNcpHdlcInitMulti(
  otInstance **aInstance,
  uint8_t aCount,
  otNcpHdlcSendCallback aSendCallback
)

Inicialize o NCP com base no enquadramento HDLC.

Detalhes
Parâmetros
[in] aInstances
A matriz de ponteiros de instância do OpenThread.
[in] aCount
Número de elementos na matriz.
[in] aSendCallback
O ponteiro de função usado para enviar dados do NCP.

otNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

É chamado após os dados NCP codificados em HDLC serem recebidos.

Detalhes
Parâmetros
[in] aBuf
Um ponteiro para um buffer.
[in] aBufLength
O comprimento dos dados armazenados no buffer.

otNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

É chamado após a conclusão do envio do NCP.

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 formatação.
[in] aArgs
va_list correspondente a um Format.

otNcpRegisterPeekPokeDelegates

void otNcpRegisterPeekPokeDelegates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Registra as funções delegadas de exibição/poke com o módulo NCP.

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

Detalhes
Parâmetros
[in] aAllowPeekDelegate
Delegar o ponteiro de função para a operação de exibição.
[in] aAllowPokeDelegate
Delegar o ponteiro de função para a operação de poke.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Inicialize o NCP com base no enquadramento de SPI.

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

otNcpStreamWrite

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

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

Tenta enviar os dados informados ao host usando o aStreamId especificado. Isso é útil para relatar mensagens de erro, implementar consoles de depuração/diagnóstico e, possivelmente, outros tipos de fluxos de dados.

A gravação é aceita ou rejeitada por inteiro. Não são feitas gravações parciais.

Detalhes
Parâmetros
[in] aStreamId
Um identificador numérico em que o stream vai fazer a gravação. Se definido como "0", o padrão será o fluxo de depuraçã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 de aDataPtr a serem enviados.
Valores de retorno
OT_ERROR_NONE
Os dados foram colocados na 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.