EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL fonction de rappel (sercx.h)

Article
02/29/2024

La fonction de rappel d’événement EvtSerCx2SystemDmaReceiveConfigureDmaChannel est appelée par la version 2 de l’extension d’infrastructure série (SerCx2) pour permettre au pilote du contrôleur série d’effectuer toute configuration personnalisée de l’adaptateur DMA qui peut être nécessaire avant le début de chaque transfert dans une transaction de réception DMA système.

Syntaxe

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL EvtSercx2SystemDmaReceiveConfigureDmaChannel;

NTSTATUS EvtSercx2SystemDmaReceiveConfigureDmaChannel(
  [in] SERCX2SYSTEMDMARECEIVE SystemDmaReceive,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

Paramètres

[in] SystemDmaReceive

Un handle SERCX2SYSTEMDMARECEIVE à un objet system-DMA-receive. Le pilote de contrôleur série a précédemment appelé la méthode SerCx2SystemDmaReceiveCreate 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 de lecture pour la transaction system-DMA-receive. 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 retournée

La fonction EvtSerCx2SystemDmaReceiveConfigureDmaChannel retourne STATUS_SUCCESS si l’appel réussit. Sinon, il retourne une erreur appropriée status code.

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 SerCx2SystemDmaReceiveCreate qui crée l’objet system-DMA-receive.

Avant de lancer une transaction system-DMA-receive, SerCx2 appelle la fonction EvtSerCx2SystemDmaReceiveConfigureDmaChannel , si elle est implémentée. Cette fonction effectue toute configuration spéciale du contrôleur DMA système qui peut être nécessaire avant que SerCx2 démarre la transaction system-DMA-receive.

Le pilote de contrôleur série peut appeler une méthode telle que SerCx2SystemDmaReceiveGetDmaEnabler pour obtenir l’enabler DMA pour le contrôleur DMA système utilisé pour les transactions de réception system-DMA.

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

Exemples

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

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL  MySystemDmaReceiveConfigureDmaChannel;

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

_Use_decl_annotations_
NTSTATUS
  MySystemDmaReceiveConfigureDmaChannel(
    SERCX2SYSTEMDMARECEIVE SystemDmaReceive,
    PMDL Mdl,
    ULONG Offset,
    ULONG Length
    )
  {...}

Le type de fonction EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL 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_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL 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.