GPIO_CLIENT_STOP_CONTROLLER fonction de rappel (gpioclx.h)
La fonction de rappel d’événement CLIENT_StopController effectue des opérations nécessaires pour préparer l’appareil de contrôleur d’E/S à usage général (GPIO) pour 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 de contrôleur GPIO.
[in] SaveContext
Indique si le pilote client doit enregistrer le contexte matériel actuel de l’appareil 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 Remarques.
[in] TargetState
État de l’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 alimentation que l’appareil doit entrer lorsqu’il quitte l’état d’alimentation D0. Le pilote de contrôleur GPIO peut utiliser ces informations pour déterminer comment configurer l’appareil du contrôleur avant de quitter D0.
Valeur de retour
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 de framework GPIO (GpioClx) appelle cette fonction pour préparer l’appareil du contrôleur GPIO à désactiver ou à passer à un état à faible alimentation. Cette fonction de rappel doit effectuer toutes les opérations nécessaires avant que l’appareil entre dans un état de faible alimentation, par exemple enregistrer les informations dont le pilote aura besoin ultérieurement après la restauration de l’appareil vers l’état d’alimentation D0.
En règle générale, la fonction de rappel CLIENT_StopController configure les broches GPIO à 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 temporaires de sortie 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 à IRQL = PASSIVE_LEVEL, vous ne devez pas rendre cette fonction paginable. Le rappel CLIENT_StopController est dans le chemin de minutage critique pour restaurer la puissance sur les appareils de la plateforme matérielle et, pour des raisons de performances, il ne doit pas être retardé par les 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 fonctions de rappel permet d'Analyse du code pour les pilotes, static Driver Verifier (SDV) et d’autres outils de vérification recherchent des erreurs, et il est nécessaire d’écrire des 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 illustré 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 lorsque vous exécutez les 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 annoter le comportement de la fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Prise en charge à partir de Windows 8. |
| plateforme cible | Bureau |
| d’en-tête | gpioclx.h |
| IRQL | Appelé à PASSIVE_LEVEL. |