EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO funzione di callback (sercx.h)

Articolo
08/07/2023

La funzione di callback dell'evento EvtSerCx2PioTransmitCancelDrainFifo 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_PIO_TRANSMIT_CANCEL_DRAIN_FIFO EvtSercx2PioTransmitCancelDrainFifo;

BOOLEAN EvtSercx2PioTransmitCancelDrainFifo(
  [in] SERCX2PIOTRANSMIT PioTransmit
)
{...}

Parametri

[in] PioTransmit

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

Valore restituito

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

Commenti

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

Il driver deve implementare una funzione EvtSerCx2PioTransmitCancelDrainFifo 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 EvtSerCx2PioTransmitDrainFifo e EvtSerCx2PioTransmitPurgeFifo .

SerCx2 chiama la funzione di callback dell'evento EvtSerCx2PioTransmitDrainFifo per chiedere al driver del controller seriale di svuotare il fiFO di trasmissione e quindi attende che il driver del controller seriale chiami SerCx2PioTransmitDrainFifoComplete. Un'operazione di scarico può richiedere un periodo di tempo illimitato per terminare. Pertanto, se la richiesta di scrittura scade o viene annullata mentre l'operazione di scarico è in corso, SerCx2 chiama la funzione EvtSerCx2PioTransmitCancelDrainFifo per annullare l'operazione di scarico in sospeso prima del completamento.

Per altre informazioni, vedere SerCx2 PIO-Transmit Transazioni.

Esempio

Per definire una funzione di callback EvtSerCx2PioTransmitCancelDrainFifo , è prima necessario specificare una dichiarazione di funzione che identifica il tipo di funzione 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 EvtSerCx2PioTransmitCancelDrainFifo denominata MyPioTransmitCancelDrainFifo, usare il tipo di funzione EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO , come illustrato in questo esempio di codice:

EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO  MyPioTransmitCancelDrainFifo;

Implementare quindi la funzione di callback come indicato di seguito:

_Use_decl_annotations_
BOOLEAN
  MyPioTransmitCancelDrainFifo(
    SERCX2PIOTRANSMIT  PioTransmit
    )
  {...}

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