EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événements EvtSerCx2SystemDmaTransmitDrainFifo est appelée par la version 2 de l’extension de framework série (SerCx2) pour vider 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 du contrôleur série a précédemment appelé la méthode SerCx2SystemDmaTransmitCreate pour créer cet objet.

Valeur de retour

Aucun

Remarques

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

SerCx2 appelle la fonction EvtSerCx2SystemDmaTransmitDrainFifo, si elle est implémentée, pour vider 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 la FIFO sont transmis à l’appareil 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 du contrôleur série implémente une requête EvtSerCx2SystemDmaTransmitDrainFifo, SerCx2 ne termine pas une requête d’écriture en attente (IRP_MJ_WRITE) jusqu’à ce que le pilote appelle SerCx2SystemDmaTransmitDrainFifoComplete.

Si votre contrôleur série dispose d’un système FIFO matériel (ou mécanisme de mise en mémoire tampon similaire) pour contenir les données de transmission, votre pilote doit implémenter une fonction EvtSerCx2SystemDmaTransmitDrainFifo. Sinon, SerCx2 ne peut pas confirmer que la transmission FIFO a été vidée avant la fin de la demande d’écriture en attente. Au lieu de cela, SerCx2 termine cette requête une fois que le dernier octet dans la mémoire tampon d’écriture est écrit dans la 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 la FIFO une fois la demande d’écriture terminée peuvent être perdues avant de pouvoir être transmises à l’appareil 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 périphérique.

Pour plus d’informations, consultez système SerCx2DMA-Transmit Transactions.

Exemples

Pour définir une fonction de rappel EvtSerCx2SystemDmaTransmitDrainFifo fonction de rappel, 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 fonctions de rappel permet d'Analyse du code pour les pilotes, static Driver Verifier (SDV) et d’autres outils de vérification recherchent des erreurs, et il est nécessaire d’écrire des pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction de rappel EvtSerCx2SystemDmaTransmitDrainFifo appelée MySystemDmaTransmitDrainFifo, utilisez le type de fonction EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO, comme illustré 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 lorsque vous exécutez les 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 annoter le comportement de la fonction.