HW_FIND_ADAPTER回调函数 (storport.h)

项目
02/29/2024

HwStorFindAdapter 例程使用提供的配置来确定特定 HBA 是否受支持，如果支持，则返回有关该适配器的配置信息。

语法

HW_FIND_ADAPTER HwFindAdapter;

ULONG HwFindAdapter(
           PVOID DeviceExtension,
  [in]     PVOID HwContext,
  [in]     PVOID BusInformation,
  [in]     PCHAR ArgumentString,
  [in/out] PPORT_CONFIGURATION_INFORMATION ConfigInfo,
  [in]     PBOOLEAN Reserved3
)
{...}

参数

DeviceExtension

为每个适配器存储区域提供。

[in] HwContext

设置为 NULL。

[in] BusInformation

设置为 NULL。

[in] ArgumentString

提供以 NULL 结尾的字符串，其中包含有关驱动程序的上下文信息。

[in/out] ConfigInfo

提供微型端口驱动程序在初始化期间使用的初始化 PORT_CONFIGURATION_INFORMATION 结构。

[in] Reserved3

预留给系统使用。

返回值

HwStorFindAdapter 必须返回以下状态值之一：

返回代码	说明
SP_RETURN_FOUND	指示找到受支持的 HBA，并且已成功确定和设置 PORT_CONFIGURATION_INFORMATION 结构中与 HBA 相关的配置信息。
SP_RETURN_ERROR	指示已找到 HBA，但在获取配置信息时出错。如果可能，应使用 StorPortLogError 记录此类错误。
SP_RETURN_BAD_CONFIG	指示提供的配置信息对适配器无效。
SP_RETURN_NOT_FOUND	指示提供的配置信息未找到受支持的 HBA。

注解

由于 Storport 驱动程序仅支持即插即用 (PnP) 设备，因此 HwStorFindAdapter 的 HwContext 和 BusInformation 参数不会提供给非虚拟微型端口驱动程序。

HwStorFindAdapter 必须在 ConfigInfo 结构中设置 MaximumTransferLength 和 NumberOfPhysicalBreaks 字段。除这些字段外， PORT_CONFIGURATION_INFORMATION 结构将始终完全指定启动适配器所需的所有适配器资源。

名称 HwStorFindAdapter 只是占位符。此例程的实际原型在 Storport.h 中定义，如下所示：

typedef
ULONG
HW_FIND_ADAPTER (
  _In_ PVOID  DeviceExtension,
  _In_ PVOID  HwContext,
  _In_ PVOID  BusInformation,
  _In_z_ PCHAR  ArgumentString,
  _Inout_ PPORT_CONFIGURATION_INFORMATION  ConfigInfo,
  _In_ PBOOLEAN  Reserved3
  );

在大多数情况下，StorPort 在 IRQL == PASSIVE_LEVEL调用 HwStorFindAdapter 例程，而无需获取任何旋转锁。例外情况是微型端口不支持使用 ScsiRestartAdapter 控件类型调用 HwStorAdaptorControl。在这种情况下，StorPort 将通过调用 HwStorFindAdapter 和 HwStorInitialize 来重新初始化适配器。在这种情况下，会在 IRQL == DISPATCH_LEVEL调用 HwStorFindAdapter 。此外，在转储模式下，会在 IRQL == HIGH_LEVEL调用 HwStorFindAdapter 。

示例

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

例如，若要定义名为 MyHwFindAdapter 的 HwStorFindAdapter 回调例程，请使用 HW_FIND_ADAPTER 类型，如以下代码示例所示：

HW_FIND_ADAPTER MyHwFindAdapter;

然后，按如下所示实现回调例程：

_Use_decl_annotations_
ULONG
MyHwFindAdapter (
  _In_ PVOID  DeviceExtension,
  _In_ PVOID  HwContext,
  _In_ PVOID  BusInformation,
  _In_z_ PCHAR  ArgumentString,
  _Inout_ PPORT_CONFIGURATION_INFORMATION  ConfigInfo,
  _In_ PBOOLEAN  Reserved3
  );
  {
      ...
  }

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