EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION fonction de rappel (sercx.h)

Article
02/26/2024

La fonction de rappel d’événement EvtSerCx2SystemDmaReceiveCancelNewDataNotification est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour annuler une notification de nouvelles données activée par SerCx2 dans un appel précédent à la fonction de rappel d’événement EvtSerCx2SystemDmaReceiveEnableNewDataNotification .

Syntaxe

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION EvtSercx2SystemDmaReceiveCancelNewDataNotification;

BOOLEAN EvtSercx2SystemDmaReceiveCancelNewDataNotification(
  [in] SERCX2SYSTEMDMARECEIVE SystemDmaReceive
)
{...}

Paramètres

[in] SystemDmaReceive

Un handle SERCX2SYSTEMDMARECEIVE à un objet system-DMA-receive. Le pilote de contrôleur série a précédemment appelé la méthode SerCx2SystemDmaReceiveCreate pour créer cet objet.

Valeur retournée

La fonction EvtSerCx2SystemDmaReceiveCancelNewDataNotification retourne TRUE si la notification de nouvelles données a été annulée et si le pilote du contrôleur série peut garantir que cette notification n’entraîne pas l’appel de la méthode SerCx2SystemDmaReceiveNewDataNotification . La fonction retourne FALSE si le pilote a déjà appelé la méthode SerCx2SystemDmaReceiveNewDataNotification ou est sur le point d’appeler cette méthode.

Remarques

Votre pilote de contrôleur série peut, en option, implémenter cette fonction. S’il est implémenté, le pilote inscrit la fonction dans l’appel SerCx2SystemDmaReceiveCreate qui crée l’objet system-DMA-receive. Un pilote qui implémente cette fonction doit également implémenter une fonction de rappel d’événement EvtSerCx2SystemDmaReceiveEnableNewDataNotification .

Si la demande de lecture associée expire ou est annulée alors qu’une demande de notification de nouvelles données est en attente, SerCx2 appelle la fonction EvtSerCx2SystemDmaReceiveCancelNewDataNotification pour annuler la notification en attente. Si cet appel retourne FALSE, SerCx2 s’attend à ce que le pilote du contrôleur série appelle SerCx2SystemDmaReceiveNewDataNotification ; ce n’est qu’après cet appel que SerCx2 appelle la fonction EvtSerCx2SystemDmaReceiveCleanupTransaction , si elle est implémentée, et termine la demande.

Pour annuler la notification de nouvelles données, la fonction EvtSerCx2SystemDmaReceiveCancelNewDataNotification désactive généralement l’interruption dans le contrôleur série qui indique que davantage de données sont disponibles pour être lues à partir du fiFO de réception. Cette interruption a été activée par un appel précédent à la fonction EvtSerCx2SystemDmaReceiveEnableNewDataNotification .

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

Exemples

Pour définir une fonction de rappel EvtSerCx2SystemDmaReceiveCancelNewDataNotification , 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 aide l’analyse du code pour les pilotes, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification à la recherche d’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 EvtSerCx2SystemDmaReceiveCancelNewDataNotification nommée MySystemDmaReceiveCancelNewDataNotification, utilisez le type de fonction EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION , comme indiqué dans cet exemple de code :

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION  MySystemDmaReceiveCancelNewDataNotification;

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

_Use_decl_annotations_
BOOLEAN
  MySystemDmaReceiveCancelNewDataNotification(
    SERCX2SYSTEMDMARECEIVE  SystemDmaReceive
    )
  {...}

Le type de fonction EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_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_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_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.