função de retorno de chamada GPIO_CLIENT_PREPARE_CONTROLLER (gpioclx.h)
A função de retorno de chamada de evento CLIENT_PrepareController executa todas as operações necessárias para tornar o controlador de E/S de uso geral (GPIO) pronto para ser acessado pelo driver do controlador GPIO.
Sintaxe
GPIO_CLIENT_PREPARE_CONTROLLER GpioClientPrepareController;
NTSTATUS GpioClientPrepareController(
[in] WDFDEVICE Device,
[in] PVOID Context,
[in] WDFCMRESLIST ResourcesRaw,
[in] WDFCMRESLIST ResourcesTranslated
)
{...}
Parâmetros
[in] Device
Um identificador WDFDEVICE para o objeto de dispositivo de estrutura que representa o controlador GPIO.
[in] Context
Um ponteiro para o contexto do dispositivo do driver do controlador GPIO.
[in] ResourcesRaw
Um identificador WDFCMRESLIST para uma coleção de objetos de recurso de estrutura. Essa coleção identifica os recursos de hardware brutos (relativos ao barramento) que o gerenciador de Plug and Play (PnP) atribuiu ao dispositivo controlador GPIO.
[in] ResourcesTranslated
Um identificador WDFCMRESLIST para uma coleção de objetos de recurso de estrutura. Essa coleção identifica os recursos de hardware traduzidos (físicos do sistema) que o gerenciador PnP atribuiu ao dispositivo controlador GPIO.
Retornar valor
A função CLIENT_PrepareController 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 inicializar os recursos de hardware necessários pelo driver do controlador GPIO para que ele possa acessar o dispositivo controlador GPIO.
Os parâmetros ResourcesRaw e ResourcesTranslated são identificadores para listas de recursos brutos e traduzidos. Essas listas descrevem os recursos de hardware que o gerenciador de PnP atribuiu ao dispositivo controlador GPIO especificado pelo parâmetro Device . Para obter mais informações, consulte Recursos brutos e traduzidos.
Durante o retorno de chamada CLIENT_PrepareController, o driver do controlador GPIO pode adquirir os recursos de hardware necessários da lista ResourcesRaw ou ResourcesTranslated . Se o dispositivo controlador GPIO for mapeado pela memória, o driver deverá mapear o intervalo de endereços de memória relativos ao barramento ou os intervalos atribuídos aos registros de hardware do dispositivo para endereços virtuais do sistema. Para obter mais informações, consulte Mapeamento Bus-Relative endereços para endereços virtuais.
Se o controlador GPIO não for mapeado para memória, os recursos de hardware do driver conterão uma ID de conexão em vez de um intervalo de memória. O driver usa essa ID para abrir uma conexão lógica com o controlador GPIO e envia solicitações de E/S por meio dessa conexão para acessar os registros do controlador.
O GpioClx se conecta a (e, posteriormente, desconecta de) qualquer recurso de interrupção que o gerenciador PnP atribui ao controlador GPIO. Se o GpioClx receber esse recurso de interrupção, ele não removerá esse recurso de interrupção das listas de recursos que ele passa para a função de retorno de chamada CLIENT_PrepareController . No entanto, o driver do controlador GPIO não deve tentar se conectar a (ou desconectar-se posteriormente) a qualquer recurso de interrupção encontrado nessas listas.
A função de retorno de chamada de evento CLIENT_ReleaseController executa operações que são necessárias quando o dispositivo controlador GPIO não está mais acessível. Durante esse retorno de chamada, o driver do controlador GPIO deve liberar todos os recursos de hardware adquiridos durante o retorno de chamada CLIENT_PrepareController anterior.
Para registrar a função de retorno de chamada CLIENT_PrepareController 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_PrepareController .
Embora a função de retorno de chamada CLIENT_PrepareController seja chamada em IRQL = PASSIVE_LEVEL, você não deve tornar essa função paginável. O retorno de chamada CLIENT_PrepareController está no caminho de tempo crítico para restaurar a energia para os dispositivos na plataforma de hardware e, por motivos de desempenho, ele não deve ser atrasado por falhas de página.
Exemplos
Para definir uma função de retorno de chamada CLIENT_PrepareController, 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_PrepareController chamada MyEvtGpioPrepareController, use o tipo de função GPIO_CLIENT_PREPARE_CONTROLLER, conforme mostrado neste exemplo de código:
GPIO_CLIENT_PREPARE_CONTROLLER MyEvtGpioPrepareController;
Em seguida, implemente a função de retorno de chamada da seguinte maneira:
_Use_decl_annotations_
NTSTATUS
MyEvtGpioPrepareController(
WDFDEVICE Device,
PVOID Context,
WDFCMRESLIST ResourcesRaw,
WDFCMRESLIST ResourcesTranslated
)
{ ... }
O tipo de função GPIO_CLIENT_PREPARE_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_PREPARE_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 |
|---|---|
| Cliente mínimo com suporte | Com suporte começando com Windows 8. |
| Plataforma de Destino | Área de Trabalho |
| Cabeçalho | gpioclx.h |
| IRQL | Chamado em PASSIVE_LEVEL. |