CAPSENSE™ Touchpad I2C Host enumerated types

General Description

Enumerated types for the CAPSENSE™ Touchpad I2C Host middleware.

Enumerations
enum	MTB_TOUCHPAD_COMMAND_t {   MTB_TOUCHPAD_CMD_SOFTWARE_RESET = 0x0001 ,   MTB_TOUCHPAD_CMD_SAVE = 0x0002 ,   MTB_TOUCHPAD_CMD_RESTORE = 0x0004 ,   MTB_TOUCHPAD_CMD_CP_TEST = 0x0008 ,   MTB_TOUCHPAD_CMD_SHORT_TEST = 0x0010 ,   MTB_TOUCHPAD_CMD_BOOTLOADER_JUMP = 0x0020 }
	Enum representing command for touchpad operations. More...
enum	MTB_TOUCHPAD_RET_TYPE_t {   MTB_TOUCHPAD_RSLT_SUCCESS = 0 ,   MTB_TOUCHPAD_RSLT_INVALID_PARAM = 1 ,   MTB_TOUCHPAD_RET_ERROR = 2 }
	Enum which represents result codes for the middleware API. More...
enum	MTB_TOUCHPAD_TEST_STATUS_t {   MTB_TOUCHPAD_TEST_SUCCESS = 0x00 ,   MTB_TOUCHPAD_TEST_RESERVED = 0x01 ,   MTB_TOUCHPAD_HW_BUSY = 0x02 ,   MTB_TOUCHPAD_TEST_FAIL = 0x05 ,   MTB_TOUCHPAD_SHORT_DETECTED = 0x0F }
	Enum representing test status results for the touchpad. More...
enum	MTB_TOUCHPAD_SHIELD_EN_t {   MTB_TOUCHPAD_SHIELD_DISABLED = 0x00 ,   MTB_TOUCHPAD_SHIELD_ENABLED = 0x01 }
	Enum representing shield enable/disable state. More...
enum	MTB_TOUCHPAD_SCAN_MODE_t {   MTB_TOUCHPAD_SCAN_MODE_IDLE = 0x01 ,   MTB_TOUCHPAD_SCAN_MODE_ACTIVE = 0x02 ,   MTB_TOUCHPAD_SCAN_MODE_ALR = 0x04 ,   MTB_TOUCHPAD_SCAN_MODE_WAKE_ON_TOUCH = 0x08 ,   MTB_TOUCHPAD_SCAN_MODE_TIMEOUT_ENABLE = 0x80 }
	Enum representing scan modes of the touchpad. More...
enum	MTB_TOUCHPAD_CONFIG_STORED_t {   MTB_TOUCHPAD_REGISTER_CNFG_NOT_PRST = 0x00 ,   MTB_TOUCHPAD_REGISTER_CNFG_STORED = 0x01 }
	Enum representing the storage status of touchpad configuration in NVM. More...
enum	MTB_TOUCHPAD_INT_SOURCE_t {   MTB_TOUCHPAD_INT_SCAN_FRAME_RESULT_READY = 0x01 ,   MTB_TOUCHPAD_INT_TOUCH_DETECTED = 0x02 ,   MTB_TOUCHPAD_INT_TEST_RESULT_READY = 0x04 ,   MTB_TOUCHPAD_INT_SENSING_APP_RUNNING = 0x08 ,   MTB_TOUCHPAD_INT_GESTURE_DETECTED = 0x10 ,   MTB_TOUCHPAD_INT_LIFTOFF_TOUCHDOWN_DETECTED = 0x20 ,   MTB_TOUCHPAD_INT_USER_DATA_READY = 0x40 ,   MTB_TOUCHPAD_INT_APPLICATION_ERROR = 0x80 }
	Enum representing enabled interrupt sources. More...
enum	MTB_TOUCHPAD_INT_STATUS_t {   MTB_TOUCHPAD_INT_STATUS_NONE = 0x00 ,   MTB_TOUCHPAD_INT_STATUS_SCAN_COMPLETE = 0x01 ,   MTB_TOUCHPAD_INT_STATUS_TOUCH_DETECTED = 0x02 ,   MTB_TOUCHPAD_INT_STATUS_TEST_RESULT_READY = 0x04 ,   MTB_TOUCHPAD_INT_STATUS_SENSING_APP_RUNNING = 0x08 ,   MTB_TOUCHPAD_INT_STATUS_GESTURE_DETECTED = 0x10 ,   MTB_TOUCHPAD_INT_STATUS_LIFTOFF_TOUCHDOWN_DETECTED = 0x20 ,   MTB_TOUCHPAD_INT_STATUS_USER_DATA_READY = 0x40 ,   MTB_TOUCHPAD_INT_STATUS_APPLICATION_ERROR = 0x80 }
	Enum representing pending interrupt status. More...
enum	MTB_TOUCHPAD_ERROR_STATUS_t {   MTB_TOUCHPAD_ERROR_STATUS_NONE = 0x00 ,   MTB_TOUCHPAD_ERROR_STATUS_INVALID_PARAM = 0x01 ,   MTB_TOUCHPAD_ERROR_STATUS_I2C_TIMEOUT = 0x02 ,   MTB_TOUCHPAD_ERROR_STATUS_CAPSENSE_CALIB_FAIL = 0x04 }
	Enum representing error status. More...
enum	MTB_TOUCHPAD_RESET_CAUSE_t {   MTB_TOUCHPAD_RESET_CAUSE_VOLTAGE = 0x00 ,   MTB_TOUCHPAD_RESET_CAUSE_WDT = 0x01 ,   MTB_TOUCHPAD_RESET_CAUSE_PROTECTION_FAULT = 0x08 ,   MTB_TOUCHPAD_RESET_CAUSE_SOFTWARE = 0x10 }
	Enum representing the cause of the latest reset. More...
enum	MTB_TOUCHPAD_FILTER_t {   MTB_TOUCHPAD_FILTER_NONE = 0x0000 ,   MTB_TOUCHPAD_FILTER_MEDIAN = 0x0001 ,   MTB_TOUCHPAD_FILTER_AVERAGE = 0x0002 ,   MTB_TOUCHPAD_FILTER_IIR = 0x0004 ,   MTB_TOUCHPAD_FILTER_SW_IIR_COEFF_MASK = 0xFF00 }
	Enum representing CAPSENSE raw count filters. More...
enum	MTB_TOUCHPAD_GESTURE_STATUS_t {   MTB_TOUCHPAD_GESTURE_ONE_FINGER_SINGLE_CLICK = 0x00000001 ,   MTB_TOUCHPAD_GESTURE_ONE_FINGER_DOUBLE_CLICK = 0x00000002 ,   MTB_TOUCHPAD_GESTURE_ONE_FINGER_CLICK_DRAG = 0x00000004 ,   MTB_TOUCHPAD_GESTURE_TWO_FINGER_SINGLE_CLICK = 0x00000008 ,   MTB_TOUCHPAD_GESTURE_ONE_FINGER_SCROLL = 0x00000010 ,   MTB_TOUCHPAD_GESTURE_TWO_FINGER_SCROLL = 0x00000020 ,   MTB_TOUCHPAD_GESTURE_ONE_FINGER_EDGE_SWIPE = 0x00000040 ,   MTB_TOUCHPAD_GESTURE_ONE_FINGER_FLICK = 0x00000080 ,   MTB_TOUCHPAD_GESTURE_ONE_FINGER_ROTATE = 0x00000100 ,   MTB_TOUCHPAD_GESTURE_TWO_FINGER_ZOOM = 0x00000200 ,   MTB_TOUCHPAD_GESTURE_LONG_PRESS = 0x00000400 ,   MTB_TOUCHPAD_GESTURE_ONE_FINGER_TRIPLE_CLICK = 0x00000800 ,   MTB_TOUCHPAD_GESTURE_RESERVED_BIT12 = 0x00001000 ,   MTB_TOUCHPAD_GESTURE_TOUCHDOWN = 0x00002000 ,   MTB_TOUCHPAD_GESTURE_LIFTOFF = 0x00004000 ,   MTB_TOUCHPAD_GESTURE_FILTERING = 0x00008000 ,   MTB_TOUCHPAD_GESTURE_TWO_FINGER_DOUBLE_CLICK = 0x00010000 ,   MTB_TOUCHPAD_GESTURE_TWO_FINGER_LONG_PRESS = 0x00020000 ,   MTB_TOUCHPAD_GESTURE_TWO_FINGER_FLICK = 0x00040000 ,   MTB_TOUCHPAD_GESTURE_TWO_FINGER_EDGE_SWIPE = 0x00080000 }
	Enum representing gesture status bits. More...
enum	MTB_TOUCHPAD_GESTURE_DIR_t {   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_SCROLL_POS = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_SCROLL_MASK = 0x00000003 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_SCROLL_UP = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_SCROLL_DOWN = 0x00000001 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_SCROLL_RIGHT = 0x00000002 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_SCROLL_LEFT = 0x00000003 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_SCROLL_POS = 0x00000002 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_SCROLL_MASK = 0x0000000C ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_SCROLL_UP = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_SCROLL_DOWN = 0x00000004 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_SCROLL_RIGHT = 0x00000008 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_SCROLL_LEFT = 0x0000000C ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_EDGE_SWIPE_POS = 0x00000004 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_EDGE_SWIPE_MASK = 0x00000030 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_EDGE_SWIPE_UP = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_EDGE_SWIPE_DOWN = 0x00000010 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_EDGE_SWIPE_RIGHT = 0x00000020 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_EDGE_SWIPE_LEFT = 0x00000030 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_ROTATE_POS = 0x00000006 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_ROTATE_MASK = 0x00000040 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_ROTATE_CW = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_ROTATE_CCW = 0x00000040 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_ZOOM_POS = 0x00000007 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_ZOOM_MASK = 0x00000080 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_ZOOM_IN = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_ZOOM_OUT = 0x00000080 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_POS = 0x00000008 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_MASK = 0x00000700 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_UP = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_DOWN = 0x00000100 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_RIGHT = 0x00000200 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_LEFT = 0x00000300 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_UP_RIGHT = 0x00000400 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_DOWN_LEFT = 0x00000500 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_DOWN_RIGHT = 0x00000600 ,   MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_FLICK_UP_LEFT = 0x00000700 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_EDGE_SWIPE_POS = 0x0000000B ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_EDGE_SWIPE_MASK = 0x00001800 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_EDGE_SWIPE_UP = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_EDGE_SWIPE_DOWN = 0x00000800 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_EDGE_SWIPE_RIGHT = 0x00001000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_EDGE_SWIPE_LEFT = 0x00001800 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_POS = 0x0000000D ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_MASK = 0x0000E000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_UP = 0x00000000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_DOWN = 0x00002000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_RIGHT = 0x00004000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_LEFT = 0x00006000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_UP_RIGHT = 0x00008000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_DOWN_LEFT = 0x0000A000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_DOWN_RIGHT = 0x0000C000 ,   MTB_TOUCHPAD_GESTURE_DIR_TWO_FINGER_FLICK_UP_LEFT = 0x0000E000 }
	Enum representing gesture direction fields. More...
enum	MTB_TOUCHPAD_SHORT_TEST_IO_t {   MTB_TOUCHPAD_SHORT_TEST_IO_D1 = 0x00000001 ,   MTB_TOUCHPAD_SHORT_TEST_IO_C3 = 0x00000002 ,   MTB_TOUCHPAD_SHORT_TEST_IO_C2 = 0x00000004 ,   MTB_TOUCHPAD_SHORT_TEST_IO_C1 = 0x00000008 ,   MTB_TOUCHPAD_SHORT_TEST_IO_B1 = 0x00000010 ,   MTB_TOUCHPAD_SHORT_TEST_IO_B2 = 0x00000020 ,   MTB_TOUCHPAD_SHORT_TEST_IO_A4 = 0x00000040 ,   MTB_TOUCHPAD_SHORT_TEST_IO_B4 = 0x00000080 ,   MTB_TOUCHPAD_SHORT_TEST_IO_A5 = 0x00000100 ,   MTB_TOUCHPAD_SHORT_TEST_IO_B5 = 0x00000200 ,   MTB_TOUCHPAD_SHORT_TEST_IO_C5 = 0x00000400 ,   MTB_TOUCHPAD_SHORT_TEST_IO_C4 = 0x00000800 ,   MTB_TOUCHPAD_SHORT_TEST_IO_D5 = 0x00001000 ,   MTB_TOUCHPAD_SHORT_TEST_IO_E5 = 0x00002000 ,   MTB_TOUCHPAD_SHORT_TEST_IO_D4 = 0x00004000 ,   MTB_TOUCHPAD_SHORT_TEST_IO_E4 = 0x00008000 ,   MTB_TOUCHPAD_SHORT_TEST_IO_D3 = 0x00010000 ,   MTB_TOUCHPAD_SHORT_TEST_IO_E3 = 0x00020000 ,   MTB_TOUCHPAD_SHORT_TEST_IO_D2 = 0x00040000 ,   MTB_TOUCHPAD_SHORT_TEST_IO_E2 = 0x00080000 ,   MTB_TOUCHPAD_SHORT_TEST_IO_E1 = 0x00100000 }
	Enum representing IO IDs with a short circuit detected. More...

Enumeration Type Documentation

MTB_TOUCHPAD_COMMAND_t

enum MTB_TOUCHPAD_COMMAND_t

Enum representing command for touchpad operations.

This enum defines command used to trigger various operations in the touchpad firmware.

MTB_TOUCHPAD_RET_TYPE_t

enum MTB_TOUCHPAD_RET_TYPE_t

Enum which represents result codes for the middleware API.

This enum represents the result of the middleware API. Each value indicates either successful operation or a specific type of error condition.

MTB_TOUCHPAD_TEST_STATUS_t

enum MTB_TOUCHPAD_TEST_STATUS_t

Enum representing test status results for the touchpad.

This enum defines the possible outcomes of various touchpad test operations. Each value indicates whether the test passed, failed, or encountered a specific condition.

MTB_TOUCHPAD_SHIELD_EN_t

enum MTB_TOUCHPAD_SHIELD_EN_t

Enum representing shield enable/disable state.

This enum controls whether the touchpad shield functionality is enabled or disabled.

MTB_TOUCHPAD_SCAN_MODE_t

enum MTB_TOUCHPAD_SCAN_MODE_t

Enum representing scan modes of the touchpad.

This enum defines different operational scan modes supported by the touchpad.

MTB_TOUCHPAD_CONFIG_STORED_t

enum MTB_TOUCHPAD_CONFIG_STORED_t

Enum representing the storage status of touchpad configuration in NVM.

This enum indicates whether the touchpad configuration registers have been successfully stored in Non-Volatile Memory (NVM).

MTB_TOUCHPAD_INT_SOURCE_t

enum MTB_TOUCHPAD_INT_SOURCE_t

Enum representing enabled interrupt sources.

This enum defines the interrupt sources that can be enabled in the touchpad firmware.

MTB_TOUCHPAD_INT_STATUS_t

enum MTB_TOUCHPAD_INT_STATUS_t

Enum representing pending interrupt status.

This enum defines the current status of pending interrupts. Write '0' to the associated bit to clear the pending interrupt.

MTB_TOUCHPAD_ERROR_STATUS_t

enum MTB_TOUCHPAD_ERROR_STATUS_t

Enum representing error status.

This enum defines the current status of any errors that are not otherwise covered by other registers.

MTB_TOUCHPAD_RESET_CAUSE_t

enum MTB_TOUCHPAD_RESET_CAUSE_t

Enum representing the cause of the latest reset.

This enum defines the possible causes of the latest reset. Automatically updated after any reset.

MTB_TOUCHPAD_FILTER_t

enum MTB_TOUCHPAD_FILTER_t

Enum representing CAPSENSE raw count filters.

This enum defines the filters applied to the CAPSENSE raw counts. SW IIR filter is not applied if coefficient (bits 8-15) is 0.

MTB_TOUCHPAD_GESTURE_STATUS_t

enum MTB_TOUCHPAD_GESTURE_STATUS_t

Enum representing gesture status bits.

This enum defines the gesture status bits used to identify the type of gesture detected by the touchpad firmware.

MTB_TOUCHPAD_GESTURE_DIR_t

enum MTB_TOUCHPAD_GESTURE_DIR_t

Enum representing gesture direction fields.

Each field group provides a POS (bit position), MASK, and pre-shifted direction values. To check a direction, mask the raw value then compare directly to the corresponding direction constant.

Example (rotate): if ((dir & MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_ROTATE_MASK) == MTB_TOUCHPAD_GESTURE_DIR_ONE_FINGER_ROTATE_CCW) { ... }

MTB_TOUCHPAD_SHORT_TEST_IO_t

enum MTB_TOUCHPAD_SHORT_TEST_IO_t

Enum representing IO IDs with a short circuit detected.

This enum defines the IO IDs that indicate a short circuit when TEST_STATUS = 0x0F. Each bit corresponds to a specific IO pin.