EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START fonction de rappel (sercx.h)

Article
02/29/2024

La fonction de rappel d’événement EvtSerCx2CustomReceiveTransactionStart est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour démarrer une transaction de réception personnalisée.

Syntaxe

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START EvtSercx2CustomReceiveTransactionStart;

void EvtSercx2CustomReceiveTransactionStart(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction,
  [in] WDFREQUEST Request,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

Paramètres

[in] CustomReceiveTransaction

Un handle SERCX2CUSTOMRECEIVETRANSACTION à un objet de transaction de réception personnalisée. Le pilote de contrôleur série a précédemment appelé la méthode SerCx2CustomReceiveTransactionCreate pour créer cet objet.

[in] Request

Handle de l’objet de demande d’infrastructure associé à la transaction de réception personnalisée. Le pilote est responsable de la réalisation de cette demande. Cette demande n’est peut-être pas la IRP_MJ_READ requête envoyée par le client, et par conséquent, le pilote de contrôleur série ne doit pas essayer d’utiliser cette demande pour accéder à la mémoire tampon de lecture. Cette demande est principalement utilisée pour l’annulation, l’achèvement et le transfert de file d’attente (si nécessaire). Pour accéder à la mémoire tampon de lecture pour la demande de lecture du client, utilisez les paramètres Mdl, Offset et Length .

[in] Mdl

Pointeur vers un MDL qui décrit les pages de mémoire qui sont étendues par la mémoire tampon de lecture pour la transaction de réception personnalisée. La liste de points/regroupements pour le transfert de données utilise la région de cette mémoire spécifiée par les paramètres Offset et Length .

[in] Offset

Décalage de départ pour le transfert de données. Ce paramètre est un décalage d’octet par rapport au début de la zone de mémoire tampon décrite par le MDL. Si le MDL spécifie un total de N octets d’espace tampon, les valeurs possibles de Décalage se trouvent dans la plage de 0 à N–1.

[in] Length

Taille, en octets, du transfert de données. Si le MDL spécifie un total de N octets d’espace tampon, les valeurs possibles de Length se trouvent dans la plage de 1 à N-Offset.

Valeur de retour

None

Remarques

Votre pilote de contrôleur série doit implémenter cette fonction s’il crée un objet de transaction de réception personnalisée. Le pilote inscrit la fonction dans l’appel SerCx2CustomReceiveTransactionCreate qui crée cet objet.

Une fois que SerCx2 a appelé la fonction EvtSerCx2CustomReceiveTransactionStart , le pilote de contrôleur série lance la transaction en programmant le mécanisme de transfert de données personnalisé pour déplacer les données du fiFO de réception dans le matériel du contrôleur série vers la mémoire tampon de la demande de lecture. À moins que la demande ne puisse être effectuée immédiatement, avant que la fonction EvtSerCx2CustomReceiveTransactionStart ne retourne, le pilote doit appeler une méthode telle que WdfRequestMarkCancelableEx pour marquer la demande comme annulable.

Une fois que la fonction EvtSerCx2CustomReceiveTransactionStart a démarré la transaction, SerCx2 appelle régulièrement la fonction de rappel d’événement EvtSerCx2CustomReceiveTransactionQueryProgress pour surveiller la progression effectuée par le pilote de contrôleur série dans l’exécution de cette transaction. Une fois la transaction terminée et que le pilote a terminé la demande de lecture en attente, SerCx2 appelle la fonction de rappel d’événement EvtSerCx2CustomReceiveTransactionCleanup , si le pilote implémente cette fonction.

Si le pilote de contrôleur série implémente une fonction de rappel d’événement EvtSerCx2CustomReceiveTransactionInitialize , SerCx2 appelle cette fonction avant d’appeler la fonction EvtSerCx2CustomReceiveTransactionStart . Juste avant l’appel EvtSerCx2CustomReceiveTransactionStart et après le retour de l’appel EvtSerCx2CustomReceiveTransactionInitialize , SerCx2 démarre le minuteur qui détecte si la demande de lecture expire. Pour plus d’informations, consultez la discussion sur les délais d’attente totaux dans SERIAL_TIMEOUTS.

Si le mécanisme de transfert de données personnalisé est un appareil DMA master bus, la fonction EvtSerCx2CustomReceiveTransactionStart peut appeler une méthode telle que WdfDmaTransactionInitializeUsingOffset pour lancer une transaction DMA qui utilise la mémoire tampon de lecture décrite par les paramètres Mdl, Offset et Length.

Si l’objet de requête identifié par le paramètre Request contient du stockage pour un contexte privé, ce stockage peut être non initialisé la première fois que le pilote de contrôleur série accède au contexte. Lors du premier accès, le pilote doit généralement remplir le contexte avec des zéros, puis, si nécessaire, définir explicitement tous les champs du contexte qui nécessitent des valeurs initiales différentes de zéro.

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

Exemples

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

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START  MyCustomReceiveTransactionStart;

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

_Use_decl_annotations_
VOID
  MyCustomReceiveTransactionStart(
    SERCX2CUSTOMRECEIVETRANSACTION  CustomReceiveTransaction,
    WDFREQUEST  Request,
    PMDL  Mdl,
    ULONG  Offset,
    ULONG  Length
    )
  {...}

Le type de fonction EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START 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_CUSTOM_RECEIVE_TRANSACTION_START 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.