EVT_SERCX2_SELECT_NEXT_TRANSMIT_TRANSACTION_TYPE回调函数 (sercx.h)

项目
08/07/2023

序列化框架扩展的版本 2 (SerCx2) 调用 EvtSerCx2SelectNextTransmitTransactionType 事件回调函数，以确定下一次写入操作要使用的数据传输机制。

语法

EVT_SERCX2_SELECT_NEXT_TRANSMIT_TRANSACTION_TYPE EvtSercx2SelectNextTransmitTransactionType;

SERCX2_TRANSACTION_TYPE EvtSercx2SelectNextTransmitTransactionType(
  [in]  WDFDEVICE Device,
  [in]  PMDL Mdl,
  [in]  ULONG Offset,
  [in]  ULONG RemainingLength,
  [out] SERCX2CUSTOMTRANSMIT *CustomTransmit,
  [out] PULONG NextTransactionLength
)
{...}

参数

[in] Device

表示串行控制器的框架设备对象的 WDFDEVICE 句柄。串行控制器驱动程序在其 EvtDriverDeviceAdd 回调函数中创建此对象。有关详细信息，请参阅 SerCx2InitializeDevice。

[in] Mdl

指向 MDL 的指针，该 MDL 描述写入缓冲区为下一个传输事务跨越的内存页。 DMA 传输的散点/收集列表将使用此内存的区域，该区域由 Offset 和 Length 参数指定。

[in] Offset

下一次数据传输的起始偏移量。此参数是 MDL 描述的缓冲区区域开头的字节偏移量。如果 MDL 指定缓冲区空间的总 N 个字节，则 Offset 的可能值介于 0 到 N–1 之间。

[in] RemainingLength

当前写入 (IRP_MJ_WRITE) 请求中要传输的数据的总字节数。如果 MDL 指定缓冲区空间的总 N 个字节，则 Length 的可能值在 1 到 N–Offset 的范围内。

[out] CustomTransmit

指向函数将 SERCX2CUSTOMTRANSMIT 句柄写入自定义传输对象的位置的指针。如果函数返回 SerCx2TransactionTypeCustom，则函数必须提供串行控制器驱动程序在上一次调用 SerCx2CustomTransmitCreate 方法中创建的对象句柄。如果返回值不是 SerCx2TransactionTypeCustom，则 SerCx2 将忽略此输出值。

[out] NextTransactionLength

指向函数写入下一个传输事务中要传输的字节数的位置的指针。如果返回值为 SerCx2TransactionTypeDefault，则 SerCx2 将忽略此输出值。

返回值

EvtSerCx2SelectNextTransmitTransactionType 函数返回一个SERCX2_TRANSACTION_TYPE枚举常量，以指示是使用驱动程序选择的事务类型 (编程的 I/O (PIO) 、系统 DMA 或自定义数据传输) ，还是让 SerCx2 选择要用于下一个传输事务的事务类型。

注解

串行控制器驱动程序可以选择实现此函数。如果实现，驱动程序会在对 SerCx2InitializeDevice 方法的调用中注册此函数，该方法完成串行控制器的框架设备对象的初始化。

如果串行控制器驱动程序未实现 EvtSerCx2SelectNextTransmitTransactionType 函数，则 SerCx2 始终决定 (PIO、系统 DMA 或自定义) 用于下一个传输事务的数据传输机制的类型。 SerCx2 基于串行控制器驱动程序提供的 I/O 配置信息做出决策。支持系统-DMA 传输事务的驱动程序提供包含此信息的SERCX2_SYSTEM_DMA_TRANSMIT_CONFIG 结构。支持自定义传输事务的驱动程序提供包含此信息的SERCX2_CUSTOM_TRANSMIT_CONFIG 结构。

如果串行控制器驱动程序实现了 EvtSerCx2SelectNextTransmitTransactionType 函数，则 SerCx2 将调用此函数来确定 (PIO、系统 DMA 或自定义) 用于下一个传输事务的数据传输机制的类型。如果串行控制器具有无法通过 SERCX2_XXX_TRANSMIT_CONFIG 结构中的 I/O 配置信息充分描述的特殊硬件功能，则可能需要实现此函数。

注意即使串行控制器驱动程序实现了 EvtSerCx2SelectNextTransmitTransactionType 函数，SerCx2 也使用 PIO 传输事务来执行某些类型的数据传输，而无需首先调用此函数。

有关详细信息，请参阅 SerCx2 I/O 事务概述。

示例

若要定义 EvtSerCx2CustomTransmitSelectNextTransactionType 回调函数，必须首先提供一个函数声明，用于标识要定义的回调函数的类型。 Windows 为驱动程序提供一组回调函数类型。使用回调函数类型声明函数有助于驱动程序代码分析、静态驱动程序验证程序 (SDV) 和其他验证工具查找错误，并且这是编写适用于 Windows 操作系统的驱动程序的要求。

例如，若要定义名为 MyCustomTransmitSelectNextTransactionType的 EvtSerCx2CustomTransmitSelectNextTransactionType 回调函数，请使用 EVT_SERCX2_CUSTOM_TRANSMIT_SELECT_NEXT_TRANSACTION_TYPE 函数类型，如以下代码示例所示：

EVT_SERCX2_CUSTOM_TRANSMIT_SELECT_NEXT_TRANSACTION_TYPE  MyCustomTransmitTransactionStart;

然后，按如下所示实现回调函数：

_Use_decl_annotations_
SERCX2_TRANSACTION_TYPE
  EvtSerCx2SelectNextTransmitTransactionType(
    WDFDEVICE  Device,
    PMDL  Mdl,
    ULONG  Offset,
    ULONG  RemainingLength,
    SERCX2CUSTOMTRANSMIT  *CustomTransmit,
    PULONG  NextTransactionLength
    )
  {...}

EVT_SERCX2_CUSTOM_TRANSMIT_SELECT_NEXT_TRANSACTION_TYPE函数类型在 Sercx.h 头文件中定义。若要在运行代码分析工具时更准确地识别错误，请务必将 Use_decl_annotations 注释添加到函数定义。 Use_decl_annotations注释可确保使用应用于头文件中EVT_SERCX2_CUSTOM_TRANSMIT_SELECT_NEXT_TRANSACTION_TYPE函数类型的注释。有关函数声明要求的详细信息，请参阅使用 KMDF 驱动程序的函数角色类型声明函数。有关 Use_decl_annotations的详细信息，请参阅批注函数行为。