MINIPORT_SHUTDOWN fonction de rappel (ndis.h)

Article
02/29/2024

NDIS appelle la fonction MiniportShutdownEx d’un pilote miniport lorsque le système s’arrête. Cette fonction place le miniport dans l’état Arrêt, où aucun autre rappel ne peut se produire (y compris MiniportHaltEx). Pour plus d’informations sur les états du pilote miniport, consultez États et opérations de l’adaptateur miniport.

Note Vous devez déclarer la fonction à l’aide du type MINIPORT_SHUTDOWN . Pour plus d’informations, consultez la section Exemples suivante.

Syntaxe

MINIPORT_SHUTDOWN MiniportShutdown;

void MiniportShutdown(
  [in] NDIS_HANDLE MiniportAdapterContext,
  [in] NDIS_SHUTDOWN_ACTION ShutdownAction
)
{...}

Paramètres

[in] MiniportAdapterContext

Handle à une zone de contexte que le pilote miniport a allouée dans sa fonction MiniportInitializeEx . Le pilote utilise cette zone de contexte pour conserver les informations d’état d’un adaptateur miniport.

[in] ShutdownAction

Raison pour laquelle NDIS a appelé la fonction d’arrêt. Les valeurs suivantes sont valides :

NdisShutdownPowerOff

Indique que NDIS a appelé MiniportShutdownEx , car le système s’arrête.

NdisShutdownBugCheck

Indique que NDIS a appelé MiniportShutdownEx en raison d’une erreur système.

Valeur de retour

None

Remarques

Un pilote spécifie le point d’entrée MiniportShutdownEx lorsqu’il appelle le Fonction NdisMRegisterMiniportDriver .

MiniportShutdownEx restaure l’adaptateur miniport à un état initial connu (l’état avant que NDIS appelait la fonction MiniportInitializeEx du pilote miniport pour l’adaptateur miniport). Cela garantit que l’adaptateur miniport est dans un état connu et prêt à être réinitialisé lorsque l’ordinateur est redémarré après un arrêt du système pour une raison quelconque, y compris une erreur système irrécupérable.

MiniportShutdownEx peut lire ou écrire dans des ports d’E/S, un espace d’E/S d’appareil mappé en mémoire ou un espace de configuration spécifique au bus en appelant la fonction NdisMGetBusData ou NdisMSetBusData pour désactiver un moteur DMA, désactiver les interruptions ou réinitialiser le matériel à un état connu afin que le matériel puisse être redémarré en toute sécurité.

Si NDIS appelle MiniportShutdownEx en raison d’un arrêt initié par l’utilisateur, MiniportShutdownEx s’exécute à IRQL = PASSIVE_LEVEL et le pilote miniport peut appeler d’autres fonctions NdisXxx .

Si NDIS appelle MiniportShutdownEx en raison d’une erreur irrécupérable, le paramètre ShutdownAction est défini sur NdisShutdownBugCheck et MiniportShutdownEx s’exécute à un IRQL élevé. Dans ce cas, le pilote miniport ne doit appeler aucune fonction NdisXxx à l’exception des fonctions qui peuvent être appelées à n’importe quel IRQL. À compter des miniports NDIS 6.30, NDIS n’appelle pas MiniportShutdownEx pendant une vérification de bogue, sauf si le miniport fournit l’indicateur NDIS_MINIPORT_ATTRIBUTES_REGISTER_BUGCHECK_CALLBACK dans ses attributs d’inscription d’adaptateur.

Si la valeur de ShutdownAction est NdisShutdownPowerOff, le pilote miniport peut éventuellement libérer ses ressources. Toutefois, cela n’est ni obligatoire ni encouragé, car l’arrêt du système le rend inutile.

Si la valeur de ShutdownAction est NdisShutdownBugCheck, le pilote miniport ne doit pas libérer ses ressources.

Important Si MiniportHaltEx provoque une erreur système, le pilote miniport voit un appel imbriqué à MiniportShutdownEx avec ShutdownActionNdisShutdownBugCheck. Dans ce cas, MiniportShutdownEx doit revenir immédiatement sans effectuer de travail.

Exemples

Pour définir une fonction MiniportShutdownEx , vous devez d’abord fournir une déclaration de fonction qui identifie le type de fonction que vous définissez. Windows fournit un ensemble de types de fonctions pour les pilotes. La déclaration d’une fonction à l’aide des types de fonction permet à l’analyse du code pour les pilotes, au vérificateur de pilotes statiques (SDV) et à d’autres outils de vérification de trouver des erreurs. Il s’agit d’une exigence pour l’écriture de pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction MiniportShutdownEx nommée « MyShutdownEx », utilisez le type MINIPORT_SHUTDOWN comme indiqué dans cet exemple de code :

MINIPORT_SHUTDOWN MyShutdownEx;

Ensuite, implémentez votre fonction comme suit :

_Use_decl_annotations_
VOID
 MyShutdownEx(
    NDIS_HANDLE  MiniportAdapterContext,
    NDIS_SHUTDOWN_ACTION  ShutdownAction
    )
  {...}

Le type de fonction MINIPORT_SHUTDOWN est défini dans le fichier d’en-tête Ndis.h. Pour identifier plus précisément les erreurs lors de l’exécution des outils d’analyse du code, veillez à ajouter l’annotation Use_decl_annotations à votre définition de fonction. L’annotation Use_decl_annotations garantit que les annotations appliquées au type de fonction MINIPORT_SHUTDOWN dans le fichier d’en-tête sont utilisées. Pour plus d’informations sur la configuration requise pour les déclarations de fonction, consultez Déclaration de fonctions à l’aide de types de rôles de fonction pour les pilotes NDIS.

Pour plus d’informations sur Use_decl_annotations, consultez Annotating Function Behavior.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Pris en charge dans NDIS 6.0 et versions ultérieures.
Plateforme cible	Windows
En-tête	ndis.h (inclure Ndis.h)
IRQL	Voir la section Notes