EVT_SPB_CONTROLLER_LOCK回呼函式 (spbcx.h)
SPB 控制器驅動程式的 EvtSpbControllerLock 事件回呼函式會鎖定 SPB 控制器,以存取總線上的單一目標裝置。
語法
EVT_SPB_CONTROLLER_LOCK EvtSpbControllerLock;
void EvtSpbControllerLock(
[in] WDFDEVICE Controller,
[in] SPBTARGET Target,
[in] SPBREQUEST LockRequest
)
{...}
參數
[in] Controller
代表SPB控制器之 架構裝置物件的 WDFDEVICE句柄。
[in] Target
此 I/O 要求的目標的 SPBTARGET 句柄。 目標是附加至總線的周邊裝置或埠。 SPB 架構延伸模組 (SpbCx) 先前在開啟目標連線的 EvtSpbTargetConnect 回呼中將此句柄指派給目標。
[in] LockRequest
I/O 控制項要求的 SPBREQUEST 句柄,可鎖定控制器。 SPB 控制器驅動程式必須藉由執行要求的作業或傳回錯誤狀態來完成此要求。 如需詳細資訊,請參閱。
傳回值
無
備註
SpbCx 會管理SPB控制器的 I/O 佇列。 如果SPB控制器驅動程式註冊 EvtSpbControllerLock 回呼函式,SpbCx 會在控制器的用戶端 (周邊驅動程式) 將 IOCTL_SPB_LOCK_CONTROLLER 要求傳送至總線上的目標時呼叫此函式。 LockRequest 參數值是封裝此要求的句柄。
EvtSpbControllerLock 和 EvtSpbControllerUnlock 函式會執行互補作業。 這兩個函式都是選擇性的。 如果您的SPB控制器驅動程序實作 EvtSpbControllerUnlock 函式,則不需要驅動程式來實作 EvtSpbControllerLock 函式,但可能這麼做。 不過,如果您的SPB控制器驅動程序實作 EvtSpbControllerLock 函式,它也必須實作 EvtSpbControllerUnlock 函式。 如需詳細資訊,請參閱 SPB_CONTROLLER_CONFIG 中的。
鎖定生效時,控制器不得允許在 LockRequest 參數所指定目標以外的總線上存取目標。
如果SPB控制器驅動程式需要變更其控制器的模式,以暫時覆寫一般目標選取機制,則可以在 EvtSpbControllerLock 回呼期間執行此動作。 如果此模式變更牽涉到長時間延遲,或需要驅動程式等候裝置中斷,驅動程式應該起始模式變更,然後從回呼傳回而不延遲。 稍後,驅動程式可以在定時器 DPC 或中斷 DPC 中完成鎖定作業。
如果鎖定作業在 DPC 中完成,SPB 控制器驅動程式先前應該已配置鎖定作業所需的所有資源。
EvtSpbControllerLock 回呼必須避免鎖定要求失敗。 如果已啟用驅動程式驗證器,這類失敗會觸發驗證器陷阱,這會向控制器失敗的 隨插即用 管理員回報。 SpbCx 會忽略鎖定要求的失敗,而且不會嘗試處理或減輕失敗。
EvtSpbControllerLock 函式不會傳回值。 相反地,SPB 控制器驅動程式會指出 LockRequest 參數所識別之 I/O 要求的完成狀態中鎖定作業的狀態。 將完成狀態設定為 STATUS_SUCCESS。
SpbCx 會呼叫 EvtSpbControllerUnlock 事件回呼函式,以解除鎖定先前由 EvtSpbControllerLock 回呼鎖定的控制器。
若要註冊 EvtSpbControllerLock 回呼函式,請呼叫 SpbDeviceInitialize 方法。
如需 EvtSpbControllerLock 函式的詳細資訊,請參閱 處理 Client-Implemented 序列。
範例
若要定義 EvtSpbControllerLock 回呼函式,您必須先提供函式宣告,以識別您要定義的回呼函式類型。 Windows 提供一組驅動程式的回呼函式類型。 使用回呼函式類型宣告函式有助於 驅動程式的程式代碼分析、 靜態驅動程式驗證器 (SDV) ,以及其他驗證工具會尋找錯誤,而且這是撰寫 Windows 操作系統驅動程式的需求。
例如,若要定義名為 MyEvtSpbControllerLock
的 EvtSpbControllerLock 回呼函式,請使用 EVT_SPB_CONTROLLER_LOCK 函式類型,如下列程式代碼範例所示:
EVT_SPB_CONTROLLER_LOCK MyEvtSpbControllerLock;
然後,實作您的回呼函式,如下所示:
_Use_decl_annotations_
VOID
MyEvtSpbControllerLock(
WDFDEVICE Controller,
SPBTARGET Target,
SPBREQUEST LockRequest
)
{ ... }
EVT_SPB_CONTROLLER_LOCK函式類型定義於Spbcx.h頭檔中。 若要在執行程式代碼分析工具時更精確地識別錯誤,請務必將 Use_decl_annotations 註釋新增至函式定義。 Use_decl_annotations註釋可確保使用頭檔中套用至EVT_SPB_CONTROLLER_LOCK函式類型的批註。 如需函數宣告需求的詳細資訊,請參閱 使用 KMDF 驅動程式的函式角色類型來宣告函式。 如需 Use_decl_annotations的詳細資訊,請參閱 標註函式行為。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 從 Windows 8 開始支援。 |
目標平台 | 桌面 |
標頭 | spbcx.h |
IRQL | 在 IRQL <= DISPATCH_LEVEL呼叫。 |