EVT_SERCX2_PURGE_FIFOS回调函数 (sercx.h)

串行框架扩展的版本 2 (SerCx2) 调用 EvtSerCx2PurgeFifos 事件回调函数，以清除串行控制器硬件中的 FIFO 缓冲区。

语法

EVT_SERCX2_PURGE_FIFOS EvtSercx2PurgeFifos;

void EvtSercx2PurgeFifos(
  [in] WDFDEVICE Device,
  [in] BOOLEAN PurgeRxFifo,
  [in] BOOLEAN PurgeTxFifo
)
{...}

参数

[in] Device

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

[in] PurgeRxFifo

是否清除接收 FIFO。 如果此参数设置为 TRUE，请清除接收 FIFO。 如果 为 FALSE，则不清除接收 FIFO。

[in] PurgeTxFifo

是否清除传输 FIFO。 如果此参数设置为 TRUE，请清除传输 FIFO。 如果 为 FALSE，则不清除传输 FIFO。

返回值

无

备注

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

当客户端 (外设驱动程序) 发送IOCTL_SERIAL_PURGE控制请求时，SerCx2 调用 EvtSerCx2PurgeFifos 函数，该请求要求串行控制器硬件中的一个或两个 FIFO 缓冲区进行清除。 如果 IOCTL_SERIAL_PURGE 控制请求需要挂起的读取或写入 (IRP_MJ_READ 或 IRP_MJ_WRITE) 请求才能取消，则 SerCx2 会在调用 EvtSerCx2PurgeFifos 函数之前取消这些请求。

当客户端打开与串行控制器设备的逻辑连接并获取此连接的文件句柄时，SerCx2 还会调用 EvtSerCx2PurgeFifos 函数。 有关详细信息，请参阅 框架文件对象。

示例

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

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

EVT_SERCX2_PURGE_FIFOS  MyPurgeFifos;

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

_Use_decl_annotations_
VOID
  MyPurgeFifos(
    WDFDEVICE  Device,
    BOOLEAN PurgeRxFifo,
    BOOLEAN PurgeTxFifo
    )
  {...}

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

要求

要求	值
最低受支持的客户端	从Windows 8.1开始可用。
目标平台	桌面
标头	sercx.h
IRQL	在 PASSIVE_LEVEL 调用。

另请参阅

IOCTL_SERIAL_PURGE

SerCx2InitializeDevice