GPIO_CLIENT_START_CONTROLLER fonction de rappel (gpioclx.h)
La fonction de rappel d’événement CLIENT_StartController effectue des opérations nécessaires lorsque l’appareil de contrôleur d’E/S à usage général (GPIO) entre dans l’état d’alimentation D0.
Syntaxe
GPIO_CLIENT_START_CONTROLLER GpioClientStartController;
NTSTATUS GpioClientStartController(
[in] PVOID Context,
[in] BOOLEAN RestoreContext,
[in] WDF_POWER_DEVICE_STATE PreviousPowerState
)
{...}
Paramètres
[in] Context
Pointeur vers le contexte de périphérique du pilote de contrôleur GPIO.
[in] RestoreContext
Indique si le pilote client doit restaurer le contrôleur GPIO dans un contexte matériel précédemment enregistré. Si la valeur est TRUE, le contexte matériel doit être restauré. Si la valeur est FALSE, le contexte matériel ne doit pas être restauré. Pour plus d’informations, consultez Remarques.
[in] PreviousPowerState
État d’alimentation de l’appareil précédent. Ce paramètre est une valeur d’énumération WDF_POWER_DEVICE_STATE qui spécifie l’état de faible alimentation à partir duquel l’appareil a entré 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 afin qu’il soit prêt à être utilisé.
Valeur de retour
La fonction CLIENT_StartController 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 placer l’appareil du contrôleur GPIO dans un état connu et initial au démarrage du système ou lorsque l’appareil passe d’un état de faible alimentation à un état de fonctionnement. Cette fonction de rappel doit effectuer toutes les opérations nécessaires après le réveil de l’appareil à partir d’un état de faible alimentation, telles que la restauration des informations dont le pilote a besoin une fois que l’appareil entre dans l’état d’alimentation D0.
En règle générale, une fonction de rappel CLIENT_StartController définit toutes les broches GPIO à leur état par défaut.
Pour inscrire la fonction de rappel CLIENT_StartController 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_StartController.
Bien que la fonction de rappel CLIENT_StartController soit appelée à IRQL = PASSIVE_LEVEL, vous ne devez pas rendre cette fonction paginable. Le rappel CLIENT_StartController est dans le chemin de minutage critique pour restaurer l’alimentation 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_StartController, 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_StartController nommée MyEvtGpioStartController, utilisez le type de fonction GPIO_CLIENT_START_CONTROLLER, comme illustré dans cet exemple de code :
GPIO_CLIENT_START_CONTROLLER MyEvtGpioStartController;
Ensuite, implémentez votre fonction de rappel comme suit :
_Use_decl_annotations_
VOID
MyEvtGpioStartController(
PVOID Context,
BOOLEAN RestoreContext,
WDF_POWER_DEVICE_STATE PreviousPowerState
)
{ ... }
Le type de fonction GPIO_CLIENT_START_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_START_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 (voir Remarques). |