EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événement EvtSerCx2SystemDmaReceiveEnableNewDataNotification est appelée par la version 2 de l’extension de framework 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_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION EvtSercx2SystemDmaReceiveEnableNewDataNotification;

void EvtSercx2SystemDmaReceiveEnableNewDataNotification(
  [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

Aucun

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.

Une fois que la fonction EvtSerCx2SystemDmaReceiveEnableNewDataNotification est appelée pour activer une notification new-data pour une transaction system-DMA-receive, le pilote du contrôleur série doit appeler la méthode SerCx2SystemDmaReceiveNewDataNotification pour notifier SerCx2 lorsque le pilote détecte qu’un ou plusieurs octets de données reçues sont prêts à être transférés ou ont déjà été transférés par le contrôleur DMA système.

La notification new-data activée par la fonction EvtSerCx2SystemDmaReceiveEnableNewDataNotification est une notification ponctuelle. Une fois cette fonction appelée et que le pilote du contrôleur série envoie une notification new-data à SerCx2, aucune notification supplémentaire n’est envoyée tant que SerCx2 n’appelle à nouveau la fonction pour activer une autre notification.

La fonction EvtSerCx2SystemDmaReceiveEnableNewDataNotification permet généralement de déclencher une interruption lorsque le contrôleur série reçoit les données de l’appareil périphérique.

Aucune notification de nouvelle donnée ne peut être en attente à la fois. Une fois que SerCx2 appelle la fonction EvtSerCx2SystemDmaReceiveEnableNewDataNotification pour activer une notification new-data, SerCx2 n’appelle pas cette fonction tant que le pilote du contrôleur n’appelle SerCx2SystemDmaReceiveNewDataNotification.

Une notification de nouvelles données en attente peut être annulée si la demande de lecture associée expire ou est annulée. Pour annuler une notification new-data pour une transaction system-DMA-receive, SerCx2 appelle la fonction de rappel d’événement EvtSerCx2SystemDmaReceiveCancelNewDataNotification. Un pilote qui implémente une fonction EvtSerCx2SystemDmaReceiveEnableNewDataNotification doit également implémenter une fonction EvtSerCx2SystemDmaReceiveCancelNewDataNotification.

SerCx2 utilise des notifications de nouvelles données pour gérer efficacement les délais d’expiration d’intervalle qui se produisent pendant la gestion des demandes de lecture traitées en tant que transactions de réception système-DMA.

Pour plus d’informations, consultez système SerCx2DMA-Receive Transactions.

Exemples

Pour définir une fonction de rappel EvtSerCx2SystemDmaReceiveEnableNewDataNotification, 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 EvtSerCx2SystemDmaReceiveEnableNewDataNotification fonction de rappel nommée MySystemDmaReceiveEnableNewDataNotification, utilisez le type de fonction EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION, comme illustré dans cet exemple de code :

EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION  MySystemDmaReceiveEnableNewDataNotification;

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

_Use_decl_annotations_
VOID
  MySystemDmaReceiveEnableNewDataNotification(
    SERCX2SYSTEMDMARECEIVE  SystemDmaReceive
    )
  {...}

Le type de fonction EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_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_ENABLE_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.