Función WdfUsbTargetDeviceFormatRequestForUrb (wdfusb.h)

Artículo
02/27/2024

[Solo se aplica a KMDF]

El método WdfUsbTargetDeviceFormatRequestForUrb crea una solicitud USB para un dispositivo USB especificado, mediante parámetros de solicitud descritos por un URB, pero no envía la solicitud.

Sintaxis

NTSTATUS WdfUsbTargetDeviceFormatRequestForUrb(
  [in]           WDFUSBDEVICE      UsbDevice,
  [in]           WDFREQUEST        Request,
  [in]           WDFMEMORY         UrbMemory,
  [in, optional] PWDFMEMORY_OFFSET UrbMemoryOffset
);

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

Identificador de un objeto de memoria de marco que contiene una estructura URB o uno de los miembros de unión de la estructura. (Todos los miembros de unión de la estructura URB contienen la estructura _URB_HEADER ).

Si el controlador llamado anteriormente WdfUsbTargetDeviceCreateWithParameters para crear UsbDevice, el controlador debe usar WdfUsbTargetDeviceCreateUrb o WdfUsbTargetDeviceCreateIsochUrb para crear el URB contenido en este objeto de memoria. De lo contrario, se produce una comprobación de errores.

[in, optional] UrbMemoryOffset

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 inicial del URB dentro de la memoria que especifica UrbMemory . Si este puntero es NULL, el URB se encuentra al principio de la memoria UrbMemory .

Valor devuelto

WdfUsbTargetDeviceFormatRequestForUrb 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
STATUS_INVALID_PARAMETER	Se ha detectado un parámetro no válido.
STATUS_INSUFFICIENT_RESOURCES	No había memoria suficiente.
STATUS_INTEGER_OVERFLOW	El desplazamiento que especificó el parámetro UsbMemoryOffset no era válido.

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 WdfUsbTargetDeviceFormatRequestForUrb, 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 WdfUsbTargetDeviceSendUrbSynchronously 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 bien 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 WdfUsbTargetDeviceFormatRequestForUrb.

Para crear una nueva solicitud de E/S, llame a WdfRequestCreate para preasignar un objeto de solicitud. Proporcione el identificador de solicitud para el parámetro Request del método WdfUsbTargetDeviceFormatRequestForUrb. Puede reutilizar el objeto 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.

Después de llamar a WdfUsbTargetDeviceFormatRequestForUrb para dar formato a una solicitud de E/S, el controlador debe llamar a WdfRequestSend para enviar la solicitud (ya sea de forma sincrónica o asincrónica) a un destino de E/S. No use la opción enviar y olvidar para enviar la solicitud.

Varias llamadas a WdfUsbTargetDeviceFormatRequestForUrb 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 WdfUsbTargetDeviceFormatRequestForUrb) 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 WdfUsbTargetDeviceFormatRequestForUrb 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 WdfUsbTargetDeviceFormatRequestForUrb 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 memoria para contener una estructura URB, se inicializa la estructura URB y se llama a WdfUsbTargetDeviceFormatRequestForUrb para dar formato a una solicitud que usa el contenido de la estructura URB. A continuación, el ejemplo registra una función de devolución de llamada CompletionRoutine y envía la solicitud a un destino de E/S.

WDFMEMORY urbMemory;
URB *urbBuffer;

status = WdfMemoryCreate(
                         WDF_NO_OBJECT_ATTRIBUTES,
                         NonPagedPool,
                         0,
                         sizeof(struct _URB_CONTROL_GET_CONFIGURATION_REQUEST),
                         &urbMemory,
                         NULL
                         );

if (!NT_SUCCESS(status)){
    return status;
}
urbBuffer = (PURB) WdfMemoryGetBuffer(
                                      urbMemory,
                                      NULL
                                      );
urbBuffer->UrbHeader.Function =  URB_FUNCTION_GET_CONFIGURATION;
urbBuffer->UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_CONFIGURATION_REQUEST);
urbBuffer->UrbControlGetConfigurationRequest.TransferBufferLength = 1 ;
urbBuffer->UrbControlGetConfigurationRequest.TransferBufferMDL = NULL;
urbBuffer->UrbControlGetConfigurationRequest.TransferBuffer = outBuffer;
urbBuffer->UrbControlGetConfigurationRequest.UrbLink = NULL;

status = WdfUsbTargetDeviceFormatRequestForUrb(
                                               deviceContext->WdfUsbTargetDevice,
                                               request,
                                               urbMemory,
                                               NULL
                                               );
WdfRequestSetCompletionRoutine(
                              request,
                              MyCompletionRoutine,
                              NULL);

if (WdfRequestSend(
                   request,
                   WdfUsbTargetDeviceGetIoTarget(UsbDevice),
                   NULL
                   ) == FALSE) {
    status = WdfRequestGetStatus(request);
}

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	<=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)