EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION fonction de rappel (sercx.h)

Article
02/26/2024

La fonction de rappel d’événement EvtSerCx2PioReceiveEnableReadyNotification 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 contrôleur série reçoit de nouvelles données.

Syntaxe

EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION EvtSercx2PioReceiveEnableReadyNotification;

void EvtSercx2PioReceiveEnableReadyNotification(
  [in] SERCX2PIORECEIVE PioReceive
)
{...}

Paramètres

[in] PioReceive

Handle SERCX2PIORECEIVE à un objet piO-receive. Le pilote de contrôleur série a précédemment appelé la méthode SerCx2PioReceiveCreate 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 SerCx2PioReceiveCreate qui crée l’objet PIO-receive.

Une fois que la fonction EvtSerCx2PioReceiveEnableReadyNotification est appelée pour activer une notification prête pour une transaction piO-receive, le pilote de contrôleur série doit appeler la méthode SerCx2PioReceiveReady pour informer SerCx2 lorsque le pilote détecte qu’un ou plusieurs octets de données sont disponibles pour être lus à partir du fiFO de réception dans le matériel du contrôleur série. Si des données sont déjà disponibles dans le fiFO de réception 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 piO-receive est une notification one-shot. 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 EvtSerCx2PioReceiveEnableReadyNotification pour activer une autre notification.

Un appel de fonction de rappel d’événement EvtSerCx2PioReceiveReadBuffer ne peut que partiellement terminer une transaction de réception PIO, car aucune donnée supplémentaire n’est immédiatement disponible pour être lue à partir du FIFO de réception. Dans ce cas, SerCx2 appelle la fonction EvtSerCx2PioReceiveEnableReadyNotification pour activer une notification prête. Dans ce cas, le pilote du contrôleur série doit notifier SerCx2 lorsque le fiFO de réception contient plus de données. En réponse à cette notification, SerCx2 reprend la transaction de réception partiellement terminée en appelant à nouveau la fonction EvtSerCx2PioReceiveReadBuffer .

En règle générale, une fonction EvtSerCx2PioReceiveEnableReadyNotification active une interruption qui se produit lorsque le contrôleur série a plus de données disponibles pour la lecture. En réponse à cette interruption, le pilote du contrôleur série appelle SerCx2PioReceiveReady.

Pas plus d’une notification prête peut être en attente à la fois. Une fois que SerCx2 a appelé la fonction EvtSerCx2PioReceiveEnableReadyNotification pour activer une notification prête, SerCx2 n’appelle plus cette fonction tant que le pilote du contrôleur n’appelle pas SerCx2PioReceiveReady.

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

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

SerCx2 utilise des notifications prêtes pour gérer efficacement les délais d’attente d’intervalles qui se produisent pendant la gestion des demandes de lecture qui sont traitées en tant que transactions piO-receive.

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

Exemples

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

EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION  MyPioReceiveEnableReadyNotification;

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

_Use_decl_annotations_
VOID
  MyPioReceiveEnableReadyNotification(
    SERCX2PIORECEIVE  PioReceive
    )
  {...}

Le type de fonction EVT_SERCX2_PIO_RECEIVE_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_RECEIVE_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.