EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE回调函数 (wdfchildlist.h)

[仅适用于 KMDF]

驱动程序的 EvtChildListAddressDescriptionDuplicate 事件回调函数复制子地址说明。

语法

EVT_WDF_CHILD_LIST_ADDRESS_DESCRIPTION_DUPLICATE EvtWdfChildListAddressDescriptionDuplicate;

NTSTATUS EvtWdfChildListAddressDescriptionDuplicate(
  [in]  WDFCHILDLIST ChildList,
  [in]  PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER SourceAddressDescription,
  [out] PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER DestinationAddressDescription
)
{...}

参数

[in] ChildList

框架子列表对象的句柄。

[in] SourceAddressDescription

指向标识子地址说明的源位置的 WDF_CHILD_ADDRESS_DESCRIPTION_HEADER 结构的指针。

[out] DestinationAddressDescription

指向标识子地址说明的目标位置的WDF_CHILD_ADDRESS_DESCRIPTION_HEADER结构的指针。

返回值

如果作成功,则 EvtChildListAddressDescriptionDuplicate 回调函数必须返回STATUS_SUCCESS,或者 NT_SUCCESS状态等于 TRUE的另一个状态值。 否则,此函数必须返回一个状态值,NT_SUCCESS(状态)等于 FALSE

言论

如果总线驱动程序使用 动态枚举,则可以通过调用 WdfFdoInitSetDefaultChildListConfigWdfChildListCreate来注册 EvtChildListAddressDescriptionDuplicate 回调函数。

框架复制驱动程序提供的地址说明,以便它可以有说明的内部副本。

EvtChildListAddressDescriptionDuplicate 回调函数必须创建地址说明的副本。 如果驱动程序的子设备需要地址说明,并且框架无法调用 RtlCopyMemory 复制地址说明,驱动程序必须提供此回调函数。 (如果说明包含指向其他内存的指针,则框架无法调用 RtlCopyMemory

如果驱动程序提供地址说明,但不提供 EvtChildListAddressDescriptionDuplicate 回调函数,则框架会通过调用 RtlCopyMemory来复制地址说明。

以下步骤描述了典型方案:

  1. 驱动程序确定子设备是否存在。
  2. 驱动程序通过填写包含 WDF_CHILD_ADDRESS_DESCRIPTION_HEADER 结构的驱动程序定义结构,并可能通过动态分配其他内存来存储具有设备特定大小的地址信息来创建地址说明。
  3. 驱动程序调用 WdfChildListAddOrUpdateChildDescriptionAsPresent 来报告子设备,并提供指向地址说明的指针。
  4. 该框架调用 EvtChildListAddressDescriptionDuplicate 回调函数(如果存在),或 RtlCopyMemory 复制地址说明,以便它可以具有说明的内部副本。
如果说明包含由 AddressDescriptionSize WDF_CHILD_ADDRESS_DESCRIPTION_HEADER 成员指定的单个结构,则框架可以使用 RtlCopyMemory 复制地址说明。 但是,有时说明还必须包含存储在动态分配内存中的其他信息。 在这种情况下,通常会定义说明结构,以便成员指向动态分配的内存,并且驱动程序必须提供 EvtChildListAddressDescriptionDuplicate 回调函数。 回调函数必须执行以下作:
  1. 分配额外的内存,通常通过调用 exAllocatePool
  2. 将分配的内存地址存储在驱动程序定义的地址描述结构中(即回调函数的 DestinationAddressDescription 结构)。
  3. 将回调函数的 SourceAddressDescription 结构中的其他结构成员复制到回调函数的 DestinationAddressDescription 结构。
驱动程序 EvtChildListAddressDescriptionDuplicate 回调函数调用的唯一 框架子列表对象 方法是 WdfChildListGetDevice

框架在调用 EvtChildListAddressDescriptionDuplicate 回调函数之前获取内部子列表对象锁。 回调函数只能执行与描述的重复作相关的作,例如调用框架内存对象方法和访问对象上下文空间。 它不得调用访问其他驱动程序的方法。

如果驱动程序提供 EvtChildListAddressDescriptionDuplicate 回调函数,则它可能需要 EvtChildListAddressDescriptionCopyEvtChildListAddressDescriptionCleanup 回调函数。

有关动态枚举的详细信息,请参阅 枚举总线上的设备。

要求

要求 价值
目标平台 普遍
最低 KMDF 版本 1.0
标头 wdfchildlist.h (包括 Wdf.h)
IRQL <= DISPATCH_LEVEL

另请参阅

EvtChildListAddressDescriptionCleanup

ExAllocatePool

RtlCopyMemory

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

WdfChildListAddOrUpdateChildDescriptionAsPresent

WdfChildListCreate

WdfChildListGetDevice

WdfFdoInitSetDefaultChildListConfig