struktur SERCX2_CONFIG (sercx.h)

Artikel
08/07/2023

Struktur SERCX2_CONFIG berisi informasi konfigurasi untuk versi 2 ekstensi kerangka kerja serial (SerCx2).

Sintaks

typedef struct _SERCX2_CONFIG {
  ULONG                                            Size;
  PFN_SERCX2_FILEOPEN                              EvtSerCx2FileOpen;
  PFN_SERCX2_FILECLOSE                             EvtSerCx2FileClose;
  PFN_SERCX2_SET_WAIT_MASK                         EvtSerCx2SetWaitMask;
  PFN_SERCX2_PURGE_FIFOS                           EvtSerCx2PurgeFifos;
  PFN_SERCX2_CONTROL                               EvtSerCx2Control;
  PFN_SERCX2_APPLY_CONFIG                          EvtSerCx2ApplyConfig;
  PFN_SERCX2_SELECT_NEXT_RECEIVE_TRANSACTION_TYPE  EvtSerCx2SelectNextReceiveTransactionType;
  PFN_SERCX2_SELECT_NEXT_TRANSMIT_TRANSACTION_TYPE EvtSerCx2SelectNextTransmitTransactionType;
  PWDF_OBJECT_ATTRIBUTES                           RequestAttributes;
} SERCX2_CONFIG, *PSERCX2_CONFIG;

Anggota

Size

Ukuran, dalam byte, dari struktur ini. Metode SerCx2InitializeDevice menggunakan anggota ini untuk menentukan versi struktur mana yang digunakan pemanggil. Ukuran struktur ini mungkin berubah dalam versi file header Sercx.h yang akan datang.

EvtSerCx2FileOpen

Penunjuk ke fungsi panggilan balik peristiwa EvtSerCx2FileOpen yang diimplementasikan driver. Anggota ini bersifat opsional dan dapat diatur ke NULL untuk menunjukkan bahwa driver tidak mengimplementasikan fungsi. Namun, driver yang mengimplementasikan fungsi ini juga harus mengimplementasikan fungsi EvtSerCx2FileClose .

EvtSerCx2FileClose

Penunjuk ke fungsi panggilan balik peristiwa EvtSerCx2FileClose yang diimplementasikan driver. Anggota ini bersifat opsional dan dapat diatur ke NULL untuk menunjukkan bahwa driver tidak mengimplementasikan fungsi.

EvtSerCx2SetWaitMask

Penunjuk ke fungsi panggilan balik peristiwa EvtSerCx2SetWaitmask yang diimplementasikan driver. Anggota ini harus menunjuk ke fungsi yang valid.

EvtSerCx2PurgeFifos

Penunjuk ke fungsi panggilan balik peristiwa EvtSerCx2PurgeFifos yang diimplementasikan driver. Anggota ini harus menunjuk ke fungsi yang valid.

EvtSerCx2Control

Penunjuk ke fungsi panggilan balik peristiwa EvtSerCx2Control yang diimplementasikan driver. Anggota ini harus menunjuk ke fungsi yang valid.

EvtSerCx2ApplyConfig

Penunjuk ke fungsi panggilan balik peristiwa EvtSerCx2ApplyConfig yang diimplementasikan driver. Anggota ini harus menunjuk ke fungsi yang valid.

EvtSerCx2SelectNextReceiveTransactionType

Penunjuk ke fungsi panggilan balik peristiwa EvtSerCx2SelectNextReceiveTransactionType yang diimplementasikan driver. Anggota ini bersifat opsional dan dapat diatur ke NULL untuk menunjukkan bahwa driver tidak mengimplementasikan fungsi.

EvtSerCx2SelectNextTransmitTransactionType

Penunjuk ke fungsi panggilan balik peristiwa EvtSerCx2SelectNextTransmitTransactionType yang diimplementasikan driver. Anggota ini bersifat opsional dan dapat diatur ke NULL untuk menunjukkan bahwa driver tidak mengimplementasikan fungsi.

RequestAttributes

Penunjuk ke struktur WDF_OBJECT_ATTRIBUTES yang menjelaskan atribut untuk ditetapkan ke objek permintaan kerangka kerja yang diteruskan SerCx2 ke driver pengontrol serial. Sebelum memanggil metode SerCx2InitializeDevice , pemanggil harus memanggil fungsi WDF_OBJECT_ATTRIBUTES_INIT untuk menginisialisasi struktur. Anggota ini bersifat opsional dan dapat ditentukan sebagai WDF_NO_OBJECT_ATTRIBUTES jika driver pengontrol serial tidak perlu menetapkan atribut ke objek. Untuk informasi selengkapnya, lihat Keterangan.

Keterangan

Metode SerCx2InitializeDevice menerima penunjuk ke struktur SERCX2_CONFIG sebagai parameter input. Sebelum memanggil SerCx2InitializeDevice, panggil fungsi SERCX2_CONFIG_INIT untuk menginisialisasi struktur ini.

Jika anggota RequestAttributes menunjuk ke struktur WDF_OBJECT_ATTRIBUTES , pemanggil tidak boleh menimpa nilai yang ditulis fungsi inisialisasi WDF_OBJECT_ATTRIBUTES_INIT ke anggota ParentObject, ExecutionLevel, dan SynchronizationScope dari struktur ini.

Driver mungkin perlu menyimpan informasi di area konteks dalam objek permintaan kerangka kerja yang diterima driver. Biasanya, driver memanggil metode WdfDeviceInitSetRequestAttributes untuk menentukan atribut yang diperlukan untuk objek permintaan. Atribut ini mencakup nama dan ukuran area konteks di setiap objek permintaan. Selain itu, dalam implementasi SerCx2 saat ini, driver pengontrol serial yang memerlukan konteks permintaan harus menentukan atribut yang sama ini dalam anggota RequestAttributes dari struktur SERCX2_CONFIG yang diteruskan driver ke SerCx2InitializeDevice. Artinya, driver harus menentukan atribut permintaan yang sama dua kali—dalam panggilan SerCx2InitializeDevice , dan dalam panggilan WdfDeviceInitSetRequestAttributes . Untuk informasi selengkapnya, lihat Transaksi Custom-Receive SerCx2 dan Transaksi Custom-Transmit SerCx2.

Driver yang tidak pernah memerlukan konteks permintaan tidak perlu memanggil WdfDeviceInitSetRequestAttributes, dan dapat mengatur anggota RequestAttributes dari struktur SERCX2_CONFIG ke WDF_NO_OBJECT_ATTRIBUTES.