Función WdfUsbTargetPipeFormatRequestForWrite (wdfusb.h)
[Se aplica a KMDF y UMDF]
El método WdfUsbTargetPipeFormatRequestForWrite crea una solicitud de escritura para una canalización de salida USB, pero no envía la solicitud.
Sintaxis
NTSTATUS WdfUsbTargetPipeFormatRequestForWrite(
[in] WDFUSBPIPE Pipe,
[in] WDFREQUEST Request,
[in, optional] WDFMEMORY WriteMemory,
[in, optional] PWDFMEMORY_OFFSET WriteOffset
);
Parámetros
[in] Pipe
Identificador de un objeto de canalización de marco que se obtuvo mediante una llamada a WdfUsbInterfaceGetConfiguredPipe.
[in] Request
Identificador de un objeto de solicitud de marco. Para obtener más información, vea la sección Comentarios que se muestra más adelante.
[in, optional] WriteMemory
Identificador de un objeto de memoria de marco. Este objeto representa un búfer que contiene datos que se enviarán a la canalización. Para obtener más información sobre este búfer, consulte la siguiente sección Comentarios.
[in, optional] WriteOffset
Puntero a una estructura de WDFMEMORY_OFFSET asignada por el autor de la llamada que proporciona valores opcionales de desplazamiento de bytes y longitud. El marco usa estos valores para determinar la dirección y la longitud iniciales, dentro del búfer de escritura, para la transferencia de datos. Si este puntero es NULL, la transferencia de datos comienza al principio del búfer y el tamaño de la transferencia es el tamaño del búfer.
Valor devuelto
WdfUsbTargetPipeFormatRequestForWrite devuelve STATUS_SUCCESS si la operación se realiza correctamente. De lo contrario, este método podría devolver uno de los siguientes valores:
| Código devuelto | Descripción |
|---|---|
|
Se ha detectado un parámetro no válido. |
|
Memoria insuficiente disponible. |
|
Se especificó un descriptor de memoria no válido, el tipo de canalización no era válido, la dirección de transferencia no era válida o la solicitud de E/S especificada ya estaba en cola en un destino de E/S. |
|
Desplazamiento que el parámetro Offset especificó no válido. |
|
El paquete de solicitud de E/S (IRP) que representa el parámetro Request no proporciona suficientes estructuras IO_STACK_LOCATION para permitir que el controlador reenvíe la solicitud. |
Este método también podría devolver otros valores NTSTATUS.
Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.
Comentarios
Use WdfUsbTargetPipeFormatRequestForWrite, seguido de WdfRequestSend, para enviar solicitudes de escritura de forma sincrónica o asincrónica. Como alternativa, use el método WdfUsbTargetPipeWriteSynchronously para enviar solicitudes de escritura de forma sincrónica.
La canalización especificada debe ser una canalización de salida y el tipo de la canalización debe ser WdfUsbPipeTypeBulk o WdfUsbPipeTypeInterrupt.
Puede reenviar una solicitud de E/S que el controlador recibió en una cola de E/S o puede crear y enviar una nueva solicitud. En cualquier caso, el marco requiere un objeto de solicitud y un espacio de búfer.
Para reenviar una solicitud de E/S que el controlador recibió en una cola de E/S:
- Especifique el identificador de la solicitud recibida para el parámetro Request del método Request del método WdfUsbTargetPipeFormatRequestForWrite.
-
Use el búfer de entrada de la solicitud recibida para el parámetro WriteMemory del método WdfUsbTargetPipeFormatRequestForWrite.
El controlador debe llamar a WdfRequestRetrieveInputMemory para obtener un identificador para un objeto de memoria del marco que representa el búfer de entrada de la solicitud y usar ese identificador como valor para WriteMemory.
Los controladores suelen dividir las solicitudes de E/S recibidas en solicitudes más pequeñas que envían a un destino de E/S, por lo que el controlador podría crear nuevas solicitudes.
Para crear una nueva solicitud de E/S:
-
Cree un nuevo objeto de solicitud y proporcione su identificador para el parámetro Request del método Request del método WdfUsbTargetPipeFormatRequestForWrite.
Llame a WdfRequestCreate para preasignar uno o varios objetos de solicitud. Puede reutilizar estos objetos de solicitud llamando a WdfRequestReuse. La función de devolución de llamada EvtDriverDeviceAdd del controlador puede asignar previamente objetos de solicitud para un dispositivo.
-
Proporcione espacio de búfer y proporcione el identificador del búfer para el parámetro WriteMemory del método WdfUsbTargetPipeFormatRequestForWrite.
El controlador debe especificar este espacio en búfer como identificador WDFMEMORY para la memoria administrada por el marco. El controlador puede hacer lo siguiente:
- Llame a WdfMemoryCreate o WdfMemoryCreatePreallocated para crear un nuevo búfer de memoria, si desea que el controlador pase un nuevo búfer al destino de E/S.
- Llame a WdfRequestRetrieveInputMemory para obtener un identificador para el objeto de memoria que representa el búfer de una solicitud de E/S recibida, si desea que el controlador pase el contenido de ese búfer al destino de E/S.
Varias llamadas a WdfUsbTargetPipeFormatRequestForWrite que usan la misma solicitud no provocan asignaciones de recursos adicionales. Por lo tanto, para reducir la posibilidad de que WdfRequestCreate devuelva STATUS_INSUFFICIENT_RESOURCES, la función de devolución de llamada EvtDriverDeviceAdd del controlador puede llamar a WdfRequestCreate para asignar previamente uno o varios objetos de solicitud para un dispositivo. Posteriormente, el controlador puede volver a usar (llamar a WdfRequestReuse), formatear (llamar a WdfUsbTargetPipeFormatRequestForWrite) y reenviar (llamar a WdfRequestSend) cada objeto de solicitud sin arriesgar un valor devuelto STATUS_INSUFFICIENT_RESOURCES desde una llamada posterior a WdfRequestCreate. Todas las llamadas posteriores a WdfUsbTargetPipeFormatRequestForWrite para el objeto de solicitud reutilizado devolverán STATUS_SUCCESS, si los valores de parámetro no cambian. (Si el controlador no llama al mismo método de formato de solicitud cada vez, se pueden asignar recursos adicionales).
Para obtener información sobre cómo obtener información de estado una vez completada una solicitud de E/S, vea Obtener información de finalización.
Para obtener más información sobre el método WdfUsbTargetPipeFormatRequestForWrite y los destinos de E/S USB, consulte Destinos de E/S USB.
Ejemplos
El ejemplo de código siguiente procede del controlador de ejemplo de kmdf_fx2 . Este ejemplo es una función de devolución de llamada EvtIoWrite que reenvía una solicitud de escritura a una canalización USB. El ejemplo llama a WdfRequestRetrieveInputMemory para obtener el búfer de entrada de la solicitud y, a continuación, da formato a la solicitud de escritura para que la solicitud se pueda enviar a una canalización USB. A continuación, el ejemplo registra una función de devolución de llamada CompletionRoutine . Por último, envía la solicitud a la canalización 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;
}
Requisitos
| Requisito | Value |
|---|---|
| Plataforma de destino | Universal |
| Versión mínima de KMDF | 1.0 |
| Versión mínima de UMDF | 2.0 |
| Encabezado | wdfusb.h (incluya Wdfusb.h) |
| Library | Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF) |
| IRQL | <=DISPATCH_LEVEL |
| Reglas de cumplimiento de DDI | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestFormattedValid(kmdf), RequestSendAndForgetNoFormatting(kmdf), RequestSendAndForgetNoFormatting2(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf) |
Consulte también
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de