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

Статья
08/07/2023

Функция обратного вызова события CLIENT_WriteGpioPinsUsingMask выполняет запись в набор контактов ввода-вывода общего назначения (GPIO), настроенных в качестве выходных данных.

Синтаксис

GPIO_CLIENT_WRITE_PINS_MASK GpioClientWritePinsMask;

NTSTATUS GpioClientWritePinsMask(
  [in] PVOID Context,
  [in] PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
)
{...}

Параметры

[in] Context

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

[in] WriteParameters

Указатель на структуру GPIO_WRITE_PINS_MASK_PARAMETERS , которая описывает банк контактов GPIO и содержит данные для записи в эти контакты.

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

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

Контакты GPIO, в которые должна быть записана эта функция, обозначены двумя 64-разрядными масками. Первая маска задает группу контактов GPIO, для которых должно быть задано значение 1; бит в этой маске равен 1, если соответствующий контакт GPIO должен иметь значение 1. Вторая маска задает группу контактов GPIO, которым необходимо задать значение 0; бит в этой маске равен 1, если соответствующий контакт GPIO должен иметь значение 0.

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

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

Примеры

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

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

GPIO_CLIENT_WRITE_PINS_MASK  MyEvtGpioWritePinsUsingMask;

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

_Use_decl_annotations_
VOID
  MyEvtGpioWritePinsUsingMask(
    PVOID Context,
    PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
    )
{ ... }

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

Требования

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