InputController

Description:

Provides interfaces for controlling the business process of input devices.

The interfaces can be called to control the power status, enable or disable a feature, get driver chip information, and control the production test.

Summary

Data Fields

Details

GetChipInfo

Description:

Gets the chip information of the specified device.

Parameters:

Name	Description
devIndex	Indicates the index of an input device. A maximum of 32 input devices are supported. The value ranges from 0 to 31, and value 0 represents the first input device.
chipInfo	Indicates the pointer to the chip information.
length	Indicates the length of the chip information.

Returns:

Returns 0 if the operation is successful; returns an error code defined in RetStatus otherwise.

GetChipName

Description:

Gets the driver chip name of the specified device.

Parameters:

Name	Description
devIndex	Indicates the index of an input device. A maximum of 32 input devices are supported. The value ranges from 0 to 31, and value 0 represents the first input device.
chipName	Indicates the pointer to the driver chip name.
length	Indicates the length of the driver chip name.

Returns:

Returns 0 if the operation is successful; returns an error code defined in RetStatus otherwise.

GetDeviceType

int32_t(* InputController::GetDeviceType) (uint32_t devIndex, uint32_t *deviceType)

Description:

Gets the type of the input device based on the specified device index.

Parameters:

Returns:

Returns 0 if the operation is successful; returns an error code defined in RetStatus otherwise.

Description:

Gets the power status.

The input service or the power management module can set the power status for the input device when the OS is in the Resume or Suspend status, so that the driver IC of the device can normally enter the specified status. You can call this function to obtain the power status.

Parameters:

Name	Description
devIndex	Indicates the index of an input device. A maximum of 32 input devices are supported. The value ranges from 0 to 31, and value 0 represents the first input device.
status	Indicates the pointer to the power status of the device. For details, see PowerStatus.

Returns:

Returns 0 if the operation is successful; returns an error code defined in otherwise.

GetVendorName

Description:

Gets the module vendor name of the specified device.

Parameters:

Name
devIndex	Indicates the index of an input device. A maximum of 32 input devices are supported. The value ranges from 0 to 31, and value 0 represents the first input device.
vendorName	Indicates the pointer to the module vendor name.
length	Indicates the length of the vendor name.

Returns:

Returns 0 if the operation is successful; returns an error code defined in otherwise.

RunCapacitanceTest

int32_t(* InputController::RunCapacitanceTest) (uint32_t devIndex, uint32_t testType, char *result, uint32_t length)

Description:

Conducts a capacitance self-test.

The capacitance self-test items are defined by the component vendor, such as the tests on the raw data, short circuit, open circuit, interference, and row/column difference.

Parameters:

Returns:

Returns 0 if the operation is successful; returns an error code defined in otherwise.

RunExtraCommand

Description:

Executes the extra command.

Parameters:

Name	Description
devIndex	Indicates the index of an input device. A maximum of 32 input devices are supported. The value ranges from 0 to 31, and value 0 represents the first input device.
cmd	Indicates the pointer to the extra command data packet, including the command codes and parameters. For details, see .

Returns:

Returns 0 if the operation is successful; returns an error code defined in RetStatus otherwise.

Description:

Sets the gesture mode.

The input service can use this function to enable or disable the gesture mode by setting EnableBit of the gesture mode.

Parameters:

Name	Description
devIndex	Indicates the index of an input device. A maximum of 32 input devices are supported. The value ranges from 0 to 31, and value 0 represents the first input device.
gestureMode	Indicates the gesture mode to set.

Returns:

Returns 0 if the operation is successful; returns an error code defined in RetStatus otherwise.

SetPowerStatus

int32_t(* InputController::SetPowerStatus) (uint32_t devIndex, uint32_t status)

Description:

Sets the power status.

This function is called only when the power status of the OS is changed. The input service or the power management module can call this function to set the power status for the input device when the OS is in the Resume or Suspend status, so that the driver integrated circuit (IC) of the device can normally enter the specified status.

Parameters:

Returns: