Función WdfUsbTargetPipeFormatRequestForRead (wdfusb.h)
[Se aplica a KMDF y UMDF]
El método WdfUsbTargetPipeFormatRequestForRead crea una solicitud de lectura para una canalización de entrada USB, pero no envía la solicitud.
Sintaxis
NTSTATUS WdfUsbTargetPipeFormatRequestForRead(
[in] WDFUSBPIPE Pipe,
[in] WDFREQUEST Request,
[in, optional] WDFMEMORY ReadMemory,
[in, optional] PWDFMEMORY_OFFSET ReadOffset
);
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] ReadMemory
Identificador de un objeto de memoria de marco. Este objeto representa un búfer que recibirá datos de la canalización. El tamaño del búfer debe ser un múltiplo del tamaño máximo del paquete de la canalización a menos que el controlador haya llamado WdfUsbTargetPipeSetNoMaximumPacketSizeCheck. Para obtener más información sobre este búfer, consulte la siguiente sección Comentarios.
[in, optional] ReadOffset
Puntero a una estructura de WDFMEMORY_OFFSET asignada por el autor de la llamada que proporciona valores opcionales de desplazamiento y longitud de bytes. El marco usa estos valores para determinar la dirección y la longitud iniciales, dentro del búfer de lectura, 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
WdfUsbTargetPipeFormatRequestForRead devuelve STATUS_SUCCESS si la operación se realiza correctamente. De lo contrario, este método puede devolver uno de los valores siguientes:
| Código devuelto | Descripción |
|---|---|
|
Se ha detectado un parámetro no válido. |
|
No había suficiente memoria disponible. |
|
Se especificó un descriptor de memoria no válido, el tipo de la 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 es válido. |
|
El tamaño del búfer no era un múltiplo del tamaño máximo del paquete de la canalización. El tamaño del búfer debe ser un múltiplo del tamaño máximo del paquete de la canalización a menos que el controlador haya llamado WdfUsbTargetPipeSetNoMaximumPacketSizeCheck. |
|
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 WdfUsbTargetPipeFormatRequestForRead, seguido de WdfRequestSend, para enviar solicitudes de lectura de forma sincrónica o asincrónica. Como alternativa, use el método WdfUsbTargetPipeReadSynchronously para enviar solicitudes de lectura de forma sincrónica.
La canalización que especifica el parámetro Pipe debe ser una canalización de entrada 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 bien puede crear y enviar una nueva solicitud. En cualquier caso, el marco requiere un objeto de solicitud y algún 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 WdfUsbTargetPipeFormatRequestForRead.
-
Use el búfer de salida de la solicitud recibida para el parámetro ReadMemory del método ReadMemory de WdfUsbTargetPipeFormatRequestForRead.
El controlador debe llamar a WdfRequestRetrieveOutputMemory para obtener un identificador de un objeto de memoria de marco que representa el búfer de salida de la solicitud y usar ese identificador como valor para el parámetro ReadMemory .
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 puede 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 WdfUsbTargetPipeFormatRequestForRead.
Llame a WdfRequestCreate para preasignar uno o varios objetos de solicitud. Puede reutilizar estos objetos de solicitud mediante una llamada 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 ReadMemory del método ReadMemory de WdfUsbTargetPipeFormatRequestForRead.
El controlador debe especificar este espacio de búfer como identificador WDFMEMORY para la memoria administrada por el marco. El controlador puede hacer una de las siguientes acciones:
- 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 WdfRequestRetrieveOutputMemory 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 del búfer al destino de E/S.
Varias llamadas a WdfUsbTargetPipeFormatRequestForRead 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 reutilizar (llamar a WdfRequestReuse), formatear (llamar a WdfUsbTargetPipeFormatRequestForRead) y volver a enviar (llamada 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 WdfUsbTargetPipeFormatRequestForRead 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).
El marco establece la marca USBD_SHORT_TRANSFER_OK en su URB interno. Establecer esta marca permite que el último paquete de una transferencia de datos sea menor que el tamaño máximo del paquete.
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 WdfUsbTargetPipeFormatRequestForRead y los destinos de E/S USB, consulte Destinos de E/S USB.
Ejemplos
El ejemplo de código siguiente es del controlador de ejemplo de kmdf_fx2 . Este ejemplo es una función de devolución de llamada EvtIoRead que reenvía una solicitud de lectura a una canalización USB. El ejemplo llama a WdfRequestRetrieveOutputMemory para obtener el búfer de salida de la solicitud y, a continuación, da formato a la solicitud de lectura 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
OsrFxEvtIoRead(
IN WDFQUEUE Queue,
IN WDFREQUEST Request,
IN size_t Length
)
{
WDFUSBPIPE pipe;
NTSTATUS status;
WDFMEMORY reqMemory;
PDEVICE_CONTEXT pDeviceContext;
//
// First, validate input parameters.
//
if (Length > TEST_BOARD_TRANSFER_BUFFER_SIZE) {
status = STATUS_INVALID_PARAMETER;
goto Exit;
}
pDeviceContext = GetDeviceContext(WdfIoQueueGetDevice(Queue));
pipe = pDeviceContext->BulkReadPipe;
status = WdfRequestRetrieveOutputMemory(
Request,
&reqMemory
);
if (!NT_SUCCESS(status)){
goto Exit;
}
status = WdfUsbTargetPipeFormatRequestForRead(
pipe,
Request,
reqMemory,
NULL
);
if (!NT_SUCCESS(status)) {
goto Exit;
}
WdfRequestSetCompletionRoutine(
Request,
EvtRequestReadCompletionRoutine,
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
WdfRequestCompleteWithInformation
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