Función WdfUsbTargetPipeFormatRequestForUrb (wdfusb.h)

Artículo
08/08/2023

[Solo se aplica a KMDF]

El método WdfUsbTargetPipeFormatRequestForUrb crea una solicitud USB para una canalización USB especificada, utilizando parámetros de solicitud que describe un URB especificado, pero no envía la solicitud.

Sintaxis

NTSTATUS WdfUsbTargetPipeFormatRequestForUrb(
                 WDFUSBPIPE        PIPE,
  [in]           WDFREQUEST        Request,
  [in]           WDFMEMORY         UrbMemory,
  [in, optional] PWDFMEMORY_OFFSET UrbMemoryOffset
);

Parámetros

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

Identificador de un objeto de memoria de marco que contiene una estructura URB .

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.

[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

WdfUsbTargetPipeFormatRequestForUrb 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_INTEGER_OVERFLOW	El desplazamiento que especificó el parámetro UsbMemoryOffset no era válido.
STATUS_REQUEST_NOT_ACCEPTED	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 WdfUsbTargetPipeFormatRequestForUrb, seguido de WdfRequestSend, para enviar una solicitud USB de forma sincrónica o asincrónica. Como alternativa, use el método WdfUsbTargetPipeSendUrbSynchronously para enviar una solicitud de forma sincrónica.

El marco no examina la solicitud USB. Si la solicitud cambia el estado de la canalización USB, el marco no será consciente del cambio.

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

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 Request del método WdfUsbTargetPipeFormatRequestForUrb. Puede reutilizar el objeto de solicitud llamando a WdfRequestReuse, por lo que 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 WdfUsbTargetPipeFormatRequestForUrb 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.

Varias llamadas a WdfUsbTargetPipeFormatRequestForUrb 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 WdfUsbTargetPipeFormatRequestForUrb) 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 WdfUsbTargetPipeFormatRequestForUrb 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 WdfUsbTargetPipeFormatRequestForUrb 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 que representa un URB. A continuación, el ejemplo inicializa el URB, da formato a una solicitud USB que contiene el URB, registra una función de devolución de llamada CompletionRoutine y envía la solicitud.

URB  urb;
PURB  pUrb = NULL;
WDFMEMORY  urbMemory
NTSTATUS status;

status = WdfMemoryCreate(
                         WDF_NO_OBJECT_ATTRIBUTES,
                         NonPagedPool,
                         0,
                         sizeof(struct _URB_GET_CURRENT_FRAME_NUMBER),
                         &urbMemory,
                         NULL
                         );
if (!NT_SUCCESS(status)){
    return status;
}

pUrb = WdfMemoryGetBuffer(
                          urbMemory,
                          NULL
                          );

pUrb->UrbHeader.Length = (USHORT) sizeof(struct _URB_GET_CURRENT_FRAME_NUMBER);
pUrb->UrbHeader.Function = URB_FUNCTION_GET_CURRENT_FRAME_NUMBER;
pUrb->UrbGetCurrentFrameNumber.FrameNumber = 0; 

status = WdfUsbTargetPipeFormatRequestForUrb(
                                             pipe,
                                             Request,
                                             urbMemory,
                                             NULL
                                             );
if (!NT_SUCCESS(status)) {
    goto Exit;
}
WdfRequestSetCompletionRoutine(
                               Request,
                               UrbCompletionRoutine,
                               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
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)