GPIO_CLIENT_READ_PINS_MASK回呼函式 (gpioclx.h)

發行項
02/26/2024

CLIENT_ReadGpioPinsUsingMask事件回呼函式會讀取一組一般用途 I/O (GPIO) 針腳。

語法

GPIO_CLIENT_READ_PINS_MASK GpioClientReadPinsMask;

NTSTATUS GpioClientReadPinsMask(
  [in]      PVOID Context,
  [in, out] PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
)
{...}

參數

[in] Context

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

[in, out] ReadParameters

GPIO_READ_PINS_MASK_PARAMETERS 結構的指標，在專案上描述要讀取的 GPIO 針腳，而結束時則包含從 GPIO 針腳讀取的數據。

傳回值

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

備註

GPIO 控制器驅動程式會實作此回呼函式。 GpioClx 會呼叫此函式。

CLIENT_ReadGpioPinsUsingMask回呼函式會讀取針腳銀行中所有 GPIO 針腳的值。函式會將這些值儲存在 GPIO_READ_PINS_MASK_PARAMETERS 結構的 PinValues 成員中。位 0 (這個成員的最小有效位) 包含 pin 0 的值、位 1 包含針腳 1 的值等等。

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

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

範例

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

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

GPIO_CLIENT_READ_PINS_MASK MyEvtGpioReadPinsUsingMask;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioReadPinsUsingMask(
    PVOID Context,
    PGPIO_READ_PINS_MASK_PARAMETERS ReadParameters
    )
{ ... }

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