EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événement EvtSerCx2CustomTransmitTransactionStart est appelée par la version 2 de l’extension de framework 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 transmission-transaction personnalisé. Le pilote du contrôleur série a précédemment appelé la méthode SerCx2CustomTransmitTransactionCreate pour créer cet objet.

[in] Request

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

[in] Mdl

Pointeur vers un 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 Longueur. Pour plus d’informations sur les chaînes MDL, consultez Utilisation de MDLs.

[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 le MDL. Si le MDL spécifie un total de N octets d’espace tampon, les valeurs possibles d'Offset se trouvent dans la plage 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 Longueur se trouvent dans la plage 1 à N –Offset.

Valeur de retour

Aucun

Remarques

Votre pilote de contrôleur série doit implémenter cette fonction s’il crée un objet de transmission-transaction personnalisé. Si elle est implémentée, le pilote inscrit la fonction dans l’appel SerCx2CustomTransmitTransactionCreate qui crée cet objet.

Une fois que SerCx2 appelle la fonction EvtSerCx2CustomTransmitTransactionStart, 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 requête d’écriture vers la transmission fiFO dans le matériel du contrôleur série. Sauf si la requête peut être effectuée immédiatement, avant que la fonction EvtSerCx2CustomTransmitTransactionStart retourne, le pilote doit appeler une méthode telle que WdfRequestMarkCancelableEx pour marquer la requête 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 du contrôleur série implémente une EvtSerCx2CustomTransmitTransactionInitialize fonction de rappel d’événement, SerCx2 appelle cette fonction avant d’appeler la fonction EvtSerCx2CustomTransmitTransactionStart. Juste avant l’appel EvtSerCx2CustomTransmitTransactionStart et après l’appel EvtSerCx2CustomTransmitTransactionInitialize appel retourne, SerCx2 démarre le minuteur qui détecte si la demande d’écriture expire. Pour plus d’informations, consultez la discussion sur le délai d’attente total dans SERIAL_TIMEOUTS.

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

Si le mécanisme de transfert de données personnalisé est un appareil DMA maître de 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 la Mdl, Offsetet paramètres Length.

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

Si l’objet de requête identifié par le paramètre de demande de 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 dans le contexte qui nécessitent des valeurs initiales différente de zéro.

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

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 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 EvtSerCx2CustomTransmitTransactionStart nommée MyCustomTransmitTransactionStart, utilisez le type de fonction EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START, comme illustré 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 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_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 annoter le comportement de la fonction.