EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO fonction de rappel (sercx.h)

Article
08/07/2023

La fonction de rappel d’événement EvtSerCx2PioTransmitPurgeFifo 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 le fiFO de transmission dans le contrôleur série.

Syntaxe

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO EvtSercx2PioTransmitPurgeFifo;

void EvtSercx2PioTransmitPurgeFifo(
  [in] SERCX2PIOTRANSMIT PioTransmit,
  [in] ULONG BytesAlreadyTransmittedToHardware
)
{...}

Paramètres

[in] PioTransmit

Handle SERCX2PIOTRANSMIT à un objet de transmission PIO. Le pilote du contrôleur série a précédemment appelé la méthode SerCx2PioTransmitCreate pour créer cet objet.

[in] BytesAlreadyTransmittedToHardware

Nombre d’octets qui ont déjà été chargés dans le FIFO de transmission au cours de la transaction de transmission PIO actuelle. Ce paramètre est la somme de tous les octets transférés dans les appels précédents à la fonction de rappel d’événement EvtSerCx2PioTransmitWriteBuffer qui font partie de cette transaction.

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 SerCx2PioTransmitCreate qui crée l’objet PIO-transmit.

Votre pilote doit implémenter une fonction EvtSerCx2PioTransmitPurgeFifo 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 EvtSerCx2PioTransmitDrainFifo et EvtSerCx2PioTransmitCancelDrainFifo .

SerCx2 lance une transaction de transmission piO en réponse à une demande d’écriture (IRP_MJ_WRITE) d’un client. Si cette requête expire ou est annulée avant sa fin, SerCx2 appelle la fonction EvtSerCx2PioTransmitPurgeFifo , si elle est implémentée, pour vider toutes les données non envoyées susceptibles de rester le FIFO de transmission.

Une fois le FIFO de transmission purgé, la fonction EvtSerCx2PioTransmitPurgeFifo doit appeler la méthode SerCx2PioTransmitPurgeFifoComplete pour informer SerCx2 que le FIFO a été vidé, puis SerCx2 termine la demande d’écriture.

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

Exemples

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

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO  MyPioTransmitPurgeFifo;

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

_Use_decl_annotations_
VOID
  MyPioTransmitPurgeFifo(
    SERCX2PIOTRANSMIT  PioTransmit,
    ULONG  BytesAlreadyTransmittedToHardware

    )
  {...}

Le type de fonction EVT_SERCX2_PIO_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_PIO_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.