EVT_SPB_CONTROLLER_WRITE fonction de rappel (spbcx.h)

Article
08/07/2023

La fonction de rappel d’événement EvtSpbControllerIoWrite d’un pilote de contrôleur SPB écrit des données sur l’appareil cible spécifié à partir des mémoires tampons fournies avec la demande d’écriture.

Syntaxe

EVT_SPB_CONTROLLER_WRITE EvtSpbControllerWrite;

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

Paramètres

[in] Controller

Un handle WDFDEVICE pour l’objet d’appareil framework qui représente le contrôleur SPB.

[in] Target

Un handle SPBTARGET à la cible pour cette demande d’E/S. La cible est un périphérique ou un port attaché au bus. L’extension d’infrastructure SPB (SpbCx) a précédemment affecté ce handle à la cible dans le rappel EvtSpbTargetConnect qui a ouvert la connexion à la cible.

[in] Request

Un handle SPBREQUEST pour la demande d’E/S. Votre pilote de contrôleur SPB doit effectuer cette demande en effectuant l’opération demandée ou en retournant une erreur status. Pour plus d’informations, consultez Remarques.

[in] Length

Nombre d’octets à écrire sur l’appareil cible.

Valeur de retour

None

Remarques

SpbCx gère la file d’attente d’E/S pour le contrôleur SPB. SpbCx appelle la fonction de rappel EvtSpbControllerIoWrite du pilote du contrôleur SPB lorsqu’un client (pilote périphérique) du contrôleur SPB envoie une requête IRP_MJ_WRITE à un appareil cible attaché au bus. La valeur du paramètre Request est un handle qui encapsule cette demande.

Un rappel EvtSpbControllerIoWrite ne retourne pas de valeur status. Au lieu de cela, le pilote du contrôleur SPB indique la status de l’opération d’écriture dans le status d’achèvement de la demande d’E/S.

Un rappel EvtSpbControllerIoWrite est asynchrone. Autrement dit, la fonction de rappel doit lancer l’opération d’écriture demandée, puis retourner sans attendre la fin de l’opération. Plus tard, le pilote du contrôleur SPB termine la demande d’écriture lors d’une interruption DPC ou d’un DPC du minuteur.

Si l’opération d’écriture se termine entièrement, la fonction de rappel doit définir la status d’achèvement sur STATUS_SUCCESS. Si l’appareil cible indique qu’il ne peut plus accepter de données avant la fin d’une transmission, le pilote doit définir le status d’achèvement sur STATUS_SUCCESS et spécifier le nombre d’octets transmis.

Si une erreur de transmission se produit pendant l’opération d’écriture, le pilote doit définir le status d’achèvement dans la demande d’E/S sur un code d’erreur approprié. Tous les bus ne fournissent pas un mécanisme permettant à un appareil cible de signaler une erreur de transport ou un transfert partiellement terminé, et tous les contrôleurs ne peuvent pas détecter ces conditions.

Pour inscrire une fonction de rappel EvtSpbControllerIoWrite , appelez la méthode SpbDeviceInitialize .

Exemples

Pour définir une fonction de rappel EvtSpbControllerIoWrite , vous devez d’abord fournir une déclaration de fonction qui identifie le type de fonction de rappel que vous définissez. Windows fournit un ensemble de types de fonctions de rappel pour les pilotes. La déclaration d’une fonction à l’aide des types de fonction de rappel aide l’analyse du code pour les pilotes, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification à la recherche d’erreurs. Il s’agit d’une exigence pour l’écriture de pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction de rappel EvtSpbControllerIoWrite nommée MyEvtSpbControllerIoWrite, utilisez le type de fonction EVT_SPB_CONTROLLER_WRITE, comme indiqué dans cet exemple de code :

EVT_SPB_CONTROLLER_WRITE  MyEvtSpbControllerIoWrite;

Ensuite, implémentez votre fonction de rappel comme suit :

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

Le type de fonction EVT_SPB_CONTROLLER_WRITE est défini dans le fichier d’en-tête Spbcx.h. Pour identifier plus précisément les erreurs lors de l’exécution des outils d’analyse du code, veillez à ajouter l’annotation Use_decl_annotations à votre définition de fonction. L’annotation Use_decl_annotations garantit que les annotations appliquées au type de fonction EVT_SPB_CONTROLLER_WRITE dans le fichier d’en-tête sont utilisées. Pour plus d’informations sur la configuration requise pour les déclarations de fonction, consultez Déclaration de fonctions à l’aide de types de rôles de fonction pour les pilotes KMDF. Pour plus d’informations sur Use_decl_annotations, consultez Annotating Function Behavior.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Pris en charge à partir de Windows 8.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	spbcx.h
IRQL	Appelé à IRQL <= DISPATCH_LEVEL.

Partager via