GPIO_CLIENT_READ_PINS_MASK funzione di callback (gpioclx.h)

Articolo
08/07/2023

La funzione di callback dell'evento CLIENT_ReadGpioPinsUsingMask legge una banca di pin di I/O (GPIO) per utilizzo generico.

Sintassi

GPIO_CLIENT_READ_PINS_MASK GpioClientReadPinsMask;

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

Parametri

[in] Context

Puntatore al contesto del dispositivo del controller GPIO.

[in, out] ReadParameters

Puntatore a una struttura GPIO_READ_PINS_MASK_PARAMETERS che, nella voce, descrive i pin GPIO da leggere e, all'uscita, contiene i dati letti dai pin GPIO.

Valore restituito

La funzione CLIENT_ReadGpioPinsUsingMask restituisce STATUS_SUCCESS se la chiamata ha esito positivo. In caso contrario, restituisce un codice di errore appropriato.

Commenti

Questa funzione di callback viene implementata dal driver del controller GPIO. GpioClx chiama questa funzione.

La funzione di callback CLIENT_ReadGpioPinsUsingMask legge i valori di tutti i pin GPIO in una banca di pin. La funzione archivia questi valori nel membro PinValues della struttura GPIO_READ_PINS_MASK_PARAMETERS . Bit 0 (bit meno significativo) di questo membro contiene il valore di pin 0, bit 1 contiene il valore di pin 1 e così via.

Per registrare la funzione di callback del driver CLIENT_ReadGpioPinsUsingMask , chiamare il metodo GPIO_CLX_RegisterClient . Questo metodo accetta, come parametro di input, un puntatore a una struttura GPIO_CLIENT_REGISTRATION_PACKET che contiene un puntatore alla funzione CLIENT_ReadGpioPinsUsingMask .

La funzione CLIENT_ReadGpioPinsUsingMask può essere chiamata dalla routine del servizio di interruzione (ISR) in GpioClx. Questo ISR viene eseguito in PASSIVE_LEVEL o DIRQL, a seconda delle informazioni sul dispositivo fornite dalla funzione di callback CLIENT_QueryControllerBasicInformation a GpioClx. La funzione CLIENT_QueryControllerBasicInformation fornisce informazioni sul dispositivo sotto forma di una struttura CLIENT_CONTROLLER_BASIC_INFORMATION . Se il bit del flag MemoryMappedController è impostato nel membro Flag di questa struttura, GpioClx ISR viene eseguito in DIRQL e chiama la funzione di CLIENT_ReadGpioPinsUsingMask in DIRQL. In caso contrario, l'ISR viene eseguito in PASSIVE_LEVEL e chiama la funzione in PASSIVE_LEVEL. Per altre informazioni su questo bit di flag, vedere Funzioni di callback facoltativo e obbligatorio per GPIO.

Esempio

Per definire una funzione di callback CLIENT_ReadGpioPinsUsingMask , è prima necessario specificare una dichiarazione di funzione che identifica il tipo di funzione di callback che si sta definendo. Windows fornisce un set di tipi di funzione di callback per i driver. La dichiarazione di una funzione usando i tipi di funzione callback consente l'analisi del codice per i driver, il verifica driver statico (SDV) e altri strumenti di verifica trovano errori ed è un requisito per la scrittura di driver per il sistema operativo Windows.

Ad esempio, per definire una funzione di callback CLIENT_ReadGpioPinsUsingMask denominata MyEvtGpioReadGpioPinsUsingMask, usare il tipo di funzione GPIO_CLIENT_READ_PINS_MASK, come illustrato nell'esempio di codice seguente:

GPIO_CLIENT_READ_PINS_MASK MyEvtGpioReadPinsUsingMask;

Implementare quindi la funzione di callback come indicato di seguito:

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

Il tipo di funzione GPIO_CLIENT_READ_PINS_MASK è definito nel file di intestazione Gpioclx.h. Per identificare in modo più accurato gli errori durante l'esecuzione degli strumenti di analisi del codice, assicurarsi di aggiungere l'annotazione Use_decl_annotations alla definizione della funzione. L'annotazione Use_decl_annotations garantisce che vengano usate le annotazioni applicate al tipo di funzione GPIO_CLIENT_READ_PINS_MASK nel file di intestazione. Per altre informazioni sui requisiti per le dichiarazioni di funzione, vedere Dichiarazione di funzioni tramite tipi di ruolo per i driver KMDF. Per altre informazioni su Use_decl_annotations, vedere Annotazione del comportamento della funzione.

Requisiti

Requisito	Valore
Client minimo supportato	Supportato a partire da Windows 8.
Piattaforma di destinazione	Desktop
Intestazione	gpioclx.h
IRQL	Vedere la sezione Osservazioni.