MINIPORT_RESTART回调函数 (ndis.h)

项目
08/07/2023

MiniportRestart 函数为已暂停的微型端口适配器启动重启请求。

注意必须使用 MINIPORT_RESTART 类型声明函数。有关详细信息，请参阅以下示例部分。

语法

MINIPORT_RESTART MiniportRestart;

NDIS_STATUS MiniportRestart(
  [in] NDIS_HANDLE MiniportAdapterContext,
       PNDIS_MINIPORT_RESTART_PARAMETERS RestartParameters
)
{...}

参数

[in] MiniportAdapterContext

微型端口驱动程序在其 MiniportInitializeEx 函数中分配的上下文区域的句柄。微型端口驱动程序使用此上下文区域来维护微型端口适配器的状态信息。

RestartParameters

指向的指针 NDIS_MINIPORT_RESTART_PARAMETERS 结构，用于定义微型端口适配器的重启参数。

返回值

MiniportRestart 返回以下状态值之一：

返回代码	说明
NDIS_STATUS_SUCCESS	MiniportRestart 已成功通过微型端口适配器重启网络数据流。
NDIS_STATUS_PENDING	MiniportRestart 未完成重启操作，操作将以异步方式完成。操作完成后，微型端口驱动程序必须调用 NdisMRestartComplete 函数。
NDIS_STATUS_RESOURCES	MiniportRestart 由于资源不足而失败。
NDIS_STATUS_FAILURE	上述状态值均未应用。在这种情况下，驱动程序应使用指定失败原因的参数调用 NdisWriteErrorLogEntry 函数。

注解

驱动程序在调用时指定 MiniportRestart 入口点 NdisMRegisterMiniportDriver 函数。

由 MiniportAdapterContext 参数指定的微型端口适配器在 NDIS 调用 MiniportRestart 时进入 Restarting 状态。

当 NDIS 调用 MiniportRestart 时，微型端口驱动程序：

必须完成恢复发送和接收操作所需的任何任务。
（可选）修改在 的 RestartAttributes 成员中指定的重启属性 NDIS_MINIPORT_RESTART_PARAMETERS 结构。如果 RestartAttributes 中的指针为 NULL，微型端口驱动程序不应修改或添加到重启属性列表。如果 RestartAttributes 中的指针非 NULL，则指向 NDIS_RESTART_ATTRIBUTES 结构。如果微型端口驱动程序未重启，则不应修改任何属性。
可以使用提供状态指示 NdisMIndicateStatusEx 函数。
应在 MiniportOidRequest 函数中处理状态请求。

如果微型端口驱动程序修改重启属性列表，则微型端口驱动程序：

可将特定于媒体的新属性添加到重启属性列表中。在这种情况下，微型端口驱动程序必须分配新的 NDIS_RESTART_ATTRIBUTES 结构-例如，使用 NdisAllocateMemoryWithTagPriority 函数 -- 并为新属性提供内存空间。将重启属性传播到过度覆盖的驱动程序后，NDIS 将释放微型端口驱动程序的属性内存。
可以修改重启属性列表中特定于媒体的属性。如果微型端口驱动程序需要更多的内存空间，则可以使用 NdisFreeMemory 函数释放NDIS_RESTART_ATTRIBUTES结构，并分配新结构以包含修改后的信息。将重启属性传播到过度覆盖的驱动程序后，NDIS 将释放微型端口驱动程序的属性内存。
可以修改中的任意字段 NDIS_RESTART_GENERAL_ATTRIBUTES 结构。当 NDIS 在 的 RestartAttributes 成员中提供非 NULL 指针时 NDIS_MINIPORT_RESTART_PARAMETERS结构，属性列表包含一个条目，其中NDIS_RESTART_ATTRIBUTES结构中的 Oid 成员 OID_GEN_MINIPORT_RESTART_ATTRIBUTES 和 Data 成员包含NDIS_RESTART_GENERAL_ATTRIBUTES结构。
应确保 NDIS_RESTART_GENERAL_ATTRIBUTES 结构包含正确的信息。若要确保NDIS_RESTART_GENERAL_ATTRIBUTES结构包含所需信息，应首先通过检查在 NDIS_RESTART_GENERAL_ATTRIBUTES 结构的 Header 成员中指定的 NDIS_OBJECT_HEADER 结构中的 Revision 成员来确定结构的版本。

在重启操作完成之前，NDIS 不会为微型端口适配器启动其他即插即用 (PnP) 操作，例如停止、初始化、电源更改或暂停请求。

微型端口驱动程序成功重启发送和接收操作后，必须完成重启操作。如果驱动程序从 MiniportRestart 返回NDIS_STATUS_SUCCESS，则重启操作已完成。如果驱动程序返回NDIS_STATUS_PENDING，它可以继续重启操作。驱动程序调用 NdisMRestartComplete 函数后，重启操作完成。重启操作完成后，微型端口适配器将处于 “正在运行” 状态。

微型端口驱动程序可以恢复指示在 NDIS 调用 MiniportRestart 之后和驱动程序调用 NdisMRestartComplete 之前收到的微型端口适配器的数据包。微型端口驱动程序应在驱动程序完成重启请求后准备好接受发送请求。

如果微型端口驱动程序不重启发送和接收操作，则驱动程序必须从 MiniportRestart 返回相应的失败状态。在这种情况下，驱动程序必须停止已启动的任何发送或接收操作，然后返回到 “暂停” 状态。

NDIS 在 IRQL = PASSIVE_LEVEL 调用 MiniportRestart 。

示例

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

例如，若要定义名为“MyRestart”的 MiniportRestart 函数，请使用 MINIPORT_RESTART 类型，如以下代码示例所示：

MINIPORT_RESTART MyRestart;

然后，按如下所示实现函数：

_Use_decl_annotations_
NDIS_STATUS
 MyRestart(
    NDIS_HANDLE  MiniportAdapterContext,
    PNDIS_MINIPORT_RESTART_PARAMETERS  RestartParameters
    )
  {...}

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

有关 Use_decl_annotations的信息，请参阅批注函数行为。