GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT fonction de rappel (gpioclx.h)

Article
02/07/2025

La fonction de rappel d’événement CLIENT_SaveBankHardwareContext enregistre le contexte matériel d’une banque d’E/S à usage général (GPIO).

Syntaxe

GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT GpioClientSaveBankHardwareContext;

void GpioClientSaveBankHardwareContext(
  [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 de contrôleur GPIO.

[in] Parameters

Pointeur vers une structure GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS qui décrit la banque des broches GPIO à enregistrer.

Valeur de retour

Aucun

Remarques

La fonction CLIENT_SaveBankHardwareContext retourne STATUS_SUCCESS si l’appel réussit. Sinon, elle retourne un code d’état d’erreur approprié.

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 à faible puissance si la banque est inactive. Si la banque du contrôleur GPIO perd son contexte matériel dans l’état Fx, le pilote du contrôleur GPIO doit enregistrer ce contexte avant la transition F0-to-Fx et, plus tard, restaurer le contexte après la transition Fx-to-F0. Actuellement, F1 est le seul état à faible alimentation défini pour les contrôleurs GPIO qui utilisent GpioClx.

GpioClx appelle la fonction CLIENT_SaveBankHardwareContext pour enregistrer le contexte matériel de la banque. Plus tard, GpioClx appelle la fonction de rappel d’événement CLIENT_RestoreBankHardwareContext pour restaurer le contexte précédemment enregistré.

Certains périphériques de contrôleur GPIO permettent aux banques sélectionnées d’épingles d’être activées et désactivées indépendamment des autres banques dans le même appareil. Ainsi, la puissance peut être sauvée en désactivant une banque inactive.

Pour inscrire la fonction de rappel CLIENT_SaveBankHardwareContext 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_SaveBankHardwareContext.

GpioClx appelle la fonction de rappel CLIENT_SaveBankHardwareContext à PASSIVE_LEVEL ou DIRQL, selon les informations de l’appareil fournies par la fonction de rappel CLIENT_QueryControllerBasicInformation à GpioClx. La fonction CLIENT_QueryControllerBasicInformation fournit des informations sur l’appareil sous la forme d’une structure CLIENT_CONTROLLER_BASIC_INFORMATION. Si le bit d’indicateur MemoryMappedController est défini dans le membre Indicateurs de de cette structure, GpioClx appelle la fonction CLIENT_SaveBankHardwareContext au niveau DIRQL, qui est l’IRQL auquel l’ISR dans GpioClx s’exécute. 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_SaveBankHardwareContext, 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 fonctions de rappel permet d'Analyse du code pour les pilotes, static Driver Verifier (SDV) et d’autres outils de vérification recherchent des erreurs, et il est nécessaire d’écrire des pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction de rappel CLIENT_SaveBankHardwareContext nommée MyEvtGpioSaveBankHardwareContext, utilisez le type de fonction GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT, comme illustré dans cet exemple de code :

GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT MyEvtGpioSaveBankHardwareContext;

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

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

Le type de fonction GPIO_CLIENT_SAVE_BANK_HARDWARE_CONTEXT est défini dans le fichier d’en-tête Gpioclx.h. Pour identifier plus précisément les erreurs lorsque vous exécutez les 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_SAVE_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 annoter le comportement de la fonction.