GPIO_CLIENT_STOP_CONTROLLER fonction de rappel (gpioclx.h)

La fonction de rappel d’événement CLIENT_StopController effectue les opérations nécessaires pour préparer l’appareil de contrôleur d’E/S à usage général (GPIO) à quitter l’état d’alimentation D0.

Syntaxe

GPIO_CLIENT_STOP_CONTROLLER GpioClientStopController;

NTSTATUS GpioClientStopController(
  [in] PVOID Context,
  [in] BOOLEAN SaveContext,
  [in] WDF_POWER_DEVICE_STATE TargetState
)
{...}

Paramètres

[in] Context

Pointeur vers le contexte de périphérique du pilote du contrôleur GPIO.

[in] SaveContext

Indique si le pilote client doit enregistrer le contexte matériel actuel du périphérique du contrôleur GPIO. Si la valeur est TRUE, le contexte matériel doit être enregistré. Si la valeur est FALSE, le contexte matériel ne doit pas être enregistré. Pour plus d'informations, consultez la section Notes.

[in] TargetState

État d’alimentation de l’appareil cible. Ce paramètre est une valeur d’énumération WDF_POWER_DEVICE_STATE qui spécifie l’état de faible consommation que l’appareil doit entrer lorsqu’il quitte l’état d’alimentation D0. Le pilote du contrôleur GPIO peut utiliser ces informations pour déterminer comment configurer le périphérique de contrôleur avant qu’il ne quitte D0.

Valeur retournée

La fonction CLIENT_StopController retourne STATUS_SUCCESS si l’appel réussit. Sinon, elle retourne un code d’erreur approprié.

Remarques

Cette fonction de rappel est implémentée par le pilote du contrôleur GPIO. L’extension d’infrastructure GPIO (GpioClx) appelle cette fonction pour préparer l’appareil du contrôleur GPIO à être désactivé ou à passer à un état de faible consommation. Cette fonction de rappel doit effectuer toutes les opérations nécessaires avant que l’appareil ne passe à un état d’alimentation faible, par exemple enregistrer les informations dont le pilote aura besoin ultérieurement après la restauration de l’appareil à l’état d’alimentation D0.

En règle générale, la fonction de rappel CLIENT_StopController configure les broches GPIO sur un état initial spécifique à la plateforme. Par exemple, cette fonction peut configurer toutes les broches GPIO en tant qu’entrées pour empêcher les sorties temporaires de se produire lorsque l’appareil du contrôleur GPIO est désactivé.

Pour inscrire la fonction de rappel CLIENT_StopController de votre pilote, appelez la méthode GPIO_CLX_RegisterClient . Cette méthode accepte, en tant que paramètre d’entrée, un pointeur vers une structure GPIO_CLIENT_REGISTRATION_PACKET qui contient un pointeur de fonction CLIENT_StopController .

Bien que la fonction de rappel CLIENT_StopController soit appelée dans IRQL = PASSIVE_LEVEL, vous ne devez pas rendre cette fonction paginable. Le rappel CLIENT_StopController se trouve dans le chemin de temporisation critique pour restaurer l’alimentation des appareils dans la plateforme matérielle et, pour des raisons de performances, il ne doit pas être retardé par des erreurs de page.

Exemples

Pour définir une fonction de rappel CLIENT_StopController , vous devez d’abord fournir une déclaration de fonction qui identifie le type de fonction de rappel que vous définissez. Windows fournit un ensemble de types de fonctions de rappel pour les pilotes. La déclaration d’une fonction à l’aide des types de fonction de rappel permet à l’analyse du code pour les pilotes, au vérificateur de pilotes statiques (SDV) et à d’autres outils de vérification de trouver des erreurs. Il s’agit d’une exigence pour l’écriture de pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction de rappel CLIENT_StopController nommée MyEvtGpioStopController, utilisez le type de fonction GPIO_CLIENT_STOP_CONTROLLER, comme indiqué dans cet exemple de code :

GPIO_CLIENT_STOP_CONTROLLER  MyEvtGpioStopController;

Ensuite, implémentez votre fonction de rappel comme suit :

_Use_decl_annotations_
VOID
  MyEvtGpioStopController(
    PVOID Context,
    BOOLEAN RestoreContext,
    WDF_POWER_DEVICE_STATE TargetState
    )
{ ... }

Le type de fonction GPIO_CLIENT_STOP_CONTROLLER est défini dans le fichier d’en-tête Gpioclx.h. Pour identifier plus précisément les erreurs lors de l’exécution des outils d’analyse du code, veillez à ajouter l’annotation Use_decl_annotations à votre définition de fonction. L’annotation Use_decl_annotations garantit que les annotations appliquées au type de fonction GPIO_CLIENT_STOP_CONTROLLER dans le fichier d’en-tête sont utilisées. Pour plus d’informations sur la configuration requise pour les déclarations de fonction, consultez Déclaration de fonctions à l’aide de types de rôles de fonction pour les pilotes KMDF. Pour plus d’informations sur Use_decl_annotations, consultez Annotating Function Behavior.

Configuration requise

Voir aussi

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient