PGET_SCATTER_GATHER_LIST_EX fonction de rappel (wdm.h)

Article
03/08/2023

La routine GetScatterGatherListEx alloue les ressources requises pour un transfert DMA, génère une liste de points/regroupements et appelle la routine AdapterListControl fournie par le pilote pour lancer le transfert DMA.

Attention

N’appelez pas cette routine pour un appareil DMA système.

Syntaxe

PGET_SCATTER_GATHER_LIST_EX PgetScatterGatherListEx;

NTSTATUS PgetScatterGatherListEx(
  [in]            PDMA_ADAPTER DmaAdapter,
  [in]            PDEVICE_OBJECT DeviceObject,
  [in]            PVOID DmaTransferContext,
  [in]            PMDL Mdl,
  [in]            ULONGLONG Offset,
  [in]            ULONG Length,
  [in]            ULONG Flags,
  [in, optional]  PDRIVER_LIST_CONTROL ExecutionRoutine,
  [in, optional]  PVOID Context,
  [in]            BOOLEAN WriteToDevice,
  [in, optional]  PDMA_COMPLETION_ROUTINE DmaCompletionRoutine,
  [in, optional]  PVOID CompletionContext,
  [out, optional] PSCATTER_GATHER_LIST *ScatterGatherList
)
{...}

Paramètres

[in] DmaAdapter

Pointeur vers une structure DMA_ADAPTER . Cette structure est l’objet adaptateur qui représente le périphérique DMA master bus du pilote. L’appelant a obtenu ce pointeur à partir d’un appel précédent à la routine IoGetDmaAdapter .

[in] DeviceObject

Pointeur vers une structure DEVICE_OBJECT . Cette structure est l’objet d’appareil physique (PDO) qui représente l’appareil cible pour l’opération DMA demandée.

[in] DmaTransferContext

Pointeur vers un contexte de transfert DMA initialisé. Ce contexte a été initialisé par un appel précédent à la routine InitializeDmaTransferContext . Ce contexte doit être unique pour toutes les demandes d’allocation d’adaptateur. Pour annuler une demande d’allocation en attente, l’appelant doit fournir le contexte de transfert DMA de la demande à la routine CancelAdapterChannel .

[in] Mdl

Pointeur vers une chaîne MDL qui décrit la mise en page physique d’une collection de mémoires tampons verrouillées dans la mémoire virtuelle. 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 . Pour plus d’informations sur les chaînes MDL, consultez Utilisation de MDL.

[in] Offset

Décalage de départ pour le transfert DMA de points/regroupements. Ce paramètre est un décalage d’octet par rapport au début de la mémoire tampon dans la première MDL de la chaîne MDL. Si les dll MDL de la chaîne MDL spécifient un total de N octets d’espace tampon, les valeurs valides de Décalage sont comprises entre 0 et N–1.

[in] Length

Longueur, en octets, du transfert DMA. Si la chaîne MDL spécifie un total de N octets d’espace tampon, les valeurs valides de Longueur se trouvent dans la plage de 1 à N-Offset.

[in] Flags

Indicateurs d’allocation de canal d’adaptateur. L’indicateur suivant est pris en charge :

Indicateur	Signification
DMA_SYNCHRONOUS_CALLBACK	La routine GetScatterGatherListEx est appelée de manière synchrone. Si cet indicateur est défini et que les ressources DMA requises ne sont pas immédiatement disponibles, l’appel échoue et retourne STATUS_INSUFFICIENT_RESOURCES.

Si l’indicateur DMA_SYNCHRONOUS_CALLBACK est défini, le paramètre ExecutionRoutine est facultatif et peut être NULL. Si cet indicateur n’est pas défini, ExecutionRoutine doit être un pointeur valide et non NULL . Pour plus d’informations sur cet indicateur, consultez la section Remarques.

[in, optional] ExecutionRoutine

Pointeur vers la routine AdapterListControl fournie par le pilote qui lance le transfert DMA pour le pilote. Le gestionnaire d’E/S appelle la routine AdapterListControl une fois que les ressources requises sont allouées pour l’objet adaptateur. Une fois la routine AdapterListControl retournée, le gestionnaire d’E/S libère automatiquement l’objet d’adaptateur et les ressources qui ont été allouées pour cet objet.

Si l’indicateur DMA_SYNCHRONOUS_CALLBACK est défini, le paramètre ExecutionRoutine est facultatif et peut être NULL. Si ce paramètre a la valeur NULL, l’appelant peut utiliser les ressources allouées par GetScatterGatherListEx pour effectuer le transfert DMA après le retour de GetScatterGatherListEx . Pour plus d'informations, consultez la section Notes.

[in, optional] Context

Contexte de contrôle de l’adaptateur déterminé par le pilote. Ce contexte est passé à la routine AdapterListControl en tant que paramètre Context .

[in] WriteToDevice

Direction du transfert DMA. Définissez ce paramètre sur TRUE pour une opération d’écriture, qui transfère les données de la mémoire vers l’appareil. Définissez ce paramètre sur FALSE pour une opération de lecture, qui transfère des données de l’appareil vers la mémoire.

[in, optional] DmaCompletionRoutine

Non utilisé. Défini sur NULL.

[in, optional] CompletionContext

Non utilisé. Défini sur NULL.

[out, optional] ScatterGatherList

Pointeur vers une variable dans laquelle la routine écrit un pointeur vers la liste de points/regroupements allouée. Ce paramètre pointe vers une structure SCATTER_GATHER_LIST . La routine alloue cette structure et le tableau SCATTER_GATHER_ELEMENT vers lequel elle pointe.

Le paramètre ScatterGatherList est facultatif et peut avoir la valeur NULL si le paramètre ExecutionRoutine n’est pas NULL.

Si l’indicateur DMA_SYNCHRONOUS_CALLBACK est défini et que le paramètre ExecutionRoutine a la valeur NULL, ScatterGatherList doit être un pointeur valide et non NULL . Si ExecutionRoutine n’a pas la valeur NULL, ScatterGatherList est facultatif et peut avoir la valeur NULL si le pilote appelant n’a pas besoin de la liste de points/regroupements. L’appel GetScatterGatherListEx échoue si l’indicateur DMA_SYNCHRONOUS_CALLBACK est défini et que ScatterGatherList et ExecutionRoutine ont la valeur NULL, ou si l’indicateur DMA_SYNCHRONOUS_CALLBACK n’est pas défini et ExecutionRoutine a la valeur NULL.

Valeur retournée

GetScatterGatherListEx retourne STATUS_SUCCESS si l’appel réussit. Les valeurs de retour d’erreur possibles incluent les codes status suivants :

Code de retour	Description
STATUS_INVALID_PARAMETERS	La routine a échoué en raison de valeurs de paramètre non valides transmises par l’appelant.
STATUS_INSUFFICIENT_RESOURCES	La routine n’a pas pu allouer les ressources requises pour le transfert DMA.

Remarques

GetScatterGatherListEx n’est pas une routine système qui peut être appelée directement par nom. Cette routine peut être appelée uniquement par un pointeur à partir de l’adresse retournée dans une structure de DMA_OPERATIONS . Les pilotes obtiennent l’adresse de cette routine en appelant IoGetDmaAdapter avec le membre Version du paramètre DeviceDescription défini sur DEVICE_DESCRIPTION_VERSION3. Si IoGetDmaAdapter retourne NULL, la routine n’est pas disponible sur votre plateforme.

Utilisez GetScatterGatherListEx uniquement pour les adaptateurs master bus. N’utilisez pas cette routine pour un adaptateur DMA système.

Le pilote d’un appareil master bus peut utiliser GetScatterGatherListEx pour combiner les opérations effectuées par les routines AllocateAdapterChannelEx et MapTransferEx en un seul appel. GetScatterGatherListEx effectue les opérations suivantes :

Alloue les ressources requises pour le transfert DMA.
Génère une liste de points/regroupements en fonction des valeurs des paramètres Mdl, Offset et Length .
Appelle la routine AdapterListControl fournie par le pilote et fournit la liste de points/regroupements à cette routine en tant que paramètre.

Les ressources allouées sont automatiquement libérées après le retour de la routine AdapterListControl . Si GetScatterGatherListEx est appelé de manière synchrone (autrement dit, si l’indicateur DMA_SYNCHRONOUS_CALLBACK est défini), la routine AdapterListControl peut être omise. Dans ce cas, l’appelant utilise les ressources allouées pour lancer le transfert DMA après le retour de GetScatterGatherListEx . L’appelant doit libérer explicitement ces ressources.

Par défaut, GetScatterGatherListEx retourne de manière asynchrone, sans attendre la fin de l’allocation de ressources demandée. Après ce retour, l’appelant peut, si nécessaire, annuler la demande d’allocation en attente en appelant la routine CancelAdapterChannel .

Si le pilote appelant définit l’indicateur DMA_SYNCHRONOUS_CALLBACK , la routine GetScatterGatherListEx se comporte comme suit :

Si les ressources demandées ne sont pas immédiatement disponibles, GetScatterGatherListEx n’attend pas les ressources, ne génère pas de liste de points/regroupements et n’appelle pas la routine AdapterListControl . Au lieu de cela, GetScatterGatherListEx échoue et retourne STATUS_INSUFFICIENT_RESOURCES.
Le pilote n’est pas nécessaire pour fournir une routine AdapterListControl si l’indicateur DMA_SYNCHRONOUS_CALLBACK est défini.
Si le pilote fournit une routine AdapterListControl , l’indicateur DMA_SYNCHRONOUS_CALLBACK indique que cette routine doit être appelée dans le contexte du thread appelant, avant que GetScatterGatherListEx ne retourne.
Si le pilote ne fournit pas de routine AdapterListControl , il peut utiliser les ressources allouées et la liste de points/regroupements après le retour de GetScatterGatherListEx . Dans ce cas, le pilote doit fournir un pointeur ScatterGatherList non NULL valide. En outre, une fois que le pilote a lancé le transfert DMA, le pilote doit appeler la routine FreeAdapterObject pour libérer les ressources allouées par GetScatterGatherListEx pour l’objet adaptateur.

GetScatterGatherListEx est une version étendue de la routine GetScatterGatherList . Les fonctionnalités suivantes sont disponibles uniquement dans la version étendue :

GetScatterGatherListEx est similaire à la routine BuildScatterGatherListEx , à ceci près que GetScatterGatherListEx alloue automatiquement la mémoire tampon pour la liste de points/regroupements.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible à partir de Windows 8.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
IRQL	<= DISPATCH_LEVEL