GPIO_CLIENT_RELEASE_CONTROLLER fonction de rappel (gpioclx.h)

La fonction de rappel d’événement CLIENT_ReleaseController effectue les opérations nécessaires lorsque l’appareil de contrôleur d’E/S à usage général (GPIO) n’est plus accessible.

Syntaxe

GPIO_CLIENT_RELEASE_CONTROLLER GpioClientReleaseController;

NTSTATUS GpioClientReleaseController(
  [in] WDFDEVICE Device,
  [in] PVOID Context
)
{...}

Paramètres

[in] Device

Un handle WDFDEVICE pour l’objet d’appareil d’infrastructure qui représente le contrôleur GPIO.

[in] Context

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

Valeur retournée

La fonction CLIENT_ReleaseController 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 une fois que l’appareil du contrôleur GPIO n’est plus accessible.

Pendant le rappel CLIENT_ReleaseController , le pilote de contrôleur GPIO doit libérer toutes les ressources matérielles qu’il a acquises à la suite de l’appel précédent à la fonction de rappel CLIENT_PrepareController . Dans le cas d’un périphérique contrôleur GPIO mappé en mémoire, le pilote doit annuler le mappage de la ou des plages d’adresses mémoire affectées aux registres matériels. Pour un contrôleur qui n’est pas mappé en mémoire, le pilote doit fermer la connexion logique précédemment ouverte au contrôleur.

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

Bien que la fonction de rappel CLIENT_ReleaseController soit appelée dans IRQL = PASSIVE_LEVEL, vous ne devez pas rendre cette fonction paginable. Le rappel CLIENT_ReleaseController se trouve dans le chemin de minutage 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_ReleaseController , 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_ReleaseController nommée MyEvtGpioReleaseController, utilisez le type de fonction GPIO_CLIENT_RELEASE_CONTROLLER, comme indiqué dans cet exemple de code :

GPIO_CLIENT_RELEASE_CONTROLLER  MyEvtGpioReleaseController;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReleaseController(
    WDFDEVICE Device,
    PVOID Context
)
{ ... }

Le type de fonction GPIO_CLIENT_RELEASE_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_RELEASE_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