Index: firmware/App/Drivers/InternalADC.h =================================================================== diff -u -ra49bd0780d97bb4ce04a9d7b128a6e3c2df044e1 -rebd11d01f826a08806d2f4984bd57e829371b687 --- firmware/App/Drivers/InternalADC.h (.../InternalADC.h) (revision a49bd0780d97bb4ce04a9d7b128a6e3c2df044e1) +++ firmware/App/Drivers/InternalADC.h (.../InternalADC.h) (revision ebd11d01f826a08806d2f4984bd57e829371b687) @@ -19,41 +19,46 @@ #include "DGCommon.h" +/** + * @defgroup InternalADC InternalADC + * @brief DG internal ADC module. + * + * @addtogroup InternalADC + * @{ + */ + // ********** public definitions ********** -#define INT_ADC_BITS_PER_CHANNEL 12 -#define INT_ADC_FULL_SCALE_BITS 4096 -#ifndef BREADBOARD_TARGET - #define INT_ADC_REF_V 3.0 -#else - #define INT_ADC_REF_V 3.3 -#endif +#define INT_ADC_BITS_PER_CHANNEL 12 ///< DG internal ADC bits per channel. +#define INT_ADC_FULL_SCALE_BITS 4096 ///< DG internal ADC full scale range. +#define INT_ADC_REF_V 3.0 ///< DG internal ADC reference voltage. +/// Enumeration of DG internal ADC channels. typedef enum Int_ADC_Channels { - INT_ADC_NOT_USED = 0, - INT_ADC_RO_PUMP_INLET_PRESSURE, - INT_ADC_RO_PUMP_OUTLET_PRESSURE, - INT_ADC_DRAIN_PUMP_OUTLET_PRESSURE, - INT_ADC_DRAIN_PUMP_INLET_PRESSURE, - INT_ADC_CONCENTRATE_PUMP_1, - INT_ADC_CONCENTRATE_PUMP_2, - INT_ADC_PRIMARY_HEATER_24_VOLTS, - INT_ADC_TRIMMER_HEATER_24_VOLTS, - INT_ADC_BOARD_THERMISTOR, - INT_ADC_FPGA_1_8_VOLTS, - INT_ADC_FPGA_1_VOLT, - INT_ADC_PROCESSOR_1_8_VOLTS, - INT_ADC_PROCESSOR_1_2_VOLTS, - INT_ADC_SENSORS_3_3_VOLTS, - INT_ADC_SENSORS_5_VOLTS, - INT_ADC_SENSORS_6_VOLTS, - INT_ADC_LOGIC_5_VOLTS, - INT_ADC_3_3_VOLTS, - INT_ADC_REFERENCE_VOLTAGE, - INT_ADC_REF_IN1, - INT_ADC_REF_IN2, - NUM_OF_INT_ADC_CHANNELS + INT_ADC_NOT_USED = 0, ///< DG internal ADC channel not used. + INT_ADC_RO_PUMP_INLET_PRESSURE, ///< DG internal ADC RO pump inlet pressure channel. + INT_ADC_RO_PUMP_OUTLET_PRESSURE, ///< DG internal ADC RO pump outlet pressure channel. + INT_ADC_DRAIN_PUMP_OUTLET_PRESSURE, ///< DG internal ADC drain pump outlet pressure channel. + INT_ADC_DRAIN_PUMP_INLET_PRESSURE, ///< DG internal ADC drain pump inlet pressure channel. + INT_ADC_CONCENTRATE_PUMP_1, ///< DG internal ADC concentrate pump #1 channel. + INT_ADC_CONCENTRATE_PUMP_2, ///< DG internal ADC concentrate pump #2 channel. + INT_ADC_PRIMARY_HEATER_24_VOLTS, ///< DG internal ADC primary heater 24 volt supply channel. + INT_ADC_TRIMMER_HEATER_24_VOLTS, ///< DG internal ADC trimmer heater 24 volt supply channel. + INT_ADC_BOARD_THERMISTOR, ///< DG internal ADC DG board thermistor channel. + INT_ADC_FPGA_1_8_VOLTS, ///< DG internal ADC DG FPGA 1.8 volt supply channel. + INT_ADC_FPGA_1_VOLT, ///< DG internal ADC DG FPGA 1 volt supply channel. + INT_ADC_PROCESSOR_1_8_VOLTS, ///< DG internal ADC DG processor 1.8 volt supply channel. + INT_ADC_PROCESSOR_1_2_VOLTS, ///< DG internal ADC DG processor 1.2 volt supply channel. + INT_ADC_SENSORS_3_3_VOLTS, ///< DG internal ADC DG sensors 3.3 volt supply channel. + INT_ADC_SENSORS_5_VOLTS, ///< DG internal ADC DG sensors 5 volt supply channel. + INT_ADC_SENSORS_6_VOLTS, ///< DG internal ADC DG sensors 6 volt supply channel. + INT_ADC_LOGIC_5_VOLTS, ///< DG internal ADC DG logic 5 volt supply channel. + INT_ADC_3_3_VOLTS, ///< DG internal ADC DG 3.3 volt supply channel. + INT_ADC_REFERENCE_VOLTAGE, ///< DG internal ADC reference voltage channel. + INT_ADC_REF_IN1, ///< DG internal ADC ??? channel. TODO + INT_ADC_REF_IN2, ///< DG internal ADC ??? channel. TODO + NUM_OF_INT_ADC_CHANNELS ///< Number of DG internal ADC channels } INT_ADC_CHANNEL_T; // ********** public function prototypes ********** @@ -62,4 +67,6 @@ void execInternalADC( void ); U16 getIntADCReading( INT_ADC_CHANNEL_T channel ); +/**@}*/ + #endif