WdfInterruptCreate, fonction (wdfinterrupt.h)

[S’applique à KMDF et UMDF]

La méthode WdfInterruptCreate crée un objet d’interruption de framework.

Syntaxe

NTSTATUS WdfInterruptCreate(
  [in]           WDFDEVICE              Device,
  [in]           PWDF_INTERRUPT_CONFIG  Configuration,
  [in, optional] PWDF_OBJECT_ATTRIBUTES Attributes,
  [out]          WDFINTERRUPT           *Interrupt
);

Paramètres

[in] Device

Handle vers un objet d’appareil framework.

[in] Configuration

Pointeur vers une structure WDF_INTERRUPT_CONFIG qui a été initialisée par un appel à WDF_INTERRUPT_CONFIG_INIT.

[in, optional] Attributes

Pointeur vers une structure WDF_OBJECT_ATTRIBUTES qui spécifie les attributs d’objet pour l’objet d’interruption du framework. (Consultez les remarques pour plus d’informations.) Ce paramètre est facultatif et peut être WDF_NO_OBJECT_ATTRIBUTES.

[out] Interrupt

Pointeur vers un emplacement qui reçoit un handle vers le nouvel objet d’interruption.

Valeur de retour

WdfInterruptCreate retourne STATUS_SUCCESS si l’opération réussit. Sinon, cette méthode peut retourner l’une des valeurs suivantes.

Pour obtenir la liste des autres valeurs de retour que la méthode WdfInterruptCreate peut retourner, consultez Framework Object Creation Errors.

Cette méthode peut également retourner d’autres valeurs NTSTATUS .

Une vérification de bogue se produit si le pilote fournit un handle d’objet non valide.

Remarques

Les pilotes appellent généralement la méthode WdfInterruptCreate à partir d’une fonction de rappel EvtDriverDeviceAdd. À compter de KMDF version 1.11 et UMDF version 2.0, les pilotes peuvent appeler WdfInterruptCreate à partir de EvtDevicePrepareHardware. Si le pilote appelle WdfInterruptCreate à partir de EvtDriverDeviceAdd, le InterruptRaw et membres de InterruptTranslated de la structure WDF_INTERRUPT_CONFIG doit être NULL. Si le pilote appelle WdfInterruptCreate à partir de EvtDevicePrepareHardware, ces membres doivent être valides.

Si vous créez un objet d’interruption compatible wake, comme décrit dans Utilisation d’une interruption pour sortir un appareil, vous devez appeler WdfInterruptCreate à partir de EvtDevicePrepareHardware.

Votre pilote doit appeler WdfInterruptCreate une fois pour chaque vecteur d’interruption requis par son appareil. Si l’appareil prend en charge les interruptions signalées par des messages (MSI), le pilote doit créer un objet d’interruption pour chaque message que l’appareil peut prendre en charge.

Une fois que le gestionnaire PnP affecte des ressources système à l’appareil, l’infrastructure stocke des informations sur les ressources d’interruption attribuées par l’appareil dans les objets d’interruption créés par le pilote. (Les pilotes qui ne prennent pas en charge Plug-and-Play ne peuvent pas utiliser d’objets d’interruption.)

Le système peut ne pas affecter toutes les ressources d’interruption qu’un appareil peut prendre en charge. Par exemple, un pilote crée huit objets d’interruption pour un appareil capable de prendre en charge huit messages MSI. Toutefois, le système peut affecter un seul message à l’appareil. Dans ce cas, sept des objets d’interruption ne seront pas utilisés.

En règle générale, votre pilote doit stocker des informations spécifiques aux interruptions, telles que le contenu copié des registres d’interruptions d’appareil, dans l’espace de contexte de l’objet d’interruption. La structure WDF_OBJECT_ATTRIBUTES que le pilote passe à WdfInterruptCreate doit décrire l’espace de contexte.

Pour les pilotes utilisant framework version 1.9 et antérieure, le parent de chaque objet d’interruption est l’objet de périphérique auquel appartient l’interruption. Le pilote ne peut pas modifier ce parent et le membre ParentObject de la structure WDF_OBJECT_ATTRIBUTES doit être NULL. À compter de la version 1.11, ParentObject peut être un objet d’appareil framework ou un objet file d’attente. Si le pilote spécifie un parent, le pilote doit définir l'AutomaticSerialization membre de la structure de configuration sur TRUE. Le pilote peut spécifier un parent pour les deux interruptions au niveau de DIRQL et interruptions au niveau passif.

Si votre pilote fournit EvtCleanupCallback ou EvtDestroyCallback fonctions de rappel pour l’objet d’interruption du framework, notez que l’infrastructure appelle ces fonctions de rappel à IRQL = PASSIVE_LEVEL.

Pour plus d’informations sur la gestion des interruptions dans les pilotes basés sur l’infrastructure, consultez Gestion des interruptions matérielles.

Exemples

L’exemple de code suivant initialise une structure WDF_INTERRUPT_CONFIG et une structure WDF_OBJECT_ATTRIBUTES, puis appelle WdfInterruptCreate.

NTSTATUS  status;
WDF_INTERRUPT_CONFIG  interruptConfig;
WDF_OBJECT_ATTRIBUTES  interruptAttributes;

WDF_INTERRUPT_CONFIG_INIT(
                          &interruptConfig,
                          MyEvtInterruptIsr,
                          MyEvtInterruptDpc
                          );
WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(
                                        &interruptAttributes,
                                        INTERRUPT_DATA
                                        );
status = WdfInterruptCreate(
                            device,
                            &interruptConfig,
                            &interruptAttributes,
                            &devExt->WdfInterrupt
                            );

Spécifications

Voir aussi

EvtDriverDeviceAdd

WDF_INTERRUPT_CONFIG

WDF_INTERRUPT_CONFIG_INIT

WDF_OBJECT_ATTRIBUTES

WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE