GPIO_CLIENT_READ_PINS Rückruffunktion (gpioclx.h)

Artikel
02/07/2025

Die CLIENT_ReadGpioPins Ereignisrückruffunktion liest eine Reihe von allgemeinen I/O-Pins (GPIO), die als Dateneingaben konfiguriert sind.

Syntax

GPIO_CLIENT_READ_PINS GpioClientReadPins;

NTSTATUS GpioClientReadPins(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_PARAMETERS ReadParameters
)
{...}

Parameter

[in] Context

Ein Zeiger auf den Gerätekontext des GPIO-Controllertreibers.

[in, out] ReadParameters

Ein Zeiger auf eine GPIO_READ_PINS_PARAMETERS Struktur, die beim Einstieg die zu lesenden GPIO-Pins beschreibt und beim Beenden die Daten enthält, die von den GPIO-Pins gelesen wurden.

Rückgabewert

Die CLIENT_ReadGpioPins-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. GpioClx ruft diese Funktion auf.

Alle Pins im PinNumberTable Array gehören zur Bank, die vom BankId Parameter identifiziert wird.

Rufen Sie die GPIO_CLX_RegisterClient Methode auf, um die CLIENT_ReadGpioPins Rückruffunktion des Treibers zu registrieren. Diese Methode akzeptiert als Eingabeparameter einen Zeiger auf eine GPIO_CLIENT_REGISTRATION_PACKET Struktur, die einen CLIENT_ReadGpioPins Funktionszeiger enthält.

Die CLIENT_ReadGpioPins-Funktion kann über die Unterbrechungsdienstroutine (Interrupt Service Routine, ISR) in GpioClx aufgerufen werden. Dieser ISR wird entweder bei PASSIVE_LEVEL oder DIRQL ausgeführt, abhängig von den Geräteinformationen, die die CLIENT_QueryControllerBasicInformation Rückruffunktion für GpioClx bereitstellt. Die CLIENT_QueryControllerBasicInformation-Funktion stellt Geräteinformationen in Form einer CLIENT_CONTROLLER_BASIC_INFORMATION Struktur bereit. Wenn das MemoryMappedController- Flagbit im Flags Mitglied dieser Struktur festgelegt ist, wird der GPioClx ISR bei DIRQL ausgeführt und ruft die CLIENT_ReadGpioPins-Funktion bei DIRQL auf. Andernfalls wird der ISR bei PASSIVE_LEVEL ausgeführt und ruft die Funktion bei PASSIVE_LEVEL auf. Weitere Informationen zu diesem Flagbit finden Sie unter Optional und Required GPIO Callback Functions.

Beispiele

Um eine CLIENT_ReadGpioPins 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_ReadGpioPins Rückruffunktion zu definieren, die MyEvtGpioReadGpioPinsbenannt ist, verwenden Sie den funktionstyp GPIO_CLIENT_READ_PINS, wie in diesem Codebeispiel gezeigt:

GPIO_CLIENT_READ_PINS MyEvtGpioReadPins;

Implementieren Sie dann die Rückruffunktion wie folgt:

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReadPins(
    PVOID Context,
    PGPIO_READ_PINS_PARAMETERS ReadParameters
    )
{ ... }

Der GPIO_CLIENT_READ_PINS 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_READ_PINS 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.