EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL fonction de rappel (sercx.h)
La fonction de rappel d’événement EvtSerCx2SystemDmaReceiveConfigureDmaChannel est appelée par la version 2 de l’extension de framework série (SerCx2) pour permettre au pilote du contrôleur série d’effectuer n’importe quelle 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 système-DMA.
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
Handle SERCX2SYSTEMDMARECEIVE à un objet de réception système-DMA. Le pilote du 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 de réception système-DMA. 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
[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
La fonction EvtSerCx2SystemDmaReceiveConfigureDmaChannel retourne STATUS_SUCCESS si l’appel réussit. Sinon, elle retourne un code d’état d’erreur approprié.
Remarques
Votre pilote de contrôleur série peut, en tant qu’option, implémenter cette fonction. Si elle est implémentée, le pilote inscrit la fonction dans l’appel SerCx2SystemDmaReceiveCreate qui crée l’objet system-DMA-receive.
Avant de lancer une transaction de réception système-DMA, 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 système SerCx2DMA-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 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 EvtSerCx2SystemDmaReceiveConfigureDmaChannel appelée MySystemDmaReceiveConfigureDmaChannel
, utilisez le type de fonction EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL, comme illustré 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 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_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 annoter le comportement de la fonction.
Exigences
Exigence | Valeur |
---|---|
client minimum pris en charge | Disponible à partir de Windows 8.1. |
plateforme cible | Bureau |
d’en-tête | sercx.h |
IRQL | Appelé au <IRQL = DISPATCH_LEVEL. |