EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO fonction de rappel (sercx.h)

Article
03/01/2024

La fonction de rappel d’événement EvtSerCx2SystemDmaTransmitCancelDrainFifo est appelée par la version 2 de l’extension de l’infrastructure série (SerCx2) pour annuler une demande précédente visant à drainer le FIFO de transmission dans le matériel du contrôleur série.

Syntaxe

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2SystemDmaTransmitCancelDrainFifo;

BOOLEAN EvtSercx2SystemDmaTransmitCancelDrainFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit
)
{...}

Paramètres

[in] SystemDmaTransmit

Un SERCX2SYSTEMDMATRANSMIT handle à un objet de transmission système-DMA. Le pilote de contrôleur série a précédemment appelé la méthode SerCx2SystemDmaTransmitCreate pour créer cet objet.

Valeur retournée

La fonction EvtSerCx2SystemDmaTransmitCancelDrainFifo retourne TRUE si elle annule correctement la demande de drain en attente, et le pilote du contrôleur série peut garantir qu’il n’appellera pas la méthode SerCx2SystemDmaTransmitDrainFifoComplete pour informer SerCx2 que le FIFO est vidé. Sinon, cette fonction retourne FALSE pour indiquer que le pilote a déjà appelé ou est sur le point d’appeler SerCx2SystemDmaTransmitDrainFifoComplete.

Remarques

Votre pilote de contrôleur série peut, en option, implémenter cette fonction. S’il est implémenté, le pilote inscrit la fonction dans l’appel SerCx2SystemDmaTransmitCreate qui crée l’objet system-DMA-transmit.

Votre pilote doit implémenter une fonction EvtSerCx2SystemDmaTransmitCancelDrainFifo si le contrôleur série dispose d’un fiFO matériel (ou d’un mécanisme de mise en mémoire tampon similaire) pour contenir les données de transmission. Si votre pilote implémente cette fonction, il doit également implémenter les fonctions de rappel d’événements EvtSerCx2SystemDmaTransmitDrainFifo et EvtSerCx2SystemDmaTransmitPurgeFifo .

Une fois que SerCx2 a appelé la fonction de rappel d’événement EvtSerCx2SystemDmaTransmitDrainFifo pour demander que le pilote de contrôleur série vide le FIFO de transmission, SerCx2 peut appeler la fonction EvtSerCx2SystemDmaTransmitCancelDrainFifo pour annuler la demande de drain en attente avant que le FIFO ne termine le drainage. Par exemple, SerCx2 peut appeler la fonction EvtSerCx2SystemDmaTransmitCancelDrainFifo si le client annule la demande d’écriture (IRP_MJ_WRITE) en attente ou si la demande d’écriture expire.

Pour plus d’informations, consultez Transactions SerCx2 System-DMA-Transmit.

Exemples

Pour définir une fonction de rappel EvtSerCx2SystemDmaTransmitCancelDrainFifo , 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 EvtSerCx2SystemDmaTransmitCancelDrainFifo nommée MySystemDmaTransmitCancelDrainFifo, utilisez le type de fonction EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO , comme indiqué dans cet exemple de code :

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO  MySystemDmaTransmitCancelDrainFifo;

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

_Use_decl_annotations_
BOOLEAN
  MySystemDmaTransmitCancelDrainFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit
    )
  {...}

Le type de fonction EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO est défini dans le fichier d’en-tête Sercx.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 EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO 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	Disponible à partir de Windows 8.1.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	sercx.h
IRQL	Appelé à IRQL <= DISPATCH_LEVEL.