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

Artículo
08/07/2023

La función de devolución de llamada de evento CLIENT_ReadGpioPinsUsingMask lee un banco de patillas de E/S de uso general (GPIO).

Sintaxis

GPIO_CLIENT_READ_PINS_MASK GpioClientReadPinsMask;

NTSTATUS GpioClientReadPinsMask(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_MASK_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_MASK_PARAMETERS que, en la entrada, describe las patillas GPIO que se van a leer y, al salir, contiene los datos leídos de las patillas GPIO.

Valor devuelto

La función CLIENT_ReadGpioPinsUsingMask devuelve STATUS_SUCCESS si la llamada se realiza correctamente. 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.

La función de devolución de llamada CLIENT_ReadGpioPinsUsingMask lee los valores de todos los patillas GPIO en un banco de patillas. La función almacena estos valores en el miembro PinValues de la estructura GPIO_READ_PINS_MASK_PARAMETERS . Bit 0 (el bit menos significativo) de este miembro contiene el valor de pin 0, bit 1 contiene el valor de pin 1, etc.

Para registrar la función de devolución de llamada de CLIENT_ReadGpioPinsUsingMask 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_ReadGpioPinsUsingMask .

Se puede llamar a la función CLIENT_ReadGpioPinsUsingMask desde la rutina de servicio de interrupción (ISR) en GpioClx. Este ISR se ejecuta en PASSIVE_LEVEL o DIRQL, según 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 estructura CLIENT_CONTROLLER_BASIC_INFORMATION . Si el bit de marca MemoryMappedController se establece en el miembro Flags de esta estructura, el ISR de GpioClx se ejecuta en DIRQL y llama a la función CLIENT_ReadGpioPinsUsingMask 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 obligatorias.

Ejemplos

Para definir un CLIENT_ReadGpioPinsUsingMask función de devolución de llamada, primero debe proporcionar una declaración de función que identifique el tipo de función de devolución de llamada que está definiendo. 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 Análisis de código para controladores, Comprobador de controladores estáticos (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_ReadGpioPinsUsingMask denominada MyEvtGpioReadGpioPinsUsingMask, use el tipo de función GPIO_CLIENT_READ_PINS_MASK, como se muestra en este ejemplo de código:

GPIO_CLIENT_READ_PINS_MASK MyEvtGpioReadPinsUsingMask;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReadPinsUsingMask(
    PVOID Context,
    PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
    )
{ ... }

El tipo de función GPIO_CLIENT_READ_PINS_MASK 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_MASK 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 rol 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.