EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION fonction de rappel (sercx.h)

Article
10/30/2024

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

Syntaxe

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION EvtSercx2SystemDmaReceiveCancelNewDataNotification;

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

Paramètres

[in] SystemDmaReceive

Handle SERCX2SYSTEMDMARECEIVE à un objet de réception système-DMA. Le pilote du contrôleur série a précédemment appelé la méthode SerCx2SystemDmaReceiveCreate pour créer cet objet.

Valeur de retour

La fonction EvtSerCx2SystemDmaReceiveCancelNewDataNotification retourne TRUE si la notification new-data a été correctement annulée et que 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 FAUX si le pilote a déjà appelé la méthode SerCx2SystemDmaReceiveNewDataNotification ou s’apprête à appeler cette méthode.

Remarques

Votre pilote de contrôleur série peut, en tant qu’option, implémenter cette fonction. Si elle est implémentée, 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 pendant qu’une demande de notification new-data est en attente, SerCx2 appelle la EvtSerCx2SystemDmaReceiveCancelNewDataNotification fonction pour annuler la notification en attente. Si cet appel retourne faux, SerCx2 attend que le pilote du contrôleur série appelle SerCx2SystemDmaReceiveNewDataNotification; Seulement après cet appel, SerCx2 appelle la fonction EvtSerCx2SystemDmaReceiveCleanupTransaction, si elle est implémentée, et terminez la requête.

Pour annuler la notification new-data, la fonction EvtSerCx2SystemDmaReceiveCancelNewDataNotification désactive généralement l’interruption dans le contrôleur série qui indique que d’autres 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 système SerCx2DMA-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 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 EvtSerCx2SystemDmaReceiveCancelNewDataNotification nommée MySystemDmaReceiveCancelNewDataNotification, utilisez le type de fonction EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION, comme illustré 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 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_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 annoter le comportement de la fonction.