EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE回调函数 (sercx.h)

项目
08/07/2023

串行框架扩展版本 2 (SerCx2) 调用 EvtSerCx2CustomReceiveTransactionInitialize 事件回调函数，以准备串行控制器硬件以执行新的自定义接收事务。

语法

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE EvtSercx2CustomReceiveTransactionInitialize;

void EvtSercx2CustomReceiveTransactionInitialize(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

参数

[in] CustomReceiveTransaction

自定义接收事务对象的 SERCX2CUSTOMRECEIVETRANSACTION 句柄。串行控制器驱动程序之前调用 SerCx2CustomReceiveTransactionCreate 方法来创建此对象。

[in] Mdl

指向 MDL 的指针，该指针描述自定义接收事务的读取缓冲区跨越的内存页。 DMA 传输的散点/收集列表将使用由 Offset 和 Length 参数指定的内存区域。

[in] Offset

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

[in] Length

数据传输的大小（以字节为单位）。如果 MDL 指定缓冲区空间的 N 个字节总数，则 Length 的可能值在 1 到 N–Offset 范围内。

返回值

无

备注

串行控制器驱动程序可以选择实现此函数。如果实现，驱动程序会在 SerCx2CustomReceiveTransactionCreate 调用中注册函数，以创建自定义接收对象。

如果驱动程序需要初始化串行控制器和相关硬件以准备新的自定义接收事务，则驱动程序应实现 EvtSerCx2CustomReceiveTransactionInitialize 函数。 SerCx2 在启动自定义接收事务之前调用此函数（如果已实现）。为了响应此调用，串行控制器驱动程序必须调用 SerCx2CustomReceiveTransactionInitializeComplete 方法，以便在初始化完成后通知 SerCx2。

有关详细信息，请参阅 SerCx2 Custom-Receive 事务。

示例

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

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

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE  MyCustomReceiveTransactionInitialize;

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

_Use_decl_annotations_
VOID
  MyCustomReceiveTransactionInitialize(
    SERCX2CUSTOMRECEIVETRANSACTION  CustomReceiveTransaction,
    WDFREQUEST  Request,
    PMDL  Mdl,
    ULONG  Offset,
    ULONG  Length
    )
  {...}

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