Función WdfIoTargetSendIoctlSynchronously (wdfiotarget.h)

Artículo
08/08/2023

[Se aplica a KMDF y UMDF]

El método WdfIoTargetSendIoctlSynchronously crea una solicitud de control de dispositivo y la envía de forma sincrónica a un destino de E/S.

Sintaxis

NTSTATUS WdfIoTargetSendIoctlSynchronously(
  [in]            WDFIOTARGET               IoTarget,
  [in, optional]  WDFREQUEST                Request,
  [in]            ULONG                     IoctlCode,
  [in, optional]  PWDF_MEMORY_DESCRIPTOR    InputBuffer,
  [in, optional]  PWDF_MEMORY_DESCRIPTOR    OutputBuffer,
  [in, optional]  PWDF_REQUEST_SEND_OPTIONS RequestOptions,
  [out, optional] PULONG_PTR                BytesReturned
);

Parámetros

[in] IoTarget

Identificador de un objeto de destino de E/S local o remoto obtenido de una llamada anterior a WdfDeviceGetIoTarget o WdfIoTargetCreate, o desde un método que proporciona un destino de E/S especializado.

[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] IoctlCode

Código de control de E/S (IOCTL) que admite el destino de E/S.

[in, optional] InputBuffer

Puntero a una estructura de WDF_MEMORY_DESCRIPTOR asignada por el autor de la llamada que describe un búfer que se escribirá en el destino de E/S. Para obtener más información, vea la sección Comentarios que se muestra más adelante. Este parámetro es opcional y puede ser NULL si la solicitud no envía datos.

[in, optional] OutputBuffer

Puntero a una estructura de WDF_MEMORY_DESCRIPTOR asignada por el autor de la llamada que describe un búfer que recibirá datos del destino de E/S. Para obtener más información, vea la sección Comentarios que se muestra más adelante. Este parámetro es opcional y puede ser NULL si la solicitud no recibe datos.

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

[out, optional] BytesReturned

Puntero a una ubicación que recibe información (como el número de bytes transferidos) que otro controlador proporciona cuando completa la solicitud llamando a WdfRequestCompleteWithInformation. Este puntero es opcional y puede ser NULL.

Valor devuelto

Si la operación se realiza correctamente, WdfIoTargetSendIoctlSynchronousmente devuelve una vez completada la solicitud de control de dispositivo y el valor devuelto es el valor de estado de finalización de la solicitud. De lo contrario, este método podría devolver uno de los siguientes valores:

Código devuelto	Descripción
STATUS_INVALID_PARAMETER	Se ha detectado un parámetro no válido.
STATUS_INFO_LENGTH_MISMATCH	El tamaño de la estructura de WDF_REQUEST_SEND_OPTIONS al que apuntaba el parámetro RequestOptions era incorrecto.
STATUS_INVALID_DEVICE_REQUEST	La solicitud ya estaba en cola en un destino de E/S.
STATUS_INSUFFICIENT_RESOURCES	El marco de trabajo no puede asignar recursos del sistema (normalmente memoria).
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 el método WdfIoTargetSendIoctlSynchronously para enviar solicitudes de control de dispositivos de forma sincrónica. Para enviar solicitudes de control de dispositivos de forma asincrónica, use el método WdfIoTargetFormatRequestForIoctl , seguido del método WdfRequestSend .

Para obtener más información sobre las solicitudes de control de dispositivos, consulte Uso de códigos de control de E/S.

El método WdfIoTargetSendIoctlSynchronously 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 control de dispositivo 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 control de dispositivo 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 WdfIoTargetSendIoctlSynchronously.
Use el búfer de entrada de la solicitud recibida para el parámetro InputBuffer del método WdfIoTargetSendIoctlSynchronously.
El controlador debe llamar a WdfRequestRetrieveInputMemory para obtener un identificador para un objeto de memoria del marco que representa el búfer de entrada de la solicitud. A continuación, el controlador debe colocar ese identificador en la estructura WDF_MEMORY_DESCRIPTOR que el controlador proporciona para el parámetro InputBuffer de WdfIoTargetSendIoctlSynchronously.
Use el búfer de salida de la solicitud recibida para el parámetro OutputBuffer del método OutputBuffer de WdfIoTargetSendIoctlSynchronously.
El controlador debe llamar a WdfRequestRetrieveOutputMemory para obtener un identificador a un objeto de memoria del marco que representa el búfer de salida de la solicitud. A continuación, el controlador debe colocar ese identificador en la estructura de WDF_MEMORY_DESCRIPTOR que el controlador proporciona para el parámetro OutputBuffer de WdfIoTargetSendIoctlSynchronously.

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

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 Request del método WdfIoTargetSendIoctlSynchronously, 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 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 que no sea NULL, ya sea que el controlador proporcione 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 los parámetros InputBuffer y OutputBuffer del método WdfIoTargetSendIoctlSynchronously, si la solicitud las requiere.
El controlador puede especificar este espacio de búfer como búferes asignados localmente, como identificadores WDFMEMORY o como listas de descriptores de memoria (MDL). Puede usar el método más conveniente.

Si es necesario, el marco convierte las descripciones del búfer para que sean correctas para el tipo de transferencia del IOCTL. Para obtener más información sobre los tipos de transferencia de IOCTL, vea Definición de códigos de control de E/S.

Las técnicas siguientes para especificar el espacio en búfer están disponibles:
- Proporcione búferes locales.
  Dado que WdfIoTargetSendIoctlSynchronousmente 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));
```
- Proporcione identificadores WDFMEMORY.
  Llame a WdfMemoryCreate o WdfMemoryCreatePreallocated para obtener un identificador para 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 o WdfRequestRetrieveOutputMemory para obtener un identificador para un objeto de memoria de marco que representa el búfer de una solicitud de E/S recibida, si desea que el controlador pase el contenido del búfer al destino de E/S. El controlador no debe completar la solicitud de E/S recibida hasta que la nueva solicitud que WdfIoTargetSendIoctlSynchronousmente envía al destino de E/S se ha eliminado, reutilizado o vuelto a formatear. (WdfIoTargetSendIoctlSynchronousmente 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).
- Proporcione MDL.
  Los controladores pueden obtener MDL asociados a una solicitud de E/S recibida llamando a WdfRequestRetrieveInputWdmMdl y WdfRequestRetrieveOutputWdmMdl.

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 WdfIoTargetSendIoctlSynchronously, vea Enviar solicitudes de E/S a destinos de E/S generales.

Para obtener más información sobre los destinos de E/S, consulte Uso de destinos de E/S.

Ejemplos

En el ejemplo de código siguiente se define un búfer local, se inicializa una estructura de WDF_MEMORY_DESCRIPTOR y se llama a WdfIoTargetSendIoctlSynchronously. 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.

WDF_MEMORY_DESCRIPTOR  outputDescriptor;
NTSTATUS  status;
HID_COLLECTION_INFORMATION  collectionInformation;

WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(
                                  &outputDescriptor,
                                  (PVOID) &collectionInformation,
                                  sizeof(HID_COLLECTION_INFORMATION)
                                  );

status = WdfIoTargetSendIoctlSynchronously(
                                           hidTarget,
                                           NULL,
                                           IOCTL_HID_GET_COLLECTION_INFORMATION,
                                           NULL,
                                           &outputDescriptor,
                                           NULL,
                                           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	wdfiotarget.h (incluya Wdf.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
Reglas de cumplimiento de DDI	DeferredRequestCompleted(kmdf), DriverCreate(kmdf), InternalIoctlReqs(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), ReadReqs(kmdf), RequestCompleted(kmdf), RequestCompletedLocal(kmdf), SyncReqSend(kmdf), WriteReqs(kmdf)