EVT_SPB_CONTROLLER_LOCK fonction de rappel (spbcx.h)
Le contrôleur SPB EvtSpbControllerLock fonction de rappel d’événement verrouille le contrôleur SPB pour les accès à un seul appareil cible sur le bus.
Syntaxe
EVT_SPB_CONTROLLER_LOCK EvtSpbControllerLock;
void EvtSpbControllerLock(
[in] WDFDEVICE Controller,
[in] SPBTARGET Target,
[in] SPBREQUEST LockRequest
)
{...}
Paramètres
[in] Controller
Handle WDFDEVICE pour l’objet d’appareil framework qui représente le contrôleur SPB.
[in] Target
Un SPBTARGET de gérer la cible pour cette requête d’E/S. La cible est un périphérique ou un port attaché au bus. L’extension de framework SPB (SpbCx) a précédemment affecté ce handle à la cible dans le EvtSpbTargetConnect rappel qui a ouvert la connexion à la cible.
[in] LockRequest
Un SPBREQUEST de gérer une demande de contrôle d’E/S pour verrouiller le contrôleur. Votre pilote de contrôleur SPB doit effectuer cette requête en effectuant l’opération demandée ou en retournant un état d’erreur. Pour plus d’informations, consultez Remarques.
Valeur de retour
Aucun
Remarques
SpbCx gère la file d’attente d’E/S pour le contrôleur SPB. Si le pilote du contrôleur SPB inscrit une fonction de rappel EvtSpbControllerLock, SpbCx appelle cette fonction lorsqu’un client (pilote périphérique) du contrôleur envoie une requête IOCTL_SPB_LOCK_CONTROLLER à une cible sur le bus. La valeur du paramètre LockRequest 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, le pilote n’est pas nécessaire pour implémenter une fonction EvtSpbControllerLock, mais peut le faire. Toutefois, si votre pilote de contrôleur SPB implémente une fonction EvtSpbControllerLock, elle doit également implémenter une fonction EvtSpbControllerUnlock. Pour plus d’informations, consultez Remarques dans SPB_CONTROLLER_CONFIG.
Bien que le verrou soit en vigueur, le contrôleur ne doit pas autoriser les accès aux cibles sur le bus autre que la cible désignée par le paramètre LockRequest.
Si le pilote du contrôleur SPB doit modifier le mode de son contrôleur pour remplacer temporairement le mécanisme de sélection cible normal, il peut le faire pendant la EvtSpbControllerLock rappel. Si ce changement de mode implique un retard long ou nécessite que le pilote attende une interruption de périphérique, le pilote doit lancer le changement de mode, puis revenir du rappel sans délai. Plus tard, le pilote peut effectuer l’opération de verrouillage dans un DPC du minuteur ou une DPC d’interruption.
Si l’opération de verrouillage se termine dans une DPC, le pilote du contrôleur SPB doit avoir précédemment alloué toutes les ressources dont il a besoin pour l’opération de verrouillage.
Un rappel EvtSpbControllerLock doit éviter d’échouer une demande de verrouillage. Si vérificateur de pilotes est activé, un tel échec déclenche une interruption de vérificateur, qui signale au gestionnaire Plug-and-Play que le contrôleur a échoué. SpbCx ignore l’échec d’une demande de verrouillage et n’essaie pas de gérer ou d’atténuer l’échec.
La fonction EvtSpbControllerLock ne retourne pas de valeur. Au lieu de cela, le pilote du contrôleur SPB indique l’état de l’opération de verrouillage dans l’état d’achèvement de la demande d’E/S identifiée par le paramètre LockRequest. Définissez l’état d’achèvement sur STATUS_SUCCESS.
SpbCx appelle la fonction de rappel d’événement EvtSpbControllerUnlock pour déverrouiller un contrôleur précédemment verrouillé par un rappel EvtSpbControllerLock.
Pour inscrire une fonction de rappel EvtSpbControllerLock, appelez la méthode SpbDeviceInitialize.
Pour plus d’informations sur la fonction EvtSpbControllerLock, consultez Gestion des séquences Client-Implemented.
Exemples
Pour définir une fonction de rappel EvtSpbControllerLock, 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 fonctions de rappel permet d'Analyse du code pour les pilotes, static Driver Verifier (SDV) et d’autres outils de vérification recherchent des erreurs, et il est nécessaire d’écrire des pilotes pour le système d’exploitation Windows.
Par exemple, pour définir une fonction de rappel EvtSpbControllerLock nommée MyEvtSpbControllerLock, utilisez le type de fonction EVT_SPB_CONTROLLER_LOCK, comme illustré dans cet exemple de code :
EVT_SPB_CONTROLLER_LOCK MyEvtSpbControllerLock;
Ensuite, implémentez votre fonction de rappel comme suit :
_Use_decl_annotations_
VOID
MyEvtSpbControllerLock(
WDFDEVICE Controller,
SPBTARGET Target,
SPBREQUEST LockRequest
)
{ ... }
Le type de fonction EVT_SPB_CONTROLLER_LOCK est défini dans le fichier d’en-tête Spbcx.h. Pour identifier plus précisément les erreurs lorsque vous exécutez les 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_LOCK 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 annoter le comportement de la fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Prise en charge à partir de Windows 8. |
| plateforme cible | Bureau |
| d’en-tête | spbcx.h |
| IRQL | Appelé au <IRQL = DISPATCH_LEVEL. |