EVT_SPB_CONTROLLER_WRITE Rückruffunktion (spbcx.h)

Artikel
08/07/2023

Die EvtSpbControllerIoWrite-Ereignisrückruffunktion eines SPB-Controllertreibers schreibt Daten aus den Puffern, die mit der Schreibanforderung bereitgestellt werden, auf das angegebene Zielgerät.

Syntax

EVT_SPB_CONTROLLER_WRITE EvtSpbControllerWrite;

void EvtSpbControllerWrite(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST Request,
  [in] size_t Length
)
{...}

Parameter

[in] Controller

Ein WDFDEVICE-Handle für das Framework-Geräteobjekt , das den SPB-Controller darstellt.

[in] Target

Ein SPBTARGET-Handle für das Ziel für diese E/A-Anforderung. Das Ziel ist ein Peripheriegerät oder ein Port, das an den Bus angeschlossen ist. Die SPB-Frameworkerweiterung (SpbCx) hat dieses Handle zuvor dem Ziel im EvtSpbTargetConnect-Rückruf zugewiesen, der die Verbindung mit dem Ziel geöffnet hat.

[in] Request

Ein SPBREQUEST-Handle für die E/A-Anforderung. Ihr SPB-Controllertreiber muss diese Anforderung entweder durch Ausführen des angeforderten Vorgangs oder durch Zurückgeben eines Fehlers status abschließen. Weitere Informationen finden Sie unter Hinweise.

[in] Length

Die Anzahl der Bytes, die auf das Zielgerät geschrieben werden sollen.

Rückgabewert

Keine

Bemerkungen

SpbCx verwaltet die E/A-Warteschlange für den SPB-Controller. SpbCx ruft die EvtSpbControllerIoWrite-Rückruffunktion des SPB-Controllertreibers auf, wenn ein Client (Peripherietreiber) des SPB-Controllers eine IRP_MJ_WRITE-Anforderung an ein Zielgerät sendet, das an den Bus angeschlossen ist. Der Wert des Request-Parameters ist ein Handle, das diese Anforderung kapselt.

Ein EvtSpbControllerIoWrite-Rückruf gibt keinen status Wert zurück. Stattdessen gibt der SPB-Controllertreiber die status des Schreibvorgangs im abschluss-status für die E/A-Anforderung an.

Ein EvtSpbControllerIoWrite-Rückruf ist asynchron. Das heißt, die Rückruffunktion sollte den angeforderten Schreibvorgang initiieren und dann zurückgeben, ohne auf den Abschluss des Vorgangs zu warten. Später schließt der SPB-Controllertreiber die Schreibanforderung während eines Interrupt-DPC oder einer Timer-DPC ab.

Ein EvtSpbControllerIoWrite-Rückruf gibt keinen status Wert zurück. Stattdessen gibt der SPB-Controllertreiber die status des Schreibvorgangs im abschluss-status für die E/A-Anforderung an.

Wenn der Schreibvorgang vollständig abgeschlossen ist, sollte die Rückruffunktion den Abschluss status auf STATUS_SUCCESS festlegen. Wenn das Zielgerät angibt, dass es vor Abschluss einer Übertragung keine weiteren Daten akzeptieren kann, sollte der Treiber den Abschluss status auf STATUS_SUCCESS festlegen und die Anzahl der übertragenen Bytes angeben.

Wenn während des Schreibvorgangs ein Übertragungsfehler auftritt, sollte der Treiber den Abschluss status in der E/A-Anforderung auf einen entsprechenden Fehlercode festlegen. Nicht alle Busse bieten einen Mechanismus für ein Zielgerät, um einen Transportfehler oder eine teilweise abgeschlossene Übertragung zu melden, und nicht alle Controller können diese Bedingungen erkennen.

Um eine EvtSpbControllerIoWrite-Rückruffunktion zu registrieren, rufen Sie die SpbDeviceInitialize-Methode auf .

Beispiele

Um eine EvtSpbControllerIoWrite-Rückruffunktion zu definieren, müssen Sie zunächst eine Funktionsdeklaration bereitstellen, die den Typ der Rückruffunktion identifiziert, die Sie definieren. Windows bietet eine Reihe von Rückruffunktionstypen für Treiber. Das Deklarieren einer Funktion mithilfe der Rückruffunktionstypen hilft der Codeanalyse für Treiber, der statischen Treiberüberprüfung (Static Driver Verifier , SDV) und anderen Überprüfungstools, Fehler zu finden, und es ist eine Voraussetzung für das Schreiben von Treibern für das Windows-Betriebssystem.

Um beispielsweise eine EvtSpbControllerIoWrite-Rückruffunktion mit dem Namen MyEvtSpbControllerIoWritezu definieren, verwenden Sie den Funktionstyp EVT_SPB_CONTROLLER_WRITE, wie in diesem Codebeispiel gezeigt:

EVT_SPB_CONTROLLER_WRITE  MyEvtSpbControllerIoWrite;

Implementieren Sie dann Ihre Rückruffunktion wie folgt:

_Use_decl_annotations_
VOID
  MyEvtSpbControllerIoWrite(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST Request,
    size_t Length
    )
{ ... }

Der EVT_SPB_CONTROLLER_WRITE Funktionstyp ist in der Spbcx.h-Headerdatei definiert. Um Fehler beim Ausführen der Codeanalysetools genauer zu identifizieren, müssen Sie der Funktionsdefinition die anmerkung Use_decl_annotations hinzufügen. Die Use_decl_annotations Anmerkung stellt sicher, dass die Anmerkungen verwendet werden, die auf den EVT_SPB_CONTROLLER_WRITE Funktionstyp in der Headerdatei angewendet 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_annotations finden Sie unter Annotating Function Behavior.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Unterstützt ab Windows 8.
Zielplattform	Desktop
Kopfzeile	spbcx.h
IRQL	Wird unter IRQL <= DISPATCH_LEVEL aufgerufen.

Freigeben über