Función WdfIoTargetFormatRequestForIoctl (wdfiotarget.h)
[Se aplica a KMDF y UMDF]
El método WdfIoTargetFormatRequestForIoctl crea una solicitud de control de dispositivo para un destino de E/S, pero no envía la solicitud.
Sintaxis
NTSTATUS WdfIoTargetFormatRequestForIoctl(
[in] WDFIOTARGET IoTarget,
[in] WDFREQUEST Request,
[in] ULONG IoctlCode,
[in, optional] WDFMEMORY InputBuffer,
[in, optional] PWDFMEMORY_OFFSET InputBufferOffset,
[in, optional] WDFMEMORY OutputBuffer,
[in, optional] PWDFMEMORY_OFFSET OutputBufferOffset
);
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] 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.
[in] IoctlCode
Código de control de E/S (IOCTL) que admite el destino de E/S.
[in, optional] InputBuffer
Identificador de un objeto de memoria de marco. Este objeto representa un búfer que contiene datos que se enviarán al destino de E/S. Para obtener más información, vea la sección Comentarios que se muestra más adelante.
[in, optional] InputBufferOffset
Puntero a una estructura de WDFMEMORY_OFFSET asignada por el autor de la llamada que proporciona valores opcionales de desplazamiento de bytes y longitud. El marco usa estos valores para determinar la dirección y la longitud iniciales, dentro del búfer de entrada, para la transferencia de datos. Si este puntero es NULL, la transferencia de datos comienza al principio del búfer de entrada y el tamaño de la transferencia es el tamaño del búfer.
[in, optional] OutputBuffer
Identificador de un objeto de memoria de marco. Este objeto representa 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.
[in, optional] OutputBufferOffset
Puntero a una estructura de WDFMEMORY_OFFSET asignada por el autor de la llamada que proporciona valores opcionales de desplazamiento de bytes y longitud. El marco usa estos valores para determinar la dirección y la longitud iniciales, dentro del búfer de salida, para la transferencia de datos. Si este puntero es NULL, la transferencia de datos comienza al principio del búfer de salida y el tamaño de la transferencia es el tamaño del búfer.
Valor devuelto
WdfIoTargetFormatRequestForIoctl devuelve STATUS_SUCCESS 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 |
|---|---|
|
Se ha detectado un parámetro no válido. |
|
La longitud de la transferencia era mayor que la longitud del búfer o la solicitud de E/S ya estaba en cola en un destino de E/S. |
|
El marco no pudo asignar recursos del sistema (normalmente memoria). |
|
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 WdfIoTargetFormatRequestForIoctl , seguido del método WdfRequestSend , para enviar solicitudes de control de dispositivos de forma sincrónica o asincrónica. Como alternativa, use el método WdfIoTargetSendIoctlSynchronously para enviar solicitudes de control de dispositivos de forma sincrónica.
Para obtener más información sobre las solicitudes de control de dispositivos, consulte Uso de códigos de control de E/S.
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 Request del método WdfIoTargetFormatRequestForIoctl.
-
Use el búfer de entrada de la solicitud recibida para el parámetro InputBuffer del método InputBuffer de WdfIoTargetFormatRequestForIoctl.
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 y debe usar ese identificador como el valor de InputBuffer.
-
Use el búfer de salida de la solicitud recibida para el parámetro OutputBuffer del método OutputBuffer de WdfIoTargetFormatRequestForIoctl.
El controlador debe llamar a WdfRequestRetrieveOutputMemory para obtener un identificador en el búfer de salida de la solicitud y debe usar ese identificador como el valor de OutputBuffer.
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:
-
Cree un nuevo objeto de solicitud y proporcione su identificador para el parámetro Request del método Request del método WdfIoTargetFormatRequestForIoctl.
Llame a WdfRequestCreate para preasignar uno o varios objetos de solicitud. Puede reutilizar estos objetos 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.
-
Proporcione espacio de búfer y proporcione el identificador del búfer para los parámetros InputBuffer y OutputBuffer del método WdfIoTargetFormatRequestForIoctl.
El controlador debe especificar este espacio de búfer como identificadores WDFMEMORY para la memoria administrada por el marco. El controlador puede hacer lo siguiente:
- Llame a WdfMemoryCreate o WdfMemoryCreatePreallocated para crear un nuevo búfer de memoria, si desea que el controlador pase un nuevo búfer al destino de E/S.
- Llame a WdfRequestRetrieveInputMemory o WdfRequestRetrieveOutputMemory para obtener un identificador para el objeto de memoria que representa el búfer de una solicitud de E/S recibida, si desea que el controlador pase el contenido de ese búfer al destino de E/S.
Varias llamadas a WdfIoTargetFormatRequestForIoctl 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 WdfIoTargetFormatRequestForIoctl) y reenviar (llamar a WdfRequestSend) cada objeto de solicitud sin arriesgar un valor devuelto STATUS_INSUFFICIENT_RESOURCES de una llamada posterior a WdfRequestCreate. Todas las llamadas posteriores a WdfIoTargetFormatRequestForIoctl 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. Además, si el código de control de E/S especifica un tipo de transferencia de METHOD_BUFFERED, el marco debe asignar un búfer del sistema para cada solicitud y esa asignación podría producir un error debido a recursos de memoria insuficientes).
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 WdfIoTargetFormatRequestForIoctl, vea Envío de 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
El código siguiente reutiliza un objeto de solicitud asignado previamente y objetos de memoria asignados previamente. En el ejemplo se asignan búferes de entrada y salida a los objetos de memoria, se da formato al objeto de solicitud, se registra una función de devolución de llamada CompletionRoutine y se envía la solicitud a un destino de E/S.
NTSTATUS
NICSendOidRequestToTargetAsync(
IN WDFIOTARGET IoTarget,
IN WDFREQUEST Request,
IN PFILE_OBJECT FileObject,
IN ULONG IoctlControlCode,
IN OUT PVOID InputBuffer,
IN ULONG InputBufferLength,
IN OUT PVOID OutputBuffer,
IN ULONG OutputBufferLength,
OUT PULONG BytesReadOrWritten
)
{
NTSTATUS status;
PREQUEST_CONTEXT reqContext;
WDF_REQUEST_REUSE_PARAMS params;
WDFMEMORY inputMem, outputMem;
WDF_REQUEST_REUSE_PARAMS_INIT(
¶ms,
WDF_REQUEST_REUSE_NO_FLAGS,
STATUS_SUCCESS
);
status = WdfRequestReuse(Request, ¶ms);
if (!NT_SUCCESS(status)){
return status;
}
reqContext = GetRequestContext(Request);
inputMem = outputMem = NULL;
if (InputBuffer != NULL) {
status = WdfMemoryAssignBuffer(
reqContext->InputMemory,
InputBuffer,
InputBufferLength
);
if (!NT_SUCCESS(status)) {
return status;
}
inputMem = reqContext->InputMemory;
}
if (OutputBuffer != NULL) {
status = WdfMemoryAssignBuffer(
reqContext->OutputMemory,
OutputBuffer,
OutputBufferLength
);
if (!NT_SUCCESS(status)) {
return status;
}
outputMem = reqContext->OutputMemory;
}
status = WdfIoTargetFormatRequestForIoctl(
IoTarget,
Request,
IoctlControlCode,
inputMem,
NULL,
outputMem,
NULL
);
if (!NT_SUCCESS(status)) {
return status;
}
WdfRequestSetCompletionRoutine(
Request,
NICSendOidRequestToTargetAsyncCompletionRoutine,
BytesReadOrWritten
);
if (WdfRequestSend(
Request,
IoTarget,
WDF_NO_SEND_OPTIONS
) == FALSE) {
status = WdfRequestGetStatus(Request);
}
return status;
}
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 | <=DISPATCH_LEVEL |
| Reglas de cumplimiento de DDI | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestFormattedValid(kmdf), RequestSendAndForgetNoFormatting(kmdf), RequestSendAndForgetNoFormatting2(kmdf) |
Consulte también
WdfIoTargetFormatRequestForInternalIoctl
WdfIoTargetSendIoctlSynchronously