EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO fonction de rappel (sercx.h)

Article
10/30/2024

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

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.

Valeur de retour

La fonction EvtSerCx2PioTransmitCancelDrainFifo 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 méthode SerCx2PioTransmitDrainFifoComplete pour avertir SerCx2 que la FIFO est vidée. 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 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 EvtSerCx2PioTransmitCancelDrainFifo 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 l'EvtSerCx2PioTransmitDrainFifo et EvtSerCx2PioTransmitPurgeFifo fonctions de rappel d’événement.

SerCx2 appelle la fonction de rappel d’événement EvtSerCx2PioTransmitDrainFifo demander au pilote du 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 une durée indéfinie pour se terminer. 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 EvtSerCx2PioTransmitCancelDrainFifo fonction pour annuler l’opération de drainage en attente avant qu’elle ne se termine.

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

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 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 EvtSerCx2PioTransmitCancelDrainFifo nommée MyPioTransmitCancelDrainFifo, utilisez le type de fonction EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO, comme illustré 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 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_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.