Index: firmware/App/Drivers/SafetyShutdown.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -r2fe8834dda9d8f69068c151ff0474d915eef6eb5 --- firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision 2fe8834dda9d8f69068c151ff0474d915eef6eb5) @@ -27,22 +27,21 @@ // ********** private definitions ********** -// pin I/O macros -#define SAFETY_SPI1_PORT_MASK 0x00000010 // (CS[4] - re-purposed as output GPIO) -#define SET_SAFETY_SHUTDOWN() {mibspiREG1->PC3 |= SAFETY_SPI1_PORT_MASK;} -#define CLR_SAFETY_SHUTDOWN() {mibspiREG1->PC3 &= ~SAFETY_SPI1_PORT_MASK;} +#define SAFETY_SPI1_PORT_MASK 0x00000010 ///< Safety shutdown GPIO port mask (CS[4] - re-purposed as output GPIO). +#define SET_SAFETY_SHUTDOWN() {mibspiREG1->PC3 |= SAFETY_SPI1_PORT_MASK;} ///< Set safety shutdown GPIO macro. +#define CLR_SAFETY_SHUTDOWN() {mibspiREG1->PC3 &= ~SAFETY_SPI1_PORT_MASK;} ///< Clear safety shutdown GPIO macro. // ********** private definitions ********** -static BOOL safetyShutdownActivated = FALSE; ///< Status of safety shutdown signal. -static BOOL safetyShutdownOverrideResetState = FALSE; ///< Natural status of safety shutdown signal. Used to restore state on override reset. +static BOOL safetyShutdownActivated = FALSE; ///< Status of safety shutdown signal. +static BOOL safetyShutdownOverrideResetState = FALSE; ///< Natural status of safety shutdown signal. Used to restore state on override reset. /*********************************************************************//** * @brief - * The initSafetyShutdown function initializes the Safety Shutdown module. + * The initSafetyShutdown function initializes the safety shutdown module. * @details * Inputs : none - * Outputs : Safety Shutdown module signal output set to initial state. + * Outputs : Safety shutdown module signal output set to initial state. * @return none *************************************************************************/ void initSafetyShutdown( void ) @@ -55,7 +54,7 @@ * The activateSafetyShutdown function activates the safety shutdown signal. * @details * Inputs : none - * Outputs : Safety Shutdown signal output set to active state. + * Outputs : Safety shutdown signal output set to active state. * @return none *************************************************************************/ void activateSafetyShutdown( void ) @@ -65,7 +64,7 @@ /*********************************************************************//** * @brief - * The isSafetyShutdownActivated function returns whether the safety shutdown \n + * The isSafetyShutdownActivated function returns whether the safety shutdown * signal has been activated. * @details * Inputs : none @@ -79,8 +78,7 @@ /*********************************************************************//** * @brief - * The testSetSafetyShutdownOverride function overrides the HD safety \n - * shutdown. + * The testSetSafetyShutdownOverride function overrides the HD safety shutdown. * @details * Inputs : none * Outputs : HD safety shutdown overridden @@ -113,7 +111,7 @@ /*********************************************************************//** * @brief - * The testResetSafetyShutdownOverride function resets the override of the \n + * The testResetSafetyShutdownOverride function resets the override of the * HD safety shutdown. * @details * Inputs : none