Index: firmware/App/Drivers/InternalADC.c =================================================================== diff -u -r766e65a173747dd60a9faae1cac228cd5f8a55a6 -r3518e8a088c32e75c0c8960d5e629a7401095feb --- firmware/App/Drivers/InternalADC.c (.../InternalADC.c) (revision 766e65a173747dd60a9faae1cac228cd5f8a55a6) +++ firmware/App/Drivers/InternalADC.c (.../InternalADC.c) (revision 3518e8a088c32e75c0c8960d5e629a7401095feb) @@ -98,9 +98,9 @@ /*********************************************************************//** * @brief - * The initInternalADC function initializes the InternalADC module. - * @details Inputs: none - * @details Outputs: InternalADC module is initialized. + * The initInternalADC function initializes the InternalADC unit. + * @details \b Inputs: none + * @details \b Outputs: InternalADC unit is initialized. * @return none *************************************************************************/ void initInternalADC( void ) @@ -130,8 +130,8 @@ * @brief * The adcNotification function handles an ADC conversion complete interrupt. * All channel readings in the FIFO are retrieved. - * @details Inputs: ADC FIFO - * @details Outputs: adcRawReadingsCount, adcRawReadings[] + * @details \b Inputs: ADC FIFO + * @details \b Outputs: adcRawReadingsCount, adcRawReadings[] * @param adc pointer to the ADC1 controller * @param group ADC channel group ID * @return none @@ -147,9 +147,11 @@ /*********************************************************************//** * @brief * The execInternalADC function processes the last set of raw ADC channel - * readings and kicks off the next conversion of ADC channels. - * @details Inputs: adcRawReadingsCount, adcRawReadings[] - * @details Outputs: adcReadings[][], adcReadingsIdx[], adcReadingsTotals[], adcReadingsAvgs[] + * readings and kicks off the next conversion of ADC channels. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if raw readings count exceeds + * ADC channel count + * @details \b Inputs: adcRawReadingsCount, adcRawReadings[] + * @details \b Outputs: adcReadings[][], adcReadingsIdx[], adcReadingsTotals[], adcReadingsAvgs[] * @return none *************************************************************************/ void execInternalADC( void ) @@ -182,11 +184,12 @@ /*********************************************************************//** * @brief * The getIntADCReading function gets the latest average reading for a given - * channel. - * @details Inputs: adcReadingsAvgs[] - * @details Outputs: none + * channel. + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given channel invalid. + * @details \b Inputs: adcReadingsAvgs[] + * @details \b Outputs: none * @param channel adc channel to retrieve a reading for - * @return average reading for the given channel + * @return The rolling averaged reading for the given channel *************************************************************************/ U16 getIntADCReading( INT_ADC_CHANNEL_T channel ) { @@ -208,10 +211,11 @@ * @brief * The getIntADCVoltageConverted function gets the latest average voltage * (converted per transfer function) for a given channel. - * @details Inputs: adcReadingsAvgs[], ADC_CHANNEL_READ_TO_UNITS[] - * @details Outputs: none - * @param channel adc channel to retrieve a converted voltage for - * @return average converted voltage for the given channel + * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if given channel invalid + * @details \b Inputs: adcReadingsAvgs[], ADC_CHANNEL_READ_TO_UNITS[] + * @details \b Outputs: none + * @param channel The ADC channel to retrieve a converted voltage for + * @return The rolling averaged, converted voltage for the given channel *************************************************************************/ F32 getIntADCVoltageConverted( INT_ADC_CHANNEL_T channel ) {