GPIO_CLIENT_WRITE_PINS_MASK Rückruffunktion (gpioclx.h)

Artikel
02/29/2024

Die CLIENT_WriteGpioPinsUsingMask Ereignisrückruffunktion schreibt in eine Reihe von GPIO-Pins (Universelle E/A), die als Datenausgaben konfiguriert sind.

Syntax

GPIO_CLIENT_WRITE_PINS_MASK GpioClientWritePinsMask;

NTSTATUS GpioClientWritePinsMask(
  [in] PVOID Context,
  [in] PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
)
{...}

Parameter

[in] Context

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

[in] WriteParameters

Ein Zeiger auf eine GPIO_WRITE_PINS_MASK_PARAMETERS Struktur, die eine Bank von GPIO-Pins beschreibt und die Daten enthält, die in diese Pins geschrieben werden sollen.

Rückgabewert

Die CLIENT_WriteGpioPinsUsingMask-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, um in einen bestimmten Satz von GPIO-Pins zu schreiben.

Die GPIO-Pins, in die von dieser Funktion geschrieben werden soll, werden durch zwei 64-Bit-Masken festgelegt. Die erste Maske gibt eine Gruppe von GPIO-Pins an, die auf 1 festgelegt werden sollen; ein Bit in dieser Maske ist 1, wenn der entsprechende GPIO-Pin auf 1 festgelegt werden soll. Die zweite Maske gibt eine Gruppe von GPIO-Pins an, die auf 0 festgelegt werden sollen. ein Bit in dieser Maske ist 1, wenn der entsprechende GPIO-Pin auf 0 festgelegt werden soll.

Um die CLIENT_WriteGpioPinsUsingMask 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_WriteGpioPinsUsingMask Funktionszeiger enthält.

Die CLIENT_WriteGpioPinsUsingMask-Funktion kann über die 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_WriteGpioPinsUsingMask-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_WriteGpioPinsUsingMask 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_WriteGpioPinsUsingMask Rückruffunktion namens MyEvtGpioWriteGpioPinsUsingMaskzu definieren, verwenden Sie den Funktionstyp GPIO_CLIENT_WRITE_PINS_MASK, wie in diesem Codebeispiel gezeigt:

GPIO_CLIENT_WRITE_PINS_MASK  MyEvtGpioWritePinsUsingMask;

Implementieren Sie dann Ihre Rückruffunktion wie folgt:

_Use_decl_annotations_
VOID
  MyEvtGpioWritePinsUsingMask(
    PVOID Context,
    PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
    )
{ ... }

Der GPIO_CLIENT_WRITE_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 GPIO_CLIENT_WRITE_PINS_MASK Funktionstyp 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.