EVT_SPB_CONTROLLER_WRITE回调函数 (spbcx.h)

SPB 控制器驱动程序的 EvtSpbControllerIoWrite 事件回调函数从随写入请求提供的缓冲区将数据写入指定的目标设备。

语法

EVT_SPB_CONTROLLER_WRITE EvtSpbControllerWrite;

void EvtSpbControllerWrite(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST Request,
  [in] size_t Length
)
{...}

参数

[in] Controller

表示 SPB 控制器的 框架设备对象的 WDFDEVICE 句柄

[in] Target

SPBTARGET 此 I/O 请求的目标句柄。 目标是附加到总线的外围设备或端口。 SPB 框架扩展(SpbCx)以前将此句柄分配给 EvtSpbTargetConnect 回调中打开了与目标的连接。

[in] Request

SPBREQUEST I/O 请求的句柄。 SPB 控制器驱动程序必须通过执行请求的作或返回错误状态来完成此请求。 有关详细信息,请参阅 备注

[in] Length

要写入目标设备的字节数。

返回值

没有

言论

SpbCx 管理 SPB 控制器的 I/O 队列。 SpbCx 调用 SPB 控制器驱动程序的 EvtSpbControllerIoWrite 回调函数时,SPB 控制器的客户端(外围驱动程序)向附加到总线的目标设备发送 IRP_MJ_WRITE 请求。 Request 参数值是封装此请求的句柄。

EvtSpbControllerIoWrite 回调不返回状态值。 相反,SPB 控制器驱动程序指示在 I/O 请求的完成状态中写入作的状态。

EvtSpbControllerIoWrite 回调是异步的。 也就是说,回调函数应启动请求的写入作,然后返回,而无需等待作完成。 稍后,SPB 控制器驱动程序在中断 DPC 或计时器 DPC 期间完成写入请求。

EvtSpbControllerIoWrite 回调不返回状态值。 相反,SPB 控制器驱动程序指示在 I/O 请求的完成状态中写入作的状态。

如果写入作完全完成,回调函数应将完成状态设置为STATUS_SUCCESS。 如果目标设备指示在传输完成之前无法再接受任何数据,驱动程序应将完成状态设置为STATUS_SUCCESS并指定传输的字节数。

如果在写入作期间发生传输错误,驱动程序应在 I/O 请求中将完成状态设置为适当的错误代码。 并非所有总线都为目标设备提供一种机制来报告传输错误或部分完成的传输,并非所有控制器都能够检测这些情况。

若要注册 EvtSpbControllerIoWrite 回调函数,请调用 SpbDeviceInitialize 方法。

例子

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

例如,若要定义 EvtSpbControllerIoWrite 名为 MyEvtSpbControllerIoWrite的回调函数,请使用EVT_SPB_CONTROLLER_WRITE函数类型,如以下代码示例所示:

EVT_SPB_CONTROLLER_WRITE  MyEvtSpbControllerIoWrite;

然后,按如下所示实现回调函数:

_Use_decl_annotations_
VOID
  MyEvtSpbControllerIoWrite(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST Request,
    size_t Length
    )
{ ... }

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

要求

要求 价值
最低支持的客户端 从 Windows 8 开始支持。
目标平台 桌面
标头 spbcx.h
IRQL 在 IRQL <调用 = DISPATCH_LEVEL。

另请参阅