sf_touch_panel_v2_api_t Struct Reference

#include <sf_touch_panel_v2_api.h>

Data Fields
ssp_err_t(*	open )(sf_touch_panel_v2_ctrl_t *const p_ctrl, sf_touch_panel_v2_cfg_t const *const p_cfg)
	Create required RTOS objects, call lower level module for hardware specific initialization, and create a thread to post touch data to user application. More...
ssp_err_t(*	calibrate )(sf_touch_panel_v2_ctrl_t *const p_ctrl, sf_touch_panel_v2_calibrate_t const *const p_display, sf_touch_panel_v2_calibrate_t const *const p_touchscreen, ULONG const timeout)
	Begin calibration routine based on provided expected and actual coordinates. More...
ssp_err_t(*	start )(sf_touch_panel_v2_ctrl_t *const p_ctrl)
	Start scanning for touch events. More...
ssp_err_t(*	touchDataGet )(sf_touch_panel_v2_ctrl_t *const p_ctrl, sf_touch_panel_v2_payload_t *p_payload, ULONG const timeout)
	Reads the touch data and fills in the touch payload data. More...
ssp_err_t(*	stop )(sf_touch_panel_v2_ctrl_t *const p_ctrl)
	Stop scanning for touch events. More...
ssp_err_t(*	reset )(sf_touch_panel_v2_ctrl_t *const p_ctrl)
	Reset touch chip if reset pin is provided. More...
ssp_err_t(*	close )(sf_touch_panel_v2_ctrl_t *const p_ctrl)
	Terminate touch thread and close channel at HAL layer. More...
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)
	Gets version and stores it in provided pointer p_version. More...

Detailed Description

Touch panel V2 API structure. Touch panel V2 implementations use the following API.

Field Documentation

calibrate

ssp_err_t(* sf_touch_panel_v2_api_t::calibrate) (sf_touch_panel_v2_ctrl_t *const p_ctrl, sf_touch_panel_v2_calibrate_t const *const p_display, sf_touch_panel_v2_calibrate_t const *const p_touchscreen, ULONG const timeout)

Begin calibration routine based on provided expected and actual coordinates.

Implemented as

• SF_TOUCH_PANEL_V2_Calibrate()

Parameters

[in]	p_ctrl	Handle set in sf_touch_panel_v2_api_t::open.
[in]	p_display	Expected coordinates of the display.
[in]	p_touchscreen	Actual coordinates obtained from the touch driver.
[in]	timeout	ThreadX timeout. Select TX_NO_WAIT, a value in system clock counts between 1 and 0xFFFFFFFF, or TX_WAIT_FOREVER.

close

ssp_err_t(* sf_touch_panel_v2_api_t::close) (sf_touch_panel_v2_ctrl_t *const p_ctrl)

Terminate touch thread and close channel at HAL layer.

Implemented as

• SF_TOUCH_PANEL_V2_Close()

Parameters

[in]

p_ctrl

Handle set in sf_touch_panel_v2_api_t::open.

open

ssp_err_t(* sf_touch_panel_v2_api_t::open) (sf_touch_panel_v2_ctrl_t *const p_ctrl, sf_touch_panel_v2_cfg_t const *const p_cfg)

Create required RTOS objects, call lower level module for hardware specific initialization, and create a thread to post touch data to user application.

Implemented as

• SF_TOUCH_PANEL_V2_Open()

Parameters

[in,out]	p_ctrl	Pointer to a structure allocated by user. This control structure is initialized in this function.
[in]	p_cfg	Pointer to configuration structure. All elements of the structure must be set by user.

reset

ssp_err_t(* sf_touch_panel_v2_api_t::reset) (sf_touch_panel_v2_ctrl_t *const p_ctrl)

Reset touch chip if reset pin is provided.

Implemented as

• SF_TOUCH_PANEL_V2_Reset()

Note

This does not include calibration. Use sf_touch_panel_v2_api_t::calibrate from the application after this function if calibration is required after reset.

Parameters

[in]

p_ctrl

Handle set in sf_touch_panel_v2_api_t::open.

start

ssp_err_t(* sf_touch_panel_v2_api_t::start) (sf_touch_panel_v2_ctrl_t *const p_ctrl)

Start scanning for touch events.

Implemented as

• SF_TOUCH_PANEL_V2_Start()

Parameters

[in]

p_ctrl

Handle set in sf_touch_panel_v2_api_t::open.

stop

ssp_err_t(* sf_touch_panel_v2_api_t::stop) (sf_touch_panel_v2_ctrl_t *const p_ctrl)

Stop scanning for touch events.

Implemented as

• SF_TOUCH_PANEL_V2_Stop()

Parameters

[in]

p_ctrl

Handle set in sf_touch_panel_v2_api_t::open.

touchDataGet

ssp_err_t(* sf_touch_panel_v2_api_t::touchDataGet) (sf_touch_panel_v2_ctrl_t *const p_ctrl, sf_touch_panel_v2_payload_t *p_payload, ULONG const timeout)

Reads the touch data and fills in the touch payload data.

Implemented as

• SF_TOUCH_PANEL_V2_TouchDataGet()

Parameters

[in,out]	p_ctrl	Pointer to a structure allocated by user. This control structure is initialized in this function.
[out]	p_payload	Pointer to the payload to data structure. Touch data provided should be processed to logical pixel values.
[in]	timeout	ThreadX timeout. Select TX_NO_WAIT, a value in system clock counts between 1 and 0xFFFFFFFF, or TX_WAIT_FOREVER.

versionGet

ssp_err_t(* sf_touch_panel_v2_api_t::versionGet) (ssp_version_t *const p_version)

Gets version and stores it in provided pointer p_version.

Implemented as

• SF_TOUCH_PANEL_V2_VersionGet()

Parameters

[out]

p_version

Code and API version used stored here.

---

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

• sf_touch_panel_v2_api.h