EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événement EvtSerCx2PioTransmitPurgeFifo est appelée par la version 2 de l’extension de framework série (SerCx2) pour ignorer 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 pendant la transaction piO-transmission actuelle. Ce paramètre correspond à la somme de tous les octets transférés dans les appels précédents à la fonction de rappel d’événements EvtSerCx2PioTransmitWriteBuffer qui font partie de cette transaction.

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

Votre pilote doit implémenter une fonction EvtSerCx2PioTransmitPurgeFifo si le contrôleur série a un mécanisme de mise en mémoire tampon (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 les fonctions de rappel d’événements EvtSerCx2PioTransmitDrainFifo et EvtSerCx2PioTransmitCancelDrainFifo.

SerCx2 lance une transaction de transmission d’authentification unique en réponse à une requête 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 les données non contenues susceptibles de rester la fonction FIFO de transmission.

Une fois que la fonction FIFO de transmission est vidée, la fonction EvtSerCx2PioTransmitPurgeFifo doit appeler la fonction SerCx2PioTransmitPurgeFifoComplete pour avertir SerCx2 que la FIFO a été purgée, puis SerCx2 termine la requête d’écriture.

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

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