MINIPORT_PAUSE fonction de rappel (ndis.h)

Article
05/23/2024

NDIS appelle la fonction MiniportPause d’un pilote miniport pour arrêter le flux de données réseau via une carte miniport spécifiée.

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

Syntaxe

MINIPORT_PAUSE MiniportPause;

NDIS_STATUS MiniportPause(
  [in] NDIS_HANDLE MiniportAdapterContext,
  [in] PNDIS_MINIPORT_PAUSE_PARAMETERS PauseParameters
)
{...}

Paramètres

[in] MiniportAdapterContext

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

[in] PauseParameters

Pointeur vers un NDIS_MINIPORT_PAUSE_PARAMETERS structure qui définit les paramètres de pause pour l’adaptateur miniport.

Valeur retournée

MiniportPause retourne l’une des valeurs status suivantes :

Code de retour	Description
NDIS_STATUS_SUCCESS	MiniportPause a réussi à arrêter le flux de données réseau via l’adaptateur miniport.
NDIS_STATUS_PENDING	MiniportPause n’a pas terminé l’opération de pause et l’opération sera effectuée de manière asynchrone. Le pilote miniport doit appeler la fonction NdisMPauseComplete une fois l’opération terminée.

Remarques

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

NDIS interrompt un adaptateur miniport pour arrêter le flux de données qui pourrait interférer avec les opérations PnP telles que l’ajout ou la suppression d’un pilote de filtre, ou la liaison ou la désaffichage d’un pilote de protocole.

NDIS appelle la fonction MiniportPause d’un pilote miniport pour lancer une demande de pause pour l’adaptateur miniport spécifié dans MiniportAdapterContext. L’adaptateur miniport reste à l’état De suspension jusqu’à ce que l’opération de pause soit terminée.

Pour un adaptateur miniport à l’état de suspension , le pilote miniport :

Attend tous les appels au Fonction NdisMIndicateReceiveNetBufferLists à retourner.
Attend que NDIS retourne la propriété de toutes les structures NET_BUFFER_LIST des indications de réception en suspens au pilote miniport Fonction MiniportReturnNetBufferLists .
Termine toutes les demandes d’envoi en suspens et appelle le Fonction NdisMSendNetBufferListsComplete pour toutes les demandes d’envoi en suspens.
Rejette toutes les nouvelles demandes d’envoi effectuées à son MiniportSendNetBufferLists fonctionne immédiatement en appelant NdisMSendNetBufferListsComplete. Il doit définir la status complète dans chaque NET_BUFFER_LIST sur NDIS_STATUS_PAUSED.
Peut fournir status indications avec le Fonction NdisMIndicateStatusEx .
Doit gérer les requêtes OID dans la fonction MiniportOidRequest .
Ne doit pas arrêter complètement l’adaptateur miniport si l’arrêt de l’adaptateur miniport empêche le pilote de gérer les demandes ou de fournir des indications status.
Ne doit pas libérer les ressources allouées par le pilote lors de l’initialisation.

NDIS n’initie pas d’autres opérations PnP pour l’adaptateur miniport, telles que l’arrêt, l’initialisation, le changement d’alimentation, la pause ou une demande de redémarrage, tandis que l’adaptateur miniport est à l’état De suspension . NDIS peut lancer ces opérations PnP une fois qu’un adaptateur miniport est à l’état Suspendu .

Une fois qu’un pilote miniport a terminé toutes les demandes d’envoi en attente et que NDIS retourne toutes les structures de données réseau reçues (à partir des indications de réception en attente), le pilote doit terminer l’opération de pause. Si le pilote retourne NDIS_STATUS_SUCCESS à partir de MiniportPause, l’opération de pause est terminée. Si le pilote retourne NDIS_STATUS_PENDING, l’adaptateur miniport peut rester à l’état Pause et l’opération de pause est terminée une fois que le pilote a appelé la fonction NdisMPauseComplete . Une fois l’opération de pause terminée, l’adaptateur miniport est à l’état Suspendu .

Pour un adaptateur miniport à l’état Suspendu , le pilote miniport :

Doit rejeter immédiatement toutes les demandes envoyées à MiniportSendNetBufferLists en appelant NdisMSendNetBufferListsComplete. Il doit définir le membre Status dans chaque NET_BUFFER_LIST sur NDIS_STATUS_PAUSED.
Peut gérer les interruptions de réception (voir la fonction MiniportInterrupt ) et interrompre les PDC (voir la fonction MiniportInterruptDPC ), mais ne doit pas indiquer les données réseau reçues.
Peut fournir des indications status avec la fonction NdisMIndicateStatusEx.
Doit gérer les requêtes OID dans la fonction MiniportOidRequest .
Doit gérer les demandes de modification de l’état d’alimentation de l’appareil dans le Fonction MiniportDevicePnPEventNotify .
Peut gérer les appels aux fonctions NetTimerCallback .
Peut gérer les demandes de réinitialisation du matériel dans la fonction MiniportResetEx .

Les pilotes miniport ne peuvent pas échouer une demande de pause. Par conséquent, si un pilote miniport nécessite des ressources pour gérer une demande de pause, il doit préallouer les ressources lors de l’initialisation.

NDIS appelle la fonction MiniportRestart pour lancer une demande de redémarrage pour un adaptateur miniport qui est suspendu.

NDIS appelle MiniportPause à IRQL = PASSIVE_LEVEL.

Exemples

Pour définir une fonction MiniportPause , 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, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification de trouver les erreurs, et 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 MiniportPause nommée « MyPause », utilisez le type MINIPORT_PAUSE comme indiqué dans cet exemple de code :

MINIPORT_PAUSE MyPause;

Ensuite, implémentez votre fonction comme suit :

_Use_decl_annotations_
NDIS_STATUS
 MyPause(
    NDIS_HANDLE  MiniportAdapterContext,
    PNDIS_MINIPORT_PAUSE_PARAMETERS  MiniportPauseParameters
    )
  {...}

Le type de fonction MINIPORT_PAUSE 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_PAUSE 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	PASSIVE_LEVEL