GPIO_CLIENT_MASK_INTERRUPTS回呼函式 (gpioclx.h)

發行項
02/29/2024

CLIENT_MaskInterrupts事件回呼函式遮罩會在一組設定為中斷輸入的一組一般用途 I/O (GPIO) 針腳上中斷。

語法

GPIO_CLIENT_MASK_INTERRUPTS GpioClientMaskInterrupts;

NTSTATUS GpioClientMaskInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
)
{...}

參數

[in] Context

GPIO 控制器驅動程式裝置內容的指標。

[in, out] MaskParameters

GPIO_MASK_INTERRUPT_PARAMETERS結構的指標，在專案上描述要遮罩的 GPIO 中斷針腳，而結束時則包含遮罩作業的狀態。

傳回值

如果呼叫成功， CLIENT_MaskInterrupts 函式會傳回STATUS_SUCCESS。否則，它會傳回適當的錯誤碼。

備註

GPIO 控制器驅動程式會實作此回呼函式。 GPIO 架構延伸模組 (GpioClx) 呼叫此函式，以遮罩設定為插斷要求輸入之 GPIO 針腳上的中斷。如需詳細資訊，請參閱 GPIO 插斷遮罩。

若要註冊驅動程式 的CLIENT_MaskInterrupts 回呼函式，請呼叫 GPIO_CLX_RegisterClient 方法。這個方法接受作為輸入參數的指標，指向包含CLIENT_MaskInterrupts函式指標的GPIO_CLIENT_REGISTRATION_PACKET結構。

CLIENT_MaskInterrupts函式是從 GpioClx 中的中斷服務例程 (ISR) 呼叫。此 ISR 會在 PASSIVE_LEVEL 或 DIRQL 上執行，視 CLIENT_QueryControllerBasicInformation 回呼函式提供給 GpioClx 的裝置資訊而定。 CLIENT_QueryControllerBasicInformation函式會以CLIENT_CONTROLLER_BASIC_INFORMATION結構的形式提供裝置資訊。如果在這個結構的 Flags 成員中設定 MemoryMappedController 旗標位，GpioClx ISR 會在 DIRQL 上執行，並在 DIRQL 呼叫 CLIENT_MaskInterrupts 函式。否則，ISR 會在PASSIVE_LEVEL執行，並在PASSIVE_LEVEL呼叫函式。如需此旗標位的詳細資訊，請參閱選擇性和必要的 GPIO 回呼函式。

無法將中斷遮罩設定為要求值的CLIENT_MaskInterrupts呼叫，必須將GPIO_MASK_INTERRUPT_PARAMETERS結構的 FailedMask 成員設定為非零值，並傳回適當的錯誤狀態代碼。記憶體對應 GPIO 控制器 的CLIENT_MaskInterrupts 函式預期一律會成功將插斷遮罩設定為要求的值。不過，非記憶體對應控制器 的CLIENT_MaskInterrupts 函式必須將 I/O 要求傳送至控制器以設定遮罩，而且此要求可能會失敗。如果要求無法設定遮罩，函式必須在寫入 FailedMask 成員的值中指出此失敗。

範例

若要定義 CLIENT_MaskInterrupts 回呼函式，您必須先提供函式宣告來識別您要定義的回呼函式類型。 Windows 提供一組驅動程式的回呼函式類型。使用回呼函式類型宣告函式有助於驅動程式的程式代碼分析、靜態驅動程式驗證器 (SDV) ，以及其他驗證工具尋找錯誤，而且這是撰寫 Windows 操作系統驅動程式的需求。

例如，若要定義名為 MyEvtGpioMaskInterrupts的CLIENT_MaskInterrupts回呼函式，請使用GPIO_CLIENT_MASK_INTERRUPTS函式類型，如下列程式代碼範例所示：

GPIO_CLIENT_MASK_INTERRUPTS MyEvtGpioMaskInterrupts;

然後，實作回呼函式，如下所示：

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioMaskInterrupts(
    PVOID Context,
    PGPIO_MASK_INTERRUPT_PARAMETERS MaskParameters
    )
{ ... }

GPIO_CLIENT_MASK_INTERRUPTS函式類型定義於 Gpioclx.h 頭檔中。若要在執行程式代碼分析工具時更精確地識別錯誤，請務必將 Use_decl_annotations 批註新增至函式定義。 Use_decl_annotations批註可確保使用頭檔中套用至GPIO_CLIENT_MASK_INTERRUPTS函式類型的註釋。如需函數宣告需求的詳細資訊，請參閱使用 KMDF 驅動程式的函式角色類型來宣告函式。如需 Use_decl_annotations的詳細資訊，請參閱標註函式行為。