EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE Rückruffunktion (sercx.h)

Artikel
10/30/2024

Die EvtSerCx2CustomReceiveTransactionInitialize Ereignisrückruffunktion wird von Version 2 der seriellen Framework-Erweiterung (SerCx2) aufgerufen, um die serielle Controllerhardware für die Durchführung einer neuen benutzerdefinierten Empfangstransaktion vorzubereiten.

Syntax

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE EvtSercx2CustomReceiveTransactionInitialize;

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

Parameter

[in] CustomReceiveTransaction

Ein SERCX2CUSTOMRECEIVETRANSACTION Handle für ein benutzerdefiniertes Empfangstransaktionsobjekt. Der serielle Controllertreiber hat zuvor den SerCx2CustomReceiveTransactionCreate Methode aufgerufen, um dieses Objekt zu erstellen.

[in] Mdl

Ein Zeiger auf eine MDL-, die die Speicherseiten beschreibt, die vom Lesepuffer für die benutzerdefinierte Empfangstransaktion überspannt sind. Die Punkt/Gather-Liste für die DMA-Übertragung verwendet den Bereich dieses Speichers, der durch die parameter Offset und Length angegeben wird.

[in] Offset

Der Startoffset für die Datenübertragung. Dieser Parameter ist ein Byte-Offset vom Anfang des Pufferbereichs, der von der MDL beschrieben wird. Wenn die MDL insgesamt N Bytes Pufferraum angibt, befinden sich mögliche Werte von Offset im Bereich 0 bis N-1.

[in] Length

Die Größe der Datenübertragung in Byte. Wenn die MDL insgesamt N Bytes Pufferraum angibt, befinden sich mögliche Werte Length im Bereich 1 bis N–Offset.

Rückgabewert

Nichts

Bemerkungen

Ihr serieller Controllertreiber kann diese Funktion als Option implementieren. Falls implementiert, registriert der Treiber die Funktion im SerCx2CustomReceiveTransactionCreate Aufruf, der das objekt für den benutzerdefinierten Empfang erstellt.

Ihr Treiber sollte eine EvtSerCx2CustomReceiveTransactionInitialize--Funktion implementieren, wenn der serielle Controller und die zugehörige Hardware in Vorbereitung auf eine neue benutzerdefinierte Empfangstransaktion initialisiert werden müssen. SerCx2 ruft diese Funktion auf, wenn sie implementiert ist, bevor Sie die transaktion für den benutzerdefinierten Empfang starten. Als Reaktion auf diesen Aufruf muss der serielle Controllertreiber die SerCx2CustomReceiveTransactionInitializeComplete--Methode aufrufen, um SerCx2 nach Abschluss der Initialisierung zu benachrichtigen.

Weitere Informationen finden Sie unter SerCx2 Custom-Receive Transactions.

Beispiele

Um eine EvtSerCx2CustomReceiveTransactionInitialize Rückruffunktion zu definieren, müssen Sie zuerst eine Funktionsdeklaration bereitstellen, die den Typ der rückruffunktion identifiziert, die Sie definieren. Windows stellt eine Reihe von Rückruffunktionstypen für Treiber bereit. Durch das Deklarieren einer Funktion mithilfe der Rückruffunktionstypen können Codeanalyse für Treiber, statische Treiberüberprüfung (SDV) und andere Überprüfungstools Fehler finden, und es ist eine Anforderung zum Schreiben von Treibern für das Windows-Betriebssystem.

Um beispielsweise eine EvtSerCx2CustomReceiveTransactionInitialize Rückruffunktion zu definieren, die MyCustomReceiveTransactionInitializeheißt, verwenden Sie den funktionstyp EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE, wie in diesem Codebeispiel gezeigt:

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE  MyCustomReceiveTransactionInitialize;

Implementieren Sie dann die Rückruffunktion wie folgt:

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

Der EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE Funktionstyp wird in der Headerdatei Sercx.h definiert. Um Fehler genauer zu identifizieren, wenn Sie die Codeanalysetools ausführen, müssen Sie der Funktionsdefinition die Use_decl_annotations Anmerkung hinzufügen. Die Use_decl_annotations Anmerkung stellt sicher, dass die Anmerkungen, die auf den Funktionstyp EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE in der Headerdatei angewendet werden, verwendet werden. Weitere Informationen zu den Anforderungen für Funktionsdeklarationen finden Sie unter Deklarieren von Funktionen mithilfe von Funktionsrollentypen für KMDF-Treiber. Weitere Informationen zu Use_decl_annotationsfinden Sie unter Annotating Function Behavior.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Verfügbar ab Windows 8.1.
Zielplattform-	Desktop
Header-	sercx.h
IRQL-	Wird bei IRQL <= DISPATCH_LEVEL aufgerufen.