RX Family
ADC Module Using Firmware Integration Technology
R01AN1666EJ0220 Rev. 2.20
Page 51 of 74
Dec 01, 2016
2.11 Return Values
These are the different error codes API functions can return. The enum is found in r_s12ad_rx_if.h along with the API
function declarations.
typedef
enum
e_adc_err
// ADC API error codes
{
ADC_SUCCESS =
0
,
ADC_ERR_AD_LOCKED,
// Open() call is in progress elsewhere
ADC_ERR_AD_NOT_CLOSED,
// peripheral still running in another mode
ADC_ERR_MISSING_PTR,
// missing required pointer argument
ADC_ERR_INVALID_ARG,
// argument is not valid for parameter
ADC_ERR_ILLEGAL_ARG,
// argument is illegal for mode
ADC_ERR_SCAN_NOT_DONE,
// default, Group A, or Group B scan not done
ADC_ERR_TRIG_ENABLED,
// scan running, cannot configure comparator
ADC_ERR_CONDITION_NOT_MET,
// no chans/sensors passed comparator condition
ADC_ERR_UNKNOWN
// unknown hardware error
}
adc_err_t;
2.12 Adding a FIT Module to Your Project
This module must be added, in the e² studio, to each project in which it is used.
There are two methods for adding this module: using the FIT plugin, and adding it manually.
When the FIT plugin is used, FIT modules can be added to projects easily, and the include file path can be updated
automatically. Accordingly, we recommend using the FIT plugin when adding FIT modules to projects.
Methods for adding FIT modules to projects using the FIT plugin are described in section 3, Adding FIT Modules to e
2
studio Projects Manually, in the “Adding Firmware Integration Technology Modules to Projects (R01AN1723)”
application note. See that application note for details.
See section 4, Configuring the FIT Module for the methods for addition FIT modules to projects manually.
When using a FIT module the board support package FIT module (BSP module) must also be added to the project. See
the “Board Support Package Module Using Firmware Integration Technology (R01AN1685)” application note for
details on method for adding the BSP module.