GPIO_CLIENT_READ_PINS fonction de rappel (gpioclx.h)

Article
02/29/2024

La fonction de rappel d’événement CLIENT_ReadGpioPins lit un ensemble de broches d’E/S à usage général (GPIO) configurées en tant qu’entrées de données.

Syntaxe

GPIO_CLIENT_READ_PINS GpioClientReadPins;

NTSTATUS GpioClientReadPins(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_PARAMETERS ReadParameters
)
{...}

Paramètres

[in] Context

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

[in, out] ReadParameters

Pointeur vers une structure GPIO_READ_PINS_PARAMETERS qui, lors de l’entrée, décrit les broches GPIO à lire et, à la sortie, contient les données lues à partir des broches GPIO.

Valeur retournée

La fonction CLIENT_ReadGpioPins 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. GpioClx appelle cette fonction.

Toutes les broches du tableau PinNumberTable appartiennent à la banque identifiée par le paramètre BankId .

Pour inscrire la fonction de rappel CLIENT_ReadGpioPins 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_ReadGpioPins .

La fonction CLIENT_ReadGpioPins peut être appelée à partir de la routine de service d’interruption (ISR) dans GpioClx. Cet ISR s’exécute à PASSIVE_LEVEL ou DIRQL, en fonction des informations de l’appareil que la fonction de rappel CLIENT_QueryControllerBasicInformation fournit à GpioClx. La fonction CLIENT_QueryControllerBasicInformation fournit des informations sur l’appareil sous la forme d’une structure CLIENT_CONTROLLER_BASIC_INFORMATION . Si le bit d’indicateur MemoryMappedController est défini dans le membre Flags de cette structure, l’ISR GpioClx s’exécute sur DIRQL et appelle la fonction CLIENT_ReadGpioPins au niveau de DIRQL. Sinon, l’ISR s’exécute à PASSIVE_LEVEL et appelle la fonction à PASSIVE_LEVEL. Pour plus d’informations sur ce bit d’indicateur, consultez Fonctions de rappel GPIO facultatives et requises.

Exemples

Pour définir une fonction de rappel CLIENT_ReadGpioPins , 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_ReadGpioPins nommée MyEvtGpioReadGpioPins, utilisez le type de fonction GPIO_CLIENT_READ_PINS, comme indiqué dans cet exemple de code :

GPIO_CLIENT_READ_PINS MyEvtGpioReadPins;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReadPins(
    PVOID Context,
    PGPIO_READ_PINS_PARAMETERS ReadParameters
    )
{ ... }

Le type de fonction GPIO_CLIENT_READ_PINS 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_READ_PINS 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

Condition requise	Valeur
Client minimal pris en charge	Pris en charge à partir de Windows 8.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	gpioclx.h
IRQL	Consultez la section Notes.