EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO fonction de rappel (sercx.h)

Article
02/26/2024

La fonction de rappel d’événement EvtSerCx2SystemDmaTransmitDrainFifo est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour drainer le FIFO de transmission dans le matériel du contrôleur série.

Syntaxe

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO EvtSercx2SystemDmaTransmitDrainFifo;

void EvtSercx2SystemDmaTransmitDrainFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit
)
{...}

Paramètres

[in] SystemDmaTransmit

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

Valeur de retour

None

Remarques

Votre pilote de contrôleur série peut, en option, implémenter cette fonction. Si votre pilote implémente cette fonction, il doit également implémenter les fonctions de rappel d’événements EvtSerCx2SystemDmaTransmitCancelDrainFifo et EvtSerCx2SystemDmaTransmitPurgeFifo . Un pilote qui implémente ces fonctions les inscrit dans l’appel SerCx2SystemDmaTransmitCreate qui crée l’objet system-DMA-transmit.

SerCx2 appelle la fonction EvtSerCx2SystemDmaTransmitDrainFifo , si elle est implémentée, pour drainer le fiFO de transmission dans le matériel du contrôleur série à la fin d’une transaction de transmission système DMA. Cette fonction garantit que tous les octets de données qui restent dans le FIFO sont transmis au périphérique connecté en série. Une fois le dernier octet transmis à partir du FIFO, la fonction EvtSerCx2SystemDmaTransmitDrainFifo appelle la méthode SerCx2SystemDmaTransmitDrainFifoComplete pour notifier SerCx2.

Si le pilote de contrôleur série implémente une fonction EvtSerCx2SystemDmaTransmitDrainFifo , SerCx2 ne termine pas une demande d’écriture en attente (IRP_MJ_WRITE) tant que le pilote n’appelle pas SerCx2SystemDmaTransmitDrainFifoComplete.

Si votre contrôleur série dispose d’un fiFO matériel (ou d’un mécanisme de mise en mémoire tampon similaire) pour stocker les données de transmission, votre pilote doit implémenter une fonction EvtSerCx2SystemDmaTransmitDrainFifo . Sinon, SerCx2 ne peut pas confirmer que le FIFO de transmission a été vidé avant la fin de la demande d’écriture en attente. Au lieu de cela, SerCx2 termine cette requête après l’écriture du dernier octet dans la mémoire tampon d’écriture dans le FIFO de transmission. Il ne peut y avoir aucune garantie que les données écrites dans le FIFO de transmission seront transmises sans délai significatif. Toutes les données qui restent dans le FIFO une fois la demande d’écriture terminée peuvent être perdues avant qu’elles puissent être transmises au périphérique connecté en série. Cette perte de données inattendue dans une demande d’écriture réussie peut créer des problèmes de fiabilité pour le pilote de périphérique.

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

Exemples

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO  MySystemDmaTransmitDrainFifo;

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

_Use_decl_annotations_
VOID
  MySystemDmaTransmitDrainFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit
    )
  {...}

Le type de fonction EVT_SERCX2_SYSTEM_DMA_TRANSMIT_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_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.