Index: firmware/App/Monitors/Battery.c =================================================================== diff -u -r78d196593cdcc9c3cd7166f02a99a7408a3e0b32 -rbbc62d810da9b094ea4f0fc765e1586ed37f0b34 --- firmware/App/Monitors/Battery.c (.../Battery.c) (revision 78d196593cdcc9c3cd7166f02a99a7408a3e0b32) +++ firmware/App/Monitors/Battery.c (.../Battery.c) (revision bbc62d810da9b094ea4f0fc765e1586ed37f0b34) @@ -19,6 +19,7 @@ #include "BatteryDriver.h" #include "Messaging.h" #include "PersistentAlarm.h" +#include "TestSupport.h" #include "Timers.h" /** @@ -29,29 +30,28 @@ // ********** private definitions ********** #define BATTERY_MONITOR_INTERVAL_MS 247 ///< Battery monitor interval in ms. -#define BATTERY_COMM_FAULT_COUNT 5 ///< Battery communication fault persistent count before alarming. +#define BATTERY_COMM_FAULT_COUNT 5 ///< Battery communication fault persistent count before alarming. #define BATTERY_COMM_FAULT_TIMER ( 10 * SEC_PER_MIN * MS_PER_SECOND ) ///< Battery communication fault persistence timer. #define BATTERY_PACK_ERROR_BITS 0x0F ///< Error codes are in the first byte. -#define BATTERY_MIN_CAPACITY_MAH 1950.0F ///< Minimum battery capacity for starting a treatment. - +#define BATTERY_MIN_CAPACITY_MAH 1950U ///< Minimum battery capacity for starting a treatment. +#define BATTERY_CHARGER_ERROR_BITS 0x08 ///< Error codes are in the first byte of third bit. +#define BATTERY_CHARGER_FAULTY_ERROR_BITS 0XFF ///< Error codes are in the first and second byte. // ********** private data ********** -static const U32 BATT_STATUS_ERROR_PERSIST_MS = ( 5 * MS_PER_SECOND ); ///< Persist time in ms for battery pack status error condition. -static U32 lastBatteryMonitorTime; ///< Previous battery monitor time. -static OVERRIDE_U32_T batteryStatus; ///< Battery status -static OVERRIDE_U32_T batteryChargerStatus; ///< Battery charger status -static OVERRIDE_U32_T batteryRemCapacity_mAh; ///< Battery pack remaining capacity (in mAh). -static BATTERY_MANAGEMENT_ENUM_T current_BM_value; ///< Index for which battery data to read now. -static BATTERY_DATA_PAYLOAD_T BatteryData; ///< Record with latest battery data. -static BATTERY_DATA_PAYLOAD_T batterydata; ///< Record with latest battery data. +static const U32 BATT_STATUS_ERROR_PERSIST_MS = ( 5 * MS_PER_SECOND ); ///< Persist time in ms for battery pack status error condition. +static U32 lastBatteryMonitorTime; ///< Previous battery monitor time. +static OVERRIDE_U32_T batteryRegisterOverrides[ NUM_OF_BATTERY_REGISTERS-1 ]; ///< Battery register data and overrides. +static BATTERY_MANAGEMENT_ENUM_T currentBmValue; ///< Index for which battery data to read now. +static BATTERY_DATA_PAYLOAD_T batteryData; ///< Record with latest battery data. // ********** private function prototypes ********** -static U32 getBatteryRemainingCapacity_mAh( void ); -static U32 getBatteryStatus( void ); -static U32 getBatteryChargerStatus( void ); +static void initBatteryRegisterOverrides( void ); +static void setBatteryRegisterData( BATTERY_MANAGEMENT_ENUM_T registerSel, U32 data ); +static U32 getBatteryRegisterValue( BATTERY_MANAGEMENT_ENUM_T registerSel ); static void getBatteryManagementData( void ); static void publishBatteryDataPayload( void ); +static void checkPersistentAlarmTrigger( ALARM_ID_T alarmID, BATTERY_MANAGEMENT_ENUM_T registerSel, U08 errorBits ); /*********************************************************************//** * @brief @@ -62,23 +62,12 @@ *************************************************************************/ void initBattery( void ) { - initsetupI2CDriver(); - current_BM_value = BEGINNING_OF_LIST; + initSetupI2cDriver(); + currentBmValue = BEGINNING_OF_LIST; lastBatteryMonitorTime = 0; - batteryStatus.data = 0; - batteryStatus.ovData = 0; - batteryStatus.ovInitData = 0; - batteryStatus.override = OVERRIDE_RESET; - batteryChargerStatus.data = 0; - batteryChargerStatus.ovData = 0; - batteryChargerStatus.ovInitData = 0; - batteryChargerStatus.override = OVERRIDE_RESET; - batteryRemCapacity_mAh.data = 0; - batteryRemCapacity_mAh.ovData = 0; - batteryRemCapacity_mAh.ovInitData = 0; - batteryRemCapacity_mAh.override = OVERRIDE_RESET; - memset( &BatteryData, 0, sizeof( BATTERY_DATA_PAYLOAD_T ) ); - memset( &batterydata, 0, sizeof( BATTERY_DATA_PAYLOAD_T ) ); + initBatteryRegisterOverrides(); + memset( &batteryData, 0, sizeof( BATTERY_DATA_PAYLOAD_T ) ); + // Initialize persistent alarm for battery pack status error initPersistentAlarm( ALARM_ID_TD_BATTERY_PACK_ERROR_DETECTED, 0, BATT_STATUS_ERROR_PERSIST_MS ); // Initialize bad message CRC time windowed count @@ -87,78 +76,101 @@ /*********************************************************************//** * @brief - * The execBatteryMonitor function monitors the battery status by reading - * battery data in a round robin fashion and publishing the results. - * @details \b Inputs: lastBatteryMonitorTime - * @details \b Outputs: lastBatteryMonitorTime + * The initBatteryRegisterOverrides function initializes the battery register + * data/override records. + * @details \b Inputs: none + * @details \b Outputs: batteryRegisterOverrides[] * @return none *************************************************************************/ -void execBatteryMonitor( void ) +static void initBatteryRegisterOverrides( void ) { - if ( TRUE == didTimeout( lastBatteryMonitorTime, BATTERY_MONITOR_INTERVAL_MS ) ) + U32 registerIdx; + + for ( registerIdx = 0; registerIdx < NUM_OF_BATTERY_REGISTERS-1; registerIdx++ ) { - lastBatteryMonitorTime = getMSTimerCount(); - getBatteryManagementData(); + batteryRegisterOverrides[ registerIdx ].data = 0U; + batteryRegisterOverrides[ registerIdx ].ovData = 0U; + batteryRegisterOverrides[ registerIdx ].ovInitData = 0U; + batteryRegisterOverrides[ registerIdx ].override = OVERRIDE_RESET; } } /*********************************************************************//** * @brief - * The getBatteryChargerStatus function returns the latest battery - * charger status. - * @details \b Inputs: batteryChargerStatus - * @details \b Outputs: none - * @return latest battery charger status value. + * The setBatteryRegisterData function updates the raw battery register data. + * @details \b Inputs: batteryRegisterOverrides[] + * @details \b Outputs: batteryRegisterOverrides[] + * @param registerSel battery register to update + * @param data value to store for the given register + * @return none *************************************************************************/ -static U32 getBatteryChargerStatus( void ) +static void setBatteryRegisterData( BATTERY_MANAGEMENT_ENUM_T registerSel, U32 data ) { - U32 result = batteryChargerStatus.data; - - if ( OVERRIDE_KEY == batteryChargerStatus.override ) + if ( registerSel < NUM_OF_BATTERY_REGISTERS-1 ) { - result = batteryChargerStatus.ovData; + batteryRegisterOverrides[ registerSel ].data = data; } - - return result; } /*********************************************************************//** * @brief - * The getBatteryStatus function returns the latest battery pack status. - * @details \b Inputs: batteryStatus + * The getBatteryRegisterValue function returns the current battery register + * value after applying any active override. + * @details \b Inputs: batteryRegisterOverrides[] * @details \b Outputs: none - * @return latest battery pack status value. + * @param registerSel battery register to read + * @return current battery register value *************************************************************************/ -static U32 getBatteryStatus( void ) +static U32 getBatteryRegisterValue( BATTERY_MANAGEMENT_ENUM_T registerSel ) { - U32 result = batteryStatus.data; + U32 result = 0U; - if ( OVERRIDE_KEY == batteryStatus.override ) + if ( registerSel < NUM_OF_BATTERY_REGISTERS-1 ) { - result = batteryStatus.ovData; + result = getU32OverrideValue( &batteryRegisterOverrides[ registerSel ] ); } return result; } /*********************************************************************//** * @brief - * The getBatteryRemainingCapacity_mAh function returns the latest battery - * remaining capacity in mAh. - * @details \b Inputs: batteryRemCapacity_mAh - * @details \b Outputs: none - * @return latest battery remaining capacity in mAh. + * The checkPersistentAlarmTrigger function checks whether the specified + * battery register contains any error bits and triggers a persistent alarm + * when the condition remains active for the configured persistence period. + * @details \b Inputs: batteryRegisterOverrides, persistent alarm state + * @details \b Outputs: Alarm generated if error condition persists + * @param alarmID alarm identifier associated with the error condition + * @param registerSel battery register to evaluate + * @param errorBits bit mask containing the error bits to monitor + * @return none *************************************************************************/ -static U32 getBatteryRemainingCapacity_mAh( void ) +static void checkPersistentAlarmTrigger( ALARM_ID_T alarmID, BATTERY_MANAGEMENT_ENUM_T registerSel, U08 errorBits ) { - U32 result = batteryRemCapacity_mAh.data; - - if ( OVERRIDE_KEY == batteryRemCapacity_mAh.override ) + if ( registerSel < NUM_OF_BATTERY_REGISTERS-1 ) { - result = batteryRemCapacity_mAh.ovData; + if ( TRUE == isPersistentAlarmTriggered( alarmID, ( getBatteryRegisterValue( registerSel ) & errorBits ) != 0U ) ) + { + SET_ALARM_WITH_2_U32_DATA( alarmID, getBatteryRegisterValue( registerSel ), errorBits ); + } } +} - return result; +/*********************************************************************//** + * @brief + * The execBatteryMonitor function monitors the battery status by reading + * battery data in a round robin fashion and publishing the results. + * @details \b Inputs: lastBatteryMonitorTime + * @details \b Outputs: lastBatteryMonitorTime + * @return none + *************************************************************************/ +void execBatteryMonitor( void ) +{ + if ( TRUE == didTimeout( lastBatteryMonitorTime, BATTERY_MONITOR_INTERVAL_MS ) ) + { + lastBatteryMonitorTime = getMSTimerCount(); + getBatteryManagementData(); + } } /*********************************************************************//** @@ -170,80 +182,110 @@ * pack status error bits are set. * @details \b Alarm: ALARM_ID_TD_SOFTWARE_FAULT if an invalid battery * management data state is detected. - * @details \b Inputs: current_BM_value, BatteryData - * @details \b Outputs: current_BM_value, batteryRemCapacity_mAh, - * batteryStatus, batteryChargerStatus, BatteryData + * @details \b Inputs: currentBmValue, batteryRegisterOverrides[] + * @details \b Outputs: currentBmValue, batteryRegisterOverrides[] * @return none *************************************************************************/ -static void getBatteryManagementData(void) +static void getBatteryManagementData( void ) { + U32 responseData; + // Increment the position in the enum. Starting value is BEGINNING_OF_LIST (0), so on the first // cycle through this function it will be set to the first valid position (1) - current_BM_value += 1; + currentBmValue += 1; - switch( current_BM_value ) + switch( currentBmValue ) { case BATTERY_PACK_REMAINING_CAPACITY: - getBatteryData (BATTERY_PACK_ADDRESS, BATTERY_PACK_REMAINING_CAPACITY, &batterydata.RemainingCapacity ); - batteryRemCapacity_mAh.data = batterydata.RemainingCapacity; + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_PACK_ADDRESS, BATTERY_PACK_REMAINING_CAPACITY, &responseData ) ) + { + setBatteryRegisterData( BATTERY_PACK_REMAINING_CAPACITY, responseData ); + } break; case BATTERY_PACK_BATTERY_STATUS: - getBatteryData ( BATTERY_PACK_ADDRESS, BATTERY_PACK_BATTERY_STATUS, &batterydata.BatteryStatus ); - batteryStatus.data = batterydata.BatteryStatus; - if ( ( TRUE == isPersistentAlarmTriggered( ALARM_ID_TD_BATTERY_PACK_ERROR_DETECTED, ( getBatteryStatus() & BATTERY_PACK_ERROR_BITS ) != 0 ) ) ) + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_PACK_ADDRESS, BATTERY_PACK_BATTERY_STATUS, &responseData ) ) { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_TD_BATTERY_PACK_ERROR_DETECTED, getBatteryStatus(), BATTERY_PACK_ERROR_BITS ); + setBatteryRegisterData( BATTERY_PACK_BATTERY_STATUS, responseData ); + checkPersistentAlarmTrigger( ALARM_ID_TD_BATTERY_PACK_ERROR_DETECTED, BATTERY_PACK_BATTERY_STATUS, BATTERY_PACK_ERROR_BITS ); } break; case BATTERY_PACK_RELATIVE_STATE_OF_CHARGE: - getBatteryData ( BATTERY_PACK_ADDRESS, BATTERY_PACK_RELATIVE_STATE_OF_CHARGE, &batterydata.RelativeStateOfCharge ); - break; + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_PACK_ADDRESS, BATTERY_PACK_RELATIVE_STATE_OF_CHARGE, &responseData ) ) + { + setBatteryRegisterData( BATTERY_PACK_RELATIVE_STATE_OF_CHARGE, responseData ); + } + break; case BATTERY_PACK_FULL_CHARGE_CAPACITY: - getBatteryData ( BATTERY_PACK_ADDRESS, BATTERY_PACK_FULL_CHARGE_CAPACITY, &batterydata.FullChargeCapacity ); + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_PACK_ADDRESS, BATTERY_PACK_FULL_CHARGE_CAPACITY, &responseData ) ) + { + setBatteryRegisterData( BATTERY_PACK_FULL_CHARGE_CAPACITY, responseData ); + } break; case BATTERY_CHARGER_STATUS: - if ( TRUE == getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_STATUS, &batterydata.BatteryChargerStatus ) ) + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_STATUS, &responseData ) ) { - batteryChargerStatus.data = batterydata.BatteryChargerStatus; + setBatteryRegisterData( BATTERY_CHARGER_STATUS, responseData ); + checkPersistentAlarmTrigger( ALARM_ID_TD_BATTERY_CHARGER_ERROR_DETECTED, BATTERY_CHARGER_STATUS, BATTERY_CHARGER_ERROR_BITS ); } break; case BATTERY_CHARGER_TS: - getBatteryData ( BATTERY_PACK_ADDRESS, BATTERY_CHARGER_TS, &batterydata.TS ); - batterydata.TS = (batterydata.TS * 1024.0f) / 100.0F; + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_TS, &responseData ) ) + { + setBatteryRegisterData( BATTERY_CHARGER_TS, (U32)( ( responseData * 1024.0F ) / 100.0F ) ); + } break; case BATTERY_CHARGER_VBAT: - getBatteryData( BATTERY_PACK_ADDRESS, BATTERY_CHARGER_VBAT, &batterydata.VBAT ); - batterydata.VBAT = batterydata.VBAT * 2U; + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_VBAT, &responseData ) ) + { + setBatteryRegisterData( BATTERY_CHARGER_VBAT, (U32)( responseData * 2U ) ); + } break; case BATTERY_CHARGER_VSYS: - getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_VSYS, &batterydata.VSYS ); - batterydata.VSYS = batterydata.VSYS * 2U; + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_VSYS, &responseData ) ) + { + setBatteryRegisterData( BATTERY_CHARGER_VSYS, (U32)( responseData * 2U ) ); + } break; case BATTERY_CHARGER_FAULT: - getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_FAULT, &batterydata.FaultStatus ); + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_FAULT, &responseData ) ) + { + setBatteryRegisterData( BATTERY_CHARGER_FAULT, responseData ); + checkPersistentAlarmTrigger( ALARM_ID_TD_BATTERY_CHARGER_ERROR_DETECTED, BATTERY_CHARGER_FAULT, BATTERY_CHARGER_FAULTY_ERROR_BITS ); + } break; case BATTERY_CHARGER_CURRENT: - getBatteryData( BATTERY_PACK_ADDRESS, BATTERY_CHARGER_CURRENT, &batterydata.IBAT ); - batterydata.IBAT = batterydata.IBAT * 2U; - current_BM_value += 1; /// To avoid default case and execute the publish data in a next iteration + responseData = 0U; + if ( TRUE == getBatteryData( BATTERY_CHARGER_ADDRESS, BATTERY_CHARGER_CURRENT, &responseData ) ) + { + setBatteryRegisterData( BATTERY_CHARGER_CURRENT, (U32)( responseData * 2U ) ); + } break; case BATTERY_END_OF_LIST_TIME_TO_PUBLISH: - current_BM_value = BEGINNING_OF_LIST; + currentBmValue = BEGINNING_OF_LIST; publishBatteryDataPayload(); break; default: - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_TD_SOFTWARE_FAULT, SW_FAULT_ID_INVALID_BATTERY_MANAGEMENT_DATA_STATE, current_BM_value ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_TD_SOFTWARE_FAULT, SW_FAULT_ID_INVALID_BATTERY_MANAGEMENT_DATA_STATE, currentBmValue ); break; } } @@ -252,90 +294,58 @@ * @brief * The isBatteryCharged function checks if the battery has sufficient * charge to allow starting a treatment. - * @details \b Inputs: batteryRemCapacity_mAh + * @details \b Inputs: batteryRegisterOverrides[] * @details \b Outputs: none * @return TRUE if battery has sufficient charge, otherwise FALSE *************************************************************************/ BOOL isBatteryCharged( void ) { - return ( getBatteryRemainingCapacity_mAh() > BATTERY_MIN_CAPACITY_MAH ? TRUE : FALSE ); + return ( getBatteryRegisterValue( BATTERY_PACK_REMAINING_CAPACITY ) > BATTERY_MIN_CAPACITY_MAH ? TRUE : FALSE ); } /*********************************************************************//** * @brief * The publishBatteryDataPayload function updates and publishes the battery * data payload over CAN. * @details \b Message \b Sent: MSG_ID_TD_BATTERY_DATA - * @details \b Inputs: BatteryData, batteryRemCapacity_mAh, batteryStatus, - * batteryChargerStatus, batteryI2CStatusRegister - * @details \b Outputs: BatteryData + * @details \b Inputs: batteryRegisterOverrides[], batteryData + * @details \b Outputs: batteryData * @return none *************************************************************************/ static void publishBatteryDataPayload( void ) { - BatteryData.RemainingCapacity = getBatteryRemainingCapacity_mAh(); - BatteryData.BatteryStatus = getBatteryStatus(); - BatteryData.BatteryChargerStatus = getBatteryChargerStatus(); - BatteryData.BatteryI2CStatus = getI2CStatusRegister( FALSE ); - BatteryData.FaultStatus = batterydata.FaultStatus; - BatteryData.FullChargeCapacity = batterydata.FullChargeCapacity; - BatteryData.IBAT = batterydata.IBAT; - BatteryData.RelativeStateOfCharge = batterydata.RelativeStateOfCharge; - BatteryData.TS = batterydata.TS; - BatteryData.VBAT = batterydata.VBAT; - BatteryData.VSYS = batterydata.VSYS; - broadcastData( MSG_ID_TD_BATTERY_DATA, COMM_BUFFER_OUT_CAN_TD_BROADCAST, (U08*)&BatteryData, sizeof( BATTERY_DATA_PAYLOAD_T ) ); + batteryData.remainingCapacity = getBatteryRegisterValue( BATTERY_PACK_REMAINING_CAPACITY ); + batteryData.batteryStatus = getBatteryRegisterValue( BATTERY_PACK_BATTERY_STATUS ); + batteryData.batteryChargerStatus = getBatteryRegisterValue( BATTERY_CHARGER_STATUS ); + batteryData.batteryI2cStatus = getI2cStatusRegister( FALSE ); + batteryData.faultStatus = getBatteryRegisterValue( BATTERY_CHARGER_FAULT ); + batteryData.ts = getBatteryRegisterValue( BATTERY_CHARGER_TS ); + batteryData.vbat = getBatteryRegisterValue( BATTERY_CHARGER_VBAT ); + batteryData.vsys = getBatteryRegisterValue( BATTERY_CHARGER_VSYS ); + batteryData.ibat = getBatteryRegisterValue( BATTERY_CHARGER_CURRENT ); + batteryData.relativeStateOfCharge = getBatteryRegisterValue( BATTERY_PACK_RELATIVE_STATE_OF_CHARGE ); + batteryData.fullChargeCapacity = getBatteryRegisterValue( BATTERY_PACK_FULL_CHARGE_CAPACITY ); + + broadcastData( MSG_ID_TD_BATTERY_DATA, COMM_BUFFER_OUT_CAN_TD_BROADCAST, (U08*)&batteryData, sizeof( BATTERY_DATA_PAYLOAD_T ) ); } /************************************************************************* * TEST SUPPORT FUNCTIONS *************************************************************************/ - /*********************************************************************//** * @brief - * The testBatteryRemainingCapacityOverride function overrides the battery - * remaining capacity value. + * The testBatteryRegisterOverride function overrides one battery register + * value based on the supplied array index. * @details \b Inputs: none - * @details \b Outputs: batteryRemCapacity_mAh - * @param message override message from Diamond which includes the - * remaining capacity value to override to. + * @details \b Outputs: batteryRegisterOverrides[] + * @param message override message from Diamond which includes the register + * index and value to override. * @return TRUE if override request is successful, FALSE if not *************************************************************************/ -BOOL testBatteryRemainingCapacityOverride( MESSAGE_T *message ) +BOOL testBatteryRegisterOverride( MESSAGE_T *message ) { - BOOL result = u32Override( message, &batteryRemCapacity_mAh, 0x0, 0xFFFFFFFF ); - return result; + return u32ArrayOverride( message, batteryRegisterOverrides, BATTERY_CHARGER_CURRENT, OFF, HEX_32_BIT_FULL_SCALE ); } -/*********************************************************************//** - * @brief - * The testBatteryStatusOverride function overrides the battery - * pack status value. - * @details \b Inputs: none - * @details \b Outputs: batteryStatus - * @param message override message from Diamond which includes the - * battery status value to override to. - * @return TRUE if override request is successful, FALSE if not - *************************************************************************/ -BOOL testBatteryStatusOverride( MESSAGE_T *message ) -{ - BOOL result = u32Override( message, &batteryStatus, 0x0, 0xFFFFFFFF ); - return result; -} - -/*********************************************************************//** - * @brief - * The testBatteryChargerStatusOverride function overrides the battery - * charger status value. - * @details \b Inputs: none - * @details \b Outputs: batteryChargerStatus - * @param message override message from Diamond which includes the - * charger status value to override to. - * @return TRUE if override request is successful, FALSE if not - *************************************************************************/ -BOOL testBatteryChargerStatusOverride( MESSAGE_T *message ) -{ - BOOL result = u32Override( message, &batteryChargerStatus, 0x0, 0xFFFFFFFF ); - return result; -} +/**@}*/