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/poke.
otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength) typedef
int(*
Se llama al puntero para enviar datos NCP codificados en HDLC.

remotas
otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Inicializa el NCP en función del enmarcado HDLC.
otNcpHdlcInitMulti(otInstance **aInstance, uint8_t aCount, otNcpHdlcSendCallback aSendCallback)
void
Inicializa el NCP en función del enmarcado 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 del 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 las funciones delegadas de visualización/poke con el módulo NCP.
otNcpSpiInit(otInstance *aInstance)
void
Inicializa el NCP en función del enmarcado SPI.
otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Enviar 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/poke.

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

Detalles
Parámetros
[in] aAddress
Dirección inicial de la región de la memoria.
[in] aCount
Cantidad de bytes que se deben ver o inspeccionar.
Qué muestra
TRUE para permitir la vista previa de una región de memoria determinada, FALSE de lo contrario.

otNcpHdlcSendCallback

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 una salida.
[in] aBufLength
Es la longitud de los datos de salida almacenados en el búfer.
Qué muestra
Cantidad de bytes procesados por la devolución de llamada.

remotas

otNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Inicializa el NCP en función del enmarcado HDLC.

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

otNcpHdlcInitMulti

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

Inicializa el NCP en función del enmarcado HDLC.

Detalles
Parámetros
[in] aInstances
Array de punteros de instancia de OpenThread.
[in] aCount
Cantidad de elementos del array.
[in] aSendCallback
El puntero de función que se usa para enviar datos del NCP.

otNcpHdlcReceive

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 del 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
Es la región del registro.
[in] aFormat
Un puntero para la string de formato.
[in] aArgs
va_list que coincide con aFormat.

otNcpRegisterPeekPokeDelegates

void otNcpRegisterPeekPokeDelegates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Registra las funciones delegadas de visualización/poke con el módulo NCP.

El módulo NCP llama a las funciones delegadas para decidir si se permite la vista previa o la entrada de una región de memoria específica. Si el puntero delegado se establece en NULL, se permite la operación de inspección/poke 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 de poke.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Inicializa el NCP en función del enmarcado SPI.

Detalles
Parámetros
[in] aInstance
Estructura de instancias de OpenThread

otNcpStreamWrite

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

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

Intenta enviar los datos especificados al host mediante un aStreamId determinado. Esto es útil para informar mensajes de error, implementar consolas de depuración o diagnóstico y, posiblemente, otros tipos de flujos de datos.

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

Detalles
Parámetros
[in] aStreamId
Un identificador numérico en el que la transmisión debe escribir. Si se establece en “0”, se usará de forma predeterminada la transmisión de depuración.
[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 que se enviarán.
Valores que se muestran
OT_ERROR_NONE
Los datos se pusieron en cola para la entrega al host.
OT_ERROR_BUSY
No hay recursos suficientes para completar esta solicitud. Esta suele ser 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 contribuir a nuestra documentación, consulta Recursos.