DMA_COMPLETION_ROUTINE fonction de rappel (wdm.h)

Article
02/29/2024

La routine de rappel DmaCompletionRoutine informe le pilote qui a précédemment demandé un transfert DMA système que ce transfert est terminé.

Syntaxe

DMA_COMPLETION_ROUTINE DmaCompletionRoutine;

void DmaCompletionRoutine(
  [in] PDMA_ADAPTER DmaAdapter,
  [in] PDEVICE_OBJECT DeviceObject,
  [in] PVOID CompletionContext,
  [in] DMA_COMPLETION_STATUS Status
)
{...}

Paramètres

[in] DmaAdapter

Pointeur vers une structure DMA_ADAPTER . Cette structure est l’objet adaptateur qui représente le canal DMA système du pilote.

[in] DeviceObject

Pointeur vers une structure DEVICE_OBJECT . Cette structure est l’objet d’appareil physique (PDO) qui représente l’appareil cible pour l’opération DMA demandée.

[in] CompletionContext

Pointeur vers un contexte déterminé par le pilote pour la routine DmaCompletionRoutine . Ce contexte est la valeur du paramètre CompletionContext que le pilote a précédemment passée à l’appel MapTransferEx qui a lancé le transfert DMA système.

[in] Status

Achèvement status du transfert DMA. Ce paramètre est une valeur d’énumération DMA_COMPLETION_STATUS qui indique si le transfert DMA s’est terminé avec succès.

Valeur de retour

None

Remarques

En option, un pilote peut implémenter une routine DmaCompletionRoutine . Lorsque le pilote demande un transfert DMA système, il peut fournir un pointeur vers cette routine avec la demande. Une fois le transfert DMA terminé, la routine DmaCompletionRoutine est automatiquement appelée pour avertir le pilote.

La routine DmaCompletionRoutine d’un pilote est appelée uniquement si le transfert DMA demandé par le pilote utilise un contrôleur DMA système qui peut générer une interruption une fois le transfert DMA terminé. Un pilote qui utilise un périphérique DMA master bus, ou qui utilise un contrôleur DMA système qui ne génère pas d’interruptions, doit utiliser d’autres moyens pour déterminer quand un transfert DMA se termine. Par exemple, ce pilote peut utiliser une interruption du minuteur pour interroger régulièrement la status du transfert DMA.

Un pilote peut fournir un pointeur vers une routine DmaCompletionRoutine en tant que paramètre facultatif pour la routine MapTransferEx .

Exemples

Pour définir une routine de rappel DmaCompletionRoutine , vous devez d’abord fournir une déclaration de fonction qui identifie le type de routine 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 routine de rappel DmaCompletionRoutine nommée MyDmaCompletionRoutine, utilisez le type DMA_COMPLETION_ROUTINE comme indiqué dans cet exemple de code :

DMA_COMPLETION_ROUTINE MyDmaCompletionRoutine;

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

_Use_decl_annotations_
VOID
  MyDmaCompletionRoutine(
    PDMA_ADAPTER DmaAdapter,
    PDEVICE_OBJECT DeviceObject,
    PVOID CompletionContext,
    DMA_COMPLETION_STATUS Status
    )
  {
      // Function body
  }

Le type de fonction DMA_COMPLETION_ROUTINE est défini dans le fichier d’en-tête Wdm.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 DMA_COMPLETION_ROUTINE 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 WDM. Pour plus d’informations sur _Use_decl_annotations_, consultez Annotating Function Behavior.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible à partir de Windows 8.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
IRQL	Appelé à DISPATCH_LEVEL.