The Adc Common module provides “stateless” application context independent functions which provide functionality required by both the Adc and Adc2 modules. In order to operate in any given application, the function design must not write to any fixed static variable location, unless it is in Globally shared memory. All static variable writes outside of Globally shared memory must be performed via pointer access where the caller provides the pointer reference to allowed writable memory in the application context from with the caller is executing.
The motivation for creating core functions is to reduce duplication and testing of common code design.
None
For details on module input / output variable, refer to the Data Dictionary for the application. Input / output variable names are listed here for reference.
Module Inputs | Module Outputs |
---|---|
None | None |
This section identifies the name, range and resolutions for module specific data created by this module. If there are no range restrictions on the variable, the term “FULL” is placed into the table for legal range.
Variable Name | Resolution | Legal Range (min) | Legal Range (max) | Software Segment |
---|---|---|---|---|
None |
This section documents any user types uniquely used for the module.
Typedef Name | Element Name | User Defined Type | Legal Range (min) | Legal Range (max) |
---|---|---|---|---|
None |
This section lists the calibrations used by the module. For details on calibration constants, refer to the Data Dictionary for the application.
Constant Name |
---|
None |
All embedded constants whose values are provided in Eng units will be evaluated to the equivalent counts by using the FPM_InitFixedPoint_m() macro within the #define statement.
Constant Name | Resolution | Units | Value |
---|---|---|---|
D_NUMOFADCCALREADS_CNT_U8 | 1 | Counts | 8 |
This section lists the global constants used by the module. For details on global constants, refer to the Data Dictionary for the application.
Constant Name |
---|
D_FALSE_CNT_LGC |
D_TRUE_CNT_LGC |
Constant Name | Resolution | Value | Software Segment |
---|---|---|---|
None |
The library and functions / Macros that are called by the various sub modules are identified below,
None
<None>
Function Name | ADCOffsetCalibration | Type | Min | Max | UTP Tol. |
---|---|---|---|---|---|
Arguments Passed | adcREG | adcctrlregs_t* | FULL | FULL | |
Return Value | Status_Cnt_T_u08 | uint8 | FULL | FULL |
Perform the ADC Calibration and Storing of offset.
None
None
None
None
None
None
None
None
No integration scheduling required. The only service offered by this module has a fixed scheduling within the Adc subsystem.
This table serves as reference for the Scheduler design
Function Name | Calling Frequency | System State(s) in which the function is called |
---|---|---|
None |
Function Name | Sub-Module called by (Serial Comm Function Name) |
---|---|
N/A |
This table identifies the software segments for functions identified in this module.
Name of Sub Module | Software Segment |
---|---|
ADCOffsetCalibration | ADC_START_SEC_CODE |
This table identifies the software segments for local functions identified in this module.
Name of Sub Module | Software Segment |
---|---|
INLINE functions defined in “GlobalMacro.h” are not unit tested
Item # | Rev # | Change Description | Date | Author Initials |
---|---|---|---|---|
1 | 1.0 | Initial version | 24Apr13 | Selva |