Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Coprocesseur réseau

Ce module comprend des fonctions qui contrôlent l'exécution de la pile Thread.

Résumé

Typedefs

otNcpDelegateAllowPeekPoke )(uint32_t aAddress, uint16_t aCount) typedef
bool(*
Définit le type de délégué (pointeur de fonction) pour contrôler le comportement de l'opération peek / poke.
otNcpHandlerJoinLegacyNode )(const otExtAddress *aExtAddress) typedef
void(*
Définit le type de gestionnaire (pointeur de fonction) pour lancer le processus de jointure.
otNcpHandlerSetLegacyUlaPrefix )(const uint8_t *aUlaPrefix) typedef
void(*
Définit le type de gestionnaire (pointeur de fonction) pour définir le préfixe ULA hérité.
otNcpHandlerStartLegacy )(void) typedef
void(*
Définit le type de gestionnaire (pointeur de fonction) pour démarrer le réseau hérité.
otNcpHandlerStopLegacy )(void) typedef
void(*
Définit le type de gestionnaire (pointeur de fonction) pour arrêter le réseau hérité.
otNcpHdlcSendCallback )(const uint8_t *aBuf, uint16_t aBufLength) typedef
int(*
Ce pointeur de fonction est appelé pour envoyer des données NCP codées HDLC.
otNcpLegacyHandlers typedef
Définit une structure contenant tous les gestionnaires hérités (pointeurs de fonction).

Les fonctions

otNcpHandleDidReceiveNewLegacyUlaPrefix (const uint8_t *aUlaPrefix)
void
Ce rappel est appelé par la pile héritée pour notifier que le préfixe ULA hérité a changé.
otNcpHandleLegacyNodeDidJoin (const otExtAddress *aExtAddr)
void
Ce rappel est appelé par la pile héritée pour notifier qu'un nouveau nœud hérité a bien rejoint le réseau.
otNcpHdlcInit ( otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Initialisez le NCP basé sur le cadrage HDLC.
otNcpHdlcReceive (const uint8_t *aBuf, uint16_t aBufLength)
void
Cette fonction est appelée après la réception des données NCP codées HDLC.
otNcpHdlcSendDone (void)
void
Cette fonction est appelée une fois l'envoi NCP terminé.
otNcpPlatLogv ( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Écrit le journal otNcpStreamWrite aide de otNcpStreamWrite .
otNcpRegisterLegacyHandlers (const otNcpLegacyHandlers *aHandlers)
void
Cette méthode enregistre un ensemble de gestionnaires hérités avec NCP.
otNcpRegisterPeekPokeDelagates ( otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
Cette méthode enregistre les fonctions de délégué peek / poke avec le module NCP.
otNcpSpiInit ( otInstance *aInstance)
void
Initialisez le NCP en fonction du cadrage SPI.
otNcpStreamWrite (int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Envoyez des données à l'hôte via un flux spécifique.

Structs

otNcpLegacyHandlers

Définit une structure contenant tous les gestionnaires hérités (pointeurs de fonction).

Typedefs

otNcpDelegateAllowPeekPoke

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

Définit le type de délégué (pointeur de fonction) pour contrôler le comportement de l'opération peek / poke.

Cette fonction de délégué est appelée pour décider d'autoriser ou non le peek ou le poke d'une région de mémoire spécifique.This delegate function is called to decide whether to allow peek or poke of a specific memory region. Il est utilisé si la prise en charge NCP des commandes peek / poke est activée.

Des détails
Paramètres
[in] aAddress
Adresse de début de la région mémoire.
[in] aCount
Nombre d'octets à regarder ou à pousser.
Retour
TRUE pour autoriser le peek / poke de la région mémoire donnée, FALSE dans le cas contraire.

otNcpHandlerJoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

Définit le type de gestionnaire (pointeur de fonction) pour lancer le processus de jointure.

Appelé pour lancer une procédure de jointure héritée vers un nœud ou un nœud spécifique.

Des détails
Paramètres
[in] aExtAddress
Un pointeur vers l'adresse étendue du nœud à rejoindre ou NULL si vous le souhaitez pour rejoindre un nœud voisin.

otNcpHandlerSetLegacyUlaPrefix

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

Définit le type de gestionnaire (pointeur de fonction) pour définir le préfixe ULA hérité.

Appelé pour définir le préfixe ULA hérité.

Des détails
Paramètres
[in] aUlaPrefix
Un pointeur vers un tampon contenant le préfixe ULA hérité.

otNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

Définit le type de gestionnaire (pointeur de fonction) pour démarrer le réseau hérité.

Appelé pour démarrer l'ancien réseau.

otNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

Définit le type de gestionnaire (pointeur de fonction) pour arrêter le réseau hérité.

Appelé pour arrêter l'ancien réseau.

otNcpHdlcSendCallback

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

Ce pointeur de fonction est appelé pour envoyer des données NCP codées HDLC.

Des détails
Paramètres
[in] aBuf
Un pointeur vers un tampon avec une sortie.
[in] aBufLength
Une longueur des données de sortie stockées dans la mémoire tampon.
Retour
Nombre d'octets traités par le rappel.

otNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

Définit une structure contenant tous les gestionnaires hérités (pointeurs de fonction).

Les fonctions

otNcpHandleDidReceiveNewLegacyUlaPrefix

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

Ce rappel est appelé par la pile héritée pour notifier que le préfixe ULA hérité a changé.

Des détails
Paramètres
[in] aUlaPrefix
Un pointeur vers le préfixe ULA reçu.

otNcpHandleLegacyNodeDidJoin

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

Ce rappel est appelé par la pile héritée pour notifier qu'un nouveau nœud hérité a bien rejoint le réseau.

Des détails
Paramètres
[in] aExtAddr
Un pointeur vers l'adresse étendue du nœud joint.

otNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Initialisez le NCP basé sur le cadrage HDLC.

Des détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.
[in] aSendCallback
Le pointeur de fonction utilisé pour envoyer les données NCP.

otNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Cette fonction est appelée après la réception des données NCP codées HDLC.

Des détails
Paramètres
[in] aBuf
Un pointeur vers un tampon.
[in] aBufLength
La longueur des données stockées dans la mémoire tampon.

otNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

Cette fonction est appelée une fois l'envoi NCP terminé.

otNcpPlatLogv

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

Écrit le journal otNcpStreamWrite aide de otNcpStreamWrite .

Des détails
Paramètres
[in] aLogLevel
Le niveau de journalisation.
[in] aLogRegion
La région du journal.
[in] aFormat
Un pointeur vers la chaîne de format.
[in] aArgs
va_list correspondant à un format.

otNcpRegisterLegacyHandlers

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

Cette méthode enregistre un ensemble de gestionnaires hérités avec NCP.

L'ensemble de gestionnaires fournis par la structure aHandlers est utilisé par le code NCP pour démarrer / arrêter le réseau hérité. Les aHandlers peuvent être NULL pour désactiver le support hérité sur NCP. Les gestionnaires individuels dans la structure de gestionnaires donnée peuvent également être NULL.

Des détails
Paramètres
[in] aHandlers
Un pointeur vers une structure de gestionnaire.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Cette méthode enregistre les fonctions de délégué peek / poke avec le module NCP.

Les fonctions de délégué sont appelées par le module NCP pour décider s'il faut autoriser le peek ou le poke d'une région de mémoire spécifique. Si le pointeur de délégué est défini sur NULL, il autorise l'opération peek / poke pour n'importe quelle adresse.

Des détails
Paramètres
[in] aAllowPeekDelegate
Déléguez le pointeur de fonction pour une opération d'aperçu.
[in] aAllowPokeDelegate
Déléguez le pointeur de fonction pour l'opération de poussée.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Initialisez le NCP en fonction du cadrage SPI.

Des détails
Paramètres
[in] aInstance
La structure de l'instance OpenThread.

otNcpStreamWrite

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

Envoyez des données à l'hôte via un flux spécifique.

Cette fonction tente d'envoyer les données données à l'hôte en utilisant le aStreamId donné. Ceci est utile pour signaler des messages d'erreur, implémenter des consoles de débogage / diagnostic et potentiellement d'autres types de flux de données.

L'écriture est soit acceptée dans son intégralité, soit rejetée. Les écritures partielles ne sont pas tentées.

Des détails
Paramètres
[in] aStreamId
Identificateur numérique du flux dans lequel écrire. S'il est défini sur «0», sera par défaut le flux de débogage.
[in] aDataPtr
Un pointeur vers les données à envoyer sur le flux. Si aDataLen est différent de zéro, ce paramètre NE DOIT PAS être NULL.
[in] aDataLen
Le nombre d'octets de données de aDataPtr à envoyer.
Valeurs de retour
OT_ERROR_NONE
Les données ont été mises en file d'attente pour livraison à l'hôte.
OT_ERROR_BUSY
Il n'y a pas assez de ressources pour répondre à cette demande. Il s'agit généralement d'une condition temporaire.
OT_ERROR_INVALID_ARGS
L'aStreamId donné n'était pas valide.

Macros

OT_NCP_LEGACY_ULA_PREFIX_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

Taille ULA héritée (en octets)