Index: firmware/App/Drivers/CPLD.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -r2fe8834dda9d8f69068c151ff0474d915eef6eb5 --- firmware/App/Drivers/CPLD.c (.../CPLD.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Drivers/CPLD.c (.../CPLD.c) (revision 2fe8834dda9d8f69068c151ff0474d915eef6eb5) @@ -20,33 +20,33 @@ #include "WatchdogMgmt.h" #include "CPLD.h" + +/** + * @addtogroup CPLD + * @{ + */ // ********** private definitions ********** -// GIO port B pin assignments for pins connected to CPLD -#define OFF_REQUEST_GIO_PORT_PIN 0U -#define WD_PET_GIO_PORT_PIN 1U -#define WD_EXP_GIO_PORT_PIN 2U -#define LAMP_GRN_SPI5_PORT_MASK 0x00000200 // (CLK(100) - re-purposed as output GPIO) -#define LAMP_BLU_SPI5_PORT_MASK 0x00010000 // (SIMO[0](99) - re-purposed as output GPIO) -#define LAMP_RED_SPI5_PORT_MASK 0x01000000 // (SOMI[0](98) - re-purposed as output GPIO) +#define WD_PET_GIO_PORT_PIN 1U ///< Watchdog pet GPIO pin number. +#define WD_EXP_GIO_PORT_PIN 2U ///< Watchdog expired GPIO pin number. +#define LAMP_GRN_SPI5_PORT_MASK 0x00000200 ///< Lamp green GPIO port mask (CLK(100) - re-purposed as output GPIO). +#define LAMP_BLU_SPI5_PORT_MASK 0x00010000 ///< Lamp blue GPIO port mask (SIMO[0](99) - re-purposed as output GPIO). +#define LAMP_RED_SPI5_PORT_MASK 0x01000000 ///< Lamp red GPIO port mask (SOMI[0](98) - re-purposed as output GPIO). -// CPLD pin I/O macros -#define GET_WD_EXP() ( PIN_SIGNAL_STATE_T )( gioGetBit( gioPORTB, WD_EXP_GIO_PORT_PIN ) ) +#define GET_WD_EXP() ( PIN_SIGNAL_STATE_T )( gioGetBit( gioPORTB, WD_EXP_GIO_PORT_PIN ) ) ///< Get watchdog expired pin state macro. +#define TGL_WD_PET() gioToggleBit( gioPORTB, WD_PET_GIO_PORT_PIN ) ///< Toggle watchdog GPIO macro. +#define SET_WD_PET() gioSetBit( gioPORTB, WD_PET_GIO_PORT_PIN, PIN_SIGNAL_HIGH ) ///< Set watchdog GPIO macro. +#define CLR_WD_PET() gioSetBit( gioPORTB, WD_PET_GIO_PORT_PIN, PIN_SIGNAL_LOW ) ///< Clear watchdog GPIO macro. -#define TGL_WD_PET() gioToggleBit( gioPORTB, WD_PET_GIO_PORT_PIN ) -#define SET_WD_PET() gioSetBit( gioPORTB, WD_PET_GIO_PORT_PIN, PIN_SIGNAL_HIGH ) - -#define CLR_WD_PET() gioSetBit( gioPORTB, WD_PET_GIO_PORT_PIN, PIN_SIGNAL_LOW ) - -#define SET_GREEN() {mibspiREG5->PC3 |= LAMP_GRN_SPI5_PORT_MASK;} -#define CLR_GREEN() {mibspiREG5->PC3 &= ~LAMP_GRN_SPI5_PORT_MASK;} -#define SET_BLUE() {mibspiREG5->PC3 |= LAMP_BLU_SPI5_PORT_MASK;} -#define CLR_BLUE() {mibspiREG5->PC3 &= ~LAMP_BLU_SPI5_PORT_MASK;} -#define SET_RED() {mibspiREG5->PC3 |= LAMP_RED_SPI5_PORT_MASK;} -#define CLR_RED() {mibspiREG5->PC3 &= ~LAMP_RED_SPI5_PORT_MASK;} - -/************************************************************************* +#define SET_GREEN() {mibspiREG5->PC3 |= LAMP_GRN_SPI5_PORT_MASK;} ///< Set alarm lamp green signal. +#define CLR_GREEN() {mibspiREG5->PC3 &= ~LAMP_GRN_SPI5_PORT_MASK;} ///< Clear alarm lamp green signal. +#define SET_BLUE() {mibspiREG5->PC3 |= LAMP_BLU_SPI5_PORT_MASK;} ///< Set alarm lamp blue signal. +#define CLR_BLUE() {mibspiREG5->PC3 &= ~LAMP_BLU_SPI5_PORT_MASK;} ///< Clear alarm lamp blue signal. +#define SET_RED() {mibspiREG5->PC3 |= LAMP_RED_SPI5_PORT_MASK;} ///< Set alarm lamp red signal. +#define CLR_RED() {mibspiREG5->PC3 &= ~LAMP_RED_SPI5_PORT_MASK;} ///< Clear alarm lamp red signal. + +/*********************************************************************//** * @brief initCPLD * The initCPLD function initializes the CPLD module. * @details @@ -64,8 +64,8 @@ CLR_RED(); CLR_BLUE(); } - -/************************************************************************* + +/*********************************************************************//** * @brief toggleCPLDWatchdog * The toggleCPLDWatchdog function toggles the watchdog pet signal to CPLD. * @details @@ -77,27 +77,26 @@ { TGL_WD_PET(); } - -/************************************************************************* + +/*********************************************************************//** * @brief getCPLDWatchdogExpired - * The getCPLDWatchdogExpired function determines the current signal level \n + * The getCPLDWatchdogExpired function determines the current signal level * on the watchdog expired pin from the CPLD. * @details * Inputs : Signal from CPLD on watchdog expired pin. * Outputs : none - * @return level : (LOW or HIGH) + * @return level (LOW or HIGH) *************************************************************************/ PIN_SIGNAL_STATE_T getCPLDWatchdogExpired( void ) { PIN_SIGNAL_STATE_T level = GET_WD_EXP(); return level; } - -/************************************************************************* + +/*********************************************************************//** * @brief setCPLDLampGreen - * The setCPLDLampGreen function sets the alarm lamp green signal to CPLD \n - * to given level. + * The setCPLDLampGreen function sets the alarm lamp green signal to CPLD to given level. * @details * Inputs : none * Outputs : alarm lamp green signal set to given level. @@ -115,11 +114,10 @@ CLR_GREEN(); } } - -/************************************************************************* + +/*********************************************************************//** * @brief setCPLDLampBlue - * The setCPLDLampBlue function sets the alarm lamp blue signal to CPLD \n - * to given level. + * The setCPLDLampBlue function sets the alarm lamp blue signal to CPLD to given level. * @details * Inputs : none * Outputs : alarm lamp blue signal set to given level. @@ -137,11 +135,10 @@ CLR_BLUE(); } } - -/************************************************************************* + +/*********************************************************************//** * @brief setCPLDLampRed - * The setCPLDLampRed function sets the alarm lamp red signal to CPLD \n - * to given level. + * The setCPLDLampRed function sets the alarm lamp red signal to CPLD to given level. * @details * Inputs : none * Outputs : alarm lamp red signal set to given level. @@ -158,4 +155,6 @@ { CLR_RED(); } -} +} + +/**@}*/