EVT_SPB_CONTROLLER_UNLOCK fonction de rappel (spbcx.h)

Article
08/07/2023

La fonction de rappel d’événement EvtSpbControllerUnlock d’un pilote de contrôleur SPB déverrouille le contrôleur SPB, qui a été verrouillé par un appel précédent à la fonction de rappel d’événement EvtSpbControllerLock .

Syntaxe

EVT_SPB_CONTROLLER_UNLOCK EvtSpbControllerUnlock;

void EvtSpbControllerUnlock(
  [in] WDFDEVICE Controller,
  [in] SPBTARGET Target,
  [in] SPBREQUEST UnlockRequest
)
{...}

Paramètres

[in] Controller

Un handle WDFDEVICE pour l’objet d’appareil d’infrastructure 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 qui est 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] UnlockRequest

Un handle SPBREQUEST à une demande de contrôle d’E/S pour déverrouiller le contrôleur. 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.

Valeur de retour

None

Remarques

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

Les fonctions EvtSpbControllerLock et EvtSpbControllerUnlock effectuent des opérations complémentaires. Les deux fonctions sont facultatives. Si votre pilote de contrôleur SPB implémente une fonction EvtSpbControllerUnlock , il n’est pas nécessaire d’implémenter une fonction EvtSpbControllerLock , mais il peut le faire. Toutefois, si votre pilote de contrôleur SPB implémente une fonction EvtSpbControllerLock , il doit également implémenter une fonction EvtSpbControllerUnlock . Pour plus d’informations, consultez Remarques dans SPB_CONTROLLER_CONFIG.

Si le pilote du contrôleur SPB doit modifier le mode de son contrôleur pour restaurer la sélection normale de la cible, il peut le faire pendant le rappel EvtSpbControllerUnlock . Si ce changement de mode implique un long délai ou nécessite que le pilote attende une interruption de l’appareil, le pilote doit lancer le changement de mode, puis revenir à partir du rappel sans délai. Plus tard, le pilote peut effectuer la demande de déverrouillage dans un DPC d’interruption ou un DPC du minuteur.

Un rappel EvtSpbControllerUnlock doit éviter d’échouer une demande de déverrouillage. Si driver verifier est activé, un tel échec déclenche une interruption du vérificateur, qui signale au gestionnaire de Plug-and-Play que le contrôleur a échoué. SpbCx ignore l’échec d’une demande de déverrouillage et n’essaie pas de gérer ou d’atténuer l’échec.

La fonction EvtSpbControllerUnlock ne retourne pas de valeur. Au lieu de cela, le pilote du contrôleur SPB indique la status de l’opération de déverrouillage dans la status d’achèvement de la demande d’E/S identifiée par le paramètre UnlockRequest. Définissez la status d’achèvement sur STATUS_SUCCESS.

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

Pour plus d’informations sur la fonction EvtSpbControllerUnlock , consultez Gestion des séquences Client-Implemented.

Exemples

Pour définir une fonction de rappel EvtSpbControllerUnlock , 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 permet à l’analyse du code pour les pilotes, au vérificateur de pilotes statiques (SDV) et à d’autres outils de vérification de trouver des 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 EvtSpbControllerUnlock nommée MyEvtSpbControllerUnlock, utilisez le type de fonction EVT_SPB_CONTROLLER_UNLOCK, comme indiqué dans cet exemple de code :

EVT_SPB_CONTROLLER_UNLOCK  MyEvtSpbControllerUnlock;

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

_Use_decl_annotations_
VOID
  MyEvtSpbControllerUnlock(
    WDFDEVICE Controller,
    SPBTARGET Target,
    SPBREQUEST UnlockRequest
    )
{ ... }

Le type de fonction EVT_SPB_CONTROLLER_UNLOCK 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_UNLOCK 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