GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS回呼函式 (gpioclx.h)

發行項
03/05/2024

CLIENT_ClearActiveInterrupts事件回呼函式會清除一組一組一般用途 I/O (GPIO) 針腳的作用中中斷，這些接腳設定為插斷輸入。

語法

GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS GpioClientClearActiveInterrupts;

NTSTATUS GpioClientClearActiveInterrupts(
  [in]      PVOID Context,
  [in, out] PGPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS ClearParameters
)
{...}

參數

[in] Context

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

[in, out] ClearParameters

GPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS結構的指標，在專案上描述要清除的 GPIO 中斷接點，並在結束時包含清除作業的狀態。

傳回值

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

備註

此回呼函式是由一般用途 I/O (GPIO) 控制器驅動程式所實作。 GPIO 架構延伸模組 (GpioClx) 呼叫此函式，以清除設定為插斷要求輸入之 GPIO 針腳上的作用中中斷。

此回呼函式是選擇性的。如果 GPIO 控制器硬體在讀取時自動清除作用中中斷狀態位，驅動程式就不應該註冊 CLIENT_ClearActiveInterrupts回 呼函式。如需詳細資訊，請參閱選擇性和必要的 GPIO 回呼函式。

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

GpioClx 會根據CLIENT_QueryControllerBasicInformation 回呼函 式提供給 GpioClx 的裝置資訊，在 PASSIVE_LEVEL 或 DIRQL 呼叫 CLIENT_ClearActiveInterrupts 回呼函式。 CLIENT_QueryControllerBasicInformation函式會以CLIENT_CONTROLLER_BASIC_INFORMATION結構的形式提供裝置資訊。如果在此結構的 Flags 成員中設定 MemoryMappedController 旗標位，GpioClx 會在 DIRQL 呼叫CLIENT_ClearActiveInterrupts函式，這是 GpioClx 中 ISR 執行所在的 IRQL。否則，會在PASSIVE_LEVEL呼叫此函式。如需此旗標位的詳細資訊，請參閱中斷相關的回呼。

範例

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

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

GPIO_CLIENT_CLEAR_ACTIVE_INTERRUPTS MyEvtGpioClearActiveInterrupts;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioClearActiveInterrupts(
    PVOID Context,
    PGPIO_CLEAR_ACTIVE_INTERRUPTS_PARAMETERS ClearParameters
    )
{ ... }

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