Coprocesador de red

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

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 peek / poke.
`otNcpHandlerJoinLegacyNode )(const otExtAddress *aExtAddress)`	typedef `void(*` Define el tipo de controlador (puntero de función) para iniciar el proceso de unión.
`otNcpHandlerSetLegacyUlaPrefix )(const uint8_t *aUlaPrefix)`	typedef `void(*` Define el tipo de controlador (puntero de función) para establecer el prefijo ULA heredado.
`otNcpHandlerStartLegacy )(void)`	typedef `void(*` Define el tipo de controlador (puntero de función) para iniciar la red heredada.
`otNcpHandlerStopLegacy )(void)`	typedef `void(*` Define el tipo de controlador (puntero de función) para detener la red heredada.
`otNcpHdlcSendCallback )(const uint8_t *aBuf, uint16_t aBufLength)`	typedef `int(*` Este puntero de función se llama para enviar datos NCP codificados en HDLC.
`otNcpLegacyHandlers`	typedef `struct otNcpLegacyHandlers` Define una estructura que contiene todos los controladores heredados (punteros de función).

Funciones
`otNcpHandleDidReceiveNewLegacyUlaPrefix (const uint8_t *aUlaPrefix)`	`void` La pila heredada invoca esta devolución de llamada para notificar que el prefijo ULA heredado ha cambiado.
`otNcpHandleLegacyNodeDidJoin (const otExtAddress *aExtAddr)`	`void` Esta devolución de llamada es invocada por la pila heredada para notificar que un nuevo nodo heredado se unió a la red.
`otNcpHdlcInit ( otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)`	`void` Inicialice el NCP basado en la trama HDLC.
`otNcpHdlcReceive (const uint8_t *aBuf, uint16_t aBufLength)`	`void` Esta función se llama después de recibir datos NCP codificados en HDLC.
`otNcpHdlcSendDone (void)`	`void` Esta función se llama después de que finaliza el envío NCP.
`otNcpPlatLogv ( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)`	`void` Escribe OpenThread Log mediante `otNcpStreamWrite` .
`otNcpRegisterLegacyHandlers (const otNcpLegacyHandlers *aHandlers)`	`void` Este método registra un conjunto de controladores heredados con NCP.
`otNcpRegisterPeekPokeDelagates ( otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)`	`void` Este método registra funciones de delegado peek / poke con el módulo NCP.
`otNcpSpiInit ( otInstance *aInstance)`	`void` Inicialice el NCP basado en el entramado SPI.
`otNcpStreamWrite (int aStreamId, const uint8_t *aDataPtr, int aDataLen)`	`otError` Envíe datos al host a través de una secuencia específica.

Estructuras
otNcpLegacyHandlers	Define una estructura que contiene todos los controladores heredados (punteros de función).

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 peek / poke.

Esta función de delegado se llama para decidir si se permite la ojeada o el pinchazo de una región de memoria específica. Se utiliza si está habilitada la compatibilidad con NCP para los comandos peek / poke.

Detalles

Parámetros

`[in] aAddress`	Dirección de inicio de la región de memoria.
`[in] aCount`	Número de bytes para mirar o pinchar.

Devoluciones

VERDADERO para permitir asomarse / empujar la región de memoria dada, FALSO en caso contrario.

otNcpHandlerJoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

Define el tipo de controlador (puntero de función) para iniciar el proceso de unión.

Se invoca para iniciar un procedimiento de unión heredado a cualquier nodo o a un nodo específico.

Detalles

Parámetros

[in] aExtAddress

Un puntero a la dirección extendida para que el nodo se una o NULL si desea unirse a cualquier nodo vecino.

otNcpHandlerSetLegacyUlaPrefix

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

Define el tipo de controlador (puntero de función) para establecer el prefijo ULA heredado.

Se invoca para establecer el prefijo ULA heredado.

Detalles

Parámetros

[in] aUlaPrefix

Un puntero al búfer que contiene el prefijo ULA heredado.

otNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

Define el tipo de controlador (puntero de función) para iniciar la red heredada.

Se invoca para iniciar la red heredada.

otNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

Define el tipo de controlador (puntero de función) para detener la red heredada.

Se invoca para detener la red heredada.

otNcpHdlcSendCallback

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

Este puntero de función se llama para enviar datos NCP codificados en HDLC.

Detalles

Parámetros

`[in] aBuf`	Un puntero a un búfer con una salida.
`[in] aBufLength`	Una longitud de los datos de salida almacenados en el búfer.

Devoluciones

Número de bytes procesados por la devolución de llamada.

otNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

Define una estructura que contiene todos los controladores heredados (punteros de función).

Funciones

otNcpHandleDidReceiveNewLegacyUlaPrefix

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

La pila heredada invoca esta devolución de llamada para notificar que el prefijo ULA heredado ha cambiado.

Detalles

Parámetros

[in] aUlaPrefix

Un puntero al prefijo ULA recibido.

otNcpHandleLegacyNodeDidJoin

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

La pila heredada invoca esta devolución de llamada para notificar que un nuevo nodo heredado se unió a la red.

Detalles

Parámetros

[in] aExtAddr

Un puntero a la dirección extendida del nodo unido.

otNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Inicialice el NCP basado en la trama HDLC.

Detalles

Parámetros

`[in] aInstance`	La estructura de la instancia de OpenThread.
`[in] aSendCallback`	El puntero de función utilizado para enviar datos NCP.

otNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Esta función se llama después de recibir datos NCP codificados en HDLC.

Detalles

Parámetros

`[in] aBuf`	Un puntero a un búfer.
`[in] aBufLength`	La longitud de los datos almacenados en el búfer.

otNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

Esta función se llama después de que finaliza el envío NCP.

otNcpPlatLogv

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

Escribe OpenThread Log mediante otNcpStreamWrite .

Detalles

Parámetros

`[in] aLogLevel`	El nivel de registro.
`[in] aLogRegion`	La región de registro.
`[in] aFormat`	Un puntero a la cadena de formato.
`[in] aArgs`	va_list que coincide con unFormat.

otNcpRegisterLegacyHandlers

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

Este método registra un conjunto de controladores heredados con NCP.

El conjunto de controladores proporcionados por la estructura aHandlers es utilizado por el código NCP para iniciar / detener la red heredada. aHandlers puede ser NULL para deshabilitar el soporte heredado en NCP. Los manejadores individuales en la estructura de manejadores dada también pueden ser NULL.

Detalles

Parámetros

[in] aHandlers

Un puntero a una estructura de controlador.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Este método registra funciones de delegado peek / poke con el módulo NCP.

Las funciones de delegado son llamadas por el módulo NCP para decidir si se permite mirar o tocar una región de memoria específica. Si el puntero delegado se establece en NULL, permite la operación de mirar / empujar para cualquier dirección.

Detalles

Parámetros

`[in] aAllowPeekDelegate`	Puntero de función delegada para operación de inspección.
`[in] aAllowPokeDelegate`	Puntero de función delegado para operación de empuje.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Inicialice el NCP basado en el entramado SPI.

Detalles

Parámetros

[in] aInstance

La estructura de la instancia de OpenThread.

otNcpStreamWrite

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

Envíe datos al host a través de una secuencia específica.

Esta función intenta enviar los datos dados al host utilizando el aStreamId dado. Esto es útil para informar mensajes de error, implementar consolas de depuración / diagnóstico y potencialmente otros tipos de flujos de datos.

El escrito se acepta en su totalidad o se rechaza. No se intentan escrituras parciales.

Detalles

Parámetros

`[in] aStreamId`	Un identificador numérico en el que escribir la secuencia. Si se establece en '0', se utilizará de forma predeterminada el flujo de depuración.
`[in] aDataPtr`	Un puntero a los datos para enviar en la transmisión. Si aDataLen no es cero, este parámetro NO DEBE ser NULL.
`[in] aDataLen`	El número de bytes de datos de aDataPtr para enviar.

Valores devueltos

`OT_ERROR_NONE`	Los datos se pusieron en cola para su entrega al host.
`OT_ERROR_BUSY`	No hay suficientes recursos para completar esta solicitud. Suele ser una afección temporal.
`OT_ERROR_INVALID_ARGS`	El aStreamId proporcionado no es válido.

Macros

OT_NCP_LEGACY_ULA_PREFIX_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

Tamaño de ULA heredado (en bytes)

Coprocesador de red

Resumen

Typedefs

Funciones

Estructuras

Typedefs

otNcpDelegateAllowPeekPoke

otNcpHandlerJoinLegacyNode

otNcpHandlerSetLegacyUlaPrefix

otNcpHandlerStartLegacy

otNcpHandlerStopLegacy

otNcpHdlcSendCallback

otNcpLegacyHandlers

Funciones

otNcpHandleDidReceiveNewLegacyUlaPrefix

otNcpHandleLegacyNodeDidJoin

otNcpHdlcInit

otNcpHdlcReceive

otNcpHdlcSendDone

otNcpPlatLogv

otNcpRegisterLegacyHandlers

otNcpRegisterPeekPokeDelagates

otNcpSpiInit

otNcpStreamWrite

Macros

OT_NCP_LEGACY_ULA_PREFIX_LENGTH