EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START funzione di callback (sercx.h)

Articolo
02/27/2024

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

Sintassi

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START EvtSercx2CustomTransmitTransactionStart;

void EvtSercx2CustomTransmitTransactionStart(
  [in] SERCX2CUSTOMTRANSMITTRANSACTION CustomTransmitTransaction,
  [in] WDFREQUEST Request,
  [in] PMDL Mdl,
  [in] ULONG Offset,
  [in] ULONG Length
)
{...}

Parametri

[in] CustomTransmitTransaction

Handle SERCX2CUSTOMTRANSMITTRANSACTION a un oggetto di transazione di trasmissione personalizzato. Il driver del controller seriale in precedenza denominato il metodo SerCx2CustomTransactionCreate per creare questo oggetto.

[in] Request

Handle per l'oggetto richiesta framework associato alla transazione di trasmissione personalizzata. Il driver è responsabile del completamento di questa richiesta. Questa richiesta potrebbe non essere la richiesta di IRP_MJ_WRITE inviata dal client e quindi il driver del controller seriale non deve provare a usare questa richiesta per accedere al buffer di scrittura. Questa richiesta viene usata principalmente per l'annullamento, il completamento e l'inoltro della coda (se necessario). Per accedere al buffer di scrittura per la richiesta di scrittura 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 scrittura per la transazione di trasmissione personalizzata. L'elenco di dispersione/raccolta per il trasferimento DMA userà l'area di questa memoria specificata dai parametri Offset e Length . Per altre informazioni sulle catene MDL, vedere Uso di MDLs.

[in] Offset

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

[in] Length

Dimensioni, in byte, del trasferimento dei dati. Se MDL specifica un totale di N byte di spazio buffer, i valori possibili di Lunghezza si trovano nell'intervallo da 1 a N-Offset.

Valore restituito

nessuno

Osservazioni

Il driver del controller seriale deve implementare questa funzione se crea un oggetto di transazione di trasmissione personalizzato. Se implementato, il driver registra la funzione nella chiamata SerCx2CustomTransmitTransactionCreate che crea questo oggetto.

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

Al termine della transazione e il driver completa la richiesta di scrittura in sospeso, SerCx2 chiama la funzione di callback dell'evento EvtSerCx2CustomTransmitTransactionCleanup , se il driver implementa questa funzione.

Se il driver del controller seriale implementa una funzione di callback eventi EvtSerCx2CustomTransactionTransactionInitialize event callback, SerCx2 chiama questa funzione prima di chiamare la funzione EvtSerCx2CustomTransactionStart . Subito prima della chiamata EvtSerCx2CustomTransmitTransactionStart e dopo la chiamata EvtSerCx2CustomTransmitTransactionInitialize, SerCx2 avvia il timer che rileva se la richiesta di scrittura è in timeout. Per altre informazioni, vedere la discussione sui timeout totali in SERIAL_TIMEOUTS.

Il driver del controller seriale deve completare la richiesta di scrittura in sospeso solo dopo l'ultimo byte nella trasmissione FIFO è stato trasmesso al dispositivo periferica connessa serialmente. Non è possibile garantire che i dati scritti nella trasmissione FIFO vengano trasmessi senza un ritardo significativo e un driver del controller seriale che presuppone che tale garanzia esista può causare problemi di affidabilità per i driver periferici.

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

Per altre informazioni sui parametri Mdl, Offset e Length , vedere Osservazioni in EvtSerCx2CustomTransmitTransactionInitialize.

Se l'oggetto request 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. In primo luogo, il driver deve in genere riempire il contesto con zero e quindi, se necessario, impostare in modo esplicito tutti i campi nel contesto che richiedono valori iniziali non zero.

Per altre informazioni, vedere SerCx2 Custom-Transmit Transazioni.

Esempio

Per definire una funzione di callback EvtSerCx2CustomTransmitTransactionStart , è 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 EvtSerCx2CustomTransmitTransactionStart denominataMyCustomTransmitTransactionStart, usare il tipo di funzione EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START , come illustrato in questo esempio di codice:

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START  MyCustomTransmitTransactionStart;

Implementare quindi la funzione di callback come indicato di seguito:

_Use_decl_annotations_
VOID
  MyCustomTransmitTransactionStart(
    SERCX2CUSTOMTRANSMITTRANSACTION  CustomTransmitTransaction,
    WDFREQUEST  Request,
    PMDL  Mdl,
    ULONG  Offset,
    ULONG  Length
    )
  {...}

Il tipo di funzione EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START è 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_CUSTOM_TRANSMIT_TRANSACTION_START 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.