CTSU Interface

Detailed Description

Interface for Capacitive Touch Sensing Unit (CTSU) functions.

Summary

The CTSU interface provides CTSU functionality.

Data Structures
struct	ctsu_callback_args_t
struct	ctsu_element_cfg_t
struct	ctsu_auto_button_cfg_t
struct	ctsu_cfg_t
struct	ctsu_api_t
struct	ctsu_instance_t

Typedefs
typedef void	ctsu_ctrl_t

Enumerations
enum	ctsu_event_t
enum	ctsu_cap_t
enum	ctsu_txvsel_t
enum	ctsu_txvsel2_t
enum	ctsu_atune1_t
enum	ctsu_atune12_t
enum	ctsu_md_t
enum	ctsu_posel_t
enum	ctsu_ssdiv_t
enum	ctsu_specific_data_type_t

---

Data Structure Documentation

ctsu_callback_args_t

struct ctsu_callback_args_t

Callback function parameter data

Data Fields
ctsu_event_t	event	The event can be used to identify what caused the callback.
void const *	p_context	Placeholder for user data. Set in ctsu_api_t::open function in ctsu_cfg_t.

ctsu_element_cfg_t

struct ctsu_element_cfg_t

CTSU Configuration parameters. Element Configuration

Data Fields
ctsu_ssdiv_t	ssdiv	CTSU Spectrum Diffusion Frequency Division Setting (CTSU Only)
uint16_t	so	CTSU Sensor Offset Adjustment.
uint8_t	snum	CTSU Measurement Count Setting.
uint8_t	sdpa	CTSU Base Clock Setting.

ctsu_auto_button_cfg_t

struct ctsu_auto_button_cfg_t

Configuration of each automatic judgement button

Data Fields
uint8_t	elem_index	Element number used by this button for automatic judgement.
uint16_t	threshold	Touch/non-touch judgement threshold for automatic judgement.
uint16_t	hysteresis	Threshold hysteresis for chattering prevention for automatic judgement.

ctsu_cfg_t

struct ctsu_cfg_t

User configuration structure, used in open function

Data Fields
ctsu_cap_t	cap
	CTSU Scan Start Trigger Select.
ctsu_txvsel_t	txvsel
	CTSU Transmission Power Supply Select.
ctsu_txvsel2_t	txvsel2
	CTSU Transmission Power Supply Select 2 (CTSU2 Only)
ctsu_atune1_t	atune1
	CTSU Power Supply Capacity Adjustment (CTSU Only)
ctsu_atune12_t	atune12
	CTSU Power Supply Capacity Adjustment (CTSU2 Only)
ctsu_md_t	md
	CTSU Measurement Mode Select.
ctsu_posel_t	posel
	CTSU Non-Measured Channel Output Select (CTSU2 Only)
uint8_t	tsod
	TS all terminal output control for multi electrode scan.
uint8_t	mec_ts
	TS number used when using the MEC function.
uint8_t	mec_shield_ts
	TS number of active shield used when using MEC function.
uint8_t	tlot
	Number of consecutive judgements exceeding the threshold L for automatic judgement.
uint8_t	thot
	Number of consecutive judgements exceeding the threshold H for automatic judgement.
uint8_t	jc
	Judgement condition for automatic judgement.
uint8_t	ajmmat
	Measured value moving average number of times for automatic judgement.
uint8_t	ajbmat
	Average number of baselines for automatic judgement.
uint8_t	mtucfen
	Mutual capacity operation for automatic judgement.
uint8_t	ajfen
	Automatic judgement function enabled for automatic judgement.
uint8_t	autojudge_monitor_num
	Method number for QE monitor for automatic judgement.
uint8_t	majirimd
	JMM or VMM for automatic judgement.
uint8_t	ctsuchac0
	TS00-TS07 enable mask.
uint8_t	ctsuchac1
	TS08-TS15 enable mask.
uint8_t	ctsuchac2
	TS16-TS23 enable mask.
uint8_t	ctsuchac3
	TS24-TS31 enable mask.
uint8_t	ctsuchac4
	TS32-TS39 enable mask.
uint8_t	ctsuchtrc0
	TS00-TS07 mutual-tx mask.
uint8_t	ctsuchtrc1
	TS08-TS15 mutual-tx mask.
uint8_t	ctsuchtrc2
	TS16-TS23 mutual-tx mask.
uint8_t	ctsuchtrc3
	TS24-TS31 mutual-tx mask.
uint8_t	ctsuchtrc4
	TS32-TS39 mutual-tx mask.
ctsu_element_cfg_t const *	p_elements
	Pointer to elements configuration array.
uint8_t	num_rx
	Number of receive terminals.
uint8_t	num_tx
	Number of transmit terminals.
uint16_t	num_moving_average
	Number of moving average for measurement data.
bool	tunning_enable
	Initial offset tuning flag.
void(*	p_callback )(ctsu_callback_args_t *p_args)
	Callback provided when CTSUFN ISR occurs.
transfer_instance_t const *	p_transfer_tx
	DTC instance for transmit at CTSUWR. Set to NULL if unused.
transfer_instance_t const *	p_transfer_rx
	DTC instance for receive at CTSURD. Set to NULL if unused.
adc_instance_t const *	p_adc_instance
	ADC instance for temperature correction.
IRQn_Type	write_irq
	CTSU_CTSUWR interrupt vector.
IRQn_Type	read_irq
	CTSU_CTSURD interrupt vector.
IRQn_Type	end_irq
	CTSU_CTSUFN interrupt vector.
void const *	p_context
	User defined context passed into callback function.
void const *	p_extend
	Pointer to extended configuration by instance of interface.
uint16_t	tuning_self_target_value
	Target self value for initial offset tuning.
uint16_t	tuning_mutual_target_value
	Target mutual value for initial offset tuning.
ctsu_auto_button_cfg_t const *	p_ctsu_auto_buttons
	Pointer to array of automatic judgement button configuration.
uint8_t	majority_mode
	Software majority mode selection.

ctsu_api_t

struct ctsu_api_t

Functions implemented at the HAL layer will follow this API.

Data Fields
fsp_err_t(*	open )(ctsu_ctrl_t *const p_ctrl, ctsu_cfg_t const *const p_cfg)
fsp_err_t(*	scanStart )(ctsu_ctrl_t *const p_ctrl)
fsp_err_t(*	dataGet )(ctsu_ctrl_t *const p_ctrl, uint16_t *p_data)
fsp_err_t(*	scanStop )(ctsu_ctrl_t *const p_ctrl)
fsp_err_t(*	diagnosis )(ctsu_ctrl_t *const p_ctrl)
fsp_err_t(*	callbackSet )(ctsu_ctrl_t *const p_ctrl, void(*p_callback)(ctsu_callback_args_t *), void const *const p_context, ctsu_callback_args_t *const p_callback_memory)
fsp_err_t(*	close )(ctsu_ctrl_t *const p_ctrl)
fsp_err_t(*	specificDataGet )(ctsu_ctrl_t *const p_ctrl, uint16_t *p_specific_data, ctsu_specific_data_type_t specific_data_type)
fsp_err_t(*	dataInsert )(ctsu_ctrl_t *const p_ctrl, uint16_t *p_insert_data)
fsp_err_t(*	autoJudgementDataGet )(ctsu_ctrl_t *const p_ctrl, uint64_t *p_button_status)
fsp_err_t(*	offsetTuning )(ctsu_ctrl_t *const p_ctrl)

Field Documentation

open

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

Open driver.

Parameters

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

scanStart

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

Scan start.

Parameters

[in]

p_ctrl

Pointer to control structure.

dataGet

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

Data get.

Parameters

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

scanStop

fsp_err_t(* ctsu_api_t::scanStop) (ctsu_ctrl_t *const p_ctrl)

ScanStop.

Parameters

[in]

p_ctrl

Pointer to control structure.

diagnosis

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

Diagnosis.

Parameters

[in]

p_ctrl

Pointer to control structure.

callbackSet

fsp_err_t(* ctsu_api_t::callbackSet) (ctsu_ctrl_t *const p_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.

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

fsp_err_t(* ctsu_api_t::close) (ctsu_ctrl_t *const p_ctrl)

Close driver.

Parameters

[in]

p_ctrl

Pointer to control structure.

specificDataGet

fsp_err_t(* ctsu_api_t::specificDataGet) (ctsu_ctrl_t *const p_ctrl, uint16_t *p_specific_data, ctsu_specific_data_type_t specific_data_type)

Specific Data get.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_specific_data	Pointer to get specific data array.
[in]	specific_data_type	Specific data type

dataInsert

fsp_err_t(* ctsu_api_t::dataInsert) (ctsu_ctrl_t *const p_ctrl, uint16_t *p_insert_data)

Data Insert.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_insert_data	Pointer to insert data.

autoJudgementDataGet

fsp_err_t(* ctsu_api_t::autoJudgementDataGet) (ctsu_ctrl_t *const p_ctrl, uint64_t *p_button_status)

Initialize automatic judgement and get button status.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_button_status	Pointer to get button status array.

offsetTuning

fsp_err_t(* ctsu_api_t::offsetTuning) (ctsu_ctrl_t *const p_ctrl)

Adjust the offset value to tune the sensor.

Parameters

[in]

p_ctrl

Pointer to control structure.

ctsu_instance_t

struct ctsu_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
ctsu_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
ctsu_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
ctsu_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

ctsu_ctrl_t

typedef void ctsu_ctrl_t

CTSU Control block. Allocate an instance specific control block to pass into the API calls.

Enumeration Type Documentation

ctsu_event_t

enum ctsu_event_t

CTSU Events for callback function

Enumerator
CTSU_EVENT_SCAN_COMPLETE	Normal end.
CTSU_EVENT_OVERFLOW	Sensor counter overflow (CTSUST.CTSUSOVF set)
CTSU_EVENT_ICOMP	Abnormal TSCAP voltage (CTSUERRS.CTSUICOMP set)
CTSU_EVENT_ICOMP1	Abnormal sensor current (CTSUSR.ICOMP1 set)

ctsu_cap_t

enum ctsu_cap_t

CTSU Scan Start Trigger Select

Enumerator
CTSU_CAP_SOFTWARE	Scan start by software trigger.
CTSU_CAP_EXTERNAL	Scan start by external trigger.

ctsu_txvsel_t

enum ctsu_txvsel_t

CTSU Transmission Power Supply Select

Enumerator
CTSU_TXVSEL_VCC	VCC selected.
CTSU_TXVSEL_INTERNAL_POWER	Internal logic power supply selected.

ctsu_txvsel2_t

enum ctsu_txvsel2_t

CTSU Transmission Power Supply Select 2 (CTSU2 Only)

Enumerator
CTSU_TXVSEL_MODE	Follow TXVSEL setting.
CTSU_TXVSEL_VCC_PRIVATE	VCC private selected.

ctsu_atune1_t

enum ctsu_atune1_t

CTSU Power Supply Capacity Adjustment (CTSU Only)

Enumerator
CTSU_ATUNE1_NORMAL	Normal output (40uA)
CTSU_ATUNE1_HIGH	High-current output (80uA)

ctsu_atune12_t

enum ctsu_atune12_t

CTSU Power Supply Capacity Adjustment (CTSU2 Only)

Enumerator
CTSU_ATUNE12_80UA	High-current output (80uA)
CTSU_ATUNE12_40UA	Normal output (40uA)
CTSU_ATUNE12_20UA	Low-current output (20uA)
CTSU_ATUNE12_160UA	Very high-current output (160uA)

ctsu_md_t

enum ctsu_md_t

CTSU Measurement Mode Select

Enumerator
CTSU_MODE_SELF_MULTI_SCAN	Self-capacitance multi scan mode.
CTSU_MODE_MUTUAL_FULL_SCAN	Mutual capacitance full scan mode.
CTSU_MODE_MUTUAL_CFC_SCAN	Mutual capacitance cfc scan mode (CTSU2 Only)
CTSU_MODE_CURRENT_SCAN	Current scan mode (CTSU2 Only)
CTSU_MODE_CORRECTION_SCAN	Correction scan mode (CTSU2 Only)
CTSU_MODE_DIAGNOSIS_SCAN	Diagnosis scan mode.

ctsu_posel_t

enum ctsu_posel_t

CTSU Non-Measured Channel Output Select (CTSU2 Only)

Enumerator
CTSU_POSEL_LOW_GPIO	Output low through GPIO.
CTSU_POSEL_HI_Z	Hi-Z.
CTSU_POSEL_LOW	Setting prohibited.
CTSU_POSEL_SAME_PULSE	Same phase pulse output as transmission channel through the power setting by the TXVSEL[1:0] bits.

ctsu_ssdiv_t

enum ctsu_ssdiv_t

CTSU Spectrum Diffusion Frequency Division Setting (CTSU Only)

Enumerator
CTSU_SSDIV_4000	4.00 <= Base clock frequency (MHz)
CTSU_SSDIV_2000	2.00 <= Base clock frequency (MHz) < 4.00
CTSU_SSDIV_1330	1.33 <= Base clock frequency (MHz) < 2.00
CTSU_SSDIV_1000	1.00 <= Base clock frequency (MHz) < 1.33
CTSU_SSDIV_0800	0.80 <= Base clock frequency (MHz) < 1.00
CTSU_SSDIV_0670	0.67 <= Base clock frequency (MHz) < 0.80
CTSU_SSDIV_0570	0.57 <= Base clock frequency (MHz) < 0.67
CTSU_SSDIV_0500	0.50 <= Base clock frequency (MHz) < 0.57
CTSU_SSDIV_0440	0.44 <= Base clock frequency (MHz) < 0.50
CTSU_SSDIV_0400	0.40 <= Base clock frequency (MHz) < 0.44
CTSU_SSDIV_0360	0.36 <= Base clock frequency (MHz) < 0.40
CTSU_SSDIV_0330	0.33 <= Base clock frequency (MHz) < 0.36
CTSU_SSDIV_0310	0.31 <= Base clock frequency (MHz) < 0.33
CTSU_SSDIV_0290	0.29 <= Base clock frequency (MHz) < 0.31
CTSU_SSDIV_0270	0.27 <= Base clock frequency (MHz) < 0.29
CTSU_SSDIV_0000	0.00 <= Base clock frequency (MHz) < 0.27

ctsu_specific_data_type_t

enum ctsu_specific_data_type_t

CTSU select data type for slect data get