EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START funzione di callback (sercx.h)

Articolo
10/30/2024

La EvtSerCx2CustomTransmitTransactionStart funzione di callback degli eventi 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 transaction di trasmissione personalizzato. Il driver del controller seriale precedentemente denominato SerCx2CustomTransmitTransactionCreate metodo 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 IRP_MJ_WRITE inviata dal client e pertanto 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 parametriMdl , Offsete 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 a dispersione/raccolta per il trasferimento DMA userà l'area di questa memoria specificata dai parametri offset e Lunghezza. Per altre informazioni sulle catene MDL, vedere Using MDLs.

[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 compreso tra 0 e 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 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 transaction di trasmissione personalizzato. Se implementato, il driver registra la funzione nella SerCx2CustomTransmitTransactionCreate chiamata che crea questo oggetto.

Dopo che SerCx2 chiama la funzione EvtSerCx2CustomTransmitTransactionStart, il driver del controller seriale avvia la transazione programmando il meccanismo di trasferimento dei 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 venga restituita la funzione EvtSerCx2CustomTransmitTransactionStart, 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 il EvtSerCx2CustomTransmitTransactionCleanup funzione di callback degli eventi, se il driver implementa questa funzione.

Se il driver del controller seriale implementa un EvtSerCx2CustomTransmitTransactionInitialize funzione di callback degli eventi, SerCx2 chiama questa funzione prima di chiamare la funzione EvtSerCx2CustomTransmitTransactionStart. Subito prima della chiamata EvtSerCx2CustomTransmitTransactionStart e dopo la chiamata EvtSerCx2CustomTransmitTransactionInitialize chiamata, SerCx2 avvia il timer che rileva se si verifica il timeout della richiesta di scrittura. 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 che l'ultimo byte nella trasmissione FIFO è stato trasmesso al dispositivo periferico connesso serialmente. Non vi può essere alcuna garanzia che i dati scritti nella trasmissione FIFO verranno 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 personalizzato di trasferimento dei dati è 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 dalMdl , Offsete Length parametri.

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

Se l'oggetto richiesta identificato dal parametro richiesta 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-Transmit Transactions.

Esempi

Per definire un EvtSerCx2CustomTransmitTransactionStart 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 EvtSerCx2CustomTransmitTransactionStart funzione di callback denominata MyCustomTransmitTransactionStart, usare il tipo di funzione EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START, come illustrato nell'esempio di codice seguente:

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START  MyCustomTransmitTransactionStart;

Implementare quindi la funzione di callback come segue:

_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 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_CUSTOM_TRANSMIT_TRANSACTION_START 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.