EVT_SERCX2_PIO_TRANSMIT_DRAIN_FIFO fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événements EvtSerCx2PioTransmitDrainFifo est appelée par la version 2 de l’extension de framework série (SerCx2) pour vider 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

Aucun

Remarques

Votre pilote de contrôleur série peut, en tant qu’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 de transmission PIO.

SerCx2 appelle la fonction EvtSerCx2PioTransmitDrainFifo, si elle est implémentée, pour vider 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 la fiFO de transmission sont transmis à l’appareil 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 requête EvtSerCx2PioTransmitDrainFifo, SerCx2 ne termine pas une requête d’écriture en attente (IRP_MJ_WRITE) tant que le pilote n’appelle SerCx2PioTransmitDrainFifoComplete.

Si votre contrôleur série dispose d’un système FIFO matériel (ou d’un mécanisme de mise en mémoire tampon similaire) pour contenir les données de transmission, votre pilote doit implémenter une fonction EvtSerCx2PioTransmitDrainFifo. Sinon, SerCx2 ne peut pas confirmer que la transmission FIFO a été vidée avant la fin de la demande d’écriture en attente. Au lieu de cela, SerCx2 termine cette requête une fois que le dernier octet dans la mémoire tampon d’écriture est écrit dans la 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 la FIFO une fois la demande d’écriture terminée peuvent être perdues avant de pouvoir être transmises à l’appareil 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 périphérique.

Par exemple, un pilote périphérique peut envoyer des demandes d’écriture à un port série auquel un périphérique est connecté. Tant que toutes les demandes d’écriture en attente ne sont pas terminées, ce pilote doit retarder l’envoi d’un IOCTL pour modifier le taux de baud auquel le port série transmet les données. Toutefois, si aucune fonction EvtSerCx2PioTransmitDrainFifo est implémentée, une demande d’écriture pour transmettre 100 octets de données peut être terminée alors que 50 octets de données restent dans la fiFO de transmission. Si le pilote 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 à la nouvelle vitesse de baud, provoquant une erreur.

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

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

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 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 EvtSerCx2PioTransmitDrainFifo nommée MyPioTransmitDrainFifo, utilisez le type de fonction EVT_SERCX2_PIO_TRANSMIT_DRAIN_FIFO, comme illustré 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 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_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.