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。 可能的傳回值包括下列錯誤碼。
傳回碼 | 描述 |
---|---|
|
GPIO 控制器不支援輸入參數所指定的作業。 |
|
輸入緩衝區或輸出緩衝區的大小太小。 |
言論
作為選項,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 就會完成 IOCTL 並STATUS_NOT_IMPLEMENTED錯誤碼。
例子
若要定義 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呼叫。 |