GPIO_CLIENT_UNMASK_INTERRUPT fonction de rappel (gpioclx.h)

Article
02/07/2025

La fonction de rappel d’événement CLIENT_UnmaskInterrupt masque l’interruption sur une broche d’E/S à usage général (GPIO) configurée comme entrée d’interruption.

Syntaxe

GPIO_CLIENT_UNMASK_INTERRUPT GpioClientUnmaskInterrupt;

NTSTATUS GpioClientUnmaskInterrupt(
  [in] PVOID Context,
  [in] PGPIO_ENABLE_INTERRUPT_PARAMETERS InterruptParameters
)
{...}

Paramètres

[in] Context

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

[in] InterruptParameters

Pointeur vers une structure GPIO_ENABLE_INTERRUPT_PARAMETERS qui spécifie une broche GPIO et décrit les attributs d’interruption de cette broche.

Valeur de retour

La fonction CLIENT_UnmaskInterrupt 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 de framework GPIO (GpioClx) appelle cette fonction pour annuler les interruptions sur une broche GPIO configurée comme entrée de demande d’interruption. Pour plus d’informations, consultez masques d’interruption GPIO.

Pour inscrire la fonction de rappel CLIENT_UnmaskInterrupt 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_UnmaskInterrupt.

La fonction CLIENT_UnmaskInterrupt est appelée à partir de la routine de service d’interruption (ISR) dans GpioClx. Cet ISR s’exécute à 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 des indicateurs de de cette structure, l’ISR GpioClx s’exécute sur DIRQL et appelle la fonction CLIENT_UnmaskInterrupt au niveau 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_UnmaskInterrupt, 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_UnmaskInterrupt nommée MyEvtGpioUnmaskInterrupt, utilisez le type de fonction GPIO_CLIENT_UNMASK_INTERRUPT, comme illustré dans cet exemple de code :

GPIO_CLIENT_UNMASK_INTERRUPT MyEvtGpioUnmaskInterrupt;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioUnmaskInterrupt(
    PVOID Context,
    PGPIO_ENABLE_INTERRUPT_PARAMETERS InterruptParameters
    )
{ ... }

Le type de fonction GPIO_CLIENT_UNMASK_INTERRUPT 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_UNMASK_INTERRUPT 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.