EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événement EvtSerCx2SystemDmaTransmitPurgeFifo est appelée par la version 2 de l’extension de framework série (SerCx2) pour ignorer les octets de données non jointes qui restent dans le fiFO de transmission 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

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.

[in] BytesAlreadyTransmittedToHardware

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

Valeur de retour

Aucun

Remarques

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

Votre pilote doit implémenter une fonction EvtSerCx2SystemDmaTransmitPurgeFifo si le contrôleur série a un mécanisme fiFO matériel (ou 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 la EvtSerCx2SystemDmaTransmitDrainFifo et EvtSerCx2SystemDmaTransmitCancelDrainFifo fonctions de rappel d’événements.

Si une requête d’écriture en attente (IRP_MJ_WRITE) expire ou est annulée, SerCx2 peut avoir besoin d’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 de données de la mémoire tampon d’écriture vers la 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 avertir SerCx2 que la FIFO a été vidée et SerCx2 termine la demande d’écriture.

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

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 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 EvtSerCx2SystemDmaTransmitPurgeFifo nommée MySystemDmaTransmitPurgeFifo, utilisez le type de fonction EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO, comme illustré 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 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_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 annoter le comportement de la fonction.