EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START funzione di callback (sercx.h)

Articolo
08/07/2023

La funzione di callback dell'evento EvtSerCx2CustomReceiveTransactionStart viene chiamata dalla versione 2 dell'estensione del framework seriale (SerCx2) per avviare una transazione di ricezione personalizzata.

Sintassi

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START EvtSercx2CustomReceiveTransactionStart;

void EvtSercx2CustomReceiveTransactionStart(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction,
  [in] WDFREQUEST Request,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

Parametri

[in] CustomReceiveTransaction

Handle SERCX2CUSTOMRECEIVETRANSACTION a un oggetto custom-receive-transaction. Il driver del controller seriale precedentemente denominato il metodo SerCx2CustomReceiveTransactionCreate per creare questo oggetto.

[in] Request

Handle per l'oggetto richiesta framework associato alla transazione di ricezione personalizzata. Il driver è responsabile del completamento della richiesta. Questa richiesta potrebbe non essere la richiesta IRP_MJ_READ inviata dal client e pertanto il driver del controller seriale non deve tentare di usare questa richiesta per accedere al buffer di lettura. Questa richiesta viene usata principalmente per l'annullamento, il completamento e l'inoltro della coda (se necessario). Per accedere al buffer di lettura per la richiesta di lettura del client, usare i parametri Mdl, Offset e Length .

[in] Mdl

Puntatore a un MDL che descrive le pagine di memoria estese dal buffer di lettura per la transazione di ricezione personalizzata. L'elenco di dispersione/raccolta per il trasferimento dei dati userà l'area di questa memoria specificata dai parametri Offset e Length .

[in] Offset

Offset iniziale per il trasferimento dei dati. Questo parametro è un offset di byte dall'inizio dell'area del buffer descritta dal linguaggio MDL. Se MDL specifica un totale di N byte di spazio buffer, i valori possibili di Offset sono compresi nell'intervallo da 0 a N-1.

[in] Length

Dimensione, in byte, del trasferimento dei dati. Se MDL specifica un totale di N byte di spazio buffer, i valori possibili di Length sono compresi nell'intervallo da 1 a N-Offset.

Valore restituito

nessuno

Osservazioni

Il driver del controller seriale deve implementare questa funzione se crea un oggetto custom-receive-transaction. Il driver registra la funzione nella chiamata SerCx2CustomReceiveTransactionCreate che crea questo oggetto.

Dopo che SerCx2 chiama la funzione EvtSerCx2CustomReceiveTransactionStart , il driver del controller seriale avvia la transazione programmando il meccanismo di trasferimento dei dati personalizzato per spostare i dati dalla ricezione FIFO nell'hardware del controller seriale al buffer nella richiesta di lettura. A meno che la richiesta non possa essere completata immediatamente, prima che la funzione EvtSerCx2CustomReceiveTransactionStart restituisca un risultato, il driver deve chiamare un metodo come WdfRequestMarkCancelableEx per contrassegnare la richiesta come annullabile.

Dopo che la funzione EvtSerCx2CustomReceiveTransactionStart avvia la transazione, SerCx2 chiama periodicamente la funzione di callback dell'evento EvtSerCx2CustomReceiveTransactionQueryProgress per monitorare lo stato di avanzamento eseguito dal driver del controller seriale per eseguire questa transazione. Al termine della transazione e il driver completa la richiesta di lettura in sospeso, SerCx2 chiama la funzione di callback dell'evento EvtSerCx2CustomReceiveTransactionCleanup , se il driver implementa questa funzione.

Se il driver del controller seriale implementa una funzione di callback degli eventi EvtSerCx2CustomReceiveTransactionInitialize , SerCx2 chiama questa funzione prima di chiamare la funzione EvtSerCx2CustomReceiveTransactionStart . Subito prima della chiamata evtSerCx2CustomReceiveTransactionStart e dopo la chiamata EvtSerCx2CustomReceiveTransactionInitialize , SerCx2 avvia il timer che rileva se si verifica il timeout della richiesta di lettura. Per altre informazioni, vedere la discussione sui timeout totali in SERIAL_TIMEOUTS.

Se il meccanismo di trasferimento dati personalizzato è un dispositivo DMA master del bus, la funzione EvtSerCx2CustomReceiveTransactionStart può chiamare un metodo come WdfDmaTransactionInitializeUsingOffset per avviare una transazione DMA che usa il buffer di lettura descritto dai parametri Mdl, Offset e Length .

Se l'oggetto richiesta identificato dal parametro Request contiene l'archiviazione per un contesto privato, questa risorsa di archiviazione potrebbe non essere inizializzata la prima volta che il driver del controller seriale accede al contesto. Al primo accesso, il driver in genere deve riempire il contesto con zeri e quindi, se necessario, impostare in modo esplicito tutti i campi nel contesto che richiedono valori iniziali diversi da zero.

Per altre informazioni, vedere SerCx2 Custom-Receive Transactions.

Esempio

Per definire una funzione di callback EvtSerCx2CustomReceiveTransactionStart , è 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 tramite i tipi di funzione di callback consente di analizzare il codice per i driver, l'SDV ( Static Driver Verifier ) e altri strumenti di verifica di trovare errori ed è un requisito per la scrittura di driver per il sistema operativo Windows.

Ad esempio, per definire una funzione di callback EvtSerCx2CustomReceiveTransactionStart denominataMyCustomReceiveTransactionStart, usare il tipo di funzione EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START , come illustrato nell'esempio di codice seguente:

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START  MyCustomReceiveTransactionStart;

Implementare quindi la funzione di callback come indicato di seguito:

_Use_decl_annotations_
VOID
  MyCustomReceiveTransactionStart(
    SERCX2CUSTOMRECEIVETRANSACTION  CustomReceiveTransaction,
    WDFREQUEST  Request,
    PMDL  Mdl,
    ULONG  Offset,
    ULONG  Length
    )
  {...}

Il tipo di funzione EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START è 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 garantisce che vengano utilizzate le annotazioni applicate al tipo di funzione EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START nel file di intestazione. Per altre informazioni sui requisiti per le dichiarazioni di funzione, vedere Dichiarazione di funzioni tramite tipi di ruolo di funzione per i driver KMDF. Per altre informazioni sulle 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.