EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION fonction de rappel (sercx.h)

Article
02/26/2024

La fonction de rappel d’événement EvtSerCx2PioTransmitEnableReadyNotification est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour permettre au pilote du contrôleur série de notifier SerCx2 lorsque le FIFO de transmission dans le contrôleur série est prêt à accepter davantage de données.

Syntaxe

EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION EvtSercx2PioTransmitEnableReadyNotification;

void EvtSercx2PioTransmitEnableReadyNotification(
  [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 doit implémenter cette fonction. Le pilote inscrit la fonction dans l’appel SerCx2PioTransmitCreate qui crée l’objet de transmission PIO.

Si la notification ready pour les transactions de transmission PIO est activée, le pilote du contrôleur série doit appeler la méthode SerCx2PioTransmitReady pour notifier SerCx2 lorsque le pilote détecte que le fichier FIFO de transmission dans le matériel du contrôleur série est prêt à accepter davantage de données. Si le FIFO de transmission est prêt à accepter des données lorsque la notification prête est activée, le pilote appelle immédiatement cette méthode pour notifier SerCx2.

La notification prête pour une transaction de transmission piO est une notification en une seule fois. Après avoir envoyé une notification prête à SerCx2, le pilote du contrôleur série n’envoie aucune autre notification jusqu’à ce que SerCx2 appelle la fonction EvtSerCx2PioTransmitEnableReadyNotification pour activer une autre notification.

Un appel de fonction EvtSerCx2PioTransmitWriteBuffer peut uniquement terminer partiellement une transaction de transmission PIO, car plus de place n’est disponible immédiatement dans le FIFO de transmission pour écrire plus de données. Dans ce cas, SerCx2 appelle la fonction EvtSerCx2PioTransmitEnableReadyNotification pour activer une notification prête. Dans ce cas, le pilote du contrôleur série doit notifier SerCx2 lorsque le FIFO de transmission a de la place pour plus de données. En réponse à cette notification, SerCx2 reprend la transaction de transmission partiellement terminée en appelant à nouveau la fonction EvtSerCx2PioTransmitWriteBuffer .

En règle générale, une fonction EvtSerCx2PioTransmitEnableReadyNotification active une interruption qui se produit lorsque le fichier FIFO de transmission dans le contrôleur série est prêt à accepter davantage de données. En réponse à cette interruption, le pilote du contrôleur série appelle SerCx2PioTransmitReady.

Pas plus d’une notification prête peut être en attente à la fois. SerCx2 n’appelle jamais la fonction EvtSerCx2PioTransmitEnableReadyNotification si la notification prête est déjà activée.

SerCx2 n’appelle jamais la fonction EvtSerCx2PioTransmitWriteBuffer lorsque la notification ready est activée.

Une notification prête en attente peut être annulée si la demande d’écriture associée expire ou est annulée. Pour annuler une notification prête pour une transaction de transmission PIO, SerCx2 appelle la fonction de rappel d’événement EvtSerCx2PioTransmitCancelReadyNotification .

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

Exemples

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

EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION  MyPioTransmitEnableReadyNotification;

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

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

Le type de fonction EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION 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_ENABLE_READY_NOTIFICATION 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.