GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS fungsi panggilan balik (gpioclx.h)

Artikel
08/07/2023

Fungsi panggilan balik peristiwa CLIENT_QueryEnabledInterrupts meminta status sekumpulan pin I/O (GPIO) tujuan umum untuk menentukan pin mana yang dikonfigurasi sebagai input interupsi dan diaktifkan untuk interupsi.

Sintaks

GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS GpioClientQueryEnabledInterrupts;

NTSTATUS GpioClientQueryEnabledInterrupts(
  [in] PVOID Context,
  [in] PGPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS QueryEnabledParameters
)
{...}

Parameter

[in] Context

Penunjuk ke konteks perangkat driver pengontrol GPIO.

[in] QueryEnabledParameters

Penunjuk ke struktur GPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS yang dialokasikan penelepon. Sebelum memanggil fungsi ini, pemanggil menulis ID bank kepada anggota BankId struktur ini untuk menentukan pin bank GPIO mana yang akan dikueri. Jika berhasil, fungsi menulis nilai masker ke anggota EnabledMask dari struktur ini untuk menunjukkan gangguan mana yang diaktifkan di bank yang ditentukan.

Nilai kembali

Fungsi CLIENT_QueryEnabledInterrupts mengembalikan STATUS_SUCCESS jika panggilan berhasil. Jika tidak, kode kesalahan akan menampilkan kode kesalahan yang sesuai.

Keterangan

Dimulai dengan Windows 8.1, driver pengontrol GPIO dapat, sebagai opsi, menerapkan fungsi panggilan balik CLIENT_QueryEnabledInterrupts. Jika diimplementasikan, fungsi ini dipanggil oleh ekstensi kerangka kerja GPIO (GpioClx) untuk menentukan interupsi mana yang diaktifkan di bank pin GPIO.

Parameter QueryEnabledParameters menunjuk ke struktur GPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS yang dialokasikan pemanggil. Pemanggil menetapkan nilai anggota BankId dari struktur ini. Fungsi CLIENT_QueryEnabledInterrupts menulis ke anggota EnabledMask dari struktur.

Untuk mendaftarkan fungsi panggilan balik CLIENT_QueryEnabledInterrupts 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_QueryEnabledInterrupts .

Fungsi CLIENT_QueryEnabledInterrupts bersifat opsional. Jika driver Anda tidak menerapkan fungsi ini, atur anggota CLIENT_QueryEnabledInterrupts struktur GPIO_CLIENT_REGISTRATION_PACKET ke NULL.

Jika fungsi CLIENT_QueryEnabledInterrupts diimplementasikan, GpioClx menggunakan fungsi ini untuk meningkatkan keandalan dan diagnostik driver. GpioClx memanggil fungsi ini untuk memverifikasi bahwa set gangguan yang diaktifkan pada pengontrol GPIO cocok dengan apa yang diharapkan GpioClx. Biasanya, ketidakcocokan menunjukkan bug driver yang berpotensi menyebabkan badai gangguan. GpioClx menggunakan fungsi ini untuk melakukan validasi status yang lebih luas dalam build yang diperiksa (debug), dan mengurangi jumlah panggilan ke fungsi ini dalam build gratis (ritel) untuk menghindari dampak performa. Jika diimplementasikan, fungsi ini harus langsung membaca status perangkat keras alih-alih membaca versi status yang di-cache atau dikelola perangkat lunak.

GpioClx memanggil fungsi panggilan balik CLIENT_QueryEnabledInterrupts 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 memanggil fungsi CLIENT_QueryEnabledInterrupts di DIRQL, yang merupakan IRQL tempat ISR di GpioClx berjalan. Jika tidak, fungsi ini dipanggil pada PASSIVE_LEVEL. Untuk informasi selengkapnya tentang bit bendera ini, lihat Fungsi Panggilan Balik GPIO Opsional dan diperlukan.

Contoh

Untuk menentukan fungsi panggilan balik CLIENT_QueryEnabledInterrupts , Anda harus terlebih dahulu memberikan deklarasi fungsi yang mengidentifikasi jenis fungsi panggilan balik yang Anda tentukan. Windows menyediakan sekumpulan tipe fungsi panggilan balik untuk pengandar. 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_QueryEnabledInterrupts yang diberi nama MyEvtGpioQueryEnabledInterrupts, gunakan jenis fungsi GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS, seperti yang ditunjukkan dalam contoh kode ini:

GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS MyEvtGpioQueryEnabledInterrupts;

Kemudian, terapkan fungsi panggilan balik Anda sebagai berikut:

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioQueryEnabledInterrupts(
    PVOID Context,
    PGPIO_QUERY_ENABLED_INTERRUPTS_PARAMETERS QueryEnabledParameters
    )
{ ... }

Jenis fungsi GPIO_CLIENT_QUERY_ENABLED_INTERRUPTS ditentukan 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_QUERY_ENABLED_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.