EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO funzione di callback (sercx.h)

Articolo
10/30/2024

La EvtSerCx2PioTransmitPurgeFifo funzione di callback degli eventi viene chiamata dalla versione 2 dell'estensione del framework seriale (SerCx2) per rimuovere tutti i byte di dati non inviati che rimangono nella trasmissione FIFO nel controller seriale.

Sintassi

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO EvtSercx2PioTransmitPurgeFifo;

void EvtSercx2PioTransmitPurgeFifo(
  [in] SERCX2PIOTRANSMIT PioTransmit,
  [in] ULONG BytesAlreadyTransmittedToHardware
)
{...}

Parametri

[in] PioTransmit

Handle SERCX2PIOTRANSMIT a un oggetto di trasmissione PIO. Il driver del controller seriale precedentemente chiamato il metodo SerCx2PioTransmitCreate per creare questo oggetto.

[in] BytesAlreadyTransmittedToHardware

Numero di byte già caricati nella trasmissione FIFO durante la transazione di trasmissione PIO corrente. Questo parametro è la somma di tutti i byte trasferiti nelle chiamate precedenti alla EvtSerCx2PioTransmitWriteBuffer funzione di callback degli eventi che fanno parte di questa transazione.

Valore restituito

Nessuno

Osservazioni

Il driver del controller seriale può, come opzione, implementare questa funzione. Se implementato, il driver registra la funzione nel SerCx2PioTransmitCreate chiamata che crea l'oggetto di trasmissione PIO.

Il driver deve implementare una funzione EvtSerCx2PioTransmitPurgeFifo 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 il EvtSerCx2PioTransmitDrainFifo e EvtSerCx2PioTransmitCancelDrainFifo funzioni di callback degli eventi.

SerCx2 avvia una transazione di trasmissione PIO in risposta a una richiesta di scrittura (IRP_MJ_WRITE) da un client. Se questa richiesta scade o viene annullata prima del completamento, SerCx2 chiama la funzione EvtSerCx2PioTransmitPurgeFifo, se implementata, per eliminare eventuali dati non inviati che potrebbero rimanere il FIFO di trasmissione.

Dopo l'eliminazione della funzione FIFO di trasmissione, la funzione EvtSerCx2PioTransmitPurgeFifo deve chiamare il SerCx2PioTransmitPurgeFifoComplete metodo per notificare a SerCx2 che fifo è stato eliminato e SerCx2 completa quindi la richiesta di scrittura.

Per altre informazioni, vedere SerCx2 PIO-Transmit Transactions.

Esempi

Per definire un EvtSerCx2PioTransmitPurgeFifo 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 EvtSerCx2PioTransmitPurgeFifo funzione di callback denominata MyPioTransmitPurgeFifo, usare il tipo di funzione EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO, come illustrato in questo esempio di codice:

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO  MyPioTransmitPurgeFifo;

Implementare quindi la funzione di callback come segue:

_Use_decl_annotations_
VOID
  MyPioTransmitPurgeFifo(
    SERCX2PIOTRANSMIT  PioTransmit,
    ULONG  BytesAlreadyTransmittedToHardware

    )
  {...}

Il tipo di funzione EVT_SERCX2_PIO_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_PIO_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.