GPIO_CLIENT_WRITE_PINS_MASK回呼函式 (gpioclx.h)

發行項
02/26/2024

CLIENT_WriteGpioPinsUsingMask事件回呼函式會寫入一組一組一般用途 I/O (GPIO) 針腳，這些釘選設定為數據輸出。

語法

GPIO_CLIENT_WRITE_PINS_MASK GpioClientWritePinsMask;

NTSTATUS GpioClientWritePinsMask(
  [in] PVOID Context,
  [in] PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
)
{...}

參數

[in] Context

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

[in] WriteParameters

描述 GPIO 針腳銀行且包含要寫入這些針腳之數據之GPIO_WRITE_PINS_MASK_PARAMETERS 結構的指標。

傳回值

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

備註

此回呼函式是由 GPIO 控制器驅動程式實作。 GpioClx 會呼叫此函式，以寫入指定的 GPIO 針腳集。

要由此函式寫入的 GPIO 針腳是由兩個 64 位遮罩所指定。第一個遮罩會指定一組要設定為 1 的 GPIO 針腳;如果對應的 GPIO 針腳設定為 1，則此遮罩中的位為 1。第二個遮罩會指定一組要設定為 0 的 GPIO 針腳;如果對應的 GPIO 針腳設定為 0，則此遮罩中的位為 1。

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

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

範例

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

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

GPIO_CLIENT_WRITE_PINS_MASK  MyEvtGpioWritePinsUsingMask;

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

_Use_decl_annotations_
VOID
  MyEvtGpioWritePinsUsingMask(
    PVOID Context,
    PGPIO_WRITE_PINS_MASK_PARAMETERS WriteParameters
    )
{ ... }

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