EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO funzione di callback (sercx.h)

Articolo
08/07/2023

La funzione di callback dell'evento EvtSerCx2SystemDmaTransmitPurgeFifo viene chiamata dalla versione 2 dell'estensione del framework seriale (SerCx2) per eliminare eventuali byte di dati non inviati che rimangono nella trasmissione FIFO nell'hardware del controller seriale.

Sintassi

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO EvtSercx2SystemDmaTransmitPurgeFifo;

void EvtSercx2SystemDmaTransmitPurgeFifo(
  [in] SERCX2SYSTEMDMATRANSMIT SystemDmaTransmit,
  [in] ULONG BytesAlreadyTransmittedToHardware
)
{...}

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.

[in] BytesAlreadyTransmittedToHardware

Numero di byte già caricati nella trasmissione FIFO durante la transazione corrente di trasmissione DMA-trasmissione.

Valore restituito

nessuno

Osservazioni

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 EvtSerCx2SystemDmaTransmitPurgeFifo se il controller seriale ha un meccanismo FIFO hardware (o 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 EvtSerCx2SystemDmaTransmitCancelDrainFifo .

Se una richiesta di scrittura in sospeso (IRP_MJ_WRITE) viene interrotta o annullata, SerCx2 potrebbe dover terminare la transazione DMA del sistema corrente prima del completamento. Al termine della transazione, SerCx2 chiama la funzione EvtSerCx2SystemDmaTransmitPurgeFifo , se implementata.

La funzione EvtSerCx2SystemDmaTransmitPurgeFifo arresta il trasferimento dei dati dal buffer di scrittura alla trasmissione FIFO ed elimina eventuali dati trasferiti in precedenza che rimangono nel FIFO. Al termine della transazione di trasmissione, il driver deve chiamare il metodo SerCx2SystemDmaTransmitPurgeFifoComplete per notificare a SerCx2 che il fiFO è stato eliminato e SerCx2 e quindi completa la richiesta di scrittura.

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

Esempio

Per definire una funzione di callback EvtSerCx2SystemDmaTransmitPurgeFifo , è 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 EvtSerCx2SystemDmaTransmitPurgeFifo denominata MySystemDmaTransmitPurgeFifo, usare il tipo di funzione EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO , come illustrato in questo esempio di codice:

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO  MySystemDmaTransmitPurgeFifo;

Implementare quindi la funzione di callback come indicato di seguito:

_Use_decl_annotations_
VOID
  MySystemDmaTransmitPurgeFifo(
    SERCX2SYSTEMDMATRANSMIT  SystemDmaTransmit,
    ULONG BytesAlreadyTransmittedToHardware
    )
  {...}

Il tipo di funzione EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_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_PURGE_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.