WdfIoTargetFormatRequestForInternalIoctl 函数 (wdfiotarget.h)

[仅适用于 KMDF]

WdfIoTargetFormatRequestForInternalIoctl 方法为 I/O 目标生成内部设备控制请求,但不发送请求。

语法

NTSTATUS WdfIoTargetFormatRequestForInternalIoctl(
  [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
);

参数

[in] IoTarget

本地或远程 I/O 目标对象的句柄,该对象是从上一次调用 WdfDeviceGetIoTargetWdfIoTargetCreate 获取的,或者从专用 I/O 目标提供的方法获取的。

[in] Request

框架请求对象的句柄。 有关更多信息,请参见下面的“备注”部分。

[in] IoctlCode

I/O 目标支持的 IOCTL) (I/O 控制代码。

[in, optional] InputBuffer

框架内存对象的句柄。 此对象表示包含将发送到 I/O 目标的数据的缓冲区。 有关更多信息,请参见下面的“备注”部分。

[in, optional] InputBufferOffset

指向调用方分配 的WDFMEMORY_OFFSET 结构的指针,该结构提供可选的字节偏移量和长度值。 框架使用这些值来确定输入缓冲区内数据传输的起始地址和长度。 如果此指针为 NULL,则数据传输从输入缓冲区的开头开始,传输大小为缓冲区大小。

[in, optional] OutputBuffer

框架内存对象的句柄。 此对象表示将从 I/O 目标接收数据的缓冲区。 有关更多信息,请参见下面的“备注”部分。

[in, optional] OutputBufferOffset

指向调用方分配 的WDFMEMORY_OFFSET 结构的指针,该结构提供可选的字节偏移量和长度值。 框架使用这些值来确定输出缓冲区中数据传输的起始地址和长度。 如果此指针为 NULL,则数据传输从输出缓冲区的开头开始,传输大小为缓冲区大小。

返回值

如果操作成功,WdfIoTargetFormatRequestForInternalIoctl 将返回STATUS_SUCCESS。 否则,此方法可能会返回以下值之一:

返回代码 说明
STATUS_INVALID_PARAMETER
检测到参数无效。
STATUS_INVALID_DEVICE_REQUEST
传输长度大于缓冲区长度,或者 I/O 请求已排队到 I/O 目标。
STATUS_INSUFFICIENT_RESOURCES
框架无法分配系统资源 (通常是内存) 。
STATUS_REQUEST_NOT_ACCEPTED
Request 参数表示的 I/O 请求数据包 (IRP) 不提供足够的IO_STACK_LOCATION结构来允许驱动程序转发请求。
 

此方法还可能返回其他 NTSTATUS 值

如果驱动程序提供无效的对象句柄,则会发生 bug 检查。

注解

使用 WdfIoTargetFormatRequestForInternalIoctl 方法(后跟 WdfRequestSend 方法)以同步或异步方式发送内部设备控制请求。 或者,使用 WdfIoTargetSendInternalIoctlSynchronously 方法以同步方式发送内部设备控制请求。

有关内部设备控制请求的详细信息,请参阅 使用 I/O 控制代码

可以转发驱动程序在 I/O 队列中收到的内部设备控制请求,也可以创建并发送新请求。 在任一情况下,框架都需要请求对象和一些缓冲区空间。

若要转发驱动程序在 I/O 队列中收到的内部设备控制请求,请执行以下操作:

  1. WdfIoTargetFormatRequestForInternalIoctl 方法的 Request 参数指定接收的请求句柄。
  2. 将接收的请求的输入缓冲区用于 WdfIoTargetFormatRequestForInternalIoctl 方法的 InputBuffer 参数。

    驱动程序必须调用 WdfRequestRetrieveInputMemory 来获取请求输入缓冲区的句柄,并且必须使用该句柄作为 InputBuffer 的值。

  3. 将接收的请求的输出缓冲区用于 WdfIoTargetFormatRequestForInternalIoctl 方法的 OutputBuffer 参数。

    驱动程序必须调用 WdfRequestRetrieveOutputMemory 来获取请求输出缓冲区的句柄,并且必须使用该句柄作为 OutputBuffer 的值。

有关转发 I/O 请求的详细信息,请参阅 转发 I/O 请求

驱动程序通常将收到的 I/O 请求划分为发送到 I/O 目标的较小请求,因此驱动程序可能会创建新请求。

创建新的 I/O 请求:

  1. 创建新的请求对象,并为 WdfIoTargetFormatRequestForInternalIoctl 方法的 Request 参数提供其句柄。

    调用 WdfRequestCreate 以预分配一个或多个请求对象。 可以通过调用 WdfRequestReuse 来重复使用这些请求对象。 驱动程序的 EvtDriverDeviceAdd 回调函数可以为设备预分配请求对象。

  2. 提供缓冲区空间,并为 WdfIoTargetFormatRequestForInternalIoctl 方法的 InputBufferOutputBuffer 参数提供缓冲区的句柄。

    驱动程序必须将此缓冲区空间指定为框架托管内存的 WDFMEMORY 句柄。 驱动程序可以执行以下任一操作:

    请注意,如果驱动程序调用 WdfRequestRetrieveInputMemoryWdfRequestRetrieveOutputMemory 并将内存句柄传递给 WdfIoTargetFormatRequestForInternalIoctl,则在驱动程序删除、重用或重新设置驱动程序创建的新请求对象之前,驱动程序不得完成收到的 I/O 请求。 (WdfIoTargetFormatRequestForInternalIoctl 递增内存对象的引用计数。删除、重用或重新格式化请求对象会递减内存对象的引用计数。)
驱动程序调用 WdfIoTargetFormatRequestForInternalIoctl 格式化设备控制请求后,驱动程序必须调用 WdfRequestSend 以同步或异步方式将请求 () 发送到 I/O 目标。

对使用同一请求的 WdfIoTargetFormatRequestForInternalIoctl 的多次调用不会导致额外的资源分配。 因此,为了降低 WdfRequestCreate 返回STATUS_INSUFFICIENT_RESOURCES的可能性,驱动程序的 EvtDriverDeviceAdd 回调函数可以调用 WdfRequestCreate 来预分配设备的一个或多个请求对象。 随后,驱动程序可以重复使用 (调用 WdfRequestReuse) 、重新设置格式 (调用 WdfIoTargetFormatRequestForInternalIoctl) ,并重新发送 (调用 WdfRequestSend) 每个请求对象,而不会冒着以后调用 WdfRequestCreate STATUS_INSUFFICIENT_RESOURCES返回值的风险。 如果参数值不更改,则对重用的请求对象对 WdfIoTargetFormatRequestForInternalIoctl 的所有后续调用都将返回STATUS_SUCCESS。 (但是,如果驱动程序每次都不调用相同的请求格式设置方法,可能会分配其他资源。此外,如果 I/O 控制代码 指定METHOD_BUFFERED传输类型,则框架必须为每个请求分配一个系统缓冲区,并且该分配可能会因为内存资源不足而失败。)

有关在 I/O 请求完成后获取状态信息的信息,请参阅 获取完成信息

有关 WdfIoTargetFormatRequestForInternalIoctl 的详细信息,请参阅 向常规 I/O 目标发送 I/O 请求

有关 I/O 目标的详细信息,请参阅 使用 I/O 目标

示例

下面的代码示例创建一个框架内存对象,该对象是请求对象的子级。 接下来,该示例获取内存对象包含的缓冲区并初始化缓冲区。 然后,该示例格式化请求,设置 CompletionRoutine 回调函数,并将请求发送到 I/O 目标。

WDF_OBJECT_ATTRIBUTES memoryObjAttr;
WDFMEMORY memory;
NTSTATUS status;
IOCTL_DATA *pIoctlData;

WDF_OBJECT_ATTRIBUTES_INIT(&memoryObjAttr);
memoryObjAttr.ParentObject = Request;

status = WdfMemoryCreate(
                         &memoryObjAttr,
                         NonPagedPool,
                         0,
                         sizeof(IOCTL_DATA),
                         &memory,
                         NULL
                         );
if (!NT_SUCCESS(status)) {
    goto Done;
}
pIoctlData = WdfMemoryGetBuffer(
                                memory,
                                NULL
                                );
RtlZeroMemory(
              pIoctlData,
              sizeof(IOCTL_DATA)
              );
pIoctlData->Member1 = MY_DATA;

status = WdfIoTargetFormatRequestForInternalIoctl(
                                                  IoTarget,
                                                  Request,
                                                  IOCTL_INTERNAL_GET_MY_DATA,
                                                  memory,
                                                  NULL,
                                                  WDF_NO_HANDLE,
                                                  NULL
                                                  );

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

WdfRequestSetCompletionRoutine(
                               Request,
                               MyRequestCompletion,
                               NULL
                               );

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

要求

要求
目标平台 通用
最低 KMDF 版本 1.0
标头 wdfiotarget.h (包括 Wdf.h)
Library Wdf01000.sys (请参阅框架库 Versioning.)
IRQL <=DISPATCH_LEVEL
DDI 符合性规则 DriverCreate (kmdf) KmdfIrql (kmdf) KmdfIrql2 (kmdf) , KmdfIrqlExplicit (kmdf) , RequestFormattedValid (kmdf) RequestSendAndForgetNoFormatting (kmdf) RequestSendAndForgetNoFormatting2 (kmdf)

另请参阅

EvtDriverDeviceAdd

WDFMEMORY_OFFSET

WdfDeviceGetIoTarget

WdfIoTargetCreate

WdfIoTargetFormatRequestForIoctl

WdfIoTargetSendInternalIoctlSynchronously

WdfIoTargetSendIoctlSynchronously

WdfMemoryCreate

WdfMemoryCreatePreallocated

WdfRequestCreate

WdfRequestRetrieveInputMemory

WdfRequestRetrieveOutputMemory

WdfRequestReuse

WdfRequestSend