EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO funzione di callback (sercx.h)

Articolo
08/07/2023

La funzione di callback dell'evento EvtSerCx2SystemDmaTransmitCancelDrainFifo viene chiamata dalla versione 2 dell'estensione del framework seriale (SerCx2) per annullare una richiesta precedente per svuotare la trasmissione FIFO nell'hardware del controller seriale.

Sintassi

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2SystemDmaTransmitCancelDrainFifo;

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

Parametri

[in] SystemDmaTransmit

Handle SERCX2SYSTEMDMATRANSMIT a un oggetto system-DMA-transmit. Il driver del controller seriale in precedenza denominato il metodo SerCx2SystemDmaTransmitCreate per creare questo oggetto.

Valore restituito

La funzione EvtSerCx2SystemDmaTransmitCancelDrainFifo restituisce TRUE se annulla correttamente la richiesta di svuotamento in sospeso e il driver del controller seriale può garantire che non chiamerà il metodo SerCx2SystemDmaTransmitDrainFifoComplete per notificare a SerCx2 che fiFO è scaricato. In caso contrario, questa funzione restituisce FALSE per indicare che il driver ha già chiamato o sta per chiamare SerCx2SystemDmaTransmitDrainFifoComplete.

Commenti

Il driver del controller seriale può, come opzione, implementare questa funzione. Se implementato, il driver registra la funzione nella chiamata SerCx2SystemDmaTransmitCreate che crea l'oggetto system-DMA-transmit.

Il driver deve implementare una funzione EvtSerCx2SystemDmaTransmitCancelDrainFifo se il controller seriale ha un meccanismo FIFO hardware (o un meccanismo di buffering simile) per contenere i dati di trasmissione. Se il driver implementa questa funzione, deve anche implementare le funzioni di callback eventi EvtSerCx2SystemDmaTransmitDrainFifo e EvtSerCx2SystemDmaTransmitPurgeFifo .

Dopo che SerCx2 chiama la funzione di callback dell'evento EvtSerCx2SystemDmaTransmitDrainFifo per richiedere che il driver del controller seriale scarica la trasmissione FIFO, SerCx2 chiama la funzione EvtSerCx2SystemDmaTransmitCancelDrainFifo per annullare la richiesta di svuotamento in sospeso prima del completamento dello svuotamento fiFO. Ad esempio, SerCx2 potrebbe chiamare la funzione EvtSerCx2SystemDmaTransmitCancelDrainFifo se il client annulla la richiesta di scrittura in sospeso (IRP_MJ_WRITE) o se la richiesta di scrittura viene interrotta.

Per altre informazioni, vedere SerCx2 System-DMA-Transmit Transactions.

Esempio

Per definire una funzione di callback EvtSerCx2SystemDmaTransmitCancelDrainFifo , è prima necessario fornire una dichiarazione di funzione che identifica il tipo di funzione di callback che si sta definendo. Windows fornisce un set di tipi di funzione di callback per i driver. La dichiarazione di una funzione usando i tipi di funzione callback consente l'analisi del codice per i driver, il verifica driver statico (SDV) e altri strumenti di verifica trovano errori ed è un requisito per la scrittura di driver per il sistema operativo Windows.

Ad esempio, per definire una funzione di callback EvtSerCx2SystemDmaTransmitCancelDrainFifo denominata MySystemDmaTransmitCancelDrainFifo, usare il tipo di funzione EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO , come illustrato in questo esempio di codice:

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO  MySystemDmaTransmitCancelDrainFifo;

Implementare quindi la funzione di callback come indicato di seguito:

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

Il tipo di funzione EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO è definito nel file di intestazione Sercx.h. Per identificare in modo più accurato gli errori durante l'esecuzione degli strumenti di analisi del codice, assicurarsi di aggiungere l'annotazione Use_decl_annotations alla definizione della funzione. L'annotazione Use_decl_annotations garantisce che vengano usate le annotazioni applicate al tipo di funzione EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO nel file di intestazione. Per altre informazioni sui requisiti per le dichiarazioni di funzione, vedere Dichiarazione di funzioni tramite tipi di ruolo per i driver KMDF. Per altre informazioni su Use_decl_annotations, vedere Annotazione del comportamento della funzione.

Requisiti

Requisito	Valore
Client minimo supportato	Disponibile a partire da Windows 8.1.
Piattaforma di destinazione	Desktop
Intestazione	sercx.h
IRQL	Chiamato in IRQL <= DISPATCH_LEVEL.