EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE fonction de rappel (sercx.h)

Article
10/30/2024

La fonction de rappel d’événements EvtSerCx2CustomReceiveTransactionInitialize est appelée par la version 2 de l’extension du framework série (SerCx2) pour préparer le matériel du contrôleur série pour 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 de transaction de réception personnalisé. 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 un MDL qui décrit les pages 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 DMA utilise la région de cette mémoire spécifiée par les paramètres offset et Longueur.

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

Votre pilote doit implémenter une fonction EvtSerCx2CustomReceiveTransactionInitialize si elle 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 du contrôleur série doit appeler la méthode SerCx2CustomReceiveTransactionInitializeComplete pour notifier SerCx2 une fois l’initialisation terminée.

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

Exemples

Pour définir une EvtSerCx2CustomReceiveTransactionInitialize fonction de rappel, 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 EvtSerCx2CustomReceiveTransactionInitialize fonction de rappel nommée MyCustomReceiveTransactionInitialize, utilisez le type de fonction EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE, comme illustré 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 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_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 annoter le comportement de la fonction.