TMPM4KxA Group Peripheral Driver User Manual  V1.0.4.0
Functions | Variables
txz_adc.c File Reference

This file provides API functions for ADC driver. More...

Functions

__STATIC_INLINE int32_t check_param_refbsel (uint32_t param)
 Check the AD REFBSEL's parameter. More...
 
__STATIC_INLINE int32_t check_param_rcut (uint32_t param)
 Check the AD RCUT's parameter. More...
 
__STATIC_INLINE int32_t check_param_convert_time (uint32_t param)
 Check the Convert time's parameter. More...
 
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...
 

Variables

 C
 

Detailed Description

This file provides API functions for ADC driver.

Version
V1.0.0.1
Date
2018-07-12 17:01:50

DO NOT USE THIS SOFTWARE WITHOUT THE SOFTWARE LICENSE AGREEMENT.

(C)Copyright TOSHIBA MICROELECTRONICS CORPORATION 2017 All rights reserved

Function Documentation

◆ check_param_convert_time()

__STATIC_INLINE int32_t check_param_convert_time ( uint32_t  param)

Check the Convert time's parameter.

Parameters
param:Convert time's parameter
Return values
ADC_PARAM_OK:Valid
ADC_PARAM_NG:Invalid
Note
Macro definition is AD Convert Time & AVDD..

◆ check_param_rcut()

__STATIC_INLINE int32_t check_param_rcut ( uint32_t  param)

Check the AD RCUT's parameter.

Parameters
param:AD RCUT's parameter
Return values
ADC_PARAM_OK:Valid
ADC_PARAM_NG:Invalid
Note
Macro definition is AD RCUT..

◆ check_param_refbsel()

__STATIC_INLINE int32_t check_param_refbsel ( uint32_t  param)

Check the AD REFBSEL's parameter.

Parameters
param:AD REFBSEL's parameter
Return values
ADC_PARAM_OK:Valid
ADC_PARAM_NG:Invalid
Note
Macro definition is AD VREFHx / AINxn..