GPIO_CLIENT_MASK_INTERRUPTS fungsi panggilan balik (gpioclx.h)

Artikel
08/07/2023

Fungsi panggilan balik peristiwa CLIENT_MaskInterrupts mengganggu serangkaian pin I/O tujuan umum (GPIO) yang dikonfigurasi sebagai input interupsi.

Sintaks

GPIO_CLIENT_MASK_INTERRUPTS GpioClientMaskInterrupts;

NTSTATUS GpioClientMaskInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
)
{...}

Parameter

[in] Context

Penunjuk ke konteks perangkat driver pengontrol GPIO.

[in, out] MaskParameters

Penunjuk ke struktur GPIO_MASK_INTERRUPT_PARAMETERS yang, pada entri, menjelaskan pin interupsi GPIO untuk menutupi, dan, saat keluar, berisi status operasi masker.

Nilai kembali

Fungsi CLIENT_MaskInterrupts mengembalikan STATUS_SUCCESS jika panggilan berhasil. Jika tidak, ia mengembalikan kode kesalahan yang sesuai.

Keterangan

Fungsi panggilan balik ini diimplementasikan oleh driver pengontrol GPIO. Ekstensi kerangka kerja GPIO (GpioClx) memanggil fungsi ini untuk menutupi gangguan pada pin GPIO yang dikonfigurasi sebagai input permintaan interupsi. Untuk informasi selengkapnya, lihat GPIO Interupsi Masker.

Untuk mendaftarkan fungsi panggilan balik CLIENT_MaskInterrupts driver Anda, panggil metode GPIO_CLX_RegisterClient . Metode ini menerima, sebagai parameter input, penunjuk ke struktur GPIO_CLIENT_REGISTRATION_PACKET yang berisi penunjuk fungsi CLIENT_MaskInterrupts .

Fungsi CLIENT_MaskInterrupts dipanggil dari rutinitas layanan interupsi (ISR) di GpioClx. ISR ini berjalan baik di PASSIVE_LEVEL atau DIRQL, tergantung pada informasi perangkat yang disediakan fungsi panggilan balik CLIENT_QueryControllerBasicInformation ke GpioClx. Fungsi CLIENT_QueryControllerBasicInformation menyediakan informasi perangkat dalam bentuk struktur CLIENT_CONTROLLER_BASIC_INFORMATION . Jika bit bendera MemoryMappedController diatur dalam anggota Bendera struktur ini, GpioClx ISR berjalan di DIRQL dan memanggil fungsi CLIENT_MaskInterrupts di DIRQL. Jika tidak, ISR berjalan pada PASSIVE_LEVEL dan memanggil fungsi di PASSIVE_LEVEL. Untuk informasi selengkapnya tentang bit bendera ini, lihat Fungsi Panggilan Balik GPIO Opsional dan Diperlukan.

Panggilan CLIENT_MaskInterrupts yang gagal mengatur masker interupsi ke nilai yang diminta harus mengatur anggota FailedMask dari struktur GPIO_MASK_INTERRUPT_PARAMETERS ke nilai bukan nol dan mengembalikan kode status kesalahan yang sesuai. Fungsi CLIENT_MaskInterrupts untuk pengontrol GPIO yang dipetakan memori diharapkan selalu berhasil mengatur masker interupsi ke nilai yang diminta. Namun, fungsi CLIENT_MaskInterrupts untuk pengontrol yang tidak dipetakan memori harus mengirim permintaan I/O ke pengontrol untuk mengatur masker, dan permintaan ini mungkin gagal. Jika permintaan gagal mengatur masker, fungsi harus menunjukkan kegagalan ini dalam nilai yang ditulisnya ke anggota FailedMask .

Contoh

Untuk menentukan fungsi panggilan balik CLIENT_MaskInterrupts , Anda harus terlebih dahulu memberikan deklarasi fungsi yang mengidentifikasi jenis fungsi panggilan balik yang Anda tentukan. Windows menyediakan sekumpulan tipe fungsi panggilan balik untuk driver. Mendeklarasikan fungsi menggunakan jenis fungsi panggilan balik membantu Analisis Kode untuk Driver, Pemverifikasi Driver Statis (SDV), dan alat verifikasi lainnya menemukan kesalahan, dan itu adalah persyaratan untuk menulis driver untuk sistem operasi Windows.

Misalnya, untuk menentukan fungsi panggilan balik CLIENT_MaskInterrupts yang diberi nama MyEvtGpioMaskInterrupts, gunakan jenis fungsi GPIO_CLIENT_MASK_INTERRUPTS, seperti yang ditunjukkan dalam contoh kode ini:

GPIO_CLIENT_MASK_INTERRUPTS MyEvtGpioMaskInterrupts;

Kemudian, terapkan fungsi panggilan balik Anda sebagai berikut:

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioMaskInterrupts(
    PVOID Context,
    PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
    )
{ ... }

Jenis fungsi GPIO_CLIENT_MASK_INTERRUPTS didefinisikan dalam file header Gpioclx.h. Untuk mengidentifikasi kesalahan secara lebih akurat saat Anda menjalankan alat analisis kode, pastikan untuk menambahkan anotasi Use_decl_annotations ke definisi fungsi Anda. Anotasi Use_decl_annotations memastikan bahwa anotasi yang diterapkan ke jenis fungsi GPIO_CLIENT_MASK_INTERRUPTS dalam file header digunakan. Untuk informasi selengkapnya tentang persyaratan untuk deklarasi fungsi, lihat Mendeklarasikan Fungsi dengan Menggunakan Jenis Peran Fungsi untuk Driver KMDF. Untuk informasi selengkapnya tentang Use_decl_annotations, lihat Perilaku Fungsi Anotasi.