TMPM4KxA Group Peripheral Driver User Manual  V1.0.4.0
Functions
ADC Exported Functions

Functions

TXZ_Result adc_init (adc_t *p_obj)
 Initialize the ADC object. More...
 
TXZ_Result adc_deinit (adc_t *p_obj)
 Release the ADC object. More...
 
TXZ_Result adc_channel_setting (adc_t *p_obj, uint32_t ch, adc_channel_setting_t *p_setting)
 ADC Channel Setting. More...
 
TXZ_Result adc_channel_clear (adc_t *p_obj, uint32_t ch)
 ADC Channel Clear. More...
 
TXZ_Result adc_channel_get_value (adc_t *p_obj, uint32_t ch, uint32_t *p_value)
 Get AD value. More...
 
TXZ_Result adc_start (adc_t *p_obj)
 Start blocking single conversion. More...
 
TXZ_Result adc_stop (adc_t *p_obj)
 Stop blocking single conversion. More...
 
TXZ_Result adc_startIt (adc_t *p_obj)
 Start non-blocking single conversion. More...
 
TXZ_Result adc_stopIt (adc_t *p_obj)
 Stop non-blocking single conversion. More...
 
TXZ_WorkState adc_poll_conversion (adc_t *p_obj, uint32_t timeout)
 Wait for single conversion to be completed. More...
 
void adc_irq_handler (adc_t *p_obj)
 IRQ Handler for single conversion done. More...
 
TXZ_Result adc_ch_init (adc_ch_t *p_obj)
 Initialize the ADC Channel object. More...
 
TXZ_Result adc_ch_deinit (adc_ch_t *p_obj)
 Release the ADC Channel object. More...
 
TXZ_Result adc_ch_int_enable (adc_ch_t *p_obj)
 Enable Interrupt. More...
 
TXZ_Result adc_ch_int_disable (adc_ch_t *p_obj)
 Disable Interrupt. More...
 
TXZ_Result adc_ch_get_value (adc_ch_t *p_obj, uint32_t *p_value)
 Get conversion value. More...
 
TXZ_Result adc_ex_init (adc_ex_t *p_obj)
 Initialize the ADC object. More...
 
TXZ_Result adc_ex_deinit (adc_ex_t *p_obj)
 Release the ADC object. More...
 
TXZ_Result adc_ex_channel_setting (adc_ex_t *p_obj, uint32_t ch, adc_ex_channel_setting_t *p_setting)
 ADC Channel Setting. More...
 
TXZ_Result adc_ex_channel_clear (adc_ex_t *p_obj, uint32_t ch)
 ADC Channel Clear. More...
 
TXZ_Result adc_ex_channel_get_value (adc_ex_t *p_obj, uint32_t ch, uint32_t *p_value)
 Get AD value. More...
 
TXZ_Result adc_ex_start (adc_ex_t *p_obj)
 Start Conversion. More...
 
TXZ_Result adc_ex_stop (adc_ex_t *p_obj)
 Stop Conversion. More...
 
TXZ_Result adc_ex_get_status (adc_ex_t *p_obj, uint32_t *p_status)
 Get Conversion Status. More...
 
void adc_ex_single_irq_handler (adc_ex_t *p_obj)
 IRQ Handler for single conversion done. More...
 
void adc_ex_continuity_irq_handler (adc_ex_t *p_obj)
 IRQ Handler for continuity conversion done. More...
 
void adc_ex_trigger_irq_handler (adc_ex_t *p_obj)
 IRQ Handler for trigger conversion done. More...
 
TXZ_Result adc_sh_init (adc_sh_t *p_obj)
 
TXZ_Result adc_sh_deinit (adc_sh_t *p_obj)
 
TXZ_Result adc_sh_set (adc_sh_t *p_obj, uint32_t upper_pattern, uint32_t lower_pattern)
 
TXZ_Result adc_sh_get (adc_sh_t *p_obj, uint32_t *p_value)
 

Detailed Description

Function Documentation

◆ adc_ch_deinit()

TXZ_Result adc_ch_deinit ( adc_ch_t p_obj)

Release the ADC Channel object.

Parameters
p_obj:ADC Channel object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.

◆ adc_ch_get_value()

TXZ_Result adc_ch_get_value ( adc_ch_t p_obj,
uint32_t *  p_value 
)

Get conversion value.

Parameters
p_obj:ADC Channel object.
p_value:AD value. Destination address.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has done.

◆ adc_ch_init()

TXZ_Result adc_ch_init ( adc_ch_t p_obj)

Initialize the ADC Channel object.

Parameters
p_obj:ADC Channel object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_ch_int_disable()

TXZ_Result adc_ch_int_disable ( adc_ch_t p_obj)

Disable Interrupt.

Parameters
p_obj:ADC Channel object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_ch_int_enable()

TXZ_Result adc_ch_int_enable ( adc_ch_t p_obj)

Enable Interrupt.

Parameters
p_obj:ADC Channel object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_channel_clear()

TXZ_Result adc_channel_clear ( adc_t p_obj,
uint32_t  ch 
)

ADC Channel Clear.

Parameters
p_obj:ADC object.
ch:Channel. Range is (value < ADC_NUM_MAX).
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_channel_get_value()

TXZ_Result adc_channel_get_value ( adc_t p_obj,
uint32_t  ch,
uint32_t *  p_value 
)

Get AD value.

Parameters
p_obj:ADC object.
ch:Channel. Range is (value < ADC_NUM_MAX).
p_value:AD value. Destination address.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-

◆ adc_channel_setting()

TXZ_Result adc_channel_setting ( adc_t p_obj,
uint32_t  ch,
adc_channel_setting_t p_setting 
)

ADC Channel Setting.

Parameters
p_obj:ADC object.
ch:Channel. Range is (value < ADC_NUM_MAX).
p_setting:Channel Setting Source Address.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_deinit()

TXZ_Result adc_deinit ( adc_t p_obj)

Release the ADC object.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.

◆ adc_ex_channel_clear()

TXZ_Result adc_ex_channel_clear ( adc_ex_t p_obj,
uint32_t  ch 
)

ADC Channel Clear.

Parameters
p_obj:ADC object.
ch:Channel. Range is (value < ADC_NUM_MAX).
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_ex_channel_get_value()

TXZ_Result adc_ex_channel_get_value ( adc_ex_t p_obj,
uint32_t  ch,
uint32_t *  p_value 
)

Get AD value.

Parameters
p_obj:ADC object.
ch:Channel. Range is (value < ADC_NUM_MAX).
p_value:AD value. Destination address.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-

◆ adc_ex_channel_setting()

TXZ_Result adc_ex_channel_setting ( adc_ex_t p_obj,
uint32_t  ch,
adc_ex_channel_setting_t p_setting 
)

ADC Channel Setting.

Parameters
p_obj:ADC object.
ch:Channel. Range is (value < ADC_NUM_MAX).
p_setting:Channel Setting Source Address.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_ex_continuity_irq_handler()

void adc_ex_continuity_irq_handler ( adc_ex_t p_obj)

IRQ Handler for continuity conversion done.

Parameters
p_obj:ADC object.
Return values
-
Note
Call by Continuity Conversion Done IRQ Handler.

◆ adc_ex_deinit()

TXZ_Result adc_ex_deinit ( adc_ex_t p_obj)

Release the ADC object.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.

◆ adc_ex_get_status()

TXZ_Result adc_ex_get_status ( adc_ex_t p_obj,
uint32_t *  p_status 
)

Get Conversion Status.

Status bits.

Bit Bit Symbol Function
31-8 - -
7 ADBF AD Running Flag. Use AD Running Status..
6-4 - -
3 CNTF Continuity Conversion Running Flag. Use Continuity Conversion Running Status..
2 SNGF Single Conversion Running Flag. Use Single Conversion Running Status..
1 TRGF Trigger Conversion Running Flag. Use Trigger Conversion Running Status..
0 - -
Parameters
p_obj:ADC object.
p_status:Conversion Status. Destination address.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-

◆ adc_ex_init()

TXZ_Result adc_ex_init ( adc_ex_t p_obj)

Initialize the ADC object.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.
After initialization, 3us of stabilization time is needed.

◆ adc_ex_single_irq_handler()

void adc_ex_single_irq_handler ( adc_ex_t p_obj)

IRQ Handler for single conversion done.

Parameters
p_obj:ADC object.
Return values
-
Note
Call by Single Conversion Done IRQ Handler.

◆ adc_ex_start()

TXZ_Result adc_ex_start ( adc_ex_t p_obj)

Start Conversion.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_ex_stop()

TXZ_Result adc_ex_stop ( adc_ex_t p_obj)

Stop Conversion.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.

◆ adc_ex_trigger_irq_handler()

void adc_ex_trigger_irq_handler ( adc_ex_t p_obj)

IRQ Handler for trigger conversion done.

Parameters
p_obj:ADC object.
Return values
-
Note
Call by Trigger Conversion Done IRQ Handler.

◆ adc_init()

TXZ_Result adc_init ( adc_t p_obj)

Initialize the ADC object.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.
After initialization, 3us of stabilization time is needed.

◆ adc_irq_handler()

void adc_irq_handler ( adc_t p_obj)

IRQ Handler for single conversion done.

Parameters
p_obj:ADC object.
Return values
-
Note
Call by Single Conversion Done IRQ Handler.

◆ adc_poll_conversion()

TXZ_WorkState adc_poll_conversion ( adc_t p_obj,
uint32_t  timeout 
)

Wait for single conversion to be completed.

Parameters
p_obj:ADC object.
timeout:Timeout(tick).
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.

◆ adc_start()

TXZ_Result adc_start ( adc_t p_obj)

Start blocking single conversion.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_startIt()

TXZ_Result adc_startIt ( adc_t p_obj)

Start non-blocking single conversion.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Precondition
Conversion has stoped.
Attention
This function is not available in interrupt.

◆ adc_stop()

TXZ_Result adc_stop ( adc_t p_obj)

Stop blocking single conversion.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.

◆ adc_stopIt()

TXZ_Result adc_stopIt ( adc_t p_obj)

Stop non-blocking single conversion.

Parameters
p_obj:ADC object.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
-
Attention
This function is not available in interrupt.