GPIO_CLIENT_START_CONTROLLER fonction de rappel (gpioclx.h)

La fonction de rappel d’événement CLIENT_StartController effectue les opérations nécessaires lorsque l’appareil de contrôleur d’E/S à usage général (GPIO) passe à l’état d’alimentation D0.

Syntaxe

GPIO_CLIENT_START_CONTROLLER GpioClientStartController;

NTSTATUS GpioClientStartController(
  [in] PVOID Context,
  [in] BOOLEAN RestoreContext,
  [in] WDF_POWER_DEVICE_STATE PreviousPowerState
)
{...}

Paramètres

[in] Context

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

[in] RestoreContext

Indique si le pilote client doit restaurer le contrôleur GPIO dans un contexte matériel précédemment enregistré. Si la valeur est TRUE, le contexte matériel doit être restauré. Si la valeur est FALSE, le contexte matériel ne doit pas être restauré. Pour plus d'informations, consultez la section Notes.

[in] PreviousPowerState

État d’alimentation précédent de l’appareil. Ce paramètre est une valeur d’énumération WDF_POWER_DEVICE_STATE qui spécifie l’état de faible consommation à partir duquel l’appareil est entré dans l’état d’alimentation D0. Le pilote du contrôleur GPIO peut utiliser ces informations pour déterminer comment configurer le périphérique de contrôleur afin qu’il soit prêt à être utilisé.

Valeur retournée

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

Remarques

Cette fonction de rappel est implémentée par le pilote du contrôleur GPIO. L’extension d’infrastructure GPIO (GpioClx) appelle cette fonction pour placer l’appareil du contrôleur GPIO dans un état initial connu au démarrage du système ou lorsque l’appareil passe d’un état de faible consommation à un état opérationnel. Cette fonction de rappel doit effectuer toutes les opérations nécessaires une fois que l’appareil sort d’un état de faible consommation d’énergie, comme la restauration des informations dont le pilote a besoin une fois que l’appareil est entré dans l’état d’alimentation D0.

En règle générale, une fonction de rappel CLIENT_StartController définit l’état par défaut de toutes les broches GPIO.

Pour inscrire la fonction de rappel CLIENT_StartController 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_StartController .

Bien que la fonction de rappel CLIENT_StartController soit appelée dans IRQL = PASSIVE_LEVEL, vous ne devez pas rendre cette fonction paginable. Le rappel CLIENT_StartController se trouve dans le chemin de temporisation critique pour restaurer l’alimentation des appareils dans la plateforme matérielle et, pour des raisons de performances, il ne doit pas être retardé par des erreurs de page.

Exemples

Pour définir une fonction de rappel CLIENT_StartController , 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 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 de rappel CLIENT_StartController nommée MyEvtGpioStartController, utilisez le type de fonction GPIO_CLIENT_START_CONTROLLER, comme indiqué dans cet exemple de code :

GPIO_CLIENT_START_CONTROLLER MyEvtGpioStartController;

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

_Use_decl_annotations_
VOID
  MyEvtGpioStartController(
    PVOID Context,
    BOOLEAN RestoreContext,
    WDF_POWER_DEVICE_STATE PreviousPowerState
    )
{ ... }

Le type de fonction GPIO_CLIENT_START_CONTROLLER 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_START_CONTROLLER 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

Voir aussi

GPIO_CLIENT_REGISTRATION_PACKET

GPIO_CLX_RegisterClient