Función WdfUsbTargetDeviceFormatRequestForControlTransfer (wdfusb.h)
[Se aplica a KMDF y UMDF]
El método WdfUsbTargetDeviceFormatRequestForControlTransfer crea una solicitud de transferencia de control USB, pero no envía la solicitud.
Sintaxis
NTSTATUS WdfUsbTargetDeviceFormatRequestForControlTransfer(
[in] WDFUSBDEVICE UsbDevice,
[in] WDFREQUEST Request,
[in] PWDF_USB_CONTROL_SETUP_PACKET SetupPacket,
[in, optional] WDFMEMORY TransferMemory,
[in, optional] PWDFMEMORY_OFFSET TransferOffset
);
Parámetros
[in] UsbDevice
Identificador de un objeto de dispositivo USB obtenido de una llamada anterior a WdfUsbTargetDeviceCreateWithParameters.
[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] SetupPacket
Puntero a una estructura de WDF_USB_CONTROL_SETUP_PACKET asignada por el autor de la llamada que describe la transferencia de control.
[in, optional] TransferMemory
Identificador de un objeto de memoria de marco que describe una entrada o un búfer de salida, en función del comando específico del dispositivo. Este puntero es opcional y puede ser NULL. Para obtener más información, vea la sección Comentarios que se muestra más adelante.
[in, optional] TransferOffset
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 que especifica TransferMemory . Si este puntero es NULL, el marco usa todo el búfer.
Valor devuelto
WdfUsbTargetDeviceFormatRequestForControlTransfer 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. |
|
Memoria insuficiente disponible. |
|
Se especificó un descriptor de memoria no válido o la solicitud de E/S especificada ya estaba en cola en un destino de E/S. |
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 WdfUsbTargetDeviceFormatRequestForControlTransfer, seguido de WdfRequestSend, para enviar una solicitud de transferencia de control USB de forma sincrónica o asincrónica. Como alternativa, use el método WdfUsbTargetDeviceSendControlTransferSynchronously para enviar una solicitud de forma sincrónica.
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, dependiendo del tipo de transferencia de control, posiblemente 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 WdfUsbTargetDeviceFormatRequestForControlTransfer.
-
Use el búfer de entrada o salida de la solicitud recibida para el parámetro TransferMemory .
El controlador debe llamar a WdfRequestRetrieveInputMemory o WdfRequestRetrieveOutputMemory para obtener un identificador para un objeto de memoria de marco que representa el búfer de entrada o salida de la solicitud y usarlo como el valor de TransferMemory.
-
Cree un nuevo objeto de solicitud y proporcione su identificador para el parámetro Request del método Request del método WdfUsbTargetDeviceFormatRequestForControlTransfer.
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 TransferMemory del método TransferMemory de WdfUsbTargetDeviceFormatRequestForControlTransfer.
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 o 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 de ese búfer al destino de E/S.
Varias llamadas a WdfUsbTargetDeviceFormatRequestForControlTransfer 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 WdfUsbTargetDeviceFormatRequestForControlTransfer) 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 WdfUsbTargetDeviceFormatRequestForControlTransfer 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 WdfUsbTargetDeviceFormatRequestForControlTransfer y los destinos de E/S USB, consulte Destinos de E/S USB.
Ejemplos
En el ejemplo de código siguiente se crea un objeto de solicitud y un objeto de memoria y, a continuación, se inicializa una estructura de WDF_USB_CONTROL_SETUP_PACKET para una transferencia de control "get status". A continuación, el ejemplo llama a WdfUsbTargetDeviceFormatRequestForControlTransfer para dar formato a la solicitud. A continuación, el ejemplo establece una función de devolución de llamada CompletionRoutine y envía la solicitud a un destino de E/S.
WDF_USB_CONTROL_SETUP_PACKET packet;
NTSTATUS status;
WDF_OBJECT_ATTRIBUTES attributes;
WDFMEMORY memHandle;
WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
status = WdfRequestCreate(
&attributes,
WdfUsbTargetDeviceGetIoTarget(
UsbTargetDevice,
&request
)
);
if (!NT_SUCCESS(status)){
return status;
}
WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
attributes.ParentObject = request;
status = WdfMemoryCreate(
&attributes,
NonPagedPool,
0,
sizeof(USHORT),
&memHandle,
NULL
);
if (!NT_SUCCESS(status)){
return status;
}
WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS(
&packet,
BmRequestToDevice,
0
);
status = WdfUsbTargetDeviceFormatRequestForControlTransfer(
UsbTargetDevice,
request,
&packet,
memHandle,
NULL
);
if (!NT_SUCCESS(status)){
return status;
}
WdfRequestSetCompletionRoutine(
request,
MyCompletionRoutine,
NULL
);
if (WdfRequestSend(
request,
WdfUsbTargetDeviceGetIoTarget(UsbTargetDevice),
NULL
) == FALSE) {
status = WdfRequestGetStatus(request);
}
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), RequestForUrbXrb(kmdf), RequestSendAndForgetNoFormatting(kmdf), RequestSendAndForgetNoFormatting2(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf) |