Index: firmware/App/Drivers/Battery.c =================================================================== diff -u -r0c439ddcf7e4d3d4bf63df679eacf2f12f01255f -rcd5be724d5a3ba7457e761191d82f278654d7f5c --- firmware/App/Drivers/Battery.c (.../Battery.c) (revision 0c439ddcf7e4d3d4bf63df679eacf2f12f01255f) +++ firmware/App/Drivers/Battery.c (.../Battery.c) (revision cd5be724d5a3ba7457e761191d82f278654d7f5c) @@ -1,20 +1,21 @@ /************************************************************************** * -* Copyright (c) 2021-2022 Diality Inc. - All Rights Reserved. +* Copyright (c) 2021-2024 Diality Inc. - All Rights Reserved. * * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * * @file Battery.c * * @author (last) Dara Navaei -* @date (last) 18-Oct-2022 +* @date (last) 08-Oct-2023 * * @author (original) Quang Nguyen * @date (original) 24-Feb-2021 * ***************************************************************************/ - +#include // For memcpy + #include "i2c.h" #include "Battery.h" @@ -38,10 +39,11 @@ #define BATTERY_PACK_ERROR_BITS 0x0F ///< Error codes are in the first byte. #define BATTERY_PACK_MIN_CHARGE_PCT 50 ///< Minimum battery pack state of charge in percentage. -#define BATTERY_COMM_TIME_OUT_MS 2 ///< Battery communication time out in ms. -#define BATTERY_MONITOR_INTERVAL_MS 247 ///< Battery monitor interval in ms. -#define AC_POWER_LOST_PERSISTENT_COUNT 3 ///< AC power lost persistent count before alarming. -#define BATTERY_COMM_FAULT_PERSISTENTCE_COUNT 5 ///< Battery communication fault persistent count before alarming. +#define BATTERY_COMM_TIME_OUT_MS 2 ///< Battery communication time out in ms. +#define BATTERY_MONITOR_INTERVAL_MS 247 ///< Battery monitor interval in ms. +#define AC_POWER_LOST_PERSISTENT_COUNT 3 ///< AC power lost 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_MAH_2_MWH_FACTOR 14.7F ///< Conversion factor for mAh to mWh. #define BATTERY_MIN_CAPACITY_MWH 5000.0F ///< Minimum battery capacity for starting a treatment is 10 minutes (5 Wh @ 30W). @@ -130,14 +132,17 @@ BATTERY_PACK_MANUFACTURER_NAME, ///< Battery pack mfg name BATTERY_PACK_DEVICE_NAME, ///< Battery pack device name BATTERY_PACK_DEVICE_CHEMISTRY, ///< Battery pack device chemistry - END_OF_LIST + END_OF_LIST, ///< End of battery data list + NUM_OF_BATTERY_PACK_LIST, ///< Number of battery pack list } BATTERY_MANAGEMENT_ENUM_T; // ********** private data ********** static OVERRIDE_F32_T batteryRemCapacity_mWh = { 0.0, 0.0, 0.0, 0 }; ///< Battery pack remaining capacity (in mWh). +static OVERRIDE_U32_T batteryStatus = { 0, 0, 0, 0 }; ///< Battery status +static OVERRIDE_U32_T batteryChargerStatus = { 0, 0, 0, 0 }; ///< Battery charger status +static OVERRIDE_U32_T batteryI2CStatusRegister = { 0, 0, 0, 0 }; ///< Battery I2C Interrupt Status register static U32 lastBatteryMonitorTime; ///< Previous battery monitor time. -static U32 commFaultPersistentCount; ///< Persistence count for battery comm fault. static BATTERY_MANAGEMENT_ENUM_T current_BM_value; ///< Index for which battery data to read now. static BATTERY_MANAGER_PAYLOAD_T BatteryManagerData; ///< Record with latest battery pack data updated at the slower frequency. @@ -146,6 +151,9 @@ // ********** private function prototypes ********** static F32 getBatteryRemainingCapacity_mWh( void ); +static U32 getBatteryStatus( void ); +static U32 getBatteryChargerStatus( void ); +static U32 getI2CStatusRegister( BOOL resetOverride ); static void setupI2CDriver( void ); static BOOL waitForTxReady( void ); static BOOL waitForRxReady( void ); @@ -154,7 +162,7 @@ static BOOL getBatteryData( U32 slaveAddr, U08 command, U32 * dataPtr ); static BOOL startCommTx( U32 slaveAddr ); static BOOL getData( U08 command, U16 * dataPtr ); - +static void checkTooManyCommFaults( void ); // For logging static void getBatteryManagementData( void ); static void publishBatteryManagementData( void ); @@ -170,7 +178,6 @@ void initBattery( void ) { lastBatteryMonitorTime = 0; - commFaultPersistentCount = 0; current_BM_value = BEGINNING_OF_LIST; memset( &BatteryStatusData, 0, sizeof( BATTERY_STATUS_PAYLOAD_T ) ); @@ -179,6 +186,9 @@ // Initialize persistent alarm for battery pack status error initPersistentAlarm( ALARM_ID_HD_BATTERY_PACK_ERROR_DETECTED, 0, BATT_STATUS_ERROR_PERSIST_MS ); + // Initialize bad message CRC time windowed count + initTimeWindowedCount( TIME_WINDOWED_COUNT_BATT_COMM_ERROR, BATTERY_COMM_FAULT_COUNT, BATTERY_COMM_FAULT_TIMER ); + setupI2CDriver(); } @@ -188,7 +198,7 @@ * @details Inputs: lastBatteryMonitorTime * @details Outputs: lastBatteryMonitorTime * @return none - *************************************************************************/ + *************************************************************************/ void execBatteryMonitor( void ) { if ( TRUE == didTimeout( lastBatteryMonitorTime, BATTERY_MONITOR_INTERVAL_MS ) ) @@ -212,6 +222,31 @@ /*********************************************************************//** * @brief + * The getI2CStatusRegister function returns the I2C status register + * @details Inputs: batteryI2CStatusRegister, i2cREG1->STR + * @details Outputs: none + * @param reset override on get + * @return I2C Interrupt Status. + *************************************************************************/ +static U32 getI2CStatusRegister( BOOL resetOverride ) +{ + U32 result = i2cREG1->STR; + + if ( OVERRIDE_KEY == batteryI2CStatusRegister.override ) + { + result = batteryI2CStatusRegister.ovData; + if ( TRUE == resetOverride ) + { + batteryI2CStatusRegister.override = OVERRIDE_RESET; + batteryI2CStatusRegister.ovData = batteryI2CStatusRegister.ovInitData; + } + } + + return result; +} + +/*********************************************************************//** + * @brief * The getBatteryRemainingCapacity_mWh function returns the latest battery * remaining capacity (in mWh). * @details Inputs: batteryRemCapacity_mWh @@ -232,6 +267,45 @@ /*********************************************************************//** * @brief + * The getBatteryStatus function returns the latest battery status + * @details Inputs: batteryStatus + * @details Outputs: none + * @return battery status. + *************************************************************************/ +static U32 getBatteryStatus( void ) +{ + U32 result = batteryStatus.data; + + if ( OVERRIDE_KEY == batteryStatus.override ) + { + result = batteryStatus.ovData; + } + + return result; +} + +/*********************************************************************//** + * @brief + * The getBatteryChargerStatus function returns the latest battery + * charger status. + * @details Inputs: batteryChargerStatus + * @details Outputs: none + * @return battery charger status. + *************************************************************************/ +static U32 getBatteryChargerStatus( void ) +{ + U32 result = batteryChargerStatus.data; + + if ( OVERRIDE_KEY == batteryChargerStatus.override ) + { + result = batteryChargerStatus.ovData; + } + + return result; +} + +/*********************************************************************//** + * @brief * The setupI2CDriver function setups i2c driver in repeat mode to be * compatible with SMBus protocol. * @details Inputs: none @@ -378,18 +452,14 @@ if ( TRUE == waitForAccessReady() ) { - if ( 0 == ( i2cREG1->STR & ( (U32)I2C_NACK | (U32)I2C_AL ) ) ) + if ( 0 == ( getI2CStatusRegister( TRUE ) & ( (U32)I2C_NACK | (U32)I2C_AL ) ) ) { - commFaultPersistentCount = 0; result = TRUE; } else { generateStopCondition(); - if ( ++commFaultPersistentCount > BATTERY_COMM_FAULT_PERSISTENTCE_COUNT ) - { - SET_ALARM_WITH_1_U32_DATA( ALARM_ID_HD_BATTERY_COMM_FAULT, slaveAddr ); - } + checkTooManyCommFaults(); } } } @@ -440,18 +510,13 @@ *dataPtr = batteryData; result = TRUE; } + else + { + checkTooManyCommFaults(); + } } } - if ( FALSE == result ) - { - if ( ++commFaultPersistentCount > BATTERY_COMM_FAULT_PERSISTENTCE_COUNT ) - { - SET_ALARM_WITH_1_U32_DATA( ALARM_ID_HD_BATTERY_COMM_FAULT, dataPtr ); - commFaultPersistentCount = 0; - } - } - return result; } @@ -490,9 +555,10 @@ case BATTERY_PACK_BATTERY_STATUS4: case BATTERY_PACK_BATTERY_STATUS5: getBatteryData ( BATTERY_PACK_SLAVE_ADDRESS, BATTERY_PACK_ADDR_BATTERY_STATUS, &BatteryStatusData.BatteryStatus ); - if ( ( TRUE == isPersistentAlarmTriggered( ALARM_ID_HD_BATTERY_PACK_ERROR_DETECTED, ( BatteryStatusData.BatteryStatus & BATTERY_PACK_ERROR_BITS ) != 0 ) ) ) + batteryStatus.data = BatteryStatusData.BatteryStatus; + if ( ( TRUE == isPersistentAlarmTriggered( ALARM_ID_HD_BATTERY_PACK_ERROR_DETECTED, ( getBatteryStatus() & BATTERY_PACK_ERROR_BITS ) != 0 ) ) ) { - SET_ALARM_WITH_1_U32_DATA( ALARM_ID_HD_BATTERY_PACK_ERROR_DETECTED, BatteryStatusData.BatteryStatus ); + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_HD_BATTERY_PACK_ERROR_DETECTED, getBatteryStatus(), BATTERY_PACK_ERROR_BITS ); } break; @@ -618,24 +684,8 @@ case BATTERY_CHARGER_STATUS4: case BATTERY_CHARGER_STATUS5: if ( TRUE == getBatteryData( BATTERY_CHARGER_SLAVE_ADDRESS, BATTERY_CHARGER_STATUS_CMD, &BatteryStatusData.BatteryChargerStatus ) ) - { // If A/C not present, trigger A/C lost alarm - if ( 0 == ( BatteryStatusData.BatteryChargerStatus & BATTERY_CHARGER_STATUS_AC_PRESENT_MASK ) ) - { - // Pre-Treatment, Treatment, or Post-Treatment mode - if( opMode == MODE_PRET || opMode == MODE_TREA || opMode == MODE_POST ) - { - SET_ALARM_WITH_1_U32_DATA( ALARM_ID_HD_AC_POWER_LOST_IN_TREATMENT, BatteryStatusData.BatteryChargerStatus ); - } - // Standby, Service, or Treatment Parameters mode - else - { - SET_ALARM_WITH_1_U32_DATA( ALARM_ID_HD_AC_POWER_LOST, BatteryStatusData.BatteryChargerStatus ); - } - } - else - { - clearAlarmCondition( ALARM_ID_HD_AC_POWER_LOST ); - } + { + batteryChargerStatus.data = BatteryStatusData.BatteryChargerStatus; } // Publish battery status data after reading battery charger status (last status read) publishBatteryStatusData(); @@ -647,7 +697,7 @@ break; default: - // TODO s/w fault + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_HD_SOFTWARE_FAULT, SW_FAULT_ID_BATTERY_INVALID_MANAGEMENT_DATA_STATE, current_BM_value ) break; } } @@ -673,11 +723,34 @@ *************************************************************************/ static void publishBatteryStatusData( void ) { - BatteryStatusData.RemainingCapacity = (U32)getBatteryRemainingCapacity_mWh(); - broadcastData( MSG_ID_HD_BATTERY_STATUS_DATA, COMM_BUFFER_OUT_CAN_HD_BROADCAST, (U08*)&BatteryStatusData, sizeof( BATTERY_STATUS_PAYLOAD_T ) ); + BATTERY_STATUS_PAYLOAD_T batteryStatusData; + + batteryStatusData.RemainingCapacity = (U32)getBatteryRemainingCapacity_mWh(); + batteryStatusData.BatteryStatus = getBatteryStatus(); + batteryStatusData.BatteryChargerStatus = getBatteryChargerStatus(); + batteryStatusData.BatteryI2CStatus = getI2CStatusRegister( FALSE ); + + broadcastData( MSG_ID_HD_BATTERY_STATUS_DATA, COMM_BUFFER_OUT_CAN_HD_BROADCAST, (U08*)&batteryStatusData, sizeof( BATTERY_STATUS_PAYLOAD_T ) ); } +/*********************************************************************//** + * @brief + * The checkTooManyCommFaults function checks for too many comm faults + * within a set period of time. Assumed function is being called when a new + * comm fault is detected so a new comm fault will be added to the list. + * @details Inputs: none + * @details Outputs: alarm 98 on trigger. + * @return none + *************************************************************************/ +static void checkTooManyCommFaults( void ) +{ + if ( TRUE == incTimeWindowedCount( TIME_WINDOWED_COUNT_BATT_COMM_ERROR ) ) + { + SET_ALARM_WITH_1_U32_DATA( ALARM_ID_HD_BATTERY_COMM_FAULT, TIME_WINDOWED_COUNT_BATT_COMM_ERROR ); + } +} + /************************************************************************* * TEST SUPPORT FUNCTIONS *************************************************************************/ @@ -692,7 +765,7 @@ * @param value override battery remaining percent * @return TRUE if override successful, FALSE if not *************************************************************************/ -BOOL testSetBatteryRemainingPercentOverride( F32 value ) // TODO - rename to capacity (instead of percent) + messaging + Dialin // TODO - add override of broadcast interval // TODO - broadcast battery data +BOOL testSetBatteryRemainingCapacityOverride( F32 value ) { BOOL result = FALSE; @@ -708,13 +781,13 @@ /*********************************************************************//** * @brief - * The testResetSetBatteryRemainingPercentOverride function resets the + * The testResetBatteryRemainingPercentOverride function resets the * override of the battery remaining percent value. * @details Inputs: none * @details Outputs: batteryRemCapacity_mWh * @return TRUE if reset successful, FALSE if not *************************************************************************/ -BOOL testResetSetBatteryRemainingPercentOverride( void ) +BOOL testResetBatteryRemainingCapacityOverride( void ) { BOOL result = FALSE; @@ -728,4 +801,140 @@ return result; } +/*********************************************************************//** + * @brief + * The testSetBatteryStatusOverride function overrides the battery + * status value. + * @details Inputs: none + * @details Outputs: batteryStatus + * @param value override battery status + * @return TRUE if override successful, FALSE if not + *************************************************************************/ +BOOL testSetBatteryStatusOverride( U32 value ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + batteryStatus.ovData = value; + batteryStatus.override = OVERRIDE_KEY; + } + + return result; +} + +/*********************************************************************//** + * @brief + * The testResetBatteryStatusOverride function resets the + * override of the battery status value. + * @details Inputs: none + * @details Outputs: batteryStatus + * @return TRUE if reset successful, FALSE if not + *************************************************************************/ +BOOL testResetBatteryStatusOverride( void ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + batteryStatus.override = OVERRIDE_RESET; + batteryStatus.ovData = batteryStatus.ovInitData; + } + + return result; +} + + +/*********************************************************************//** + * @brief + * The testSetBatteryChargerStatusOverride function overrides the battery + * charger status value. + * @details Inputs: none + * @details Outputs: batteryChargerStatus + * @param value override battery charge status + * @return TRUE if override successful, FALSE if not + *************************************************************************/ +BOOL testSetBatteryChargerStatusOverride( U32 value ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + batteryChargerStatus.ovData = value; + batteryChargerStatus.override = OVERRIDE_KEY; + } + + return result; +} + +/*********************************************************************//** + * @brief + * The testResetBatteryChargerStatusOverride function resets the + * override of the battery charger status. + * @details Inputs: none + * @details Outputs: batteryChargerStatus + * @return TRUE if reset successful, FALSE if not + *************************************************************************/ +BOOL testResetBatteryChargerStatusOverride( void ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + batteryChargerStatus.override = OVERRIDE_RESET; + batteryChargerStatus.ovData = batteryChargerStatus.ovInitData; + } + + return result; +} + +/*********************************************************************//** + * @brief + * The testSetBatteryI2CStatusOverride function overrides the battery + * i2c status register value. + * @details Inputs: none + * @details Outputs: batteryI2CStatusRegister + * @param value override battery charge status + * @return TRUE if override successful, FALSE if not + *************************************************************************/ +BOOL testSetBatteryI2CStatusOverride( U32 value ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + batteryI2CStatusRegister.ovData = value; + batteryI2CStatusRegister.override = OVERRIDE_KEY; + } + + return result; +} + +/*********************************************************************//** + * @brief + * The testResetBatteryI2CStatusOverride function resets the + * override of the battery i2c status register value. + * @details Inputs: none + * @details Outputs: batteryI2CStatusRegister + * @return TRUE if reset successful, FALSE if not + *************************************************************************/ +BOOL testResetBatteryI2CStatusOverride( void ) +{ + BOOL result = FALSE; + + if ( TRUE == isTestingActivated() ) + { + result = TRUE; + batteryI2CStatusRegister.override = OVERRIDE_RESET; + batteryI2CStatusRegister.ovData = batteryI2CStatusRegister.ovInitData; + } + + return result; +} + /**@}*/