EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO fonction de rappel (sercx.h)

Article
08/07/2023

La fonction de rappel d’événement EvtSerCx2PioTransmitCancelDrainFifo est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour annuler une demande précédente visant à vider le fiFO de transmission dans le matériel du contrôleur série.

Syntaxe

EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2PioTransmitCancelDrainFifo;

BOOLEAN EvtSercx2PioTransmitCancelDrainFifo(
  [in] SERCX2PIOTRANSMIT PioTransmit
)
{...}

Paramètres

[in] PioTransmit

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

Valeur retournée

La fonction EvtSerCx2PioTransmitCancelDrainFifo retourne TRUE si elle annule correctement la demande de drain en attente, et le pilote du contrôleur série peut garantir qu’il n’appellera pas la méthode SerCx2PioTransmitDrainFifoComplete pour notifier SerCx2 que le FIFO est vidé. Sinon, cette fonction retourne FALSE pour indiquer que le pilote a déjà appelé ou est sur le point d’appeler SerCx2PioTransmitDrainFifoComplete.

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 EvtSerCx2PioTransmitCancelDrainFifo 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 EvtSerCx2PioTransmitPurgeFifo .

SerCx2 appelle la fonction de rappel d’événement EvtSerCx2PioTransmitDrainFifo pour demander au pilote de contrôleur série de vider le FIFO de transmission, puis attend que le pilote du contrôleur série appelle SerCx2PioTransmitDrainFifoComplete. Une opération de drainage peut prendre un temps indéfini. Par conséquent, si la demande d’écriture expire ou est annulée pendant que l’opération de drainage est en cours, SerCx2 appelle la fonction EvtSerCx2PioTransmitCancelDrainFifo pour annuler l’opération de drainage en attente avant qu’elle ne se termine.

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

Exemples

Pour définir une fonction de rappel EvtSerCx2PioTransmitCancelDrainFifo , 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 aide l’analyse du code pour les pilotes, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification à la recherche d’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 EvtSerCx2PioTransmitCancelDrainFifo nommée MyPioTransmitCancelDrainFifo, utilisez le type de fonction EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO , comme indiqué dans cet exemple de code :

EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO  MyPioTransmitCancelDrainFifo;

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

_Use_decl_annotations_
BOOLEAN
  MyPioTransmitCancelDrainFifo(
    SERCX2PIOTRANSMIT  PioTransmit
    )
  {...}

Le type de fonction EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_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_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 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.