通过

EVT_SERCX2_PURGE_FIFOS回调函数 （sercx.h）

  • 项目

EvtSerCx2PurgeFifos 事件回调函数由串行框架扩展版本 2 （SerCx2） 调用，以清除串行控制器硬件中的 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 方法中注册函数，该方法完成串行控制器的框架设备对象的初始化。

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

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

例子

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

例如，若要定义 EvtSerCx2PurgeFifos 名为 MyPurgeFifos的回调函数，请使用 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