EVT_SPB_TARGET_CONNECT fungsi panggilan balik (spbcx.h)

Artikel
02/26/2024

Fungsi panggilan balik peristiwa EvtSpbTargetConnect driver pengontrol SPB membuka koneksi ke perangkat target di bus.

Sintaks

EVT_SPB_TARGET_CONNECT EvtSpbTargetConnect;

NTSTATUS EvtSpbTargetConnect(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target
)
{...}

Parameter

[in] Controller

Handel WDFDEVICE ke objek perangkat kerangka kerja yang mewakili pengontrol SPB.

[in] Target

Handel SPBTARGET ke target untuk dibuka. Targetnya adalah perangkat periferal atau port yang terpasang pada bus.

Nilai kembali

EvtSpbTargetConnect mengembalikan STATUS_SUCCESS jika driver berhasil membuka koneksi ke target. Jika tidak, fungsi mengembalikan kode kesalahan NTSTATUS yang sesuai.

Keterangan

Implementasi fungsi ini oleh driver pengontrol SPB bersifat opsional.

Ekstensi kerangka kerja SPB (SpbCx) mengelola antrean I/O untuk pengontrol SPB. Jika driver pengontrol SPB mendaftarkan fungsi panggilan balik EvtSpbTargetConnect , SpbCx memanggil fungsi ini ketika klien (driver periferal) pengontrol mengirim permintaan IRP_MJ_CREATE untuk membuka koneksi ke perangkat target di bus. Jika fungsi EvtSpbTargetConnect mengembalikan kode kesalahan, SpbCx gagal dalam permintaan IRP_MJ_CREATE . Klien yang berhasil membuka koneksi ke target memiliki akses eksklusif ke target hingga koneksi ditutup.

Panggil metode SpbTargetGetConnectionParameters untuk mendapatkan parameter koneksi untuk perangkat target. Driver pengontrol SPB biasanya memanggil metode ini dari fungsi EvtSpbTargetConnect driver. SpbTargetGetConnectionParameters menulis parameter koneksi ke struktur SPB_CONNECTION_PARAMETERS yang disediakan pemanggil. Anggota ConnectionParameters dari struktur ini adalah penunjuk ke buffer yang berisi pengaturan koneksi untuk perangkat target. Driver menggunakan pengaturan ini untuk mengonfigurasi pengontrol SPB untuk berkomunikasi dengan perangkat. Untuk informasi selengkapnya, lihat Cara Mendapatkan Pengaturan Koneksi untuk Perangkat.

Fungsi panggilan balik EvtSpbTargetConnect dipanggil secara sinkron dari konteks utas klien yang meminta koneksi ke target.

SpbCx memanggil fungsi panggilan balik EvtSpbTargetDisconnect untuk menutup koneksi target yang sebelumnya dibuka oleh panggilan balik EvtSpbTargetConnect .

Untuk mendaftarkan fungsi panggilan balik EvtSpbTargetConnect , panggil metode SpbDeviceInitialize .

Contoh

Untuk menentukan fungsi panggilan balik EvtSpbTargetConnect , 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 EvtSpbTargetConnect yang diberi nama MyEvtSpbTargetConnect, gunakan jenis fungsi EVT_SPB_TARGET_CONNECT, seperti yang ditunjukkan dalam contoh kode ini:

EVT_SPB_TARGET_CONNECT  MyEvtSpbTargetConnect;

Kemudian, terapkan fungsi panggilan balik Anda sebagai berikut:

_Use_decl_annotations_
NTSTATUS
  MyEvtSpbTargetConnect(
    WDFDEVICE Controller,
    SPBTARGET Target
    )
{ ... }

Jenis fungsi EVT_SPB_TARGET_CONNECT ditentukan dalam file header Spbcx.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 EVT_SPB_TARGET_CONNECT 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.