EVT_SERCX2_PIO_TRANSMIT_DRAIN_FIFO fonction de rappel (sercx.h)

Article
08/07/2023

La fonction de rappel d’événement EvtSerCx2PioTransmitDrainFifo est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour drainer le FIFO de transmission dans le matériel du contrôleur série.

Syntaxe

EVT_SERCX2_PIO_TRANSMIT_DRAIN_FIFO EvtSercx2PioTransmitDrainFifo;

void EvtSercx2PioTransmitDrainFifo(
  [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

None

Remarques

Votre pilote de contrôleur série peut, en option, implémenter cette fonction. Si votre pilote implémente cette fonction, il doit également implémenter les fonctions de rappel d’événements EvtSerCx2PioTransmitCancelDrainFifo et EvtSerCx2PioTransmitPurgeFifo . Un pilote qui implémente ces fonctions les inscrit dans l’appel SerCx2PioTransmitCreate qui crée l’objet PIO-transmit.

SerCx2 appelle la fonction EvtSerCx2PioTransmitDrainFifo , si elle est implémentée, pour drainer le FIFO de transmission dans le matériel du contrôleur série à la fin d’une transaction de transmission PIO. Cette fonction garantit que tous les octets de données qui restent dans le fiFO de transmission sont transmis au périphérique connecté en série. Une fois le dernier octet transmis à partir du FIFO, la fonction EvtSerCx2PioTransmitDrainFifo appelle la méthode SerCx2PioTransmitDrainFifoComplete pour notifier SerCx2.

Si le pilote de contrôleur série implémente une fonction EvtSerCx2PioTransmitDrainFifo , SerCx2 ne termine pas une demande d’écriture en attente (IRP_MJ_WRITE) tant que le pilote n’appelle pas SerCx2PioTransmitDrainFifoComplete.

Si votre contrôleur série dispose d’un fiFO matériel (ou d’un mécanisme de mise en mémoire tampon similaire) pour stocker les données de transmission, votre pilote doit implémenter une fonction EvtSerCx2PioTransmitDrainFifo . Sinon, SerCx2 ne peut pas confirmer que le FIFO de transmission a été vidé avant la fin de la demande d’écriture en attente. Au lieu de cela, SerCx2 termine cette requête après l’écriture du dernier octet dans la mémoire tampon d’écriture dans le FIFO de transmission. Il ne peut y avoir aucune garantie que les données écrites dans le FIFO de transmission seront transmises sans délai significatif. Toutes les données qui restent dans le FIFO une fois la demande d’écriture terminée peuvent être perdues avant qu’elles puissent être transmises au périphérique connecté en série. Cette perte de données inattendue dans une demande d’écriture réussie peut créer des problèmes de fiabilité pour le pilote de périphérique.

Par exemple, un pilote de périphérique peut envoyer des demandes d’écriture à un port série auquel un périphérique est connecté. Jusqu’à ce que toutes les demandes d’écriture en suspens soient terminées, ce pilote doit retarder l’envoi d’un IOCTL pour modifier la vitesse de transmission des données par le port série. Toutefois, si aucune fonction EvtSerCx2PioTransmitDrainFifo n’est implémentée, une demande d’écriture pour transmettre 100 octets de données peut être effectuée alors que 50 octets de données restent dans le FIFO de transmission. Si le pilote de périphérique envoie ensuite un IOCTL pour définir un nouveau taux de bauds, certains des octets restants dans le FIFO peuvent être transmis au nouveau taux de bauds, ce qui provoque une erreur.

De même, si une demande d’écriture pour transmettre 100 octets de données est effectuée alors que 50 octets de données restent dans le fichier FIFO de transmission, et que le contrôleur série quitte D0 pour entrer dans un état de périphérique basse consommation avant que les octets restants dans le FIFO puissent être transmis, le pilote de périphérique ne sait pas que ces octets sont perdus.

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

Exemples

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

EVT_SERCX2_PIO_TRANSMIT_DRAIN_FIFO  MyPioTransmitDrainFifo;

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

_Use_decl_annotations_
VOID
  MyPioTransmitDrainFifo(
    SERCX2PIOTRANSMIT  PioTransmit
    )
  {...}

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