GPIO_CLIENT_PREPARE_CONTROLLER fonction de rappel (gpioclx.h)

La fonction de rappel d’événement CLIENT_PrepareController effectue toutes les opérations nécessaires pour rendre le contrôleur d’E/S à usage général (GPIO) prêt à être accessible par le pilote du contrôleur GPIO.

Syntaxe

GPIO_CLIENT_PREPARE_CONTROLLER GpioClientPrepareController;

NTSTATUS GpioClientPrepareController(
  [in] WDFDEVICE Device,
  [in] PVOID Context,
  [in] WDFCMRESLIST ResourcesRaw,
  [in] WDFCMRESLIST ResourcesTranslated
)
{...}

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.

[in] ResourcesRaw

Un handle WDFCMRESLIST pour une collection d’objets de ressources d’infrastructure. Cette collection identifie les ressources matérielles brutes (relatives au bus) que le gestionnaire Plug-and-Play (PnP) a attribuées au périphérique du contrôleur GPIO.

[in] ResourcesTranslated

Un handle WDFCMRESLIST pour une collection d’objets de ressources d’infrastructure. Cette collection identifie les ressources matérielles traduites (physiques système) que le gestionnaire PnP a affectées au périphérique du contrôleur GPIO.

Valeur retournée

La fonction CLIENT_PrepareController 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 initialiser les ressources matérielles dont le pilote de contrôleur GPIO a besoin afin qu’il puisse accéder au périphérique du contrôleur GPIO.

Les paramètres ResourcesRaw et ResourcesTranslated sont des handles pour des listes de ressources brutes et traduites. Ces listes décrivent les ressources matérielles que le gestionnaire PnP a affectées à l’appareil du contrôleur GPIO spécifié par le paramètre Device . Pour plus d’informations, consultez Ressources brutes et traduites.

Pendant le rappel CLIENT_PrepareController , le pilote de contrôleur GPIO peut acquérir les ressources matérielles dont il a besoin à partir de la liste ResourcesRaw ou ResourcesTranslated . Si le périphérique du contrôleur GPIO est mappé en mémoire, le pilote doit mapper la ou les plages d’adresses mémoire relatives du bus qui sont affectées aux registres matériels de l’appareil aux adresses virtuelles système. Pour plus d’informations, consultez Mappage d’adresses Bus-Relative à des adresses virtuelles.

Si le contrôleur GPIO n’est pas mappé en mémoire, les ressources matérielles du pilote contiennent un ID de connexion au lieu d’une plage de mémoire. Le pilote utilise cet ID pour ouvrir une connexion logique au contrôleur GPIO et envoie des demandes d’E/S via cette connexion pour accéder aux registres du contrôleur.

GpioClx se connecte à (et se déconnecte ultérieurement de) toute ressource d’interruption que le gestionnaire PnP affecte au contrôleur GPIO. Si GpioClx reçoit une telle ressource d’interruption, il ne supprime pas cette ressource d’interruption des listes de ressources qu’il transmet à la fonction de rappel CLIENT_PrepareController . Toutefois, le pilote du contrôleur GPIO ne doit pas essayer de se connecter (ou de se déconnecter ultérieurement) d’une ressource d’interruption qu’il trouve dans ces listes.

La fonction de rappel d’événement CLIENT_ReleaseController effectue les opérations nécessaires lorsque l’appareil du contrôleur GPIO n’est plus accessible. Pendant ce rappel, le pilote du contrôleur GPIO doit libérer toutes les ressources matérielles qu’il a acquises lors du rappel CLIENT_PrepareController précédent.

Pour inscrire la fonction de rappel CLIENT_PrepareController 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_PrepareController .

Bien que la fonction de rappel CLIENT_PrepareController soit appelée dans IRQL = PASSIVE_LEVEL, vous ne devez pas rendre cette fonction paginable. Le rappel CLIENT_PrepareController 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_PrepareController , 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_PrepareController nommée MyEvtGpioPrepareController, utilisez le type de fonction GPIO_CLIENT_PREPARE_CONTROLLER, comme indiqué dans cet exemple de code :

GPIO_CLIENT_PREPARE_CONTROLLER MyEvtGpioPrepareController;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioPrepareController(
    WDFDEVICE Device,
    PVOID Context,
    WDFCMRESLIST ResourcesRaw,
    WDFCMRESLIST ResourcesTranslated
)
{ ... }

Le type de fonction GPIO_CLIENT_PREPARE_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_PREPARE_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

CLIENT_ReleaseController

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient