EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO回调函数（sercx.h）

项目
10/30/2024

EvtSerCx2PioTransmitCancelDrainFifo 事件回调函数由串行框架扩展版本 2 （SerCx2）调用，以取消以前的请求以耗尽串行控制器硬件中的传输 FIFO。

语法

EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2PioTransmitCancelDrainFifo;

BOOLEAN EvtSercx2PioTransmitCancelDrainFifo(
  [in] SERCX2PIOTRANSMIT PioTransmit
)
{...}

参数

[in] PioTransmit

PIO 传输对象的 SERCX2PIOTRANSMIT 句柄。串行控制器驱动程序以前调用 SerCx2PioTransmitCreate 方法来创建此对象。

返回值

如果 EvtSerCx2PioTransmitCancelDrainFifo 函数成功取消挂起的清空请求，TRUE，串行控制器驱动程序可以保证它不会调用 SerCx2PioTransmitDrainFifoComplete 方法通知 SerCx2 FIFO 已清空。否则，此函数返回 FALSE 以指示驱动程序已调用或即将调用 SerCx2PioTransmitDrainFifoComplete。

言论

串行控制器驱动程序可以根据需要实现此函数。如果实现，驱动程序会在 SerCx2PioTransmitCreate 调用中注册该函数，该调用将创建 PIO 传输对象。

如果串行控制器具有硬件 FIFO（或类似缓冲机制）来保存传输数据，驱动程序应实现 EvtSerCx2PioTransmitCancelDrainFifo 函数。如果驱动程序实现此函数，则它还必须实现 EvtSerCx2PioTransmitDrainFifo 和 EvtSerCx2PioTransmitPurgeFifo 事件回调函数。

SerCx2 调用 EvtSerCx2PioTransmitDrainFifo 事件回调函数，要求串行控制器驱动程序清空传输 FIFO，然后等待串行控制器驱动程序调用 SerCx2PioTransmitDrainFifoComplete。排水操作可能需要无限期的时间才能完成。因此，如果写入请求在排空操作正在进行时超时或取消，则 SerCx2 调用 EvtSerCx2PioTransmitCancelDrainFifo 函数，以在完成之前取消挂起的清空操作。

有关详细信息，请参阅 SerCx2 PIO-Transmit 事务。

例子

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

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

EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO  MyPioTransmitCancelDrainFifo;

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

_Use_decl_annotations_
BOOLEAN
  MyPioTransmitCancelDrainFifo(
    SERCX2PIOTRANSMIT  PioTransmit
    )
  {...}

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