Función WdfUsbTargetPipeWriteSynchronously (wdfusb.h)

Artículo
07/16/2024

[Se aplica a KMDF y UMDF]

El método WdfUsbTargetPipeWriteSynchronousmente compila una solicitud de escritura y la envía de forma sincrónica a una canalización de salida USB especificada.

Sintaxis

NTSTATUS WdfUsbTargetPipeWriteSynchronously(
  [in]            WDFUSBPIPE                Pipe,
  [in, optional]  WDFREQUEST                Request,
  [in, optional]  PWDF_REQUEST_SEND_OPTIONS RequestOptions,
  [in, optional]  PWDF_MEMORY_DESCRIPTOR    MemoryDescriptor,
  [out, optional] PULONG                    BytesWritten
);

Parámetros

[in] Pipe

Identificador de un objeto de canalización de marco que se obtuvo llamando a WdfUsbInterfaceGetConfiguredPipe.

[in, optional] Request

Identificador de un objeto de solicitud de marco. Este parámetro es opcional y se puede NULL. Para obtener más información, vea la siguiente sección Comentarios.

[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 se puede NULL. Para obtener más información, vea la siguiente sección Comentarios.

[in, optional] MemoryDescriptor

Puntero a una estructura de WDF_MEMORY_DESCRIPTOR asignada por el autor de la llamada que describe el búfer que contiene los datos que se escribirán en el dispositivo. Para obtener más información sobre este búfer, consulte la siguiente sección Comentarios.

[out, optional] BytesWritten

Puntero a una ubicación que recibe el número de bytes escritos, si la operación se realiza correctamente. Este parámetro es opcional y se puede NULL.

Valor devuelto

WdfUsbTargetPipeWriteSynchronously 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 podría devolver uno de los siguientes valores:

Código devuelto	Descripción
STATUS_INFO_LENGTH_MISMATCH	El tamaño de la estructura de WDF_REQUEST_SEND_OPTIONS a la que apunta el parámetro RequestOptions de era incorrecto.
STATUS_INVALID_PARAMETER	Se detectó un parámetro no válido.
STATUS_INSUFFICIENT_RESOURCES	Memoria insuficiente disponible.
STATUS_INVALID_DEVICE_REQUEST	El IRQL del autor de la llamada no 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.
STATUS_IO_TIMEOUT	El controlador proporcionó un valor de tiempo de espera y la solicitud no se completó dentro del tiempo asignado.
STATUS_REQUEST_NOT_ACCEPTED	El paquete de solicitud de E/S (IRP) que representa el parámetro solicitud de no proporciona suficientes estructuras IO_STACK_LOCATION para permitir que el controlador reenvíe la solicitud.

Este método también puede devolver otros valores de NTSTATUS.

Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.

Observaciones

Use el método WdfUsbTargetPipeWriteSynchronously para enviar solicitudes de escritura de forma sincrónica. Para enviar solicitudes de escritura de forma asincrónica, use WdfUsbTargetPipeFormatRequestForWrite, seguido de WdfRequestSend.

La canalización especificada debe ser una canalización de salida y el tipo de de la canalización debe ser WdfUsbPipeTypeBulk o WdfUsbPipeTypeInterrupt.

El método WdfUsbTargetPipeWriteSynchronously no devuelve hasta que se haya completado la solicitud, a menos que el controlador especifique un valor de tiempo de espera en la estructura WDF_REQUEST_SEND_OPTIONS del 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 un 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 de .
Use el búfer de entrada de la solicitud recibida para el parámetro MemoryDescriptor.
El controlador debe llamar a WdfRequestRetrieveInputMemory para obtener un identificador de un objeto de memoria del marco que representa el búfer de entrada de la solicitud y, a continuación, colocar ese identificador en la estructura de WDF_MEMORY_DESCRIPTOR que MemoryDescriptor apunta.

Para obtener más información sobre el reenvío de una solicitud de E/S, consulte Solicitudes de E/S de reenvío.

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 podría crear nuevas solicitudes.

Para crear una nueva solicitud de E/S:

Proporcione un identificador de solicitud
NULL para el parámetro WdfUsbTargetPipeWriteSynchronousmente del método 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 llamando a WdfRequestReuse. Esta técnica permite al controlador EvtDriverDeviceAdd función de devolución de llamada para 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 que no sea NULLNULL o un parámetro request null 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 MemoryDescriptor del método TargetPipeWriteSynchronous mente.
El controlador puede especificar este espacio de búfer como un búfer asignado localmente, como identificador WDFMEMORY o como MDL. Puede usar el método más conveniente.

Si es necesario, el marco convierte la descripción del búfer en una que sea correcta para el método de de 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 WdfUsbTargetPipeWriteSynchronously controla las solicitudes de E/S de forma sincrónica, 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 WdfRequestRetrieveInputMemory para obtener un identificador a un objeto de memoria de marco que representa el búfer de entrada 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 WdfUsbTargetPipeWriteSynchronousmente envía al destino de E/S se ha eliminado, reutilizado o vuelto a formatear. (WdfUsbTargetPipeWriteSynchronously incrementa el recuento de referencias del objeto de memoria. Eliminar, reutilizar o volver a formatear un objeto de solicitud disminuye 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 WdfRequestRetrieveInputWdmMdl.

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 WdfUsbTargetPipeWriteSynchronously 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, se obtiene un puntero al búfer del objeto, se rellena el búfer y se usa el búfer como entrada para WdfUsbTargetPipeWriteSynchronousmente.

WDF_MEMORY_DESCRIPTOR  writeBufDesc;
WDFMEMORY  wdfMemory;
ULONG  writeSize, bytesWritten;
size_t  bufferSize;
NTSTATUS status;

writeSize = SMALL_BUF_LEN;
status = WdfMemoryCreate(
                         WDF_NO_OBJECT_ATTRIBUTES,
                         NonPagedPool,
                         0,
                         writeSize,
                         &wdfMemory,
                         NULL
                         );
if (!NT_SUCCESS(status)){
    return status;
}

writeBuffer = WdfMemoryGetBuffer(
                                 wdfMemory,
                                 &bufferSize
                                 );

FillMyBuffer(
             writeBuffer,
             writeSize
             );

WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(
                                  &writeBufDesc,
                                  writeBuffer,
                                  writeSize
                                  );

status = WdfUsbTargetPipeWriteSynchronously(
                                            pipeHandle,
                                            NULL,
                                            NULL,
                                            &writeBufDesc,
                                            &bytesWritten
                                            );

Requisitos

Requisito	Valor
de la plataforma de destino de	Universal
versión mínima de KMDF	1.0
versión mínima de UMDF	2.0
encabezado de	wdfusb.h (incluya Wdfusb.h)
biblioteca de	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), ReadReqs(kmdf), SyncReqSend(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf)