EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO fungsi panggilan balik (sercx.h)

Artikel
08/07/2023

Fungsi panggilan balik peristiwa EvtSerCx2SystemDmaTransmitCancelDrainFifo dipanggil oleh versi 2 dari ekstensi kerangka kerja serial (SerCx2) untuk membatalkan permintaan sebelumnya untuk menguras transmisi FIFO di perangkat keras pengontrol serial.

Sintaks

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2SystemDmaTransmitCancelDrainFifo;

BOOLEAN EvtSercx2SystemDmaTransmitCancelDrainFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit
)
{...}

Parameter

[in] SystemDmaTransmit

Handel SERCX2SYSTEMDMATRANSMIT ke objek transmisi DMA sistem. Driver pengontrol serial sebelumnya disebut metode SerCx2SystemDmaTransmitCreate untuk membuat objek ini.

Nilai kembali

Fungsi EvtSerCx2SystemDmaTransmitCancelDrainFifo mengembalikan TRUE jika berhasil membatalkan permintaan pengurasan yang tertunda, dan driver pengontrol serial dapat menjamin bahwa ia tidak akan memanggil metode SerCx2SystemDmaTransmitDrainFifoComplete untuk memberi tahu SerCx2 bahwa FIFO dikosongkan. Jika tidak, fungsi ini mengembalikan FALSE untuk menunjukkan bahwa driver telah dipanggil atau akan memanggil SerCx2SystemDmaTransmitDrainFifoComplete.

Keterangan

Driver pengontrol serial Anda dapat, sebagai opsi, menerapkan fungsi ini. Jika diimplementasikan, driver mendaftarkan fungsi dalam panggilan SerCx2SystemDmaTransmitCreate yang membuat objek transmisi DMA sistem.

Driver Anda harus menerapkan fungsi EvtSerCx2SystemDmaTransmitCancelDrainFifo jika pengontrol serial memiliki FIFO perangkat keras (atau mekanisme buffering serupa) untuk menyimpan data pengiriman. Jika driver Anda menerapkan fungsi ini, driver juga harus mengimplementasikan fungsi panggilan balik peristiwa EvtSerCx2SystemDmaTransmitDrainFifo dan EvtSerCx2SystemDmaTransmitPurgeFifo .

Setelah SerCx2 memanggil fungsi panggilan balik peristiwa EvtSerCx2SystemDmaTransmitDrainFifo untuk meminta driver pengontrol serial menguras transmisi FIFO, SerCx2 mungkin memanggil fungsi EvtSerCx2SystemDmaTransmitCancelDrainFifo untuk membatalkan permintaan pengurasan yang tertunda sebelum FIFO selesai menguras. Misalnya, SerCx2 mungkin memanggil fungsi EvtSerCx2SystemDmaTransmitCancelDrainFifo jika klien membatalkan permintaan tulis tertunda (IRP_MJ_WRITE), atau jika waktu permintaan tulis habis.

Untuk informasi selengkapnya, lihat SerCx2 System-DMA-Transmit Transactions.

Contoh

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

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO  MySystemDmaTransmitCancelDrainFifo;

Kemudian, terapkan fungsi panggilan balik Anda sebagai berikut:

_Use_decl_annotations_
BOOLEAN
  MySystemDmaTransmitCancelDrainFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit
    )
  {...}

Jenis fungsi EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO didefinisikan dalam file header Sercx.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_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO 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.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia dimulai dengan Windows 8.1.
Target Platform	Desktop
Header	sercx.h
IRQL	Dipanggil di IRQL <= DISPATCH_LEVEL.