Función WdfUsbTargetPipeFormatRequestForReset (wdfusb.h)
[Se aplica a KMDF y UMDF]
El método WdfUsbTargetPipeFormatRequestForReset crea una solicitud de restablecimiento para una canalización USB especificada, pero no envía la solicitud.
Sintaxis
NTSTATUS WdfUsbTargetPipeFormatRequestForReset(
[in] WDFUSBPIPE Pipe,
[in] WDFREQUEST Request
);
Parámetros
[in] 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.
Valor devuelto
WdfUsbTargetPipeFormatRequestForReset devuelve el valor de estado de finalización del destino de E/S USB 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. |
|
No había suficiente memoria disponible. |
|
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 WdfUsbTargetPipeFormatRequestForReset, seguido de WdfRequestSend, para enviar una solicitud de restablecimiento USB de forma sincrónica o asincrónica. Como alternativa, use el método WdfUsbTargetPipeResetSynchronously para enviar una solicitud de forma sincrónica.
Antes de que el controlador llame a WdfRequestSend, debe llamar a WdfIoTargetStop y debe completar o cancelar todas las solicitudes de E/S que ha enviado al destino de E/S. El controlador no debe enviar solicitudes de E/S adicionales al destino de E/S hasta que se complete la solicitud de restablecimiento.
Cuando un controlador llama a WdfRequestSend, el marco envía una solicitud de URB_FUNCTION_RESET_PIPE al destino de E/S. Para obtener más información sobre cómo restablecer una canalización USB, consulte la especificación USB.
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 WdfUsbTargetPipeFormatRequestForReset.
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 WdfUsbTargetPipeFormatRequestForReset. 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 WdfUsbTargetPipeFormatRequestForReset 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 WdfUsbTargetPipeFormatRequestForReset 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 WdfUsbTargetPipeFormatRequestForReset) 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 WdfUsbTargetPipeFormatRequestForReset 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 WdfUsbTargetPipeFormatRequestForReset y los destinos de E/S USB, consulte Destinos de E/S USB.
Ejemplos
En el ejemplo de código siguiente se da formato a una solicitud de restablecimiento de una canalización USB, se registra una función de devolución de llamada CompletionRoutine y se envía la solicitud.
status = WdfUsbTargetPipeFormatRequestForReset(
pipe,
Request
);
if (!NT_SUCCESS(status)) {
goto Exit;
}
WdfRequestSetCompletionRoutine(
Request,
AbortCompletionRoutine,
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 |
| 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) |
Consulte también
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de