Index: firmware/App/Tasks/TaskBG.c =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -r90334b92aa0ebe0c6795e649abf82ff808036004 --- firmware/App/Tasks/TaskBG.c (.../TaskBG.c) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Tasks/TaskBG.c (.../TaskBG.c) (revision 90334b92aa0ebe0c6795e649abf82ff808036004) @@ -17,16 +17,21 @@ #include "gio.h" -#include "WatchdogMgmt.h" #include "TaskTimer.h" +#include "WatchdogMgmt.h" + +/** + * @addtogroup TaskBG + * @{ + */ -/************************************************************************* - * @brief taskBackground - * The taskBackground function handles the idle Background Task loop. - * Calls the Watchdog Mgmt. and NonVolatile Data services. +/*********************************************************************//** + * @brief + * The taskBackground function handles the idle background task loop. * @details * Inputs : none - * Outputs : Executive for watchdog mgmt. and non-volatile data services called. + * Outputs : Executes the watchdog manangement service + * return none *************************************************************************/ void taskBackground( void ) { @@ -39,3 +44,4 @@ } } +/**@}*/ Index: firmware/App/Tasks/TaskBG.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -r90334b92aa0ebe0c6795e649abf82ff808036004 --- firmware/App/Tasks/TaskBG.h (.../TaskBG.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Tasks/TaskBG.h (.../TaskBG.h) (revision 90334b92aa0ebe0c6795e649abf82ff808036004) @@ -19,9 +19,19 @@ #define __TASK_BACKGROUND_H__ #include "DGCommon.h" + +/** + * @defgroup TaskBG TaskBG + * @brief Background task module. + * + * @addtogroup TaskBG + * @{ + */ + +// ********** public function prototypes ********** -// public function prototypes +void taskBackground( void ); + +/**@}*/ -void taskBackground( void ); - #endif Index: firmware/App/Tasks/TaskGeneral.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -r90334b92aa0ebe0c6795e649abf82ff808036004 --- firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Tasks/TaskGeneral.c (.../TaskGeneral.c) (revision 90334b92aa0ebe0c6795e649abf82ff808036004) @@ -25,24 +25,29 @@ #include "ROPump.h" #include "SystemComm.h" #include "SystemCommMessages.h" -#include "WatchdogMgmt.h" #include "TaskGeneral.h" +#include "WatchdogMgmt.h" +/** + * @addtogroup TaskGeneral + * @{ + */ + #ifdef TASK_TIMING_OUTPUT_ENABLED #include "mibspi.h" #define TASK_TIMING_TEST_PIN_SPI1_PORT_MASK 0x00000020 // (CS5 - re-purposed as output GPIO) #define SET_TASK_ON() { mibspiREG3->PC3 |= TASK_TIMING_TEST_PIN_SPI1_PORT_MASK; } #define SET_TASK_OFF() { mibspiREG3->PC3 &= ~TASK_TIMING_TEST_PIN_SPI1_PORT_MASK; } #endif -/************************************************************************* - * @brief taskGeneral - * The taskGeneral function handles the scheduled General Task interrupt.\n - * Calls the executive functions for most monitors and controllers, the\n - * operation modes, the system communications, and alarms.\n +/*********************************************************************//** + * @brief + * The taskGeneral function handles the scheduled general task interrupt. + * Calls the executive functions for most monitors and controllers, the + * operation modes, the system communications, and alarms. * @details * Inputs : none - * Outputs : Executive for the TBD called. + * Outputs : Executed all general task functions. * @return none *************************************************************************/ void taskGeneral( void ) @@ -83,4 +88,5 @@ // SET_TASK_OFF(); // TODO - uncomment and define TASK_TIMING_OUTPUT_ENABLED to monitor this tasks timing #endif } - + +/**@}*/ Index: firmware/App/Tasks/TaskGeneral.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -r90334b92aa0ebe0c6795e649abf82ff808036004 --- firmware/App/Tasks/TaskGeneral.h (.../TaskGeneral.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Tasks/TaskGeneral.h (.../TaskGeneral.h) (revision 90334b92aa0ebe0c6795e649abf82ff808036004) @@ -20,12 +20,22 @@ #include "DGCommon.h" -// public definitions +/** + * @defgroup TaskGeneral TaskGeneral + * @brief General task module. + * + * @addtogroup TaskGeneral + * @{ + */ + +// ********** public definitions ********** + +#define TASK_GENERAL_INTERVAL (50) ///< Interval in ms that general task runs at. -#define TASK_GENERAL_INTERVAL (50) +// ********** public function prototypes ********** -// public function prototypes - void taskGeneral( void ); + +/**@}*/ #endif Index: firmware/App/Tasks/TaskPriority.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -r90334b92aa0ebe0c6795e649abf82ff808036004 --- firmware/App/Tasks/TaskPriority.c (.../TaskPriority.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Tasks/TaskPriority.c (.../TaskPriority.c) (revision 90334b92aa0ebe0c6795e649abf82ff808036004) @@ -18,8 +18,10 @@ #include "gio.h" #include "Accel.h" +#include "ConductivitySensors.h" #include "DrainPump.h" #include "FPGA.h" +#include "Heaters.h" #include "InternalADC.h" #include "LoadCell.h" #include "Pressures.h" @@ -28,20 +30,22 @@ #include "TemperatureSensors.h" #include "Valves.h" #include "WatchdogMgmt.h" -#include "TemperatureSensors.h" -#include "ConductivitySensors.h" -#include "Heaters.h" +/** + * @addtogroup TaskPriority + * @{ + */ + #ifdef TASK_TIMING_OUTPUT_ENABLED #include "mibspi.h" #define TASK_TIMING_TEST_PIN_SPI1_PORT_MASK 0x00000020 // (CS5 - re-purposed as output GPIO) #define SET_TASK_ON() { mibspiREG3->PC3 |= TASK_TIMING_TEST_PIN_SPI1_PORT_MASK; } #define SET_TASK_OFF() { mibspiREG3->PC3 &= ~TASK_TIMING_TEST_PIN_SPI1_PORT_MASK; } #endif -/************************************************************************* - * @brief taskPriority - * The taskPriority function handles the scheduled Priority Task interrupt. +/*********************************************************************//** + * @brief + * The taskPriority function handles the scheduled priority task interrupt. * Calls the executive functions for FPGA, pumps, valves, and buttons. * @details * Inputs : none @@ -100,4 +104,5 @@ // SET_TASK_OFF(); // TODO - uncomment and define TASK_TIMING_OUTPUT_ENABLED to monitor this tasks timing #endif } - + +/**@}*/ Index: firmware/App/Tasks/TaskPriority.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -r90334b92aa0ebe0c6795e649abf82ff808036004 --- firmware/App/Tasks/TaskPriority.h (.../TaskPriority.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Tasks/TaskPriority.h (.../TaskPriority.h) (revision 90334b92aa0ebe0c6795e649abf82ff808036004) @@ -20,12 +20,22 @@ #include "DGCommon.h" -// public definitions +/** + * @defgroup TaskPriority TaskPriority + * @brief Priority task module. + * + * @addtogroup TaskPriority + * @{ + */ + +// ********** public definitions ********** -#define TASK_PRIORITY_INTERVAL (10) // in ms +#define TASK_PRIORITY_INTERVAL (10) ///< Interval in ms that priority task runs at. -// public function prototypes +// ********** public function prototypes ********** void taskPriority( void ); + +/**@}*/ #endif Index: firmware/App/Tasks/TaskTimer.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -r90334b92aa0ebe0c6795e649abf82ff808036004 --- firmware/App/Tasks/TaskTimer.c (.../TaskTimer.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Tasks/TaskTimer.c (.../TaskTimer.c) (revision 90334b92aa0ebe0c6795e649abf82ff808036004) @@ -17,12 +17,17 @@ #include "gio.h" -#include "WatchdogMgmt.h" -#include "Timers.h" #include "TaskTimer.h" +#include "Timers.h" +#include "WatchdogMgmt.h" + +/** + * @addtogroup TaskPriority + * @{ + */ -/************************************************************************* - * @brief taskTimer +/*********************************************************************//** + * @brief * The taskTimer function handles the scheduled Timer Task interrupt. * Calls the Timers executive to maintain a 1ms timer counter to * support timer and timeout functions. @@ -46,3 +51,5 @@ // SET_TASK_OFF(); // TODO - uncomment and define TASK_TIMING_OUTPUT_ENABLED to monitor this tasks timing #endif } + +/**@}*/ Index: firmware/App/Tasks/TaskTimer.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -r90334b92aa0ebe0c6795e649abf82ff808036004 --- firmware/App/Tasks/TaskTimer.h (.../TaskTimer.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Tasks/TaskTimer.h (.../TaskTimer.h) (revision 90334b92aa0ebe0c6795e649abf82ff808036004) @@ -18,12 +18,22 @@ #ifndef __TASK_TIMER_H__ #define __TASK_TIMER_H__ -// public definitions +/** + * @defgroup TaskTimer TaskTimer + * @brief Timer task module. + * + * @addtogroup TaskTimer + * @{ + */ + +// ********** public definitions ********** -#define TASK_TIMER_INTERVAL (1) +#define TASK_TIMER_INTERVAL (1) ///< Interval in ms that timer task runs at. -// public function prototypes +// ********** public function prototypes ********** void taskTimer( void ); + +/**@}*/ #endif