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

Artigo
08/07/2023

A função de retorno de chamada de evento CLIENT_MaskInterrupts mascara interrupções em um conjunto de pinos de E/S de uso geral (GPIO) configurados como entradas de interrupção.

Sintaxe

GPIO_CLIENT_MASK_INTERRUPTS GpioClientMaskInterrupts;

NTSTATUS GpioClientMaskInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
)
{...}

Parâmetros

[in] Context

Um ponteiro para o contexto do dispositivo do driver do controlador GPIO.

[in, out] MaskParameters

Um ponteiro para uma estrutura GPIO_MASK_INTERRUPT_PARAMETERS que, na entrada, descreve os pinos de interrupção gpio para mascarar e, na saída, contém o status da operação de máscara.

Retornar valor

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

Comentários

Essa função de retorno de chamada é implementada pelo driver do controlador GPIO. A gpioClx (extensão de estrutura gpio) chama essa função para mascarar interrupções em pinos GPIO configurados como entradas de solicitação de interrupção. Para obter mais informações, consulte Máscaras de Interrupção do GPIO.

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

A função CLIENT_MaskInterrupts é chamada do ISR (rotina de serviço de interrupção) em 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 de CLIENT_CONTROLLER_BASIC_INFORMATION . Se o bit do sinalizador MemoryMappedController estiver definido no membro Flags dessa estrutura, o ISR gpioClx será executado em DIRQL e chamará a função CLIENT_MaskInterrupts em 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 gpio opcionais e necessárias.

Uma chamada CLIENT_MaskInterrupts que não define a máscara de interrupção para o valor solicitado deve definir o membro FailedMask da estrutura GPIO_MASK_INTERRUPT_PARAMETERS como um valor diferente de zero e retornar um erro apropriado status código. Espera-se que a função CLIENT_MaskInterrupts para um controlador GPIO mapeado pela memória sempre tenha êxito na configuração da máscara de interrupção para o valor solicitado. No entanto, a função CLIENT_MaskInterrupts para um controlador que não é mapeado pela memória deve enviar uma solicitação de E/S ao controlador para definir a máscara e essa solicitação pode falhar. Se a solicitação não definir a máscara, a função deverá indicar essa falha no valor que ela grava no membro FailedMask .

Exemplos

Para definir uma função de retorno de chamada CLIENT_MaskInterrupts, 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 a encontrar erros e é um requisito para gravar drivers para o sistema operacional Windows.

Por exemplo, para definir uma função de retorno de chamada CLIENT_MaskInterrupts chamada MyEvtGpioMaskInterrupts, use o tipo de função GPIO_CLIENT_MASK_INTERRUPTS, conforme mostrado neste exemplo de código:

GPIO_CLIENT_MASK_INTERRUPTS MyEvtGpioMaskInterrupts;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioMaskInterrupts(
    PVOID Context,
    PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
    )
{ ... }

O tipo de função GPIO_CLIENT_MASK_INTERRUPTS é 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_MASK_INTERRUPTS 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
Cliente mínimo com suporte	Com suporte começando com Windows 8.
Plataforma de Destino	Área de Trabalho
Cabeçalho	gpioclx.h
IRQL	Consulte Observações.