Index: firmware/App/Modes/ModeInitPOST.c =================================================================== diff -u -r28dd261825b2c742df73042ac2902db0c8f6f2b7 -r1fb58baf6e7e3d1f054b2a3634e233da7609dad9 --- firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 28dd261825b2c742df73042ac2902db0c8f6f2b7) +++ firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 1fb58baf6e7e3d1f054b2a3634e233da7609dad9) @@ -8,7 +8,7 @@ * @file ModeInitPOST.c * * @author (last) Sean Nash -* @date (last) 29-May-2020 +* @date (last) 26-Aug-2020 * * @author (original) Dara Navaei * @date (original) 05-Nov-2019 @@ -38,22 +38,21 @@ // ********** private data ********** -static HD_POST_STATE_T postState = POST_STATE_START; -static BOOL postCompleted = FALSE; -static BOOL postPassed = FALSE; -static BOOL tempPOSTPassed = TRUE; +static HD_POST_STATE_T postState = POST_STATE_START; ///< Current state of initialize and POST mode. +static BOOL postCompleted = FALSE; ///< Flag indicates whether POST is completed. +static BOOL postPassed = FALSE; ///< Flag indicates all POST tests passed. +static BOOL tempPOSTPassed = TRUE; ///< Flag indicates all POST tests have passed so far. // ********** private function prototypes ********** static HD_POST_STATE_T handlePOSTStatus( SELF_TEST_STATUS_T testStatus ); -/************************************************************************* - * @brief initInitAndPOSTMode +/*********************************************************************//** + * @brief * The initInitAndPOSTMode function initializes the Initialize & POST Mode module. * @details * Inputs : none * Outputs : Initialize & POST Mode module initialized. - * @param none * @return none *************************************************************************/ void initInitAndPOSTMode( void ) @@ -64,27 +63,25 @@ tempPOSTPassed = TRUE; } -/************************************************************************* - * @brief transitionToInitAndPOSTMode - * The transitionToInitAndPOSTMode function prepares for transition to\n +/*********************************************************************//** + * @brief + * The transitionToInitAndPOSTMode function prepares for transition to * initialize & POST mode. * @details * Inputs : none - * Outputs : - * @param none + * Outputs : none * @return none *************************************************************************/ void transitionToInitAndPOSTMode( void ) { } -/************************************************************************* - * @brief execInitAndPOSTMode +/*********************************************************************//** + * @brief * The execInitAndPOSTMode function executes the Initialize & POST Mode state machine. * @details - * Inputs : none - * Outputs : - * @param none + * Inputs : postState + * Outputs : postState, postPassed, postCompleted * @return current state (sub-mode) *************************************************************************/ U32 execInitAndPOSTMode( void ) @@ -195,45 +192,43 @@ return postState; } -/************************************************************************* - * @brief isPOSTCompleted - * The isPOSTCompleted function determines whether all HD POST have \n - * been run and completed. If true, call the isPOSTPassed() to see final \n +/*********************************************************************//** + * @brief + * The isPOSTCompleted function determines whether all HD POST have + * been run and completed. If true, call the isPOSTPassed() to see final * result (pass/fail). * @details * Inputs : postCompleted * Outputs : none - * @param none * @return true if all HD POST tests have completed, false if not *************************************************************************/ BOOL isPOSTCompleted( void ) { return postCompleted; } -/************************************************************************* - * @brief isPOSTPassed - * The isPOSTPassed function determines whether all HD POST have passed. \n +/*********************************************************************//** + * @brief + * The isPOSTPassed function determines whether all HD POST have passed. * Call this function after POST is complete (call isPOSTCompleted function). * @details * Inputs : postPassed * Outputs : none - * @param none * @return true if all HD POST tests have passed, false if not *************************************************************************/ BOOL isPOSTPassed( void ) { return postPassed; } -/************************************************************************* - * @brief handlePOSTStatus +/*********************************************************************//** + * @brief * The handlePOSTStatus function handles a status result returned by a * POST function. * @details * Inputs : postPassed * Outputs : none - * @param testStatus + * @param testStatus status reported by last test * @return recommended next POST state *************************************************************************/ static HD_POST_STATE_T handlePOSTStatus( SELF_TEST_STATUS_T testStatus )