SerCx2PioReceiveCreate 函数 (sercx.h)

项目
08/07/2023

SerCx2PioReceiveCreate 方法创建一个 PIO-receive 对象，该对象的串行框架扩展 (SerCx2) 使用该对象来执行 PIO 接收事务。

语法

NTSTATUS SerCx2PioReceiveCreate(
  [in]           WDFDEVICE                  Device,
  [in]           PSERCX2_PIO_RECEIVE_CONFIG PioReceiveConfig,
  [in, optional] PWDF_OBJECT_ATTRIBUTES     Attributes,
  [out]          SERCX2PIORECEIVE           *PioReceive
);

参数

[in] Device

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

[in] PioReceiveConfig

指向 SERCX2_PIO_RECEIVE_CONFIG 结构的指针。在调用此方法之前，调用方必须调用 SERCX2_PIO_RECEIVE_CONFIG_INIT 函数来初始化结构。此结构包含指向由串行控制器驱动程序实现的一组事件回调例程的指针。 SerCx2 调用这些函数来执行 PIO 接收事务。

[in, optional] Attributes

指向 WDF_OBJECT_ATTRIBUTES 结构的指针，该结构描述要分配给新 PIO-receive 对象的属性。调用此方法之前，调用方必须调用 WDF_OBJECT_ATTRIBUTES_INIT 函数来初始化结构。此参数是可选的，如果串行控制器驱动程序不需要将属性分配给对象，则可以指定为WDF_NO_OBJECT_ATTRIBUTES。有关详细信息，请参阅“备注”。

[out] PioReceive

指向此方法将 SERCX2PIORECEIVE 句柄写入新创建的 PIO-receive 对象的位置的指针。 SerCx2 和串行控制器驱动程序在后续调用中使用此句柄来引用此对象。

返回值

如果调用成功，此方法将返回STATUS_SUCCESS。可能的错误返回值包括以下状态代码。

返回代码	说明
STATUS_INVALID_DEVICE_REQUEST	以前的 SerCx2PioReceiveCreate 调用中已存在 PIO 接收对象。
STATUS_INFO_LENGTH_MISMATCH	“配置大小”->值不等于 (SERCX2_PIO_RECEIVE_CONFIG) 的大小。
STATUS_INVALID_PARAMETER	实现的回调函数的指定组合无效。驱动程序必须实现 EvtSerCx2PioReceiveReadBuffer、 EvtSerCx2PioReceiveEnableReadyNotification 和 EvtSerCx2PioReceiveCancelReadyNotification 函数。
STATUS_INSUFFICIENT_RESOURCES	资源不足，无法执行请求的操作。

注解

串行控制器驱动程序调用此方法以创建 PIO 接收对象。 SerCx2 使用此对象执行 PIO 接收事务，该事务使用编程的 I/O (PIO) 读取串行控制器接收的数据。

通常，串行控制器驱动程序从其 EvtDriverDeviceAdd 函数调用 SerCx2PioReceiveCreate。只有在成功调用 SerCx2InitializeDevice 方法后，驱动程序才能调用此方法。

作为一个选项，串行控制器驱动程序可以使用 Attributes 参数为 PIO 接收对象创建上下文，并提供指向 EvtCleanupCallback 和 EvtDestroyCallback 函数的指针，这些函数被调用以准备要删除的对象。有关详细信息，请参阅 WDF_OBJECT_ATTRIBUTES。

如果 Attributes 参数指向 WDF_OBJECT_ATTRIBUTES 结构，则调用方不得覆盖 WDF_OBJECT_ATTRIBUTES_INIT 初始化函数写入此结构的 ParentObject、 ExecutionLevel 和 SynchronizationScope 成员的值。

有关创建 PIO 接收对象的详细信息，请参阅 SERCX2PIORECEIVE。有关 PIO 接收事务的详细信息，请参阅 SerCx2 PIO-Receive 事务。