функция обратного вызова GPIO_CLIENT_READ_PINS_MASK (gpioclx.h)

Статья
08/07/2023

Функция обратного вызова события CLIENT_ReadGpioPinsUsingMask считывает банк контактов ввода-вывода общего назначения (GPIO).

Синтаксис

GPIO_CLIENT_READ_PINS_MASK GpioClientReadPinsMask;

NTSTATUS GpioClientReadPinsMask(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
)
{...}

Параметры

[in] Context

Указатель на контекст устройства драйвера контроллера GPIO.

[in, out] ReadParameters

Указатель на структуру GPIO_READ_PINS_MASK_PARAMETERS , которая в записи описывает контакты GPIO для чтения и при выходе содержит данные, считываемые из контактов GPIO.

Возвращаемое значение

Функция CLIENT_ReadGpioPinsUsingMask возвращает STATUS_SUCCESS, если вызов выполнен успешно. В противном случае возвращается соответствующий код ошибки.

Функция обратного вызова CLIENT_ReadGpioPinsUsingMask считывает значения всех контактов GPIO в банке контактов. Функция сохраняет эти значения в элементе PinValuesструктуры GPIO_READ_PINS_MASK_PARAMETERS . Бит 0 (наименьший значимый бит) этого элемента содержит значение контакта 0, бит 1 — значение контакта 1 и т. д.

Чтобы зарегистрировать функцию обратного вызова CLIENT_ReadGpioPinsUsingMask драйвера, вызовите метод GPIO_CLX_RegisterClient . Этот метод принимает в качестве входного параметра указатель на структуру GPIO_CLIENT_REGISTRATION_PACKET , содержащую указатель функции CLIENT_ReadGpioPinsUsingMask .

Функцию CLIENT_ReadGpioPinsUsingMask можно вызвать из подпрограммы службы прерываний (ISR) в GpioClx. Этот ISR выполняется в PASSIVE_LEVEL или DIRQL в зависимости от сведений об устройстве, которые функция обратного вызова CLIENT_QueryControllerBasicInformation предоставляет GpioClx. Функция CLIENT_QueryControllerBasicInformation предоставляет сведения об устройстве в виде структуры CLIENT_CONTROLLER_BASIC_INFORMATION . Если бит флага MemoryMappedController задан в элементе Flags этой структуры, isR GpioClx запускается в DIRQL и вызывает функцию CLIENT_ReadGpioPinsUsingMask в DIRQL. В противном случае ISR запускается в PASSIVE_LEVEL и вызывает функцию в PASSIVE_LEVEL. Дополнительные сведения об этом бите флага см. в разделах Необязательные и обязательные функции обратного вызова GPIO.

Примеры

Чтобы определить функцию обратного вызова CLIENT_ReadGpioPinsUsingMask , необходимо сначала предоставить объявление функции, определяющее тип определяемой функции обратного вызова. Windows предоставляет набор типов функций обратного вызова для драйверов. Объявление функции с помощью типов функций обратного вызова помогает анализу кода для драйверов, средству проверки статических драйверов (SDV) и другим средствам проверки находить ошибки, и это требование для написания драйверов для операционной системы Windows.

Например, чтобы определить функцию обратного вызова CLIENT_ReadGpioPinsUsingMask с именем MyEvtGpioReadGpioPinsUsingMask, используйте тип функции GPIO_CLIENT_READ_PINS_MASK, как показано в следующем примере кода:

GPIO_CLIENT_READ_PINS_MASK MyEvtGpioReadPinsUsingMask;

Затем реализуйте функцию обратного вызова следующим образом:

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

Тип функции GPIO_CLIENT_READ_PINS_MASK определен в файле заголовка Gpioclx.h. Чтобы более точно определить ошибки при запуске средств анализа кода, не забудьте добавить заметку Use_decl_annotations в определение функции. Заметка Use_decl_annotations гарантирует использование заметок, которые применяются к типу функции GPIO_CLIENT_READ_PINS_MASK в файле заголовка. Дополнительные сведения о требованиях к объявлениям функций см. в статье Объявление функций с помощью типов ролей функций для драйверов KMDF. Дополнительные сведения о Use_decl_annotations см. в статье О поведении функции.

Требования

Требование	Значение
Минимальная версия клиента	Поддерживается начиная с Windows 8.
Целевая платформа	Персональный компьютер
Верхняя часть	gpioclx.h
IRQL	См. заметки.