EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO funzione di callback (sercx.h)

Articolo
10/30/2024

Il EvtSerCx2SystemDmaTransmitPurgeFifo funzione di callback degli eventi viene chiamata dalla versione 2 dell'estensione del framework seriale (SerCx2) per eliminare tutti i 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 di trasmissione DMA di sistema. Il driver del controller seriale precedentemente denominato SerCx2SystemDmaTransmitCreate metodo per creare questo oggetto.

[in] BytesAlreadyTransmittedToHardware

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

Valore restituito

Nessuno

Osservazioni

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

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

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

La funzione EvtSerCx2SystemDmaTransmitPurgeFifo interrompe il trasferimento dei dati dal buffer di scrittura alla trasmissione FIFO e rimuove tutti i dati precedentemente trasferiti che rimangono nel FIFO. Al termine della transazione di trasmissione, il driver deve chiamare il metodo SerCx2SystemDmaTransmitPurgeFifoComplete per notificare a SerCx2 che fifo è stato eliminato e SerCx2 completa quindi la richiesta di scrittura.

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

Esempi

Per definire un EvtSerCx2SystemDmaTransmitPurgeFifo funzione di callback, è 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 di callback consente di l'analisi del codice per i driver, del driver statico (SDV) e altri strumenti di verifica rilevano errori ed è un requisito per la scrittura di driver per il sistema operativo Windows.

Ad esempio, per definire un EvtSerCx2SystemDmaTransmitPurgeFifo funzione di callback 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 segue:

_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 quando si eseguono gli strumenti di analisi del codice, assicurarsi di aggiungere l'annotazione Use_decl_annotations alla definizione della funzione. L'annotazione Use_decl_annotations assicura che vengano utilizzate 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 i tipi di ruolo della funzione per i driver KMDF. Per altre informazioni su Use_decl_annotations, vedere l'annotazione del comportamento della funzione.

Fabbisogno

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.