sf_touch_ctsu_api_t Struct Reference

#include <sf_touch_ctsuv2_api.h>

Data Fields
ssp_err_t(*	open )(sf_touch_ctsu_ctrl_t *const p_ctrl, sf_touch_ctsu_cfg_t const *const p_cfg)
ssp_err_t(*	scanStart )(sf_touch_ctsu_ctrl_t *const p_ctrl)
ssp_err_t(*	dataGet )(sf_touch_ctsu_ctrl_t *const p_ctrl, uint64_t *p_button_status, uint16_t *p_slider_position, uint16_t *p_wheel_position)
ssp_err_t(*	callbackSet )(sf_touch_ctsu_ctrl_t *const p_api_ctrl, void(*p_callback)(sf_touch_ctsu_callback_args_t *), void const *const p_context, sf_touch_ctsu_callback_args_t *const p_callback_memory)
ssp_err_t(*	close )(sf_touch_ctsu_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_data)

Detailed Description

Functions implemented at the HAL layer will follow this API.

Field Documentation

callbackSet

ssp_err_t(* sf_touch_ctsu_api_t::callbackSet) (sf_touch_ctsu_ctrl_t *const p_api_ctrl, void(*p_callback)(sf_touch_ctsu_callback_args_t *), void const *const p_context, sf_touch_ctsu_callback_args_t *const p_callback_memory)

Specify callback function and optional context pointer and working memory pointer.

Implemented as

• SF_TOUCH_CTSU_CallbackSet()

Parameters

[in]	p_ctrl	Pointer to the CTSU control block.
[in]	p_callback	Callback function
[in]	p_context	Pointer to send to callback function
[in]	p_working_memory	Pointer to volatile memory where callback structure can be allocated. Callback arguments allocated here are only valid during the callback.

close

ssp_err_t(* sf_touch_ctsu_api_t::close) (sf_touch_ctsu_ctrl_t *const p_ctrl)

Close driver.

Implemented as

• SF_TOUCH_CTSU_Close()

Parameters

[in]

p_ctrl

Pointer to control structure.

dataGet

ssp_err_t(* sf_touch_ctsu_api_t::dataGet) (sf_touch_ctsu_ctrl_t *const p_ctrl, uint64_t *p_button_status, uint16_t *p_slider_position, uint16_t *p_wheel_position)

Data get.

Implemented as

• SF_TOUCH_CTSU_DataGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_button_status	Pointer to get data bitmap.
[out]	p_slider_position	Pointer to get data array.
[out]	p_wheel_position	Pointer to get data array.

open

ssp_err_t(* sf_touch_ctsu_api_t::open) (sf_touch_ctsu_ctrl_t *const p_ctrl, sf_touch_ctsu_cfg_t const *const p_cfg)

Open driver.

Implemented as

• SF_TOUCH_CTSU_Open()

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_cfg	Pointer to pin configuration structure.

scanStart

ssp_err_t(* sf_touch_ctsu_api_t::scanStart) (sf_touch_ctsu_ctrl_t *const p_ctrl)

Scan start.

Implemented as

• SF_TOUCH_CTSU_ScanStart()

Parameters

[in]

p_ctrl

Pointer to control structure.

versionGet

ssp_err_t(* sf_touch_ctsu_api_t::versionGet) (ssp_version_t *const p_data)

Return the version of the driver.

Implemented as

• SF_TOUCH_CTSU_VersionGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_data	Memory address to return version information to.

---

The documentation for this struct was generated from the following file:

• sf_touch_ctsuv2_api.h