Función WdfUsbTargetPipeResetSynchronously (wdfusb.h)
[Se aplica a KMDF y UMDF]
El método WdfUsbTargetPipeResetSynchronously compila una solicitud de restablecimiento y la envía de forma sincrónica a una canalización USB especificada.
Sintaxis
NTSTATUS WdfUsbTargetPipeResetSynchronously(
[in] WDFUSBPIPE Pipe,
[in, optional] WDFREQUEST Request,
[in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions
);
Parámetros
[in] Pipe
Identificador de un objeto de canalización de marco que se obtuvo mediante una llamada a WdfUsbInterfaceGetConfiguredPipe.
[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.
Valor devuelto
WdfUsbTargetPipeResetSynchronousmente 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 |
|---|---|
|
El tamaño de la estructura WDF_REQUEST_SEND_OPTIONS que especificó el parámetro RequestOptions era incorrecto. |
|
Se ha detectado un parámetro no válido. |
|
No había suficiente memoria disponible. |
|
El IRQL del autor de la llamada no se PASSIVE_LEVEL o la solicitud de E/S que el parámetro Request especificado ya estaba en cola en un destino de E/S. |
|
El controlador proporcionó un valor de tiempo de espera y la solicitud no se completó dentro del tiempo asignado. |
|
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 el método WdfUsbTargetPipeResetSynchronously para enviar una solicitud de restablecimiento USB de forma sincrónica. Para enviar estas solicitudes de forma asincrónica, use WdfUsbTargetPipeFormatRequestForReset, seguido de WdfRequestSend.
Antes de que el marco restablezca la canalización USB del destino de E/S, cancela todas las solicitudes de E/S que permanecen en la cola del destino de E/S. El controlador no debe enviar solicitudes de E/S adicionales al destino de E/S hasta que WdfUsbTargetPipeResetSynchronously devuelva.
El controlador debe llamar a WdfIoTargetStop antes de llamar a WdfUsbTargetPipeResetSynchronously. Después de que WdfUsbTargetPipeResetSynchronously devuelva, el controlador puede llamar a WdfIoTargetStart.
Cuando un controlador llama a WdfUsbTargetPipeResetSynchronousmente, 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.
El método WdfUsbTargetPipeResetSynchronously 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.
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 WdfUsbTargetPipeResetSynchronously.
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 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.
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 WdfUsbTargetPipeResetSynchronously y los destinos de E/S USB, consulte Destinos de E/S USB.
Ejemplos
En el ejemplo de código siguiente se envía una solicitud de restablecimiento a la canalización de un dispositivo USB.
NTSTATUS status;
status = WdfUsbTargetPipeResetSynchronously(
Pipe,
WDF_NO_HANDLE,
NULL
);
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), 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