GPIO_CLIENT_MASK_INTERRUPTS fonction de rappel (gpioclx.h)

Article
08/07/2023

La fonction de rappel d’événements CLIENT_MaskInterrupts masque les interruptions sur un ensemble de broches d’E/S à usage général (GPIO) configurées en tant qu’entrées d’interruption.

Syntaxe

GPIO_CLIENT_MASK_INTERRUPTS GpioClientMaskInterrupts;

NTSTATUS GpioClientMaskInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
)
{...}

Paramètres

[in] Context

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

[in, out] MaskParameters

Pointeur vers une structure de GPIO_MASK_INTERRUPT_PARAMETERS qui, à l’entrée, décrit les broches d’interruption GPIO à masquer et, à la sortie, contient les status de l’opération de masque.

Valeur retournée

La fonction CLIENT_MaskInterrupts retourne STATUS_SUCCESS si l’appel réussit. Sinon, il 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 masquer les interruptions sur les broches GPIO configurées en tant qu’entrées de demande d’interruption. Pour plus d’informations, consultez Masques d’interruption GPIO.

Pour inscrire la fonction de rappel CLIENT_MaskInterrupts 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_MaskInterrupts .

La fonction CLIENT_MaskInterrupts est 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 de 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 au niveau de DIRQL et appelle la fonction CLIENT_MaskInterrupts à la 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.

Un appel de CLIENT_MaskInterrupts qui ne parvient pas à définir le masque d’interruption sur la valeur demandée doit définir le membre FailedMask de la structure GPIO_MASK_INTERRUPT_PARAMETERS sur une valeur différente de zéro et renvoyer une erreur appropriée status code. La fonction CLIENT_MaskInterrupts d’un contrôleur GPIO mappé en mémoire doit toujours réussir à définir le masque d’interruption sur la valeur demandée. Toutefois, la fonction CLIENT_MaskInterrupts d’un contrôleur qui n’est pas mappé en mémoire doit envoyer une demande d’E/S au contrôleur pour définir le masque, et cette demande peut échouer. Si la demande ne parvient pas à définir le masque, la fonction doit indiquer cet échec dans la valeur qu’elle écrit dans le membre FailedMask .

Exemples

Pour définir une fonction de rappel CLIENT_MaskInterrupts , 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 aide l’analyse du code pour les pilotes, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification à la recherche d’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_MaskInterrupts nommée MyEvtGpioMaskInterrupts, utilisez le type de fonction GPIO_CLIENT_MASK_INTERRUPTS, comme indiqué dans cet exemple de code :

GPIO_CLIENT_MASK_INTERRUPTS MyEvtGpioMaskInterrupts;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioMaskInterrupts(
    PVOID Context,
    PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
    )
{ ... }

Le type de fonction GPIO_CLIENT_MASK_INTERRUPTS 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_MASK_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 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.