Función WdfUsbTargetPipeReadSynchronously (wdfusb.h)
[Se aplica a KMDF y UMDF]
El método WdfUsbTargetPipeReadSynchronously compila una solicitud de lectura y la envía sincrónicamente a una canalización de entrada USB especificada.
Sintaxis
NTSTATUS WdfUsbTargetPipeReadSynchronously(
[in] WDFUSBPIPE Pipe,
[in, optional] WDFREQUEST Request,
[in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions,
[in, optional] PWDF_MEMORY_DESCRIPTOR MemoryDescriptor,
[out, optional] PULONG BytesRead
);
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.
[in, optional] MemoryDescriptor
Puntero a una estructura de WDF_MEMORY_DESCRIPTOR asignada por el autor de la llamada que describe el búfer que recibirá datos del dispositivo. El tamaño del búfer debe ser un múltiplo del tamaño máximo del paquete de la canalización a menos que el controlador haya llamado WdfUsbTargetPipeSetNoMaximumPacketSizeCheck. Para obtener más información sobre este búfer, consulte la siguiente sección Comentarios.
[out, optional] BytesRead
Puntero a una ubicación que recibe el número de bytes leídos, si la operación se realiza correctamente. Este parámetro es opcional y puede ser NULL.
Valor devuelto
WdfUsbTargetPipeReadSynchronousmente 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 |
|---|---|
|
El tamaño de la estructura de WDF_REQUEST_SEND_OPTIONS a la que apunta 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 era PASSIVE_LEVEL, se especificó un descriptor de memoria no válido, el tipo de canalización no era válido, la dirección de transferencia no era válida o la solicitud de E/S especificada ya estaba en cola en un destino de E/S. |
|
El tamaño del búfer no era un múltiplo del tamaño máximo del paquete de la canalización. |
|
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 WdfUsbTargetPipeReadSynchronously para enviar solicitudes de lectura de forma sincrónica. Para enviar solicitudes de lectura de forma asincrónica, use WdfUsbTargetPipeFormatRequestForRead, seguido de WdfRequestSend.
La canalización que especifica el parámetro Pipe debe ser una canalización de entrada y el tipo de la canalización debe ser WdfUsbPipeTypeBulk o WdfUsbPipeTypeInterrupt.
El método WdfUsbTargetPipeReadSynchronously 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. En cualquier caso, el marco requiere un objeto de solicitud y algún espacio de búfer.
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 .
-
Use el búfer de salida de la solicitud recibida para el parámetro MemoryDescriptor del método MemoryDescriptor de WdfUsbTargetPipeReadSynchronously.
El controlador debe llamar a WdfRequestRetrieveOutputMemory para obtener un identificador de un objeto de memoria de marco que represente el búfer de salida de la solicitud y, a continuación, colocar ese identificador en la estructura de WDF_MEMORY_DESCRIPTOR a la que apunta MemoryDescriptor .
Los controladores suelen dividir las solicitudes de E/S recibidas en solicitudes más pequeñas que envían a un destino de E/S, por lo que el controlador puede crear nuevas solicitudes.
Para crear una nueva solicitud de E/S:
-
Proporcione un identificador de solicitud NULL en el parámetro Request del método WdfUsbTargetPipeReadSynchronously, 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.
El controlador puede especificar un parámetro RequestOptions distinto de NULL, independientemente de si el controlador proporciona 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.
-
Proporcione espacio de búfer para el parámetro MemoryDescriptor del método MemoryDescriptor de WdfUsbTargetPipeReadSynchronously.
El controlador puede especificar este espacio de búfer como un búfer asignado localmente, como un identificador WDFMEMORY o como MDL. Puede usar el método que sea más conveniente.
Si es necesario, el marco convierte la descripción del búfer en una que sea correcta para el método del destino de E/S para acceder a los búferes de datos.
Están disponibles las técnicas siguientes:
-
Proporcionar un búfer local
Dado que WdfUsbTargetPipeReadSynchronous controla de forma sincrónica las solicitudes de E/S, el controlador puede crear búferes de solicitudes locales para la rutina de llamada, como se muestra en el ejemplo de código siguiente.
WDF_MEMORY_DESCRIPTOR memoryDescriptor; MY_BUFFER_TYPE myBuffer; WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(&memoryDescriptor, (PVOID) &myBuffer, sizeof(myBuffer)); -
Proporcionar un identificador WDFMEMORY
Llame a WdfMemoryCreate o WdfMemoryCreatePreallocated para obtener un identificador de la memoria administrada por el marco, como se muestra en el ejemplo de código siguiente.
WDF_MEMORY_DESCRIPTOR memoryDescriptor; WDFMEMORY memoryHandle = NULL; status = WdfMemoryCreate(NULL, NonPagedPool, POOL_TAG, MY_BUFFER_SIZE, &memoryHandle, NULL); WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(&memoryDescriptor, memoryHandle, NULL);Como alternativa, el controlador puede llamar a WdfRequestRetrieveOutputMemory para obtener un identificador de un objeto de memoria de marco que representa el búfer de salida de una solicitud de E/S recibida, si desea que el controlador pase el contenido de ese búfer al destino de E/S. El controlador no debe completar la solicitud de E/S recibida hasta que la nueva solicitud que WdfUsbTargetPipeReadSynchronousmente envía al destino de E/S se ha eliminado, reutilizado o vuelto a formatear. (WdfUsbTargetPipeReadSynchronousmente incrementa el recuento de referencias del objeto de memoria. Al eliminar, reutilizar o volver a formatear un objeto de solicitud, se reduce el recuento de referencias del objeto de memoria).
-
Proporcionar una MDL
Los controladores pueden obtener la MDL asociada a una solicitud de E/S recibida llamando a WdfRequestRetrieveOutputWdmMdl.
-
Proporcionar un búfer local
Un controlador no puede llamar a WdfUsbTargetPipeReadSynchronousmente si ha configurado un lector continuo para la canalización.
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 WdfUsbTargetPipeReadSynchronously 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 de marco, se inicializa una estructura de WDF_MEMORY_DESCRIPTOR y se pasa la estructura a WdfUsbTargetPipeReadSynchronously. En este ejemplo se especifica NULL para el identificador de objeto de solicitud, por lo que el marco creará un nuevo objeto de solicitud para el destino de E/S.
WDFMEMORY wdfMemory;
WDF_MEMORY_DESCRIPTOR readBufDesc;
ULONG BytesRead;
status = WdfMemoryCreate(
WDF_NO_OBJECT_ATTRIBUTES,
NonPagedPool,
0,
readSize,
&wdfMemory,
NULL
);
if (!NT_SUCCESS(status)){
return ;
}
buffer = WdfMemoryGetBuffer(
wdfMemory,
NULL
);
WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(
&readBufDesc,
buffer,
readSize
);
status = WdfUsbTargetPipeReadSynchronously(
Pipe,
NULL,
NULL,
&readBufDesc,
&BytesRead
);
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), InternalIoctlReqs(kmdf), IoctlReqs(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), SyncReqSend(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf), WriteReqs(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