Cette page a été traduite par l'API Cloud Translation.

Coprocesseur de 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'aperçu/de l'opération poke.
`otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength)`	typedef `int(*` Ce pointeur de fonction est appelé pour envoyer des données NCP encodées en HDLC.

Fonctions
`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 réception des données NCP encodées au format HDLC.
`otNcpHdlcSendDone(void)`	`void` Cette fonction est appelée une fois l'envoi de NCP terminé.
`otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)`	`void` Écriture du journal OpenThread à l'aide de `otNcpStreamWrite`
`otNcpRegisterPeekPokeDelagates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)`	`void` Cette méthode enregistre des fonctions d'aperçu/de délégation au module NCP.
`otNcpSpiInit(otInstance *aInstance)`	`void` Initialisez le NCP en fonction du cadrage SPI.
`otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)`	`otError` Envoyez des données à l'hôte via un flux spécifique.

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'aperçu/de l'opération poke.

Cette fonction de délégué est appelée pour décider d'autoriser ou non une région de mémoire spécifique. Il est utilisé si la compatibilité NCP pour les commandes Aperçu/Poké est activée.

Détails

Paramètres

`[in] aAddress`	Adresse de départ de la région mémoire.
`[in] aCount`	Nombre d'octets à prévisualiser ou à poker.

Renvoie

TRUE pour permettre l'aperçu/le poing de la région de mémoire donnée, FALSE dans le cas contraire.

otNcpHdlcSendCallback

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

Ce pointeur de fonction est appelé pour envoyer des données NCP encodées en 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.

Fonctions

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 réception des données NCP encodées au format HDLC.

Détails

Paramètres

`[in] aBuf`	Pointeur vers un tampon.
`[in] aBufLength`	Longueur des données stockées dans le tampon.

otNcpHdlcSendOK

void otNcpHdlcSendDone(
  void
)

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

OTNcpPlatLogv

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

Écriture du journal OpenThread à l'aide de otNcpStreamWrite

Détails

Paramètres

`[in] aLogLevel`	Niveau de journalisation.
`[in] aLogRegion`	Région du journal.
`[in] aFormat`	Un pointeur vers la chaîne de format.
`[in] aArgs`	va_list correspondant à aFormat.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

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

Les fonctions de délégué sont appelées par le module NCP pour décider d'autoriser ou non une région de mémoire spécifique. Si le pointeur du délégué est défini sur une valeur NULL, il autorise une opération d'aperçu/de poker pour n'importe quelle adresse.

Détails

Paramètres

`[in] aAllowPeekDelegate`	Déléguer le pointeur de fonction pour une opération d'aperçu.
`[in] aAllowPokeDelegate`	Délégation du pointeur de fonction pour l'opération Poké.

OTNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Initialisez le NCP en fonction du cadrage SPI.

Détails

Paramètres

[in] aInstance

Structure de l'instance OpenThread

OTNcpStream Write

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 à l'aide de l'identifiant aStream. Cela est utile pour signaler des messages d'erreur, implémenter des consoles de débogage/de diagnostic et éventuellement d'autres types de flux de données.

L'écriture est soit acceptée dans son intégralité, soit refusée. Les tentatives d'écriture partielle ne sont pas prises en compte.

Détails

Paramètres

`[in] aStreamId`	Identifiant numérique du flux dans lequel écrire. Si la valeur est définie sur "0", le flux de débogage est utilisé par défaut.
`[in] aDataPtr`	Un pointeur vers les données à envoyer sur le flux. Si aDataLen n'est pas nul, ce paramètre NE DOIT PAS être NULL.
`[in] aDataLen`	Nombre d'octets de données à envoyer depuis aDataPtr.

Valeurs renvoyées

`OT_ERROR_NONE`	Les données ont été mises en file d'attente pour être envoyées à l'hôte.
`OT_ERROR_BUSY`	Il n'y a pas assez de ressources pour traiter cette demande. Il s'agit généralement d'une condition temporaire.
`OT_ERROR_INVALID_ARGS`	L'identifiant aStreamId indiqué n'est pas valide.

Ressources

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