GPIO_CLIENT_READ_PINS_MASK função de retorno de chamada (gpioclx.h)

Artigo
02/07/2025

A função de retorno de chamada de evento CLIENT_ReadGpioPinsUsingMask lê um banco de pinos de E/S de uso geral (GPIO).

Sintaxe

GPIO_CLIENT_READ_PINS_MASK GpioClientReadPinsMask;

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

Parâmetros

[in] Context

Um ponteiro para o contexto do dispositivo do driver gpio.

[in, out] ReadParameters

Um ponteiro para uma estrutura GPIO_READ_PINS_MASK_PARAMETERS que, na entrada, descreve os pinos gpio a serem lidos e, na saída, contém os dados lidos dos pinos gpio.

Valor de retorno

A função CLIENT_ReadGpioPinsUsingMask retornará STATUS_SUCCESS se a chamada for bem-sucedida. Caso contrário, ele retornará um código de erro apropriado.

Observações

Essa função de retorno de chamada é implementada pelo driver do controlador GPIO. O GpioClx chama essa função.

A função de retorno de chamada CLIENT_ReadGpioPinsUsingMask lê os valores de todos os pinos gpio em um banco de pinos. A função armazena esses valores no pinValues membro da estrutura GPIO_READ_PINS_MASK_PARAMETERS. O bit 0 (o bit menos significativo) desse membro contém o valor do pino 0, o bit 1 contém o valor do pino 1 e assim por diante.

Para registrar a função de retorno de chamada CLIENT_ReadGpioPinsUsingMask do driver, chame o método GPIO_CLX_RegisterClient. Esse método aceita, como parâmetro de entrada, um ponteiro para uma estrutura de GPIO_CLIENT_REGISTRATION_PACKET que contém um ponteiro de função CLIENT_ReadGpioPinsUsingMask.

A função CLIENT_ReadGpioPinsUsingMask pode ser chamada da ISR (rotina de serviço de interrupção) no GpioClx. Esse ISR é executado em PASSIVE_LEVEL ou DIRQL, dependendo das informações do dispositivo que a função de retorno de chamada CLIENT_QueryControllerBasicInformation fornece ao GpioClx. A função CLIENT_QueryControllerBasicInformation fornece informações do dispositivo na forma de uma estrutura CLIENT_CONTROLLER_BASIC_INFORMATION. Se o MemoryMappedController bit de sinalizador for definido no Flags membro dessa estrutura, o ISR gpioClx será executado no DIRQL e chamará a função CLIENT_ReadGpioPinsUsingMask no DIRQL. Caso contrário, o ISR será executado em PASSIVE_LEVEL e chamará a função em PASSIVE_LEVEL. Para obter mais informações sobre esse bit de sinalizador, consulte funções de retorno de chamada de GPIO opcionais e necessárias.

Exemplos

Para definir uma função de retorno de chamada CLIENT_ReadGpioPinsUsingMask, primeiro você deve fornecer uma declaração de função que identifique o tipo de função de retorno de chamada que você está definindo. O Windows fornece um conjunto de tipos de função de retorno de chamada para drivers. Declarar uma função usando os tipos de função de retorno de chamada ajuda a análise de código para drivers, SDV (Verificador de Driver Estático) e outras ferramentas de verificação encontram erros e é um requisito para gravar drivers para o sistema operacional Windows.

Por exemplo, para definir uma função de retorno de chamada CLIENT_ReadGpioPinsUsingMask denominada MyEvtGpioReadGpioPinsUsingMask, use o tipo de função GPIO_CLIENT_READ_PINS_MASK, conforme mostrado neste exemplo de código:

GPIO_CLIENT_READ_PINS_MASK MyEvtGpioReadPinsUsingMask;

Em seguida, implemente sua função de retorno de chamada da seguinte maneira:

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

O tipo de função GPIO_CLIENT_READ_PINS_MASK é definido no arquivo de cabeçalho Gpioclx.h. Para identificar erros com mais precisão ao executar as ferramentas de análise de código, adicione a anotação Use_decl_annotations à sua definição de função. A anotação Use_decl_annotations garante que as anotações aplicadas ao tipo de função GPIO_CLIENT_READ_PINS_MASK no arquivo de cabeçalho sejam usadas. Para obter mais informações sobre os requisitos para declarações de função, consulte Declarando funções usando tipos de função de função para drivers KMDF. Para obter mais informações sobre Use_decl_annotations, consulte Anotando o comportamento da função.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Com suporte a partir do Windows 8.
da Plataforma de Destino	Área de trabalho
cabeçalho	gpioclx.h
IRQL	Consulte Comentários.