GPIO_CLIENT_READ_PINS_MASK Rückruffunktion (gpioclx.h)

Artikel
02/26/2024

Die CLIENT_ReadGpioPinsUsingMask Ereignisrückruffunktion liest eine Bank von GPIO-Pins (Universelle E/A).

Syntax

GPIO_CLIENT_READ_PINS_MASK GpioClientReadPinsMask;

NTSTATUS GpioClientReadPinsMask(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
)
{...}

Parameter

[in] Context

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

[in, out] ReadParameters

Ein Zeiger auf eine GPIO_READ_PINS_MASK_PARAMETERS-Struktur , die bei der Eingabe die zu lesenden GPIO-Pins beschreibt und beim Beenden die von den GPIO-Pins gelesenen Daten enthält.

Rückgabewert

Die CLIENT_ReadGpioPinsUsingMask-Funktion gibt STATUS_SUCCESS zurück, wenn der Aufruf erfolgreich ist. Andernfalls wird ein geeigneter Fehlercode zurückgegeben.

Hinweise

Diese Rückruffunktion wird vom GPIO-Controllertreiber implementiert. GpioClx ruft diese Funktion auf.

Die CLIENT_ReadGpioPinsUsingMask Rückruffunktion liest die Werte aller GPIO-Pins in einer Pin-Bank. Die Funktion speichert diese Werte im PinValues-Member der GPIO_READ_PINS_MASK_PARAMETERS-Struktur . Bit 0 (das am wenigsten signifikante Bit) dieses Elements enthält den Wert von Pin 0, Bit 1 enthält den Wert von Pin 1 usw.

Um die CLIENT_ReadGpioPinsUsingMask Rückruffunktion Ihres Treibers zu registrieren, rufen Sie die GPIO_CLX_RegisterClient-Methode auf. Diese Methode akzeptiert als Eingabeparameter einen Zeiger auf eine GPIO_CLIENT_REGISTRATION_PACKET-Struktur , die einen CLIENT_ReadGpioPinsUsingMask Funktionszeiger enthält.

Die funktion CLIENT_ReadGpioPinsUsingMask kann von der Interruptdienstroutine (ISR) in GpioClx aufgerufen werden. Diese ISR wird entweder mit PASSIVE_LEVEL oder DIRQL ausgeführt, abhängig von den Geräteinformationen, die die CLIENT_QueryControllerBasicInformation Rückruffunktion an GpioClx bereitstellt. Die CLIENT_QueryControllerBasicInformation-Funktion stellt Geräteinformationen in Form einer CLIENT_CONTROLLER_BASIC_INFORMATION-Struktur bereit. Wenn das Flagbit "MemoryMappedController " im Flags-Element dieser Struktur festgelegt ist, wird die GpioClx-ISR bei DIRQL ausgeführt und die CLIENT_ReadGpioPinsUsingMask-Funktion bei DIRQL aufgerufen. Andernfalls wird die ISR bei PASSIVE_LEVEL ausgeführt und ruft die Funktion bei PASSIVE_LEVEL auf. Weitere Informationen zu diesem Flag-Bit finden Sie unter Optionale und erforderliche GPIO-Rückruffunktionen.

Beispiele

Um eine CLIENT_ReadGpioPinsUsingMask Rückruffunktion zu definieren, müssen Sie zunächst eine Funktionsdeklaration bereitstellen, die den Typ der Rückruffunktion identifiziert, die Sie definieren. Windows bietet eine Reihe von Rückruffunktionstypen für Treiber. Das Deklarieren einer Funktion mithilfe der Rückruffunktionstypen hilft der Codeanalyse für Treiber, der statischen Treiberüberprüfung (Static Driver Verifier , SDV) und anderen Überprüfungstools, Fehler zu finden, und es ist eine Voraussetzung für das Schreiben von Treibern für das Windows-Betriebssystem.

Um beispielsweise eine CLIENT_ReadGpioPinsUsingMask Rückruffunktion mit dem Namen MyEvtGpioReadGpioPinsUsingMaskzu definieren, verwenden Sie den Funktionstyp GPIO_CLIENT_READ_PINS_MASK, wie in diesem Codebeispiel gezeigt:

GPIO_CLIENT_READ_PINS_MASK MyEvtGpioReadPinsUsingMask;

Implementieren Sie dann Ihre Rückruffunktion wie folgt:

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReadPinsUsingMask(
    PVOID Context,
    PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
    )
{ ... }

Der GPIO_CLIENT_READ_PINS_MASK Funktionstyp ist in der Gpioclx.h-Headerdatei definiert. Um Fehler beim Ausführen der Codeanalysetools genauer zu identifizieren, müssen Sie der Funktionsdefinition die anmerkung Use_decl_annotations hinzufügen. Die Use_decl_annotations-Anmerkung stellt sicher, dass die Anmerkungen verwendet werden, die auf den funktionstyp GPIO_CLIENT_READ_PINS_MASK in der Headerdatei angewendet 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_annotations finden Sie unter Annotating Function Behavior.