Función WdfUsbTargetDeviceSendUrbSynchronously (wdfusb.h)

Artículo
08/08/2023

[Solo se aplica a KMDF]

El método WdfUsbTargetDeviceSendUrbSynchronously envía una solicitud USB de forma sincrónica a un dispositivo USB especificado, mediante parámetros de solicitud que se describen en un URB.

Sintaxis

NTSTATUS WdfUsbTargetDeviceSendUrbSynchronously(
  [in]           WDFUSBDEVICE              UsbDevice,
  [in, optional] WDFREQUEST                Request,
  [in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions,
  [in]           PURB                      Urb
);

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] Urb

Puntero a una estructura URB inicializada por el autor de la llamada.

Si el controlador llamado anteriormente WdfUsbTargetDeviceCreateWithParameters para crear UsbDevice, el controlador debe usar WdfUsbTargetDeviceCreateUrb o WdfUsbTargetDeviceCreateIsochUrb para crear este URB.

Valor devuelto

WdfUsbTargetDeviceSendUrbSynchronously 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_INVALID_DEVICE_REQUEST	El IRQL del autor de la llamada no era válido.
STATUS_INSUFFICIENT_RESOURCES	Memoria insuficiente disponible.
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 WdfUsbTargetDeviceSendUrbSynchronously para enviar una solicitud de transferencia de control USB de forma sincrónica. Para enviar estas solicitudes de forma asincrónica, use WdfUsbTargetDeviceFormatRequestForUrb, seguido de WdfRequestSend.

El método WdfUsbTargetDeviceSendUrbSynchronously no devuelve hasta que se haya completado la solicitud, a menos que el controlador especifique un valor de tiempo de espera en la estructura WDF_REQUEST_SEND_OPTIONS del 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 puede crear y enviar una nueva solicitud.

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 WdfUsbTargetDeviceSendUrbSynchronously.

Para crear y enviar una nueva solicitud, proporcione un identificador de solicitud NULL para 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 llamando 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 que no sea NULL, ya sea que el controlador proporcione 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.

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 WdfUsbTargetDeviceSendUrbSynchronously 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 URB y se llama a WdfUsbTargetDeviceSendUrbSynchronously.

URB Urb;
NTSTATUS status;

Urb.UrbHeader.Function =  URB_FUNCTION_GET_CONFIGURATION;
Urb.UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_CONFIGURATION_REQUEST);
Urb.UrbControlGetConfigurationRequest.TransferBufferLength = 1 ; // Must be 1
Urb.UrbControlGetConfigurationRequest.TransferBufferMDL = NULL;
Urb.UrbControlGetConfigurationRequest.TransferBuffer = outBuffer;
Urb.UrbControlGetConfigurationRequest.UrbLink = NULL;

status = WdfUsbTargetDeviceSendUrbSynchronously(
                                                UsbDevice,
                                                NULL,
                                                NULL,
                                                &Urb
                                                );

Requisitos

Requisito	Value
Plataforma de destino	Universal
Versión mínima de KMDF	1.0
Encabezado	wdfusb.h (incluya Wdfusb.h)
Library	Wdf01000.sys (consulte Control de versiones de la biblioteca de marcos).
IRQL	PASSIVE_LEVEL
Reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), SyncReqSend(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf)