EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO fonction de rappel (sercx.h)

Article
02/26/2024

La fonction de rappel d’événement EvtSerCx2SystemDmaTransmitPurgeFifo est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour ignorer tous les octets de données non transmises qui restent dans la transmission FIFO dans le matériel du contrôleur série.

Syntaxe

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO EvtSercx2SystemDmaTransmitPurgeFifo;

void EvtSercx2SystemDmaTransmitPurgeFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit,
  [in] ULONG BytesAlreadyTransmittedToHardware
)
{...}

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.

[in] BytesAlreadyTransmittedToHardware

Nombre d’octets qui ont déjà été chargés dans le fiFO de transmission pendant la transaction système-DMA-transmit actuelle.

Valeur de retour

None

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 EvtSerCx2SystemDmaTransmitPurgeFifo 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 EvtSerCx2SystemDmaTransmitCancelDrainFifo .

Si une requête d’écriture (IRP_MJ_WRITE) en attente expire ou est annulée, SerCx2 peut devoir arrêter la transaction système-DMA actuelle avant qu’elle ne se termine. Une fois la transaction terminée, SerCx2 appelle la fonction EvtSerCx2SystemDmaTransmitPurgeFifo , si elle est implémentée.

La fonction EvtSerCx2SystemDmaTransmitPurgeFifo arrête le transfert des données de la mémoire tampon d’écriture vers le FIFO de transmission et ignore toutes les données précédemment transférées qui restent dans le FIFO. Une fois la transaction de transmission terminée, le pilote doit appeler la méthode SerCx2SystemDmaTransmitPurgeFifoComplete pour notifier SerCx2 que le FIFO a été vidé, puis SerCx2 termine la demande d’écriture.

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

Exemples

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO  MySystemDmaTransmitPurgeFifo;

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

_Use_decl_annotations_
VOID
  MySystemDmaTransmitPurgeFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit,
    ULONG BytesAlreadyTransmittedToHardware
    )
  {...}

Le type de fonction EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_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_PURGE_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.