GPIO_CLIENT_START_CONTROLLER Rückruffunktion (gpioclx.h)
Die CLIENT_StartController Ereignisrückruffunktion führt Vorgänge aus, die benötigt werden, wenn das I/O-Controllergerät (General Purpose I/O) in den D0-Energiezustand wechselt.
Syntax
GPIO_CLIENT_START_CONTROLLER GpioClientStartController;
NTSTATUS GpioClientStartController(
[in] PVOID Context,
[in] BOOLEAN RestoreContext,
[in] WDF_POWER_DEVICE_STATE PreviousPowerState
)
{...}
Parameter
[in] Context
Ein Zeiger auf den Gerätekontext des GPIO-Controllertreibers.
[in] RestoreContext
Gibt an, ob der Clienttreiber den GPIO-Controller in einem zuvor gespeicherten Hardwarekontext wiederherstellen soll. Wenn TRUE, sollte der Hardwarekontext wiederhergestellt werden. Wenn FALSE, sollte der Hardwarekontext nicht wiederhergestellt werden. Weitere Informationen finden Sie in den Hinweisen.
[in] PreviousPowerState
Der vorherige Energiezustand des Geräts. Dieser Parameter ist ein WDF_POWER_DEVICE_STATE Enumerationswert, der den Energiesparzustand angibt, aus dem das Gerät den D0-Leistungszustand eingegeben hat. Der GPIO-Controllertreiber kann diese Informationen verwenden, um zu bestimmen, wie das Controllergerät so konfiguriert wird, dass es einsatzbereit ist.
Rückgabewert
Die CLIENT_StartController-Funktion gibt STATUS_SUCCESS zurück, wenn der Aufruf erfolgreich ist. Andernfalls wird ein entsprechender Fehlercode zurückgegeben.
Bemerkungen
Diese Rückruffunktion wird vom GPIO-Controllertreiber implementiert. Die GPIO-Framework-Erweiterung (GpioClx) ruft diese Funktion auf, um das GPIO-Controllergerät in einem bekannten, anfänglichen Zustand beim Systemstart zu platzieren oder wenn das Gerät von einem Energiesparzustand in einen Arbeitszustand wechselt. Diese Rückruffunktion muss alle Vorgänge ausführen, die nach dem Aufwachen des Geräts aus einem Energiesparzustand erforderlich sind, z. B. das Wiederherstellen von Informationen, die der Treiber benötigt, nachdem das Gerät in den D0-Energiezustand wechselt.
In der Regel legt eine CLIENT_StartController Rückruffunktion alle GPIO-Pins auf ihren Standardzustand fest.
Rufen Sie die GPIO_CLX_RegisterClient Methode auf, um die CLIENT_StartController Rückruffunktion ihres Treibers zu registrieren. Diese Methode akzeptiert als Eingabeparameter einen Zeiger auf eine GPIO_CLIENT_REGISTRATION_PACKET Struktur, die einen CLIENT_StartController Funktionszeiger enthält.
Obwohl die CLIENT_StartController Rückruffunktion bei IRQL = PASSIVE_LEVEL aufgerufen wird, sollten Sie diese Funktion nicht seitenfähige. Der CLIENT_StartController Rückruf befindet sich im kritischen Timing-Pfad zum Wiederherstellen der Energie auf den Geräten auf der Hardwareplattform und aus Leistungsgründen sollte es nicht durch Seitenfehler verzögert werden.
Beispiele
Um eine CLIENT_StartController Rückruffunktion zu definieren, müssen Sie zuerst eine Funktionsdeklaration bereitstellen, die den Typ der Rückruffunktion identifiziert, die Sie definieren. Windows stellt eine Reihe von Rückruffunktionstypen für Treiber bereit. Durch das Deklarieren einer Funktion mithilfe der Rückruffunktionstypen können Codeanalyse für Treiber, statische Treiberüberprüfung (SDV) und andere Überprüfungstools Fehler finden, und es ist eine Anforderung zum Schreiben von Treibern für das Windows-Betriebssystem.
Um beispielsweise eine CLIENT_StartController Rückruffunktion zu definieren, die MyEvtGpioStartControllerbenannt ist, verwenden Sie den funktionstyp GPIO_CLIENT_START_CONTROLLER, wie in diesem Codebeispiel gezeigt:
GPIO_CLIENT_START_CONTROLLER MyEvtGpioStartController;
Implementieren Sie dann die Rückruffunktion wie folgt:
_Use_decl_annotations_
VOID
MyEvtGpioStartController(
PVOID Context,
BOOLEAN RestoreContext,
WDF_POWER_DEVICE_STATE PreviousPowerState
)
{ ... }
Der GPIO_CLIENT_START_CONTROLLER Funktionstyp wird in der Headerdatei "Gpioclx.h" definiert. Um Fehler genauer zu identifizieren, wenn Sie die Codeanalysetools ausführen, müssen Sie der Funktionsdefinition die Use_decl_annotations Anmerkung hinzufügen. Die Use_decl_annotations Anmerkung stellt sicher, dass die Anmerkungen, die auf den funktionstyp GPIO_CLIENT_START_CONTROLLER in der Headerdatei angewendet werden, verwendet werden. Weitere Informationen zu den Anforderungen für Funktionsdeklarationen finden Sie unter Deklarieren von Funktionen mithilfe von Funktionsrollentypen für KMDF-Treiber. Weitere Informationen zu Use_decl_annotationsfinden Sie unter Annotating Function Behavior.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Wird ab Windows 8 unterstützt. |
| Zielplattform- | Desktop |
| Header- | gpioclx.h |
| IRQL- | Aufgerufen bei PASSIVE_LEVEL (siehe Hinweise). |