Coprocessore di rete

Questo modulo include funzioni che controllano l'esecuzione dello stack di Thread.

Riepilogo

Defdef
otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount) tipodef
bool(*
Definisce il tipo di delegato (funzione di suggerimento) per controllare il comportamento dell'operazione di anteprima/poke.
otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress) tipodef
void(*
Definisce il tipo di gestore (puntatore funzione) per l'avvio del processo di unione.
otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix) tipodef
void(*
Definisce il tipo di gestore (puntatore funzione) per l'impostazione del prefisso ULA precedente.
otNcpHandlerStartLegacy)(void) tipodef
void(*
Definisce il tipo di gestore (puntatore funzione) per l'avvio della rete legacy.
otNcpHandlerStopLegacy)(void) tipodef
void(*
Definisce il tipo di gestore (puntatore funzione) per l'interruzione della rete legacy.
otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength) tipodef
int(*
Questo puntatore di funzione viene chiamato per inviare dati NCP con codifica HDLC.
otNcpLegacyHandlers tipodef
Definisce una struttura contenente tutti i gestori legacy (indicatori di funzione).

Functions
otNcpHandleDidReceiveNewLegacyUlaPrefix(const uint8_t *aUlaPrefix)
void
Questo callback viene richiamato dallo stack precedente per notificare la modifica del prefisso ULA precedente.
otNcpHandleLegacyNodeDidJoin(const otExtAddress *aExtAddr)
void
Questo callback viene richiamato dallo stack precedente per informare che un nuovo nodo precedente si è aggiunto alla rete.
otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Inizializza l'NCP in base all'inquadratura HDLC.
otNcpHdlcReceive(const uint8_t *aBuf, uint16_t aBufLength)
void
Questa funzione viene chiamata dopo la ricezione di dati NCP con codifica HDLC.
otNcpHdlcSendDone(void)
void
Questa funzione viene chiamata al termine dell'invio NCP.
otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Scrive il log OpenThread utilizzando otNcpStreamWrite.
otNcpRegisterLegacyHandlers(const otNcpLegacyHandlers *aHandlers)
void
Questo metodo registra un insieme di gestori legacy con NCP.
otNcpRegisterPeekPokeDelagates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
Questo metodo registra le funzioni di delega di anteprima/poke con il modulo NCP.
otNcpSpiInit(otInstance *aInstance)
void
Inizializza l'NCP in base all'inquadratura SPI.
otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Invia i dati all'host tramite un flusso specifico.

Strutture
otNcpLegacyHandlers

Definisce una struttura contenente tutti i gestori legacy (indicatori di funzione).

Defdef

otNcpDelegaAllowPeekPoke

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

Definisce il tipo di delegato (funzione di suggerimento) per controllare il comportamento dell'operazione di anteprima/poke.

Questa funzione di delega è chiamata per decidere se consentire o meno l'anteprima di una specifica area di memoria. Viene utilizzato se il supporto NCP per i comandi Stackdriver/Poke è abilitato.

Dettagli
Parametri
[in] aAddress
Indirizzo iniziale della regione di memoria.
[in] aCount
Numero di byte da visualizzare o Poke.
Restituisce
TRUE per consentire un'anteprima/poke dell'area geografica di memoria specificata, altrimenti FALSE.

otNcpHandlerjoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

Definisce il tipo di gestore (puntatore funzione) per l'avvio del processo di unione.

Richiamato per avviare una procedura di join precedente su uno o più nodi specifici.

Dettagli
Parametri
[in] aExtAddress
Un puntatore sull'indirizzo esteso del nodo da unire o su NULL, se vuoi unire i nodi vicini.

otNcpHandlerSetLegacyUlaPrefix

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

Definisce il tipo di gestore (puntatore funzione) per l'impostazione del prefisso ULA precedente.

Richiamato per impostare il prefisso ULA precedente.

Dettagli
Parametri
[in] aUlaPrefix
Un puntatore nel buffer che contiene il prefisso ULA precedente.

otNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

Definisce il tipo di gestore (puntatore funzione) per l'avvio della rete legacy.

Richiamato per avviare la rete legacy.

OtNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

Definisce il tipo di gestore (puntatore funzione) per l'interruzione della rete legacy.

Richiamato per arrestare la rete legacy.

OtNcpHdlcSendCallback

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

Questo puntatore di funzione viene chiamato per inviare dati NCP con codifica HDLC.

Dettagli
Parametri
[in] aBuf
Un puntatore a un buffer con un output.
[in] aBufLength
Lunghezza dei dati di output memorizzati nel buffer.
Restituisce
Numero di byte elaborati dal callback.

OtNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

Definisce una struttura contenente tutti i gestori legacy (indicatori di funzione).

Functions

otNcpHandleDidReceiveNewLegacyUlaPrefix

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

Questo callback viene richiamato dallo stack precedente per notificare la modifica del prefisso ULA precedente.

Dettagli
Parametri
[in] aUlaPrefix
Un puntatore sul prefisso ULA ricevuto.

otNcpHandleLegacyNode Didjoin

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

Questo callback viene richiamato dallo stack precedente per informare che un nuovo nodo precedente si è aggiunto alla rete.

Dettagli
Parametri
[in] aExtAddr
Un puntatore sull'indirizzo esteso del nodo unito.

otNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Inizializza l'NCP in base all'inquadratura HDLC.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.
[in] aSendCallback
Il puntatore della funzione utilizzato per inviare i dati NCP.

OtNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Questa funzione viene chiamata dopo la ricezione di dati NCP con codifica HDLC.

Dettagli
Parametri
[in] aBuf
Un puntatore su un buffer.
[in] aBufLength
La lunghezza dei dati archiviati nel buffer.

otNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

Questa funzione viene chiamata al termine dell'invio NCP.

OtNcpPlatLogv

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

Scrive il log OpenThread utilizzando otNcpStreamWrite.

Dettagli
Parametri
[in] aLogLevel
Il livello di log.
[in] aLogRegion
L'area geografica del log.
[in] aFormat
Un puntatore sulla stringa di formato.
[in] aArgs
va_list corrispondente aaFormat.

otNcpRegisterLegacyHandlers

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

Questo metodo registra un insieme di gestori legacy con NCP.

Il set di gestori fornito dalla struttura aHandlers viene utilizzato dal codice NCP per avviare/interrompere la rete legacy. aHandlers può essere NULL per disattivare il supporto legacy su NCP. Anche i singoli gestori nella struttura dei gestori possono essere NULL.

Dettagli
Parametri
[in] aHandlers
Un puntatore alla struttura di un gestore.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Questo metodo registra le funzioni di delega di anteprima/poke con il modulo NCP.

Le funzioni di delega sono chiamate dal modulo NCP per decidere se consentire o meno l'anteprima di una specifica area di memoria. Se il suggerimento del delegato è impostato su NULL, consente l'operazione di anteprima/poke per qualsiasi indirizzo.

Dettagli
Parametri
[in] aAllowPeekDelegate
Delega il puntatore funzione per l'operazione di anteprima.
[in] aAllowPokeDelegate
Delega il puntatore funzione per le operazioni di Poke.

OtNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Inizializza l'NCP in base all'inquadratura SPI.

Dettagli
Parametri
[in] aInstance
La struttura dell'istanza OpenThread.

OtNcpStreamWrite

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

Invia i dati all'host tramite un flusso specifico.

Questa funzione tenta di inviare i dati specificati all'host utilizzando il parametro aStreamId specificato. Questa funzione è utile per segnalare messaggi di errore, implementare console di debug/di diagnostica e potenzialmente altri tipi di flussi di dati.

La scrittura è stata accettata o è stata rifiutata. Non vengono tentate scritture parziali.

Dettagli
Parametri
[in] aStreamId
Un identificatore numerico per la scrittura dello stream. Se impostato su '0', verrà utilizzato per impostazione predefinita lo stream di debug.
[in] aDataPtr
Un puntatore sui dati da inviare nel flusso. Se aDataLen è diverso da zero, questo parametro NON DEVE essere NULL.
[in] aDataLen
Il numero di byte di dati da aDataPtr da inviare.
Valori di ritorno
OT_ERROR_NONE
I dati sono stati messi in coda per la consegna all'host.
OT_ERROR_BUSY
Non ci sono risorse sufficienti per completare la richiesta. In genere si tratta di una condizione temporanea.
OT_ERROR_INVALID_ARGS
L'aStreamId specificato non è valido.

Macro

OT_NCP_LEGACY_ULA_PREFIX_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

Dimensioni ULA precedenti (in byte)

Risorse

Gli argomenti di riferimento per l'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per ulteriori informazioni o per contribuire alla nostra documentazione, consulta la sezione Risorse.