Divers

Ce module inclut des abstractions de plate-forme pour divers comportements.

Résumé

Énumérations

otPlatMcuPowerState{
  OT_PLAT_MCU_POWER_STATE_ON = 0,
  OT_PLAT_MCU_POWER_STATE_LOW_POWER = 1,
  OT_PLAT_MCU_POWER_STATE_OFF = 2
}
enum
Énumération des états d'alimentation du microcontrôleur.
otPlatResetReason enum
Énumération des codes de motif de réinitialisation possibles.

distantes

otPlatAssertFail(const char *aFilename, int aLineNumber)
void
Fournit une implémentation spécifique à la plate-forme pour la revendication.
otPlatGetMcuPowerState(otInstance *aInstance)
Récupère l'état d'alimentation actuel du microcontrôleur souhaité.
otPlatGetResetReason(otInstance *aInstance)
Renvoie le motif de la dernière réinitialisation de la plate-forme.
otPlatReset(otInstance *aInstance)
void
Effectue une réinitialisation logicielle sur la plate-forme, si cette fonctionnalité est disponible.
otPlatResetToBootloader(otInstance *aInstance)
Effectue une réinitialisation matérielle sur la plate-forme pour lancer le mode bootloader, le cas échéant.
otPlatSetMcuPowerState(otInstance *aInstance, otPlatMcuPowerState aState)
Définit l'état d'alimentation souhaité du microcontrôleur.
otPlatWakeHost(void)
void
Effectue une opération spécifique à la plate-forme pour activer le microcontrôleur hôte.

Énumérations

otPlatMcuPowerState

 otPlatMcuPowerState

Énumération des états d'alimentation du microcontrôleur.

Ces valeurs sont utilisées pour la configuration NCP lorsque OPENTHREAD_CONFIG_NCP_ENABLE_MCU_POWER_STATE_CONTROL est activé.

L'état d'alimentation spécifie l'état d'alimentation souhaité du microcontrôleur (MCU) du NCP lorsque le système d'exploitation de la plate-forme sous-jacente passe en mode inactif (c'est-à-dire que toutes les tâches/événements actifs sont traités et que le MCU peut potentiellement passer dans un état d'économie d'énergie).

L'état d'alimentation détermine principalement la manière dont l'hôte doit interagir avec le NCP et s'il a besoin d'un déclencheur externe (un « poke ») pour communiquer avec le NCP avant de pouvoir communiquer avec le NCP.

Après une réinitialisation, l'état d'alimentation du microcontrôleur DOIT être OT_PLAT_POWER_STATE_ON.

Propriétés
OT_PLAT_MCU_POWER_STATE_LOW_POWER

Le microcontrôleur du NCP peut passer en état à faible consommation d'énergie (économique).

Lorsque l'état d'alimentation souhaité du NCP est défini sur LOW_POWER, l'hôte doit "percuter" le NCP (par exemple, un déclencheur externe tel qu'une interruption) avant de pouvoir communiquer avec le NCP (envoyer un message au NCP). Le mécanisme de « poke » est déterminé par le code de la plate-forme (en fonction de l'interface entre le NCP et l'hôte).

Lorsque l'état d'alimentation est défini sur LOW_POWER, NCP peut toujours (à tout moment) envoyer des messages à l'hôte. Notez que la réception d'un message du NCP n'indique PAS que l'état d'alimentation du NCP a changé, c'est-à-dire que l'hôte est censé continuer à "poker" lorsqu'il veut communiquer avec le NCP jusqu'à ce que l'état d'alimentation soit explicitement modifié (par un appel réussi à otPlatSetMcuPowerState() changeant l'état en ON).

OT_PLAT_MCU_POWER_STATE_OFF

NCP est complètement désactivé.

Une réinitialisation matérielle NCP (via un code RÉINITIALISER) est nécessaire pour ramener le NCP à SPINEL_MCU_POWER_STATE_ON. La RAM n'est pas conservée après la réinitialisation.

OT_PLAT_MCU_POWER_STATE_ON

Le MCU du NCP reste activé et actif en permanence.

Lorsque l'état d'alimentation souhaité du NCP est défini sur ON, l'hôte peut envoyer des messages au NCP sans nécessiter de "poke" ni de déclencheur externe.

otPlatResetReason

 otPlatResetReason

Énumération des codes de motif de réinitialisation possibles.

Ils sont dans le même ordre que les codes de motif de réinitialisation Spinel.

distantes

otPlatAssertFail

void otPlatAssertFail(
  const char *aFilename,
  int aLineNumber
)

Fournit une implémentation spécifique à la plate-forme pour la revendication.

Détails
Paramètres
[in] aFilename
Nom du fichier dans lequel la déclaration a été effectuée.
[in] aLineNumber
Numéro de la ligne du fichier où la déclaration a été effectuée.

otPlatGetMcuPowerState

otPlatMcuPowerState otPlatGetMcuPowerState(
  otInstance *aInstance
)

Récupère l'état d'alimentation actuel du microcontrôleur souhaité.

Cela n'est applicable et utilisé pour la configuration NCP que lorsque OPENTHREAD_CONFIG_NCP_ENABLE_MCU_POWER_STATE_CONTROL est activé.

Après une réinitialisation, l'état d'alimentation DOIT renvoyer OT_PLAT_POWER_STATE_ON. Pendant l'opération, l'état de l'alimentation ne DOIT changer que via un appel réussi explicite à otPlatSetMcuPowerState().

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
État d'alimentation actuel.

otPlatGetResetReason

otPlatResetReason otPlatGetResetReason(
  otInstance *aInstance
)

Renvoie le motif de la dernière réinitialisation de la plate-forme.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.

otPlatReset

void otPlatReset(
  otInstance *aInstance
)

Effectue une réinitialisation logicielle sur la plate-forme, si cette fonctionnalité est disponible.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.

otPlatResetToBootloader

otError otPlatResetToBootloader(
  otInstance *aInstance
)

Effectue une réinitialisation matérielle sur la plate-forme pour lancer le mode bootloader, le cas échéant.

Utilisé lorsque OPENTHREAD_CONFIG_PLATFORM_BOOTLOADER_MODE_ENABLE est activé.

Détails
Paramètres
[in] aInstance
Structure de l'instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
Le bootloader a bien été rétabli.
OT_ERROR_BUSY
Échec dû à une autre opération en cours.
OT_ERROR_NOT_CAPABLE
Impossible de rétablir le bootloader.

otPlatSetMcuPowerState

otError otPlatSetMcuPowerState(
  otInstance *aInstance,
  otPlatMcuPowerState aState
)

Définit l'état d'alimentation souhaité du microcontrôleur.

Cela n'est applicable et utilisé pour la configuration NCP que lorsque OPENTHREAD_CONFIG_NCP_ENABLE_MCU_POWER_STATE_CONTROL est activé.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aState
Nouvel état d'alimentation du microcontrôleur.
Valeurs de retour
OT_ERROR_NONE
L'état d'alimentation a bien été mis à jour.
OT_ERROR_FAILED
L'état d'alimentation donné du microcontrôleur n'est pas compatible avec la plate-forme.

otPlatWakeHost

void otPlatWakeHost(
  void
)

Effectue une opération spécifique à la plate-forme pour activer le microcontrôleur hôte.

Ceci n'est utilisé que pour les configurations NCP.

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, consultez la section Ressources.