Función WdfUsbTargetDeviceSendControlTransferSynchronously (wdfusb.h)

Artículo
08/08/2023

[Se aplica a KMDF y UMDF]

El método WdfUsbTargetDeviceSendControlTransferSynchronously compila una solicitud de transferencia de control USB y la envía de forma sincrónica a un destino de E/S.

Sintaxis

NTSTATUS WdfUsbTargetDeviceSendControlTransferSynchronously(
  [in]            WDFUSBDEVICE                  UsbDevice,
  [in, optional]  WDFREQUEST                    Request,
  [in, optional]  PWDF_REQUEST_SEND_OPTIONS     RequestOptions,
  [in]            PWDF_USB_CONTROL_SETUP_PACKET SetupPacket,
  [in, optional]  PWDF_MEMORY_DESCRIPTOR        MemoryDescriptor,
  [out, optional] PULONG                        BytesTransferred
);

Parámetros

[in] UsbDevice

Identificador de un objeto de dispositivo USB obtenido de una llamada anterior a WdfUsbTargetDeviceCreateWithParameters.

[in, optional] Request

Identificador de un objeto de solicitud de marco. Este parámetro 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] RequestOptions

Puntero a una estructura de WDF_REQUEST_SEND_OPTIONS asignada por el autor de la llamada que especifica las opciones de la solicitud. 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] 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] MemoryDescriptor

Puntero a una estructura de WDF_MEMORY_DESCRIPTOR asignada por el autor de la llamada que describe una entrada o un búfer de salida, según el 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.

[out, optional] BytesTransferred

Puntero a una ubicación que recibe el número de bytes transferidos. Este parámetro es opcional y puede ser NULL.

Valor devuelto

WdfUsbTargetDeviceSendControlTransferSynchronous devuelve el valor de estado de finalización del destino de E/S 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
STATUS_INVALID_PARAMETER	Se ha detectado un parámetro no válido.
STATUS_INSUFFICIENT_RESOURCES	No había suficiente memoria disponible.
STATUS_INVALID_DEVICE_REQUEST	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.
STATUS_IO_TIMEOUT	El controlador proporcionó un valor de tiempo de espera y la solicitud no se completó dentro del tiempo asignado.

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 el método WdfUsbTargetDeviceSendControlTransferSynchronously para enviar una solicitud de transferencia de control USB de forma sincrónica. Para enviar estas solicitudes de forma asincrónica, use WdfUsbTargetDeviceFormatRequestForControlTransfer, seguido de WdfRequestSend.

El método WdfUsbTargetDeviceSendControlTransferSynchronously no devuelve hasta que se haya completado la solicitud, a menos que el controlador suministre un valor de tiempo de espera en la estructura WDF_REQUEST_SEND_OPTIONS a la que apunta el parámetro RequestOptions o a menos que se detecte un error.

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, 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 .
Use el búfer de entrada o salida de la solicitud recibida para el parámetro MemoryDescriptor .
El controlador puede llamar a WdfRequestRetrieveInputMemory o WdfRequestRetrieveOutputMemory para obtener un identificador a un objeto de memoria de marco que representa el búfer de entrada o salida de la solicitud y, a continuación, colocar ese identificador en la estructura de WDF_MEMORY_DESCRIPTOR que proporciona el controlador para el parámetro MemoryDescriptor .

Para crear y enviar una nueva solicitud:

Proporcione un identificador de solicitud NULL en el parámetro Request o cree un nuevo objeto de solicitud y proporcione su identificador:
- Si proporciona un identificador de solicitud NULL , el marco usa un objeto de solicitud interno. Esta técnica es sencilla de usar, pero el controlador no puede cancelar la solicitud.
- Si llama a WdfRequestCreate para crear uno o varios objetos de solicitud, puede reutilizar estos objetos de solicitud mediante una llamada a WdfRequestReuse. Esta técnica permite a la función de devolución de llamada EvtDriverDeviceAdd del controlador asignar previamente objetos de solicitud para un dispositivo. Además, otro subproceso de controlador puede llamar a WdfRequestCancelSentRequest para cancelar la solicitud, si es necesario.
El controlador puede especificar un parámetro RequestOptions distinto de NULL, independientemente de si el controlador proporciona un parámetro request distinto de NULL o NULL. Por ejemplo, puede usar el parámetro RequestOptions para especificar un valor de tiempo de espera.
Proporcione espacio de búfer para el parámetro MemoryDescriptor del método MemoryDescriptorWdfUsbTargetDeviceSendControlTransferSynchronously.
El controlador puede especificar este espacio de búfer como un búfer asignado localmente, como un identificador WDFMEMORY o como MDL. Puede usar el método que sea más conveniente.

Si es necesario, el marco convierte la descripción del búfer en una que sea correcta para el método del destino de E/S para acceder a los búferes de datos.

Están disponibles las técnicas siguientes:
- Proporcionar un búfer local
  Dado que WdfUsbTargetDeviceSendControlTransferSynchronous controla de forma sincrónica las solicitudes de E/S, el controlador puede crear búferes de solicitudes locales para la rutina de llamada, como se muestra en el ejemplo de código siguiente.
```
WDF_MEMORY_DESCRIPTOR  memoryDescriptor;
MY_BUFFER_TYPE  myBuffer;
WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(&memoryDescriptor,
                                  (PVOID) &myBuffer,
                                  sizeof(myBuffer));
```
- Proporcionar un identificador WDFMEMORY
  Llame a WdfMemoryCreate o WdfMemoryCreatePreallocated para obtener un identificador de la memoria administrada por el marco, como se muestra en el ejemplo de código siguiente.
```
WDF_MEMORY_DESCRIPTOR  memoryDescriptor;
WDFMEMORY  memoryHandle = NULL;
status = WdfMemoryCreate(NULL,
                         NonPagedPool,
                         POOL_TAG,
                         MY_BUFFER_SIZE,
                         &memoryHandle,
                         NULL);
WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(&memoryDescriptor,
                                  memoryHandle,
                                  NULL);
```
  Como alternativa, el controlador puede llamar a WdfRequestRetrieveInputMemory o WdfRequestRetrieveOutputMemory para obtener un identificador de un objeto de memoria de marco 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. El controlador no debe completar la solicitud de E/S recibida hasta que la nueva solicitud que WdfUsbTargetDeviceSendControlTransferSynchronousmente envía al destino de E/S se ha eliminado, reutilizado o vuelto a formatear. (WdfUsbTargetDeviceSendControlTransferSynchronousmente incrementa el recuento de referencias del objeto de memoria. Al eliminar, reutilizar o volver a formatear un objeto de solicitud, se reduce el recuento de referencias del objeto de memoria).
- Proporcionar una MDL
  Los controladores pueden obtener MDL asociados a una solicitud de E/S recibida llamando a WdfRequestRetrieveInputWdmMdl o WdfRequestRetrieveOutputWdmMdl.

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 WdfUsbTargetDeviceSendControlTransferSynchronously y los destinos de E/S USB, consulte Destinos de E/S USB.

Ejemplos

En el ejemplo de código siguiente se inicializa una estructura de WDF_USB_CONTROL_SETUP_PACKET y, a continuación, se llama a WdfUsbTargetDeviceSendControlTransferSynchronously para enviar una transferencia de control específica del proveedor.

WDF_USB_CONTROL_SETUP_PACKET  controlSetupPacket;

WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR(
                                         &controlSetupPacket,
                                         BmRequestHostToDevice,
                                         BmRequestToDevice,
                                         USBFX2LK_REENUMERATE,
                                         0,
                                         0
                                         );

status = WdfUsbTargetDeviceSendControlTransferSynchronously(
                                         UsbDevice,
                                         WDF_NO_HANDLE,
                                         NULL,
                                         &controlSetupPacket,
                                         NULL,
                                         NULL
                                         );
return status;

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	PASSIVE_LEVEL
Reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestForUrbXrb(kmdf), SyncReqSend(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf)