EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_INITIALIZE fonction de rappel (sercx.h)

Article
02/26/2024

La fonction de rappel d’événement EvtSerCx2CustomTransmitTransactionInitialize est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour préparer le pilote de contrôleur série à effectuer une transaction de transmission personnalisée.

Syntaxe

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_INITIALIZE EvtSercx2CustomTransmitTransactionInitialize;

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

Paramètres

[in] CustomTransmitTransaction

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

[in] Mdl

Pointeur vers un MDL qui décrit les pages de 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 .

[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 peut, en option, implémenter cette fonction. S’il est implémenté, le pilote inscrit la fonction dans l’appel SerCx2CustomTransmitTransactionCreate qui crée l’objet de transmission personnalisée.

Votre pilote doit implémenter une fonction EvtSerCx2CustomTransmitTransactionInitialize s’il doit initialiser le contrôleur série et le matériel associé en préparation d’une nouvelle transaction de transmission personnalisée. SerCx2 appelle cette fonction, si elle est implémentée, avant de démarrer la transaction de transmission personnalisée. En réponse à cet appel, le pilote de contrôleur série doit appeler la méthode SerCx2CustomTransmitTransactionInitializeComplete pour notifier SerCx2 une fois l’initialisation terminée.

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

Exemples

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

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_INITIALIZE  MyCustomTransmitTransactionInitialize;

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

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

Le type de fonction EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_INITIALIZE 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_INITIALIZE 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.