EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événement EvtSerCx2SystemDmaTransmitCancelDrainFifo est appelée par la version 2 de l’extension de framework série (SerCx2) pour annuler une demande précédente pour vider la 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

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

La fonction EvtSerCx2SystemDmaTransmitCancelDrainFifo retourne TRUE si elle annule correctement la demande de drainage en attente, et le pilote du contrôleur série peut garantir qu’il n’appellera pas la SerCx2SystemDmaTransmitDrainFiComfoplete méthode pour avertir SerCx2 que la FIFO est drainée. 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 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 EvtSerCx2SystemDmaTransmitCancelDrainFifo si le 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. Si votre pilote implémente cette fonction, il doit également implémenter la EvtSerCx2SystemDmaTransmitDrainFifo et EvtSerCx2SystemDmaTransmitPurgeFifo fonctions de rappel d’événements.

Une fois que SerCx2 appelle la fonction de rappel d’événement EvtSerCx2SystemDmaTransmitDrainFifo demande que le pilote du contrôleur série vide la fiFO de transmission, SerCx2 peut appeler la fonction EvtSerCx2SystemDmaTransmitCancelDrainFifo pour annuler la demande de drainage en attente avant la fin du drainage fiFO. Par exemple, SerCx2 peut appeler la fonction EvtSerCx2SystemDmaTransmitCancelDrainFifo si le client annule la requête d’écriture en attente (IRP_MJ_WRITE) ou si la demande d’écriture expire.

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

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 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 EvtSerCx2SystemDmaTransmitCancelDrainFifo appelée MySystemDmaTransmitCancelDrainFifo, utilisez le type de fonction EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO, comme illustré 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 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_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 annoter le comportement de la fonction.