GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT fonction de rappel (gpioclx.h)

Article
02/26/2024

La fonction de rappel d’événements CLIENT_RestoreBankHardwareContext restaure le contexte matériel d’une banque de broches d’E/S à usage général (GPIO).

Syntaxe

GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT GpioClientRestoreBankHardwareContext;

void GpioClientRestoreBankHardwareContext(
  [in] PVOID Context,
  [in] PGPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS Parameters
)
{...}

Paramètres

[in] Context

Pointeur vers le contexte de périphérique du pilote du contrôleur GPIO.

[in] Parameters

Pointeur vers une structure de GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS qui décrit la banque de broches GPIO à restaurer.

Valeur de retour

None

Remarques

La fonction CLIENT_RestoreBankHardwareContext retourne STATUS_SUCCESS si l’appel réussit. Sinon, il retourne une erreur appropriée status code.

Si une banque de broches GPIO prend en charge la gestion de l’alimentation au niveau des composants, GpioClx peut basculer la banque vers un état Fx de faible consommation si la banque est inactive. Si la banque de contrôleurs GPIO perd son contexte matériel à l’état Fx, le pilote du contrôleur GPIO doit enregistrer ce contexte avant la transition F0-fx et, ultérieurement, restaurer le contexte après la transition Fx-à-F0. Actuellement, F1 est le seul état de faible consommation défini pour les contrôleurs GPIO qui utilisent GpioClx.

GpioClx appelle la fonction CLIENT_RestoreBankHardwareContext pour restaurer le contexte matériel précédemment enregistré de la banque. Le contexte matériel a été précédemment enregistré par la fonction de rappel d’événement CLIENT_SaveBankHardwareContext .

Certains appareils de contrôleur GPIO permettent d’activer et de désactiver des banques de broches sélectionnées indépendamment des autres banques du même appareil. Ainsi, vous pouvez économiser l’alimentation en désactivant une banque inactive.

Pour inscrire la fonction de rappel CLIENT_RestoreBankHardwareContext de votre pilote, appelez la méthode GPIO_CLX_RegisterClient . Cette méthode accepte, en tant que paramètre d’entrée, un pointeur vers une structure GPIO_CLIENT_REGISTRATION_PACKET qui contient un pointeur de fonction CLIENT_RestoreBankHardwareContext .

GpioClx appelle la fonction de rappel CLIENT_RestoreBankHardwareContext à PASSIVE_LEVEL ou DIRQL, en fonction des informations de l’appareil que la fonction de rappel CLIENT_QueryControllerBasicInformation fournit à GpioClx. La fonction CLIENT_QueryControllerBasicInformation fournit des informations sur l’appareil sous la forme d’une structure de CLIENT_CONTROLLER_BASIC_INFORMATION . Si le bit d’indicateur MemoryMappedController est défini dans le membre Flags de cette structure, GpioClx appelle la fonction CLIENT_RestoreBankHardwareContext au niveau de DIRQL, qui est l’IRQL auquel s’exécute l’ISR dans GpioClx. Sinon, cette fonction est appelée à PASSIVE_LEVEL. Pour plus d’informations sur ce bit d’indicateur, consultez Fonctions de rappel GPIO facultatives et requises.

Exemples

Pour définir une fonction de rappel CLIENT_RestoreBankHardwareContext , vous devez d’abord fournir une déclaration de fonction qui identifie le type de fonction de rappel que vous définissez. Windows fournit un ensemble de types de fonctions de rappel pour les pilotes. La déclaration d’une fonction à l’aide des types de fonction de rappel aide l’analyse du code pour les pilotes, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification à la recherche d’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 de rappel CLIENT_RestoreBankHardwareContext nommée MyEvtGpioRestoreBankHardwareContext, utilisez le type de fonction GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT, comme indiqué dans cet exemple de code :

GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT MyEvtGpioRestoreBankHardwareContext;</pre>

Ensuite, implémentez votre fonction de rappel comme suit :

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioRestoreBankHardwareContext(
    PVOID Context,
    PGPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS Parameters
    )
{ ... }

Le type de fonction GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT est défini dans le fichier d’en-tête Gpioclx.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 GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT 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 KMDF. 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 à partir de Windows 8.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	gpioclx.h
IRQL	Consultez la section Notes.