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

Artigo
08/07/2023

A função de retorno de chamada de evento CLIENT_WriteGpioPins grava em um conjunto de pinos de GPIO (E/S de uso geral) configurados como saídas de dados.

Sintaxe

GPIO_CLIENT_WRITE_PINS GpioClientWritePins;

NTSTATUS GpioClientWritePins(
  [in] PVOID Context,
  [in] PGPIO_WRITE_PINS_PARAMETERS WriteParameters
)
{...}

Parâmetros

[in] Context

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

[in] WriteParameters

Um ponteiro para uma estrutura GPIO_WRITE_PINS_PARAMETERS que descreve um banco de pinos GPIO e que contém os dados a serem gravados nesses pinos.

Retornar valor

A função CLIENT_WriteGpioPins 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. GpioClx chama essa função.

Todos os pinos na matriz PinNumberTable pertencem ao banco identificado pelo parâmetro BankId .

Para registrar a função de retorno de chamada CLIENT_WriteGpioPins 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_WriteGpioPins.

A função CLIENT_WriteGpioPins pode ser chamada da 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 CLIENT_CONTROLLER_BASIC_INFORMATION . Se o bit do sinalizador MemoryMappedController for definido no membro Flags dessa estrutura, o ISR gpioClx será executado em DIRQL e chamará a função CLIENT_WriteGpioPins 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.

Exemplos

Para definir um CLIENT_WriteGpioPins função de retorno de chamada, 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 escrever drivers para o sistema operacional Windows.

Por exemplo, para definir uma função de retorno de chamada CLIENT_WriteGpioPins chamada chamada MyEvtGpioWriteGpioPins, use o tipo de função GPIO_CLIENT_WRITE_PINS, conforme mostrado neste exemplo de código:

GPIO_CLIENT_WRITE_PINS MyEvtGpioWritePins;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioWritePins(
    PVOID Context,
    PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
    )
{ ... }

O tipo de função GPIO_CLIENT_WRITE_PINS é 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_WRITE_PINS 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 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 a partir do Windows 8.
Plataforma de Destino	Área de Trabalho
Cabeçalho	gpioclx.h
IRQL	Consulte Observações.