EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE fonction de rappel (sercx.h)

Article
02/27/2024

La fonction de rappel d’événement EvtSerCx2CustomReceiveTransactionInitialize est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour préparer le matériel du contrôleur série à effectuer une nouvelle transaction de réception personnalisée.

Syntaxe

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE EvtSercx2CustomReceiveTransactionInitialize;

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

Paramètres

[in] CustomReceiveTransaction

Handle SERCX2CUSTOMRECEIVETRANSACTION à un objet custom-receive-transaction. Le pilote du contrôleur série a précédemment appelé la méthode SerCx2CustomReceiveTransactionCreate pour créer cet objet.

[in] Mdl

Pointeur vers une MDL qui décrit les pages de mémoire qui sont couvertes par la mémoire tampon de lecture pour la transaction de réception 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’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 peut, en option, implémenter cette fonction. S’il est implémenté, le pilote inscrit la fonction dans l’appel SerCx2CustomReceiveTransactionCreate qui crée l’objet custom-receive.

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

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

Exemples

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

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE  MyCustomReceiveTransactionInitialize;

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

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

Le type de fonction EVT_SERCX2_CUSTOM_RECEIVE_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_RECEIVE_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.