GPIO_CLIENT_STOP_CONTROLLER função de retorno de chamada (gpioclx.h)
A função de retorno de chamada de evento CLIENT_StopController executa operações necessárias para preparar o dispositivo controlador de E/S de uso geral (GPIO) para sair do estado de energia D0.
Sintaxe
GPIO_CLIENT_STOP_CONTROLLER GpioClientStopController;
NTSTATUS GpioClientStopController(
[in] PVOID Context,
[in] BOOLEAN SaveContext,
[in] WDF_POWER_DEVICE_STATE TargetState
)
{...}
Parâmetros
[in] Context
Um ponteiro para o contexto do dispositivo do driver gpio.
[in] SaveContext
Se o driver cliente deve salvar o contexto de hardware atual do dispositivo do controlador GPIO. Se TRUE, o contexto de hardware deverá ser salvo. Se FALSE, o contexto de hardware não deverá ser salvo. Para obter mais informações, consulte Comentários.
[in] TargetState
O estado de energia do dispositivo de destino. Esse parâmetro é um valor de enumeração WDF_POWER_DEVICE_STATE que especifica o estado de baixa potência que o dispositivo deve inserir quando sair do estado de energia D0. O driver do controlador GPIO pode usar essas informações para determinar como configurar o dispositivo do controlador antes de sair de D0.
Valor de retorno
A função CLIENT_StopController 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. A extensão da estrutura GPIO (GpioClx) chama essa função para preparar o dispositivo do controlador GPIO a ser desativado ou fazer a transição para um estado de baixa potência. Essa função de retorno de chamada deve executar todas as operações necessárias antes que o dispositivo insira um estado de baixa potência, como salvar qualquer informação de que o driver precisará mais tarde depois que o dispositivo for restaurado para o estado de energia D0.
Normalmente, a função de retorno de chamada CLIENT_StopController configura os pinos de GPIO para um estado inicial específico da plataforma. Por exemplo, essa função pode configurar todos os pinos gpio como entradas para impedir que transitórios de saída ocorram quando o dispositivo controlador GPIO está desativado.
Para registrar a função de retorno de chamada CLIENT_StopController 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_StopController.
Embora a função de retorno de chamada CLIENT_StopController seja chamada em IRQL = PASSIVE_LEVEL, você não deve tornar essa função paginável. O retorno de chamada CLIENT_StopController está no caminho de tempo crítico para restaurar a energia para os dispositivos na plataforma de hardware e, por motivos de desempenho, não deve ser atrasado por falhas de página.
Exemplos
Para definir uma função de retorno de chamada CLIENT_StopController, 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_StopController denominada MyEvtGpioStopController, use o tipo de função GPIO_CLIENT_STOP_CONTROLLER, conforme mostrado neste exemplo de código:
GPIO_CLIENT_STOP_CONTROLLER MyEvtGpioStopController;
Em seguida, implemente sua função de retorno de chamada da seguinte maneira:
_Use_decl_annotations_
VOID
MyEvtGpioStopController(
PVOID Context,
BOOLEAN RestoreContext,
WDF_POWER_DEVICE_STATE TargetState
)
{ ... }
O tipo de função GPIO_CLIENT_STOP_CONTROLLER é 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_STOP_CONTROLLER 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 | Chamado no PASSIVE_LEVEL. |