HW_FIND_ADAPTER回调函数 (storport.h)
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)设备,因此 HwContext 和 BusInformation 参数,HwStorFindAdapter 不会提供给非虚拟微型端口驱动程序。
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作系统编写驱动程序的要求。
例如,若要定义 HwStorFindAdapter名为 MyHwFindAdapter的回调例程,请使用 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的信息,请参阅 批注函数行为。
要求
要求 | 价值 |
---|---|
目标平台 | 普遍 |
标头 | storport.h (包括 Storport.h) |
IRQL | PASSIVE_LEVEL(请参阅“备注”部分)。 |