GPIO_CLIENT_READ_PINS función de devolución de llamada (gpioclx.h)

Artículo
02/26/2024

La función de devolución de llamada de evento CLIENT_ReadGpioPins lee un conjunto de patillas de E/S de uso general (GPIO) configuradas como entradas de datos.

Sintaxis

GPIO_CLIENT_READ_PINS GpioClientReadPins;

NTSTATUS GpioClientReadPins(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_PARAMETERS ReadParameters
)
{...}

Parámetros

[in] Context

Puntero al contexto del dispositivo del controlador GPIO.

[in, out] ReadParameters

Un puntero a una estructura de GPIO_READ_PINS_PARAMETERS que, en la entrada, describe los patillas GPIO que se van a leer y, al salir, contiene los datos leídos de los patillas GPIO.

Valor devuelto

La función CLIENT_ReadGpioPins devuelve STATUS_SUCCESS si la llamada es correcta. De lo contrario, devuelve un código de error adecuado.

Comentarios

El controlador del controlador GPIO implementa esta función de devolución de llamada. GpioClx llama a esta función.

Todos los patillas de la matriz PinNumberTable pertenecen al banco identificado por el parámetro BankId .

Para registrar la función de devolución de llamada CLIENT_ReadGpioPins del controlador, llame al método GPIO_CLX_RegisterClient . Este método acepta, como parámetro de entrada, un puntero a una estructura de GPIO_CLIENT_REGISTRATION_PACKET que contiene un puntero de función CLIENT_ReadGpioPins .

Se puede llamar a la función CLIENT_ReadGpioPins desde la rutina de servicio de interrupción (ISR) en GpioClx. Este ISR se ejecuta en PASSIVE_LEVEL o DIRQL, en función de la información del dispositivo que la función de devolución de llamada CLIENT_QueryControllerBasicInformation proporciona a GpioClx. La función CLIENT_QueryControllerBasicInformation proporciona información del dispositivo en forma de una estructura de CLIENT_CONTROLLER_BASIC_INFORMATION . Si el bit de marca MemoryMappedController se establece en el miembro Flags de esta estructura, gpioClx ISR se ejecuta en DIRQL y llama a la función CLIENT_ReadGpioPins en DIRQL. De lo contrario, el ISR se ejecuta en PASSIVE_LEVEL y llama a la función en PASSIVE_LEVEL. Para obtener más información sobre este bit de marca, vea Funciones de devolución de llamada GPIO opcionales y necesarias.

Ejemplos

Para definir una función de devolución de llamada CLIENT_ReadGpioPins, primero debe proporcionar una declaración de función que identifique el tipo de función de devolución de llamada que va a definir. Windows proporciona un conjunto de tipos de función de devolución de llamada para controladores. Declarar una función mediante los tipos de función de devolución de llamada ayuda a Code Analysis for Drivers, Static Driver Verifier (SDV) y otras herramientas de comprobación encuentran errores y es un requisito para escribir controladores para el sistema operativo Windows.

Por ejemplo, para definir una función de devolución de llamada CLIENT_ReadGpioPins denominada MyEvtGpioReadGpioPins, use el tipo de función GPIO_CLIENT_READ_PINS, como se muestra en este ejemplo de código:

GPIO_CLIENT_READ_PINS MyEvtGpioReadPins;

A continuación, implemente la función de devolución de llamada de la siguiente manera:

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReadPins(
    PVOID Context,
    PGPIO_READ_PINS_PARAMETERS ReadParameters
    )
{ ... }

El tipo de función GPIO_CLIENT_READ_PINS se define en el archivo de encabezado Gpioclx.h. Para identificar con más precisión los errores al ejecutar las herramientas de análisis de código, asegúrese de agregar la anotación Use_decl_annotations a la definición de función. La anotación Use_decl_annotations garantiza que se usen las anotaciones que se aplican al tipo de función GPIO_CLIENT_READ_PINS en el archivo de encabezado. Para obtener más información sobre los requisitos de las declaraciones de función, consulte Declaración de funciones mediante tipos de roles de función para controladores KMDF. Para obtener más información sobre Use_decl_annotations, consulte Anotación del comportamiento de la función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Se admite a partir de Windows 8.
Plataforma de destino	Escritorio
Encabezado	gpioclx.h
IRQL	Vea la sección Comentarios.