EVT_SERCX2_PURGE_FIFOS funzione di callback (sercx.h)

  • Articolo

La funzione di callback dell'evento EvtSerCx2PurgeFifos viene chiamata dalla versione 2 dell'estensione del framework seriale (SerCx2) per eliminare i buffer FIFO nell'hardware del controller seriale.

Sintassi

EVT_SERCX2_PURGE_FIFOS EvtSercx2PurgeFifos;

void EvtSercx2PurgeFifos(
  [in] WDFDEVICE Device,
  [in] BOOLEAN PurgeRxFifo,
  [in] BOOLEAN PurgeTxFifo
)
{...}

Parametri

[in] Device

Handle WDFDEVICE per l'oggetto dispositivo framework che rappresenta il controller seriale. Il driver del controller seriale ha creato questo oggetto nella relativa funzione EvtDriverDeviceAdd callback. Per altre informazioni, vedere SerCx2InitializeDevice.

[in] PurgeRxFifo

Se eliminare il FIFO di ricezione. Se questo parametro è impostato su TRUE, eliminare il fiFO di ricezione. Se FALSE, non eliminare il FIFO di ricezione.

[in] PurgeTxFifo

Se eliminare la trasmissione FIFO. Se questo parametro è impostato su TRUE, eliminare il FIFO di trasmissione. Se FALSE, non eliminare il FIFO di trasmissione.

Valore restituito

nessuno

Osservazioni

Il driver del controller seriale deve implementare questa funzione. Il driver registra la funzione nella chiamata al metodo SerCx2InitializeDevice che completa l'inizializzazione dell'oggetto dispositivo framework per il controller seriale.

SerCx2 chiama la funzione EvtSerCx2PurgeFifos quando un client (driver periferico) invia una richiesta di controllo IOCTL_SERIAL_PURGE che richiede l'eliminazione di uno o entrambi i buffer FIFO nell'hardware del controller seriale. Se la richiesta di controllo IOCTL_SERIAL_PURGE richiede richieste di lettura o scrittura in sospeso (IRP_MJ_READ o IRP_MJ_WRITE) da annullare, SerCx2 annulla queste richieste prima di chiamare la funzione EvtSerCx2PurgeFifos .

SerCx2 chiama anche la funzione EvtSerCx2PurgeFifos quando un client apre una connessione logica al dispositivo del controller seriale e ottiene un handle di file per questa connessione. Per altre informazioni, vedere Oggetti file framework.

Esempio

Per definire una funzione di callback EvtSerCx2PurgeFifos , è prima necessario specificare 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 EvtSerCx2PurgeFifos denominata MyPurgeFifos, usare il tipo di funzione EVT_SERCX2_PURGE_FIFOS , come illustrato in questo esempio di codice:

EVT_SERCX2_PURGE_FIFOS  MyPurgeFifos;

Implementare quindi la funzione di callback come indicato di seguito:

_Use_decl_annotations_
VOID
  MyPurgeFifos(
    WDFDEVICE  Device,
    BOOLEAN PurgeRxFifo,
    BOOLEAN PurgeTxFifo
    )
  {...}

Il tipo di funzione EVT_SERCX2_PURGE_FIFOS è 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_PURGE_FIFOS 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 PASSIVE_LEVEL.

Vedi anche

IOCTL_SERIAL_PURGE

SerCx2InitializeDevice