Función WdfIoTargetFormatRequestForInternalIoctlOthers (wdfiotarget.h)

Artículo
08/08/2023

[Solo se aplica a KMDF]

El método WdfIoTargetFormatRequestForInternalIoctlOthers compila una solicitud de control de dispositivo interno no estándar para un destino de E/S, pero no envía la solicitud.

Sintaxis

NTSTATUS WdfIoTargetFormatRequestForInternalIoctlOthers(
  [in]           WDFIOTARGET       IoTarget,
  [in]           WDFREQUEST        Request,
  [in]           ULONG             IoctlCode,
  [in, optional] WDFMEMORY         OtherArg1,
  [in, optional] PWDFMEMORY_OFFSET OtherArg1Offset,
  [in, optional] WDFMEMORY         OtherArg2,
  [in, optional] PWDFMEMORY_OFFSET OtherArg2Offset,
  [in, optional] WDFMEMORY         OtherArg4,
  [in, optional] PWDFMEMORY_OFFSET OtherArg4Offset
);

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 a partir de 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] OtherArg1

Identificador de un objeto de memoria de marco. Este objeto representa un búfer que el controlador usa para la información de contexto específica del controlador específica de la solicitud. 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.

[in, optional] OtherArg1Offset

Puntero a una estructura de WDFMEMORY_OFFSET asignada por el autor de la llamada que proporciona valores opcionales de desplazamiento y longitud de bytes. Los controladores pueden usar estos valores para especificar la dirección inicial y la longitud de un segmento del área de contexto especificada por OtherArg1. Este parámetro es opcional y puede ser NULL.

[in, optional] OtherArg2

[in, optional] OtherArg2Offset

Puntero a una estructura de WDFMEMORY_OFFSET asignada por el autor de la llamada que proporciona valores opcionales de desplazamiento y longitud de bytes. Los controladores pueden usar estos valores para especificar la dirección inicial y la longitud de un segmento del área de contexto especificada por OtherArg2. Este parámetro es opcional y puede ser NULL.

[in, optional] OtherArg4

[in, optional] OtherArg4Offset

Puntero a una estructura de WDFMEMORY_OFFSET asignada por el autor de la llamada que proporciona valores opcionales de desplazamiento y longitud de bytes. Los controladores pueden usar estos valores para especificar la dirección inicial y la longitud de un segmento del área de contexto especificada por OtherArg4. Este parámetro es opcional y puede ser NULL.

Valor devuelto

WdfIoTargetFormatRequestForInternalIoctlOthers 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
STATUS_INVALID_PARAMETER	Se ha detectado un parámetro no válido.
STATUS_INVALID_DEVICE_REQUEST	La longitud de 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.
STATUS_INSUFFICIENT_RESOURCES	El marco no pudo 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 WdfIoTargetFormatRequestForInternalIoctlOthers , seguido del método WdfRequestSend , para enviar solicitudes de control de dispositivos internos no estándar de forma sincrónica o asincrónica. Como alternativa, use el método WdfIoTargetSendInternalIoctlOthersSynchronously para enviar solicitudes de control de dispositivos internos no estándar de forma sincrónica.

Puede reenviar una solicitud de control de dispositivo interno no estándar 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 control de dispositivo interno no estándar 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 de WdfIoTargetFormatRequestForInternalIoctlOthers.
Use la información de contexto de la solicitud recibida para los parámetros OtherArg1, OtherArg2 y OtherArg2, de WdfIoTargetFormatRequestForInternalIoctlOthers.
Para obtener estos valores de parámetro, el controlador debe llamar a WdfRequestGetParameters y usar el miembro DeviceIoControl de la estructura WDF_REQUEST_PARAMETERS que se devuelve.

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 puede 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 WdfIoTargetFormatRequestForInternalIoctlOthers.
Llame a WdfRequestCreate para preasignar uno o varios objetos de solicitud. Puede reutilizar estos objetos de solicitud mediante una llamada a WdfRequestReuse. La función de devolución de llamada EvtDriverDeviceAdd del controlador puede asignar previamente objetos de solicitud para un dispositivo.
Proporcione búferes de contexto, si la solicitud los requiere, y proporcione identificadores de búfer para los parámetros WdfIoTargetFormatRequestForInternalIoctlOthers del método OtherArg1, OtherArg2 y OtherArg4 .
El controlador debe especificar este espacio de búfer como identificadores WDFMEMORY para la memoria administrada por el marco. Para obtener los identificadores WDFMEMORY, el controlador llama a WdfMemoryCreate o WdfMemoryCreatePreallocated.

Después de que un controlador llame a WdfIoTargetFormatRequestForInternalIoctlOthers para dar formato a una solicitud de control de dispositivo, el controlador debe llamar a WdfRequestSend para enviar la solicitud (ya sea de forma sincrónica o asincrónica) a un destino de E/S.

Varias llamadas a WdfIoTargetFormatRequestForInternalIoctlOthers 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 WdfIoTargetFormatRequestForInternalIoctlOthers) y volver a enviar (llamada a WdfRequestSend) cada objeto de solicitud sin arriesgar un valor devuelto de STATUS_INSUFFICIENT_RESOURCES desde una llamada posterior a WdfRequestCreate. (Si el controlador no llama al mismo método de formato de solicitud cada vez, se pueden asignar recursos adicionales). Todas las llamadas posteriores a WdfIoTargetFormatRequestForInternalIoctlOthers para el objeto de solicitud reutilizado devolverán STATUS_SUCCESS, si los valores de parámetro no cambian.

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 WdfIoTargetFormatRequestForInternalIoctlOthers, 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 crea un objeto de memoria de marco, se obtiene el búfer que contiene el objeto de memoria y se inicializa el búfer. A continuación, el ejemplo da formato a la solicitud, establece una función de devolución de llamada CompletionRoutine y envía la solicitud a un destino de E/S.

PIRB pIrb;
WDFMEMORY memory;
NTSTATUS status;

status = WdfMemoryCreate(
                         WDF_NO_OBJECT_ATTRIBUTES,
                         NonPagedPool,
                         0,
                         sizeof(IRB),
                         &memory,
                         NULL
                         );
if (!NT_SUCCESS(status)) {
    goto Done;
}
pIrb = WdfMemoryGetBuffer(
                          memory,
                          NULL
                          );

pIrb->FunctionNumber = REQUEST_ALLOCATE_ADDRESS_RANGE;
pIrb->Flags = 0;
pIrb->u.AllocateAddressRange.Mdl = pAsyncAddressData->pMdl;
pIrb->u.AllocateAddressRange.fulFlags = fulFlags;
pIrb->u.AllocateAddressRange.nLength = nLength;
pIrb->u.AllocateAddressRange.MaxSegmentSize = MaxSegmentSize;
pIrb->u.AllocateAddressRange.fulAccessType = fulAccessType;
pIrb->u.AllocateAddressRange.fulNotificationOptions = fulNotificationOptions;
pIrb->u.AllocateAddressRange.Callback = NULL;
pIrb->u.AllocateAddressRange.Context = NULL;
pIrb->u.AllocateAddressRange.Required1394Offset = *Required1394Offset;
pIrb->u.AllocateAddressRange.FifoSListHead = NULL;
pIrb->u.AllocateAddressRange.FifoSpinLock = NULL;
pIrb->u.AllocateAddressRange.AddressesReturned = 0;
pIrb->u.AllocateAddressRange.p1394AddressRange = pAsyncAddressData->AddressRange;
pIrb->u.AllocateAddressRange.DeviceExtension = deviceExtension;

status = WdfIoTargetFormatRequestForInternalIoctlOthers(
                                                        IoTarget,
                                                        Request,
                                                        IOCTL_1394_CLASS,
                                                        memory,
                                                        NULL,
                                                        NULL,
                                                        NULL,
                                                        NULL,
                                                        NULL
                                                        );

if (!NT_SUCCESS(status)) {
    goto Done;
}

WdfRequestSetCompletionRoutine(
                               Request,
                               MyRequestCompletion,
                               NULL
                               );

if (WdfRequestSend(
                   Request,
                   IoTarget,
                   NULL
                   ) == FALSE) {
    status = WdfRequestGetStatus(Request);
}
else {
    status = STATUS_SUCCESS;
}

Requisitos

Requisito	Value
Plataforma de destino	Universal
Versión mínima de KMDF	1.0
Encabezado	wdfiotarget.h (incluya Wdf.h)
Library	Wdf01000.sys (consulte Control de versiones de la biblioteca de marcos).
IRQL	<=DISPATCH_LEVEL
Reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestFormattedValid(kmdf), RequestSendAndForgetNoFormatting(kmdf), RequestSendAndForgetNoFormatting2(kmdf)