Coprocesador de red

Este módulo incluye funciones que controlan la ejecución de la pila de Thread.

Resumen

Typedefs

otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount) typedef
bool(*
Define el tipo de delegado (puntero de función) para controlar el comportamiento de la operación de vista rápida o de entrada.
otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength) typedef
int(*
Se llama al puntero para enviar datos NCP codificados en HDLC.

Funciones

otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Inicializa el NCP según el enmarcado de HDLC.
otNcpHdlcReceive(const uint8_t *aBuf, uint16_t aBufLength)
void
Se llama después de que se reciben los datos NCP codificados en HDLC.
otNcpHdlcSendDone(void)
void
Se llama después de que finaliza el envío de NCP.
otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Escribe el registro de OpenThread con otNcpStreamWrite.
otNcpRegisterPeekPokeDelegates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
Registra funciones delegadas y de vista rápida con el módulo NCP.
otNcpSpiInit(otInstance *aInstance)
void
Inicializa el NCP según el encuadre de SPI.
otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Envía datos al host a través de una transmisión específica.

Typedefs

otNcpDelegateAllowPeekPoke

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

Define el tipo de delegado (puntero de función) para controlar el comportamiento de la operación de vista rápida o de entrada.

Se llama a esta función delegada para decidir si se permite o no un poke de una región de memoria específica. Se usa si está habilitada la compatibilidad con NCP para los comandos de vista rápida.

Detalles
Parámetros
[in] aAddress
Dirección de inicio de la región de la memoria.
[in] aCount
Cantidad de bytes para ver o poke.
Qué muestra
TRUE para permitir el adelanto o el toque de la región de la memoria. En caso contrario, es FALSE.

oCPNcpHdlcSendCallback

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

Se llama al puntero para enviar datos NCP codificados en HDLC.

Detalles
Parámetros
[in] aBuf
Un puntero para un búfer con un resultado.
[in] aBufLength
Longitud de los datos de salida almacenados en el búfer.
Qué muestra
Cantidad de bytes procesados por la devolución de llamada.

Funciones

oNNHHlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Inicializa el NCP según el enmarcado de HDLC.

Detalles
Parámetros
[in] aInstance
Estructura de la instancia de OpenThread.
[in] aSendCallback
El puntero de función que se usa para enviar datos del NCP.

oNNHHlcRecibir

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Se llama después de que se reciben los datos NCP codificados en HDLC.

Detalles
Parámetros
[in] aBuf
Un puntero para un búfer.
[in] aBufLength
La longitud de los datos almacenados en el búfer.

otNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

Se llama después de que finaliza el envío de NCP.

otNcpPlatLogv

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

Escribe el registro de OpenThread con otNcpStreamWrite.

Detalles
Parámetros
[in] aLogLevel
El nivel de registro.
[in] aLogRegion
La región de registro.
[in] aFormat
Un puntero para la string de formato.
[in] aArgs
Va_list coincide con aFormat.

otNcpRegisterPeekPokeDelegates

void otNcpRegisterPeekPokeDelegates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Registra funciones delegadas y de vista rápida con el módulo NCP.

El módulo NCP llama a las funciones delegadas para decidir si se permite o no un poke de una región de memoria específica. Si el puntero delegado está configurado en NULO, permite la operación de visualización o activación para cualquier dirección.

Detalles
Parámetros
[in] aAllowPeekDelegate
Delegar el puntero de función para la operación de vista previa.
[in] aAllowPokeDelegate
Delegar el puntero de función para la operación poke.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Inicializa el NCP según el encuadre de SPI.

Detalles
Parámetros
[in] aInstance
Estructura de la instancia de OpenThread.

otNcpStreamWrite

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

Envía datos al host a través de una transmisión específica.

Intenta enviar los datos proporcionados al host usando el aStreamId especificado. Esto es útil para informar mensajes de error, implementar consolas de depuración/diagnóstico y, potencialmente, otros tipos de flujos de datos.

La escritura se acepta en su totalidad o se rechaza. No se intentan realizar escrituras parciales.

Detalles
Parámetros
[in] aStreamId
Es un identificador numérico en el que la transmisión debe escribir. Si se establece en "0", se usará la transmisión de depuración de forma predeterminada.
[in] aDataPtr
Un puntero para los datos que se enviarán en la transmisión. Si aDataLen no es cero, este parámetro NO DEBE ser NULO.
[in] aDataLen
La cantidad de bytes de datos de aDataPtr para enviar.
Valores que se muestran
OT_ERROR_NONE
Los datos se pusieron en cola para la entrega al host.
OT_ERROR_BUSY
No hay suficientes recursos para completar esta solicitud. Por lo general, es una condición temporal.
OT_ERROR_INVALID_ARGS
El aStreamId especificado no es válido.

Recursos

Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta la sección Recursos.