ctsu_api_t Struct Reference

#include <r_ctsuv2_api.h>

Data Fields
ssp_err_t(*	open )(ctsu_ctrl_t *const p_ctrl, ctsu_cfg_t const *const p_cfg)
ssp_err_t(*	scanStart )(ctsu_ctrl_t *const p_ctrl)
ssp_err_t(*	dataGet )(ctsu_ctrl_t *const p_ctrl, uint16_t *p_data)
ssp_err_t(*	diagnosis )(ctsu_ctrl_t *const p_ctrl)
ssp_err_t(*	callbackSet )(ctsu_ctrl_t *const p_api_ctrl, void(*p_callback)(ctsu_callback_args_t *), void const *const p_context, ctsu_callback_args_t *const p_callback_memory)
ssp_err_t(*	close )(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(* ctsu_api_t::callbackSet) (ctsu_ctrl_t *const p_api_ctrl, void(*p_callback)(ctsu_callback_args_t *), void const *const p_context, ctsu_callback_args_t *const p_callback_memory)

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

Implemented as

• R_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(* ctsu_api_t::close) (ctsu_ctrl_t *const p_ctrl)

Close driver.

Implemented as

• R_CTSU_Close()

Parameters

[in]

p_ctrl

Pointer to control structure.

dataGet

ssp_err_t(* ctsu_api_t::dataGet) (ctsu_ctrl_t *const p_ctrl, uint16_t *p_data)

Data get.

Implemented as

• R_CTSU_DataGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_data	Pointer to get data array.

diagnosis

ssp_err_t(* ctsu_api_t::diagnosis) (ctsu_ctrl_t *const p_ctrl)

Diagnosis.

Implemented as

• R_CTSU_Diagnosis()

Parameters

[in]

p_ctrl

Pointer to control structure.

open

ssp_err_t(* ctsu_api_t::open) (ctsu_ctrl_t *const p_ctrl, ctsu_cfg_t const *const p_cfg)

Open driver.

Implemented as

• R_CTSU_Open()

Parameters

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

scanStart

ssp_err_t(* ctsu_api_t::scanStart) (ctsu_ctrl_t *const p_ctrl)

Scan start.

Implemented as

• R_CTSU_ScanStart()

Parameters

[in]

p_ctrl

Pointer to control structure.

versionGet

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

Return the version of the driver.

Implemented as

• R_CTSU_VersionGet()

Parameters

[out]

p_data

Memory address to return version information to.

---

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

• r_ctsuv2_api.h