sf_touch_panel_chip_api_t Struct Reference

#include <sf_touch_panel_chip_api.h>

Data Fields
ssp_err_t(*	open )(sf_touch_panel_chip_ctrl_t *const p_ctrl, sf_touch_panel_chip_cfg_t const *const p_cfg)
	Initializes the touch chip. More...
ssp_err_t(*	payloadGet )(sf_touch_panel_chip_ctrl_t *const p_ctrl, sf_touch_panel_v2_payload_t *p_payload)
	Reads the touch chip and fills in the touch payload data. More...
ssp_err_t(*	reset )(sf_touch_panel_chip_ctrl_t *const p_ctrl)
	Resets the touch chip. More...
ssp_err_t(*	close )(sf_touch_panel_chip_ctrl_t *const p_ctrl)
	Close the touch chip. More...
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)
	Gets the chip version and stores it in provided pointer p_version. More...

Detailed Description

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

Field Documentation

close

ssp_err_t(* sf_touch_panel_chip_api_t::close) (sf_touch_panel_chip_ctrl_t *const p_ctrl)

Close the touch chip.

Parameters

[in,out]

p_ctrl

Pointer to a structure allocated by user. This control structure is initialized in this function.

open

ssp_err_t(* sf_touch_panel_chip_api_t::open) (sf_touch_panel_chip_ctrl_t *const p_ctrl, sf_touch_panel_chip_cfg_t const *const p_cfg)

Initializes the touch chip.

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.

payloadGet

ssp_err_t(* sf_touch_panel_chip_api_t::payloadGet) (sf_touch_panel_chip_ctrl_t *const p_ctrl, sf_touch_panel_v2_payload_t *p_payload)

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

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 data structure. Touch data provided should be processed to logical pixel values.

reset

ssp_err_t(* sf_touch_panel_chip_api_t::reset) (sf_touch_panel_chip_ctrl_t *const p_ctrl)

Resets the touch chip.

Parameters

[in,out]

p_ctrl

Pointer to a structure allocated by user. This control structure is initialized in this function.

versionGet

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

Gets the chip version and stores it in provided pointer p_version.

Parameters

[out]

p_version

Code and API version used are stored here.

---

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

• sf_touch_panel_chip_api.h