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

Artigo
08/07/2023

A função de retorno de chamada de evento CLIENT_RestoreBankHardwareContext restaura o contexto de hardware de um banco de pinos de GPIO (E/S de uso geral).

Sintaxe

GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT GpioClientRestoreBankHardwareContext;

void GpioClientRestoreBankHardwareContext(
  [in] PVOID Context,
  [in] PGPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS Parameters
)
{...}

Parâmetros

[in] Context

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

[in] Parameters

Um ponteiro para uma estrutura GPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS que descreve o banco de pinos GPIO a serem restaurados.

Retornar valor

Nenhum

Comentários

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

Se um banco de pinos GPIO der suporte ao gerenciamento de energia no nível do componente, o GpioClx poderá mudar o banco para um estado fx de baixa potência se o banco estiver ocioso. Se o banco do controlador GPIO perder seu contexto de hardware no estado Fx, o driver do controlador GPIO deverá salvar esse contexto antes da transição F0 para Fx e, posteriormente, restaurar o contexto após a transição Fx-to-F0. Atualmente, F1 é o único estado de baixa potência definido para controladores GPIO que usam GpioClx.

GpioClx chama a função CLIENT_RestoreBankHardwareContext para restaurar o contexto de hardware salvo anteriormente do banco. O contexto de hardware foi salvo anteriormente pela CLIENT_SaveBankHardwareContext função de retorno de chamada de evento.

Alguns dispositivos controladores GPIO permitem que bancos selecionados de pinos sejam ativados e desativados independentemente de outros bancos no mesmo dispositivo. Assim, a energia pode ser salva desativando um banco ocioso.

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

GpioClx chama a função de retorno de chamada CLIENT_RestoreBankHardwareContext 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, GpioClx chamará a função CLIENT_RestoreBankHardwareContext em DIRQL, que é o IRQL no qual o ISR em GpioClx é executado. Caso contrário, essa função será chamada 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_RestoreBankHardwareContext 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_RestoreBankHardwareContext chamada chamada MyEvtGpioRestoreBankHardwareContext, use o tipo de função GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT, conforme mostrado neste exemplo de código:

GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT MyEvtGpioRestoreBankHardwareContext;</pre>

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioRestoreBankHardwareContext(
    PVOID Context,
    PGPIO_SAVE_RESTORE_BANK_HARDWARE_CONTEXT_PARAMETERS Parameters
    )
{ ... }

O tipo de função GPIO_CLIENT_RESTORE_BANK_HARDWARE_CONTEXT é 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_RESTORE_BANK_HARDWARE_CONTEXT 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.