共用方式為

GPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION回呼函式 (gpioclx.h)

  • 發行項

CLIENT_ControllerSpecificFunction事件回呼函式會執行特定一般用途 I/O (GPIO) 控制器特定的作業。

語法

GPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION GpioClientControllerSpecificFunction;

NTSTATUS GpioClientControllerSpecificFunction(
  [in]      PVOID Context,
  [in, out] PGPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION_PARAMETERS Parameters
)
{...}

參數

[in] Context

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

[in, out] Parameters

包含控制器特定作業之輸入和輸出緩衝區 之GPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION_PARAMETERS 結構的指標。

傳回值

如果呼叫成功， CLIENT_ControllerSpecificFunction 函式會 傳回STATUS_SUCCESS 。 可能的傳回值包括下列錯誤碼。

傳回碼 Description
STATUS_NOT_SUPPORTED
 GPIO 控制器不支援輸入參數所指定的作業。
STATUS_BUFFER_TOO_SMALL
 輸入緩衝區或輸出緩衝區的大小太小。

備註

GPIO 控制器驅動程式可以選擇支援 IOCTL_GPIO_CONTROLLER_SPECIFIC_FUNCTION 要求。 這種類型的 I/O 控制要求 (IOCTL) 會執行控制器特定作業，以利需要這些作業的周邊設備驅動器。 為了支援此 IOCTL，GPIO 控制器驅動程式會實作 CLIENT_ControllerSpecificFunction 函式。

GPIO 架構擴充功能 (GpioClx) 支援 CLIENT_ControllerSpecificFunction 功能，以解決特定硬體平臺的特定需求。 一般 GPIO 控制器驅動程式不會實作此函式。 使用 IOCTL_GPIO_CONTROLLER_SPECIFIC_FUNCTION 要求在一個平臺上執行硬體特定作業的周邊設備驅動器，可能會遺失與不支援這項作業的其他平臺的相容性。

一般而言， CLIENT_ControllerSpecificFunction 函式會設定 GPIO 控制器，以在一組 GPIO 針腳上執行硬體特定作業。 此作業的輸入和輸出參數是由 GPIO 控制器驅動程式的開發人員所定義。 只有知道 GPIO 控制器驅動程式所實作之特定作業的周邊設備驅動器可以要求這些作業。

當 GpioClx 收到 IOCTL_GPIO_CONTROLLER_SPECIFIC_FUNCTION 要求時，它會檢查 GPIO 控制器驅動程式是否已實作 CLIENT_ControllerSpecificFunction 函式。 如果是，GpioClx 會將輸入和輸出緩衝區的描述從 IOCTL 複製到 GPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION_PARAMETERS 結構，並將指標當做參數傳遞至 CLIENT_ControllerSpecificFunction 函式。 如果 GPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION_PARAMETERS 結構中的參數值有效，函式會執行要求的作業，並傳回STATUS_SUCCESS。

如果 GpioClx 收到 IOCTL_GPIO_CONTROLLER_SPECIFIC_FUNCTION 要求，而且 GPIO 控制器驅動程式未實作 CLIENT_ControllerSpecificFunction 函式，GpioClx 會以錯誤碼STATUS_NOT_IMPLEMENTED完成 IOCTL。

範例

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

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

GPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION MyEvtGpioControllerSpecificFunction;

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

_Use_decl_annotations_
NTSTATUS
  MyEvtGpioControllerSpecificFunction(
    PVOID Context,
    PGPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION_PARAMETERS Parameters
    )
{ ... }

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

規格需求

需求 值
最低支援的用戶端 從 Windows 8 開始支援。
目標平台 桌面
標頭 gpioclx.h
IRQL 在 PASSIVE_LEVEL呼叫。

另請參閱

GPIO_CLIENT_CONTROLLER_SPECIFIC_FUNCTION_PARAMETERS

IOCTL_GPIO_CONTROLLER_SPECIFIC_FUNCTION