WdfUsbTargetPipeFormatRequestForWrite, fonction (wdfusb.h)
[S’applique à KMDF et UMDF]
La méthode WdfUsbTargetPipeFormatRequestForWrite génère une demande d’écriture pour un canal de sortie USB, mais elle n’envoie pas la requête.
Syntaxe
NTSTATUS WdfUsbTargetPipeFormatRequestForWrite(
[in] WDFUSBPIPE Pipe,
[in] WDFREQUEST Request,
[in, optional] WDFMEMORY WriteMemory,
[in, optional] PWDFMEMORY_OFFSET WriteOffset
);
Paramètres
[in] Pipe
Handle d’un objet de canal d’infrastructure obtenu en appelant WdfUsbInterfaceGetConfiguredPipe.
[in] Request
Handle d’un objet de requête d’infrastructure. Pour plus d'informations, consultez la section Notes qui suit.
[in, optional] WriteMemory
Handle d’un objet de mémoire framework. Cet objet représente une mémoire tampon qui contient des données qui seront envoyées au canal. Pour plus d’informations sur cette mémoire tampon, consultez la section Remarques suivante.
[in, optional] WriteOffset
Pointeur vers une structure de WDFMEMORY_OFFSET allouée à l’appelant qui fournit des valeurs facultatives de décalage d’octet et de longueur. L’infrastructure utilise ces valeurs pour déterminer l’adresse de début et la longueur, dans la mémoire tampon d’écriture, pour le transfert de données. Si ce pointeur a la valeur NULL, le transfert de données commence au début de la mémoire tampon et la taille du transfert correspond à la taille de la mémoire tampon.
Valeur retournée
WdfUsbTargetPipeFormatRequestForWrite retourne STATUS_SUCCESS si l’opération réussit. Sinon, cette méthode peut retourner l’une des valeurs suivantes :
| Code de retour | Description |
|---|---|
|
Un paramètre non valide a été détecté. |
|
La mémoire disponible était insuffisante. |
|
Un descripteur de mémoire non valide a été spécifié, le type du canal n’était pas valide, le sens du transfert n’était pas valide ou la demande d’E/S spécifiée était déjà mise en file d’attente vers une cible d’E/S. |
|
Le décalage spécifié par le paramètre Offset n’était pas valide. |
|
Le paquet de demande d’E/S (IRP) que représente le paramètre Request ne fournit pas suffisamment de structures IO_STACK_LOCATION pour permettre au pilote de transférer la requête. |
Cette méthode peut également retourner d’autres valeurs NTSTATUS.
Un bogue case activée se produit si le pilote fournit un handle d’objet non valide.
Remarques
Utilisez WdfUsbTargetPipeFormatRequestForWrite, suivi de WdfRequestSend, pour envoyer des demandes d’écriture de manière synchrone ou asynchrone. Vous pouvez également utiliser la méthode WdfUsbTargetPipeWriteSynchronously pour envoyer des demandes d’écriture de manière synchrone.
Le canal spécifié doit être un canal de sortie et le type du canal doit être WdfUsbPipeTypeBulk ou WdfUsbPipeTypeInterrupt.
Vous pouvez transférer une demande d’E/S que votre pilote a reçue dans une file d’attente d’E/S, ou vous pouvez créer et envoyer une nouvelle demande. Dans les deux cas, l’infrastructure nécessite un objet de requête et un espace de mémoire tampon.
Pour transférer une demande d’E/S que votre pilote a reçue dans une file d’E/S :
- Spécifiez le handle de la demande reçue pour le paramètre Request de la méthode WdfUsbTargetPipeFormatRequestForWrite.
-
Utilisez la mémoire tampon d’entrée de la demande reçue pour le paramètre WriteMemory de la méthode WdfUsbTargetPipeFormatRequestForWrite.
Le pilote doit appeler WdfRequestRetrieveInputMemory pour obtenir un handle sur un objet de mémoire framework qui représente la mémoire tampon d’entrée de la requête et utiliser ce handle comme valeur pour WriteMemory.
Les pilotes divisent souvent les demandes d’E/S reçues en demandes plus petites qu’ils envoient à une cible d’E/S, afin que votre pilote puisse en créer de nouvelles.
Pour créer une demande d’E/S :
-
Créez un objet de requête et fournissez son handle pour le paramètre Request de la méthode WdfUsbTargetPipeFormatRequestForWrite.
Appelez WdfRequestCreate pour préallouer un ou plusieurs objets de requête. Vous pouvez réutiliser ces objets de requête en appelant WdfRequestReuse. La fonction de rappel EvtDriverDeviceAdd de votre pilote peut préallouer des objets de requête pour un appareil.
-
Fournissez de l’espace tampon et fournissez le handle de la mémoire tampon pour le paramètre WriteMemory de la méthode WdfUsbTargetPipeFormatRequestForWrite.
Votre pilote doit spécifier cet espace tampon en tant que handle WDFMEMORY pour la mémoire gérée par l’infrastructure. Votre pilote peut effectuer l’une des opérations suivantes :
- Appelez WdfMemoryCreate ou WdfMemoryCreatePreallocated pour créer une mémoire tampon, si vous souhaitez que le pilote passe une nouvelle mémoire tampon à la cible d’E/S.
- Appelez WdfRequestRetrieveInputMemory pour obtenir un handle à l’objet mémoire qui représente la mémoire tampon d’une demande d’E/S reçue, si vous souhaitez que le pilote transmette le contenu de cette mémoire tampon à la cible d’E/S.
Les appels multiples à WdfUsbTargetPipeFormatRequestForWrite qui utilisent la même requête ne provoquent pas d’allocations de ressources supplémentaires. Par conséquent, pour réduire le risque que WdfRequestCreate retourne STATUS_INSUFFICIENT_RESOURCES, la fonction de rappel EvtDriverDeviceAdd de votre pilote peut appeler WdfRequestCreate pour préallouer un ou plusieurs objets de requête pour un appareil. Le pilote peut par la suite réutiliser (appeler WdfRequestReuse), reformater (appeler WdfUsbTargetPipeFormatRequestForWrite) et renvoyer (appeler WdfRequestSend) chaque objet de requête sans risquer un STATUS_INSUFFICIENT_RESOURCES valeur de retour à partir d’un appel ultérieur à WdfRequestCreate. Tous les appels suivants à WdfUsbTargetPipeFormatRequestForWrite pour l’objet de requête réutilisé retournent STATUS_SUCCESS, si les valeurs de paramètre ne changent pas. (Si le pilote n’appelle pas la même méthode de mise en forme des requêtes à chaque fois, des ressources supplémentaires peuvent être allouées.)
Pour plus d’informations sur l’obtention d’informations status après la fin d’une demande d’E/S, consultez Obtention des informations d’achèvement.
Pour plus d’informations sur la méthode WdfUsbTargetPipeFormatRequestForWrite et les cibles d’E/S USB, consultez Cibles d’E/S USB.
Exemples
L’exemple de code suivant provient de l’exemple de pilote kmdf_fx2 . Cet exemple est une fonction de rappel EvtIoWrite qui transfère une demande d’écriture vers un canal USB. L’exemple appelle WdfRequestRetrieveInputMemory pour obtenir la mémoire tampon d’entrée de la demande, puis met en forme la demande d’écriture afin que la demande puisse être envoyée à un canal USB. Ensuite, l’exemple inscrit une fonction de rappel CompletionRoutine . Enfin, il envoie la demande au canal USB.
VOID
OsrFxEvtIoWrite(
IN WDFQUEUE Queue,
IN WDFREQUEST Request,
IN size_t Length
)
{
NTSTATUS status;
WDFUSBPIPE pipe;
WDFMEMORY reqMemory;
PDEVICE_CONTEXT pDeviceContext;
if (Length > TEST_BOARD_TRANSFER_BUFFER_SIZE) {
status = STATUS_INVALID_PARAMETER;
goto Exit;
}
pDeviceContext = GetDeviceContext(WdfIoQueueGetDevice(Queue));
pipe = pDeviceContext->BulkWritePipe;
status = WdfRequestRetrieveInputMemory(
Request,
&reqMemory
);
if (!NT_SUCCESS(status)){
goto Exit;
}
status = WdfUsbTargetPipeFormatRequestForWrite(
pipe,
Request,
reqMemory,
NULL
);
if (!NT_SUCCESS(status)) {
goto Exit;
}
WdfRequestSetCompletionRoutine(
Request,
EvtRequestWriteCompletionRoutine,
pipe
);
if (WdfRequestSend(
Request,
WdfUsbTargetPipeGetIoTarget(pipe),
WDF_NO_SEND_OPTIONS
) == FALSE) {
status = WdfRequestGetStatus(Request);
goto Exit;
}
Exit:
if (!NT_SUCCESS(status)) {
WdfRequestCompleteWithInformation(
Request,
status,
0
);
}
return;
}
Configuration requise
| Plateforme cible | Universal |
| Version KMDF minimale | 1.0 |
| Version UMDF minimale | 2.0 |
| En-tête | wdfusb.h (inclure Wdfusb.h) |
| Bibliothèque | Wdf01000.sys (KMDF) ; WUDFx02000.dll (UMDF) |
| IRQL | <=DISPATCH_LEVEL |
| Règles de conformité DDI | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestFormattedValid(kmdf), RequestSendAndForgetNoFormatting(kmdf), RequestSendAndForgetNoFormatting2(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf) |