GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS fonction de rappel (gpioclx.h)

Article
02/07/2025

La fonction de rappel d’événement CLIENT_QueryEnabledInterrupts interroge l’état d’un ensemble de broches d’E/S à usage général (GPIO) pour déterminer quelles broches sont à la fois configurées en tant qu’entrées d’interruption et activées pour les interruptions.

Syntaxe

GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS GpioClientQueryEnabledInterrupts;

NTSTATUS GpioClientQueryEnabledInterrupts(
  [in] PVOID Context,
  [in] PGPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS QueryEnabledParameters
)
{...}

Paramètres

[in] Context

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

[in] QueryEnabledParameters

Pointeur vers une structure GPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS allouée par l’appelant. Avant d’appeler cette fonction, l’appelant écrit un ID bancaire dans le BankId membre de cette structure pour spécifier la banque des broches GPIO à interroger. Si elle réussit, la fonction écrit une valeur de masque dans le EnabledMask membre de cette structure pour indiquer quelles interruptions sont activées dans la banque spécifiée.

Valeur de retour

La fonction CLIENT_QueryEnabledInterrupts retourne STATUS_SUCCESS si l’appel réussit. Sinon, elle retourne un code d’erreur approprié.

Remarques

À compter de Windows 8.1, le pilote de contrôleur GPIO peut, en tant qu’option, implémenter une fonction de rappel CLIENT_QueryEnabledInterrupts. Si elle est implémentée, cette fonction est appelée par l’extension de framework GPIO (GpioClx) pour déterminer quelles interruptions sont activées dans une banque de broches GPIO.

Le paramètre QueryEnabledParameters pointe vers une structure GPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS allouée par l’appelant. L’appelant définit la valeur du BankId membre de cette structure. La fonction CLIENT_QueryEnabledInterrupts écrit dans le EnabledMask membre de la structure.

Pour inscrire la fonction de rappel CLIENT_QueryEnabledInterrupts 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_QueryEnabledInterrupts.

La fonction CLIENT_QueryEnabledInterrupts est facultative. Si votre pilote n’implémente pas cette fonction, définissez le membre CLIENT_QueryEnabledInterrupts de la structure GPIO_CLIENT_REGISTRATION_PACKET sur NULL.

Si la fonction CLIENT_QueryEnabledInterrupts est implémentée, GpioClx utilise cette fonction pour améliorer la fiabilité et les diagnostics des pilotes. GpioClx appelle cette fonction pour vérifier que l’ensemble d’interruptions activées sur le contrôleur GPIO correspond à ce que GpioClx attend. En règle générale, une incompatibilité indique un bogue de pilote qui peut potentiellement provoquer une tempête d’interruption. GpioClx utilise cette fonction pour effectuer une validation d’état plus étendue dans les builds vérifiées (débogage) et réduit le nombre d’appels à cette fonction dans les builds gratuites (commerciales) afin d’éviter d’affecter les performances. Si elle est implémentée, cette fonction doit lire directement l’état matériel au lieu de lire une version mise en cache ou gérée par logiciel de l’état.

GpioClx appelle la fonction de rappel CLIENT_QueryEnabledInterrupts à PASSIVE_LEVEL ou DIRQL, selon les informations de l’appareil fournies par la fonction de rappel CLIENT_QueryControllerBasicInformation à 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 Indicateurs de de cette structure, GpioClx appelle la fonction CLIENT_QueryEnabledInterrupts au niveau de DIRQL, qui est l’IRQL auquel l’ISR dans GpioClx s’exécute. Sinon, cette fonction est appelée à 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_QueryEnabledInterrupts, 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_QueryEnabledInterrupts nommée MyEvtGpioQueryEnabledInterrupts, utilisez le type de fonction GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS, comme illustré dans cet exemple de code :

GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS MyEvtGpioQueryEnabledInterrupts;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioQueryEnabledInterrupts(
    PVOID Context,
    PGPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS QueryEnabledParameters
    )
{ ... }

Le type de fonction GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS 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_QUERY_ENABLED_INTERRUPTS 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.