EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START fonction de rappel (sercx.h)

Article
03/05/2024

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

Syntaxe

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START EvtSercx2CustomTransmitTransactionStart;

void EvtSercx2CustomTransmitTransactionStart(
  [in] SERCX2CUSTOMTRANSMITTRANSACTION CustomTransmitTransaction,
  [in] WDFREQUEST Request,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

Paramètres

[in] CustomTransmitTransaction

Handle SERCX2CUSTOMTRANSMITTRANSACTION à un objet de transaction de transmission personnalisée. Le pilote du contrôleur série a précédemment appelé la méthode SerCx2CustomTransmitTransactionCreate pour créer cet objet.

[in] Request

Handle pour l’objet de requête d’infrastructure associé à la transaction de transmission personnalisée. Le pilote est responsable de la réalisation de cette demande. Cette requête peut ne pas être la IRP_MJ_WRITE demande envoyée par le client. Par conséquent, le pilote du contrôleur série ne doit pas essayer d’utiliser cette requête pour accéder à la mémoire tampon d’écriture. Cette requête 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 d’écriture pour la demande d’écriture du client, utilisez les paramètres Mdl, Offset et Length .

[in] Mdl

Pointeur vers une MDL qui décrit les pages mémoire qui sont étendues par la mémoire tampon d’écriture pour la transaction de transmission personnalisée. La liste de points/regroupements pour le transfert DMA utilise la région de cette mémoire spécifiée par les paramètres Offset et Length . Pour plus d’informations sur les chaînes MDL, consultez Utilisation de MDL.

[in] Offset

Décalage de départ pour le transfert de données. Ce paramètre est un décalage d’octets à partir du début de la région de mémoire tampon décrite par la MDL. Si la MDL spécifie un total de N octets d’espace de mémoire tampon, les valeurs possibles de Décalage sont comprises entre 0 et N–1.

[in] Length

Taille, en octets, du transfert de données. Si la MDL spécifie un total de N octets d’espace de mémoire tampon, les valeurs possibles de Length sont comprises entre 1 et 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 transmission personnalisée. S’il est implémenté, le pilote inscrit la fonction dans l’appel SerCx2CustomTransmitTransactionCreate qui crée cet objet.

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

Une fois la transaction terminée et que le pilote a terminé la demande d’écriture en attente, SerCx2 appelle la fonction de rappel d’événement EvtSerCx2CustomTransmitTransactionCleanup , si le pilote implémente cette fonction.

Si le pilote de contrôleur série implémente une fonction de rappel d’événement EvtSerCx2CustomTransmitTransactionInitialize , SerCx2 appelle cette fonction avant d’appeler la fonction EvtSerCx2CustomTransmitTransactionStart . Juste avant l’appel EvtSerCx2CustomTransmitTransactionStart et une fois que l’appel EvtSerCx2CustomTransmitTransactionInitialize est retourné, SerCx2 démarre le minuteur qui détecte si la demande d’écriture expire. Pour plus d’informations, consultez la présentation des délais d’attente totaux dans SERIAL_TIMEOUTS.

Le pilote du contrôleur série doit terminer la demande d’écriture en attente uniquement après que le dernier octet du FIFO de transmission a été transmis au périphérique connecté en série. Il ne peut pas y avoir de garantie que les données écrites dans le FIFO de transmission seront transmises sans délai significatif, et un pilote de contrôleur série qui suppose qu’une telle garantie existe peut entraîner des problèmes de fiabilité pour les pilotes de périphérique.

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

Pour plus d’informations sur les paramètres Mdl, Offset et Length , consultez Remarques dans EvtSerCx2CustomTransmitTransactionInitialize.

Si l’objet de requête identifié par le paramètre Request contient un stockage pour un contexte privé, ce stockage peut être non initialisé la première fois que le pilote du 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 Custom-Transmit SerCx2.

Exemples

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

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START  MyCustomTransmitTransactionStart;

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

_Use_decl_annotations_
VOID
  MyCustomTransmitTransactionStart(
    SERCX2CUSTOMTRANSMITTRANSACTION  CustomTransmitTransaction,
    WDFREQUEST  Request,
    PMDL  Mdl,
    ULONG  Offset,
    ULONG  Length
    )
  {...}

Le type de fonction EVT_SERCX2_CUSTOM_TRANSMIT_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_TRANSMIT_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.