Coprocesseur

Ce module inclut des fonctions qui contrôlent l'exécution des threads.

Résumé

Définitions

otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount) CANNOT TRANSLATE
bool(*
Définit le type de délégué (pointeur de fonction) pour contrôler le comportement de l'aperçu/du fonctionnement de l'aperçu.
otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress) CANNOT TRANSLATE
void(*
Définit le type de gestionnaire (sélecteur de fonction) pour lancer le processus de jointure.
otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix) CANNOT TRANSLATE
void(*
Définit le type de gestionnaire (sélecteur de fonction) pour définir le préfixe ULA de l'ancienne version.
otNcpHandlerStartLegacy)(void) CANNOT TRANSLATE
void(*
Définit le type de gestionnaire (sélecteur de fonction) pour démarrer l'ancien réseau.
otNcpHandlerStopLegacy)(void) CANNOT TRANSLATE
void(*
Définit le type de gestionnaire (sélecteur de fonction) pour arrêter l'ancien réseau.
otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength) CANNOT TRANSLATE
int(*
Ce pointeur de fonction est appelé pour envoyer des données NCP encodées au format HDLC.
otNcpLegacyHandlers CANNOT TRANSLATE
Définit une structure contenant tous les anciens gestionnaires (sélecteurs de fonction).

Fonctions

otNcpHandleDidReceiveNewLegacyUlaPrefix(const uint8_t *aUlaPrefix)
void
Ce rappel est invoqué par l'ancienne pile pour indiquer que le préfixe ULA de l'ancienne version a été modifié.
otNcpHandleLegacyNodeDidJoin(const otExtAddress *aExtAddr)
void
Ce rappel est invoqué par l'ancienne pile pour informer qu'un nouveau nœud a rejoint le réseau.
otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Initialisez le NCP en fonction du 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 encodées au format 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 un journal OpenThread à l'aide de otNcpStreamWrite.
otNcpRegisterLegacyHandlers(const otNcpLegacyHandlers *aHandlers)
void
Cette méthode enregistre un ensemble de anciens gestionnaires auprès du NCP.
otNcpRegisterPeekPokeDelagates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
Cette méthode enregistre des fonctions de délégation d'aperçu/de modification via le module NCP.
otNcpSpiInit(otInstance *aInstance)
void
Initialisez le NCP en fonction du cadrage de la SPI.
otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Envoyez des données à l'hôte via un flux spécifique.

Structures

otNcpLegacyHandlers

Définit une structure contenant tous les anciens gestionnaires (sélecteurs de fonction).

Définitions

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'aperçu/du fonctionnement de l'aperçu.

Cette fonction de délégation est appelée pour déterminer si la région du souvenir doit être autorisée ou autorisée. Il est utilisé si la compatibilité NCP pour les commandes Aperçu/poke est activée.

Détails
Paramètres
[in] aAddress
Adresse de départ de la région de la mémoire.
[in] aCount
Nombre d'octets à prévisualiser ou à "poke".
Renvoie
Prend la valeur TRUE pour autoriser/afficher l'aperçu de la région de mémoire donnée, sinon FALSE.

otNcpHandlerJoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

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

Est appelé pour initier une ancienne procédure de jointure sur n'importe quel nœud ou sur un nœud spécifique.

Détails
Paramètres
[in] aExtAddress
Pointeur vers l'adresse étendue du nœud à joindre ou NULL si vous souhaitez joindre un nœud voisin.

otNcpHandlerSetLegacyUlaPréfixe

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

Définit le type de gestionnaire (sélecteur de fonction) pour définir le préfixe ULA de l'ancienne version.

Appelé pour définir l'ancien préfixe d'ULA.

Détails
Paramètres
[in] aUlaPrefix
Point de mise en mémoire tampon contenant l'ancien préfixe d'ULA.

otNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

Définit le type de gestionnaire (sélecteur de fonction) pour démarrer l'ancien réseau.

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

otNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

Définit le type de gestionnaire (sélecteur de fonction) pour arrêter l'ancien réseau.

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 encodées au format HDLC.

Détails
Paramètres
[in] aBuf
Pointeur vers un tampon avec une sortie.
[in] aBufLength
Longueur des données de sortie stockées dans le tampon.
Renvoie
Nombre d'octets traités par le rappel.

otNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

Définit une structure contenant tous les anciens gestionnaires (sélecteurs de fonction).

Fonctions

otNcpPoignerReceivedReceivedLegacyLegacyPréfixe

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

Ce rappel est invoqué par l'ancienne pile pour indiquer que le préfixe ULA de l'ancienne version a été modifié.

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

otNcpHandlingLegacyNodeDoneJoin

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

Ce rappel est invoqué par l'ancienne pile pour informer qu'un nouveau nœud a rejoint le réseau.

Détails
Paramètres
[in] aExtAddr
Pointeur vers l'adresse étendue du nœud associé.

OTNcpHdlcInit-

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Initialisez le NCP en fonction du cadrage HDLC.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
[in] aSendCallback
Pointeur de fonction utilisé pour envoyer des 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 encodées au format HDLC.

Détails
Paramètres
[in] aBuf
Pointeur vers une mémoire tampon.
[in] aBufLength
Longueur des données stockées dans le 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 un journal OpenThread à l'aide de otNcpStreamWrite.

Détails
Paramètres
[in] aLogLevel
Niveau du journal.
[in] aLogRegion
Région de journal.
[in] aFormat
Pointeur vers la chaîne de format.
[in] aArgs
va_list correspondant à aFormat.

otNcpRegisterLegacyHandlers

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

Cette méthode enregistre un ensemble de anciens gestionnaires auprès du NCP.

L'ensemble des gestionnaires fournis par la structure aHandlers est utilisé par le code NCP pour démarrer/arrêter l'ancien réseau. Le paramètre aHandlers peut être NULL pour désactiver l'ancienne compatibilité avec NCP. Les gestionnaires individuels dans la structure des gestionnaires donnés peuvent également être NULL.

Détails
Paramètres
[in] aHandlers
Pointeur vers une structure de gestionnaire.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Cette méthode enregistre des fonctions de délégation d'aperçu/de modification via le module NCP.

Les fonctions de délégué sont appelées par le module NCP pour déterminer si elles peuvent autoriser l'aperçu ou le poker d'une région de mémoire spécifique. Si le pointeur de délégation est défini sur NULL, l'opération de prévisualisation/lecture est autorisée pour n'importe quelle adresse.

Détails
Paramètres
[in] aAllowPeekDelegate
Délégation du curseur de fonction pour l'opération d'aperçu.
[in] aAllowPokeDelegate
Délégation du pointeur de fonction pour l'opération poke.

OTNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Initialisez le NCP en fonction du cadrage de la SPI.

Détails
Paramètres
[in] aInstance
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 fournies à l'hôte à l'aide de l'ID aStreamId. Cela est utile pour signaler des messages d'erreur, mettre en œuvre des consoles de débogage et de diagnostic, et potentiellement d'autres types de flux de données.

L'écriture est acceptée dans son intégralité ou refusée. Aucune tentative d'écriture partielle n'est effectuée.

Détails
Paramètres
[in] aStreamId
Identifiant numérique du flux dans lequel écrire. Si elle est définie sur "#39;0'", elle sera définie par défaut sur le flux de débogage.
[in] aDataPtr
Pointeur vers les données à envoyer dans le flux. Si la valeur de aDataLen est différente de zéro, ce paramètre NE DOIT PAS être NULL.
[in] aDataLen
Nombre d'octets de données provenant de aDataPtr à envoyer.
Valeurs renvoyées
OT_ERROR_NONE
Les données ont été mises en attente de livraison à l'hôte.
OT_ERROR_BUSY
Impossible de traiter cette demande. En général, cette situation est temporaire.
OT_ERROR_INVALID_ARGS
L'élément aStreamId fourni n'est pas valide.

Macros

OT_NCP_LEGACY_ULA_PREFIX_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

Taille de l'ancienne portée ULA (en octets)

Resources

Les rubriques de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou contribuer à notre documentation, consultez la page Ressources.