Maxim Integrated / MAX17055_EZconfig

This is a library for the MAX17055 Li+ Battery Fuel Gauge.

Dependents:   Low_Power_Long_Distance_IR_Vision_Robot MAX17055_EZconfig MAX17055_EZconfig_Sample Low_Power_Long_Distance_IR_Vision_Robot

Fork of max17055 by Maxim Integrated

max17055.h@9:f29d5e49b190, 2018-02-06 (annotated)

Committer:
fneirab
Date:
Tue Feb 06 21:10:30 2018 +0000
Revision:
9:f29d5e49b190
Parent:
8:ca8765c30ed2
Child:
10:f145eb7522ff
latest version 1.2 with new function additions and documentation.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
fneirab 4:a4d6ae2182c2 1 /******************************************************************//**
fneirab 4:a4d6ae2182c2 2 * @file max17055.h
fneirab 4:a4d6ae2182c2 3 *
fneirab 5:a18a189588dc 4 * @author Felipe Neira - Maxim Integrated - TTS
fneirab 4:a4d6ae2182c2 5 *
fneirab 9:f29d5e49b190 6 * @version 1.2
fneirab 4:a4d6ae2182c2 7 *
fneirab 9:f29d5e49b190 8 * Started: 9JAN18
fneirab 4:a4d6ae2182c2 9 *
fneirab 9:f29d5e49b190 10 * Updated:
fneirab 9:f29d5e49b190 11 * New functions improved for continious display. Change copyright notice for 2018.
fneirab 4:a4d6ae2182c2 12 *
fneirab 9:f29d5e49b190 13 *
fneirab 4:a4d6ae2182c2 14 *
fneirab 9:f29d5e49b190 15 /*******************************************************************************
fneirab 9:f29d5e49b190 16 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
fneirab 4:a4d6ae2182c2 17 *
fneirab 4:a4d6ae2182c2 18 * Permission is hereby granted, free of charge, to any person obtaining a
fneirab 4:a4d6ae2182c2 19 * copy of this software and associated documentation files (the "Software"),
fneirab 4:a4d6ae2182c2 20 * to deal in the Software without restriction, including without limitation
fneirab 4:a4d6ae2182c2 21 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
fneirab 4:a4d6ae2182c2 22 * and/or sell copies of the Software, and to permit persons to whom the
fneirab 4:a4d6ae2182c2 23 * Software is furnished to do so, subject to the following conditions:
fneirab 4:a4d6ae2182c2 24 *
fneirab 4:a4d6ae2182c2 25 * The above copyright notice and this permission notice shall be included
fneirab 4:a4d6ae2182c2 26 * in all copies or substantial portions of the Software.
fneirab 4:a4d6ae2182c2 27 *
fneirab 4:a4d6ae2182c2 28 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
fneirab 4:a4d6ae2182c2 29 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
fneirab 4:a4d6ae2182c2 30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
fneirab 4:a4d6ae2182c2 31 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
fneirab 4:a4d6ae2182c2 32 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
fneirab 4:a4d6ae2182c2 33 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
fneirab 4:a4d6ae2182c2 34 * OTHER DEALINGS IN THE SOFTWARE.
fneirab 4:a4d6ae2182c2 35 *
fneirab 4:a4d6ae2182c2 36 * Except as contained in this notice, the name of Maxim Integrated
fneirab 4:a4d6ae2182c2 37 * Products, Inc. shall not be used except as stated in the Maxim Integrated
fneirab 4:a4d6ae2182c2 38 * Products, Inc. Branding Policy.
fneirab 4:a4d6ae2182c2 39 *
fneirab 4:a4d6ae2182c2 40 * The mere transfer of this software does not imply any licenses
fneirab 4:a4d6ae2182c2 41 * of trade secrets, proprietary technology, copyrights, patents,
fneirab 4:a4d6ae2182c2 42 * trademarks, maskwork rights, or any other form of intellectual
fneirab 4:a4d6ae2182c2 43 * property whatsoever. Maxim Integrated Products, Inc. retains all
fneirab 4:a4d6ae2182c2 44 * ownership rights.
fneirab 9:f29d5e49b190 45 *******************************************************************************
fneirab 9:f29d5e49b190 46 */
fneirab 0:80c39eb8f3ba 47
fneirab 0:80c39eb8f3ba 48 #ifndef __MAX17055_H_
fneirab 0:80c39eb8f3ba 49 #define __MAX17055_H_
fneirab 0:80c39eb8f3ba 50
fneirab 0:80c39eb8f3ba 51 // Include
fneirab 0:80c39eb8f3ba 52 #include "mbed.h"
fneirab 0:80c39eb8f3ba 53
fneirab 2:ff7db397b70f 54 /* STATUS register bits */
fneirab 2:ff7db397b70f 55 #define MAX17055_STATUS_BST (1 << 3)
fneirab 2:ff7db397b70f 56 #define MAX17055_STATUS_POR (1 << 1)
fneirab 2:ff7db397b70f 57
fneirab 5:a18a189588dc 58 /// Model loading options
fneirab 9:f29d5e49b190 59 #define MODEL_LOADING_OPTION1 1 //EZ Config
fneirab 9:f29d5e49b190 60 #define MODEL_LOADING_OPTION2 2 //Not implemented in this version of the library
fneirab 9:f29d5e49b190 61 #define MODEL_LOADING_OPTION3 3 //Not implemented in this version of the library
fneirab 4:a4d6ae2182c2 62
fneirab 0:80c39eb8f3ba 63
fneirab 0:80c39eb8f3ba 64 /**
fneirab 0:80c39eb8f3ba 65 * @brief Library for the MAX17055\n
fneirab 0:80c39eb8f3ba 66 * The MAX17055 is a low 7μA operating current fuel gauge
fneirab 0:80c39eb8f3ba 67 * which implements Maxim ModelGauge™ m5 EZ algorithm.
fneirab 0:80c39eb8f3ba 68 * ModelGauge m5 EZ makes fuel gauge implementation easy
fneirab 0:80c39eb8f3ba 69 * by eliminating battery characterization requirements
fneirab 0:80c39eb8f3ba 70 * and simplifying host software interaction.
fneirab 0:80c39eb8f3ba 71 * The ModelGauge m5 EZ robust algorithm provides tolerance against
fneirab 0:80c39eb8f3ba 72 * battery diversity for most lithium batteries and applications.
fneirab 0:80c39eb8f3ba 73 * Communication is through an SPI-compatible interface.
fneirab 0:80c39eb8f3ba 74 *
fneirab 0:80c39eb8f3ba 75 * @code
fneirab 0:80c39eb8f3ba 76 * #include "mbed.h"
fneirab 9:f29d5e49b190 77 * #include "MAX17055.h"
fneirab 0:80c39eb8f3ba 78 *
fneirab 0:80c39eb8f3ba 79 *
fneirab 0:80c39eb8f3ba 80 * // Hardware serial port
fneirab 0:80c39eb8f3ba 81 * Serial serial(USBTX, USBRX);
fneirab 0:80c39eb8f3ba 82 *
fneirab 0:80c39eb8f3ba 83 * //SPI communications
fneirab 0:80c39eb8f3ba 84 * I2C i2c(SCL, SDA);
fneirab 0:80c39eb8f3ba 85 *
fneirab 0:80c39eb8f3ba 86 * //Fuel Gauge
fneirab 0:80c39eb8f3ba 87 * MAX17055 max17055(i2C, Sutff );//To be completed
fneirab 0:80c39eb8f3ba 88 *
fneirab 0:80c39eb8f3ba 89 *
fneirab 0:80c39eb8f3ba 90 * int main(void)
fneirab 0:80c39eb8f3ba 91 * {
fneirab 9:f29d5e49b190 92 * CODE CODE TBD
fneirab 0:80c39eb8f3ba 93 * while(true)
fneirab 0:80c39eb8f3ba 94 * {
fneirab 9:f29d5e49b190 95 * CODE CODE TBD
fneirab 0:80c39eb8f3ba 96 * }
fneirab 0:80c39eb8f3ba 97 * }
fneirab 0:80c39eb8f3ba 98 * @endcode
fneirab 0:80c39eb8f3ba 99 */
fneirab 0:80c39eb8f3ba 100
fneirab 0:80c39eb8f3ba 101
fneirab 4:a4d6ae2182c2 102
fneirab 5:a18a189588dc 103 //! BATTERY Battery Parameters Class
fneirab 5:a18a189588dc 104 /*!
fneirab 5:a18a189588dc 105 Generic API for battery parameters
fneirab 5:a18a189588dc 106 */
fneirab 5:a18a189588dc 107 class BATTERY
fneirab 5:a18a189588dc 108 {
fneirab 5:a18a189588dc 109
fneirab 5:a18a189588dc 110 public:
fneirab 5:a18a189588dc 111
fneirab 0:80c39eb8f3ba 112
fneirab 5:a18a189588dc 113 struct battery_cfg_t{
fneirab 5:a18a189588dc 114 int capacity; //!< The rated capacity in mAh of the battery
fneirab 5:a18a189588dc 115 int voltageMax; //!< The maximum voltage in mV that should be used for charging
fneirab 5:a18a189588dc 116 int voltageNom; //!< The normal voltage in mV of the battery near mid charge
fneirab 5:a18a189588dc 117 int voltageMin; //!< The minimum voltage in mV that the battery should be discharged
fneirab 5:a18a189588dc 118 int temperatureMax; //!< The maximum temperature in degrees C where charging is allowed
fneirab 5:a18a189588dc 119 int temperatureMin; //!< The minimum temperature in degrees C where charging is allowed
fneirab 5:a18a189588dc 120 int currentCharge; //!< The current as a percentage of capicity used for charging
fneirab 5:a18a189588dc 121 int currentTerm; //!< The current as a percentage of capacity to stop charging
fneirab 5:a18a189588dc 122 int currentPre; //!< The current as a percentage of capacity for pre-charging
fneirab 5:a18a189588dc 123 } ;
fneirab 5:a18a189588dc 124
fneirab 5:a18a189588dc 125
fneirab 5:a18a189588dc 126
fneirab 0:80c39eb8f3ba 127
fneirab 4:a4d6ae2182c2 128 };
fneirab 0:80c39eb8f3ba 129
fneirab 4:a4d6ae2182c2 130 /******************************************************************//**
fneirab 4:a4d6ae2182c2 131 * MAX17055 Class
fneirab 4:a4d6ae2182c2 132 **********************************************************************/
fneirab 4:a4d6ae2182c2 133 /// MAX17055 Battery Fuel Gauge Class
fneirab 0:80c39eb8f3ba 134 /** Generic API for a battery fuel gauge
fneirab 0:80c39eb8f3ba 135 */
fneirab 0:80c39eb8f3ba 136 class MAX17055
fneirab 0:80c39eb8f3ba 137 {
fneirab 0:80c39eb8f3ba 138
fneirab 0:80c39eb8f3ba 139 public:
fneirab 0:80c39eb8f3ba 140
fneirab 0:80c39eb8f3ba 141 ///7-bit slave address
fneirab 0:80c39eb8f3ba 142 static const uint8_t I2C_ADRS = 0x36; //Slave address 0x6C or 0x36 for 7 MSbit Addres
fneirab 0:80c39eb8f3ba 143 ///8-bit write address
fneirab 0:80c39eb8f3ba 144 static const uint8_t I2C_W_ADRS = 0x6C;
fneirab 0:80c39eb8f3ba 145 ///8-bit read address
fneirab 0:80c39eb8f3ba 146 static const uint8_t I2C_R_ADRS = 0x6D;
fneirab 6:5ced10109ebf 147
fneirab 6:5ced10109ebf 148
fneirab 0:80c39eb8f3ba 149 /////Max # Bytes in FIFO
fneirab 0:80c39eb8f3ba 150 // static const uint16_t MAX_FIFO_BYTES = 288;
fneirab 0:80c39eb8f3ba 151 // ///# of bytes per LED channel
fneirab 0:80c39eb8f3ba 152 // static const uint8_t BYTES_PER_CH = 3;
fneirab 0:80c39eb8f3ba 153
fneirab 6:5ced10109ebf 154
fneirab 6:5ced10109ebf 155 //Defined instance for external structs
fneirab 5:a18a189588dc 156 struct BATTERY::battery_cfg_t batt_con;
fneirab 9:f29d5e49b190 157
fneirab 7:479a36909ced 158
fneirab 0:80c39eb8f3ba 159
fneirab 0:80c39eb8f3ba 160
fneirab 0:80c39eb8f3ba 161
fneirab 0:80c39eb8f3ba 162 /**
fneirab 4:a4d6ae2182c2 163 * @brief Register Addresses for the MAX17055
fneirab 5:a18a189588dc 164 * @details Enumerated register addresses
fneirab 0:80c39eb8f3ba 165 */
fneirab 0:80c39eb8f3ba 166 enum Registers_e {
fneirab 9:f29d5e49b190 167 STATUS_REG = 0x00, /**< 0x00 default = 0x0002 */
fneirab 7:479a36909ced 168 VALRTTH_REG = 0x01, /**< 0x01 */
fneirab 7:479a36909ced 169 TALRTTH_REG = 0x02, /**< 0x02 */
fneirab 9:f29d5e49b190 170 SALRTTH_REG = 0x03, /**< 0x03 */
fneirab 7:479a36909ced 171 REPCAP_REG = 0x05, /**< 0x05 */
fneirab 7:479a36909ced 172 REPSOC_REG = 0x06, /**< 0x06 */
fneirab 9:f29d5e49b190 173 TEMP_REG = 0x08, /**< 0x08 */
fneirab 9:f29d5e49b190 174 VCELL_REG = 0x09, /**< 0x09 */
fneirab 7:479a36909ced 175 CURRENT_REG = 0x0A, /**< 0x0A */
fneirab 7:479a36909ced 176 AVGCURRENT_REG = 0x0B, /**< 0x0B */
fneirab 9:f29d5e49b190 177 MIXSOC_REG = 0x0D, /**< 0x0D */
fneirab 9:f29d5e49b190 178 AVSOC_REG = 0x0E, /**< 0x0E */
fneirab 8:ca8765c30ed2 179 MIXCAP_REG = 0x0F, /**< 0x0F */
fneirab 7:479a36909ced 180
fneirab 7:479a36909ced 181 FULLCAPREP_REG = 0x10, /**< 0x10 */
fneirab 7:479a36909ced 182 TTE_REG = 0X11, /**< 0x11 */
fneirab 7:479a36909ced 183 QRTABLE00_REG = 0x12, /**< 0x12 */
fneirab 7:479a36909ced 184 FULLSOCTHR_REG = 0x13, /**< 0x13 */
fneirab 7:479a36909ced 185 CYCLES_REG = 0x17, /**< 0x17 */
fneirab 7:479a36909ced 186 DESIGNCAP_REG = 0x18, /**< 0x18 */
fneirab 7:479a36909ced 187 AVGVCELL_REG = 0x19, /**< 0x19 */
fneirab 7:479a36909ced 188 MAXMINVOLT_REG = 0x1B, /**< 0x1B */
fneirab 9:f29d5e49b190 189 CONFIG_REG = 0x1D, /**< 0x1D default = 0x2210 */
fneirab 7:479a36909ced 190 ICHGTERM_REG = 0x1E, /**< 0x1E */
fneirab 0:80c39eb8f3ba 191
fneirab 9:f29d5e49b190 192 TTF_REG = 0x20, /**< 0x20 */
fneirab 7:479a36909ced 193 VERSION_REG = 0x21, /**< 0x21 */
fneirab 9:f29d5e49b190 194 QRTABLE10_REG = 0x22, /**< 0x22 */
fneirab 9:f29d5e49b190 195 FULLCAPNOM_REG = 0x23, /**< 0x23 */
fneirab 9:f29d5e49b190 196 LEARNCFG_REG = 0x28, /**< 0x28 */
fneirab 9:f29d5e49b190 197 RELAXCFG_REG = 0x2A, /**< 0x2A */
fneirab 9:f29d5e49b190 198 TGAIN_REG = 0x2C, /**< 0x2C */
fneirab 9:f29d5e49b190 199 TOFF_REG = 0x2D, /**< 0x2D */
fneirab 7:479a36909ced 200
fneirab 9:f29d5e49b190 201 QRTABLE20_REG = 0x32, /**< 0x32 */
fneirab 9:f29d5e49b190 202 RCOMP0_REG = 0x38, /**< 0x38 */
fneirab 9:f29d5e49b190 203 TEMPCO_REG = 0x39, /**< 0x39 */
fneirab 7:479a36909ced 204 VEMPTY_REG = 0x3A,
fneirab 7:479a36909ced 205 FSTAT_REG = 0x3D,
fneirab 0:80c39eb8f3ba 206
fneirab 7:479a36909ced 207 QRTABLE30_REG = 0x42,
fneirab 7:479a36909ced 208 DQACC_REG = 0x45,
fneirab 7:479a36909ced 209 DPACC_REG = 0x46,
fneirab 7:479a36909ced 210 VFSOC0_REG = 0x48,
fneirab 7:479a36909ced 211 QH0_REG = 0x4C,
fneirab 7:479a36909ced 212 QH_REG = 0x4D,
fneirab 7:479a36909ced 213
fneirab 7:479a36909ced 214 VFSOC0_QH0_LOCK_REG = 0x60,
fneirab 7:479a36909ced 215 LOCK1_REG = 0x62,
fneirab 7:479a36909ced 216 LOCK2_REG = 0x63,
fneirab 7:479a36909ced 217
fneirab 7:479a36909ced 218 MODELDATA_START_REG = 0x80,
fneirab 7:479a36909ced 219
fneirab 7:479a36909ced 220 IALRTTH_REG = 0xB4,
fneirab 7:479a36909ced 221 CURVE_REG = 0xB9,
fneirab 7:479a36909ced 222 HIBCFG_REG = 0xBA,
fneirab 9:f29d5e49b190 223 CONFIG2_REG = 0xBB, /**< 0xBB default = 0x3658 */
fneirab 7:479a36909ced 224
fneirab 7:479a36909ced 225 MODELCFG_REG = 0xDB,
fneirab 9:f29d5e49b190 226 ATTTE_REG = 0xDD,
fneirab 0:80c39eb8f3ba 227
fneirab 7:479a36909ced 228 OCV_REG = 0xFB,
fneirab 7:479a36909ced 229 VFSOC_REG = 0xFF,
fneirab 7:479a36909ced 230 } ;
fneirab 7:479a36909ced 231
fneirab 7:479a36909ced 232
fneirab 7:479a36909ced 233 /**
fneirab 7:479a36909ced 234 * @brief Saved Fuel Gauge Parameters
fneirab 7:479a36909ced 235 * @details Struct with saved fuel Gauge Parametrs
fneirab 7:479a36909ced 236 */
fneirab 7:479a36909ced 237
fneirab 7:479a36909ced 238 struct platform_data{ //to clarify if Part of the class
fneirab 7:479a36909ced 239 uint16_t designcap;/**< struct value 1 */
fneirab 7:479a36909ced 240 uint16_t ichgterm; /**< struct value 2 */
fneirab 7:479a36909ced 241 uint16_t vempty; /**< struct value 3 */
fneirab 7:479a36909ced 242 int vcharge; /**< struct value 1 */
fneirab 0:80c39eb8f3ba 243
fneirab 7:479a36909ced 244 uint16_t learncfg; /**< struct value 1 */
fneirab 7:479a36909ced 245 uint16_t relaxcfg; /**< struct value 1 */
fneirab 7:479a36909ced 246 uint16_t config; /**< struct value 1 */
fneirab 7:479a36909ced 247 uint16_t config2; /**< struct value 1 */
fneirab 7:479a36909ced 248 uint16_t fullsocthr;/**< struct value 1 */
fneirab 7:479a36909ced 249 uint16_t tgain; /**< struct value 1 */
fneirab 7:479a36909ced 250 uint16_t toff; /**< struct value 1 */
fneirab 7:479a36909ced 251 uint16_t curve; /**< struct value 1 */
fneirab 7:479a36909ced 252 uint16_t rcomp0; /**< struct value 1 */
fneirab 7:479a36909ced 253 uint16_t tempco; /**< struct value 1 */
fneirab 7:479a36909ced 254 uint16_t qrtable00;
fneirab 7:479a36909ced 255 uint16_t qrtable10;
fneirab 7:479a36909ced 256 uint16_t qrtable20;
fneirab 7:479a36909ced 257 uint16_t qrtable30;
fneirab 7:479a36909ced 258
fneirab 7:479a36909ced 259 uint16_t dpacc;
fneirab 7:479a36909ced 260 uint16_t modelcfg;
fneirab 0:80c39eb8f3ba 261
fneirab 7:479a36909ced 262 //uint16_t model_data[MAX17055_TABLE_SIZE];
fneirab 7:479a36909ced 263 int (*get_charging_status)(void);
fneirab 7:479a36909ced 264 int model_option;
fneirab 7:479a36909ced 265 /**
fneirab 7:479a36909ced 266 * rsense in miliOhms.
fneirab 7:479a36909ced 267 * default 10 (if rsense = 0) as it is the recommended value by
fneirab 7:479a36909ced 268 * the datasheet although it can be changed by board designers.
fneirab 7:479a36909ced 269 */
fneirab 7:479a36909ced 270 unsigned int rsense;
fneirab 7:479a36909ced 271 int volt_min; /**< in mV */
fneirab 7:479a36909ced 272 int volt_max; /**< in mV */
fneirab 7:479a36909ced 273 int temp_min; /**< in DegreC */
fneirab 7:479a36909ced 274 int temp_max; /**< in DegreeC */
fneirab 7:479a36909ced 275 int soc_max; /**< in percent */
fneirab 7:479a36909ced 276 int soc_min; /**< in percent */
fneirab 7:479a36909ced 277 int curr_max; /**< in mA */
fneirab 7:479a36909ced 278 int curr_min; /**< in mA */
fneirab 7:479a36909ced 279 } ;
fneirab 7:479a36909ced 280
fneirab 7:479a36909ced 281
fneirab 7:479a36909ced 282 /**
fneirab 7:479a36909ced 283 * @brief Saved Fuel Gauge Parameters
fneirab 7:479a36909ced 284 * @details It is recommended to save the learned capacity parameters
fneirab 7:479a36909ced 285 * every time bit 2 of the Cycles register toggles
fneirab 7:479a36909ced 286 * (so that it is saved every 64% change in the battery)
fneirab 7:479a36909ced 287 * so that if power is lost the values can easily be restored.
fneirab 7:479a36909ced 288 */
fneirab 0:80c39eb8f3ba 289
fneirab 7:479a36909ced 290 struct saved_FG_params_t{
fneirab 7:479a36909ced 291 int rcomp0; /**< Explain */
fneirab 7:479a36909ced 292 int temp_co; /**< Explain */
fneirab 7:479a36909ced 293 int full_cap_rep; /**< Explain */
fneirab 7:479a36909ced 294 int cycles; /**< Explain */
fneirab 7:479a36909ced 295 int full_cap_nom; /**< Explain */
fneirab 7:479a36909ced 296 } ;
fneirab 9:f29d5e49b190 297
fneirab 9:f29d5e49b190 298
fneirab 9:f29d5e49b190 299
fneirab 4:a4d6ae2182c2 300
fneirab 4:a4d6ae2182c2 301
fneirab 4:a4d6ae2182c2 302
fneirab 0:80c39eb8f3ba 303 /**
fneirab 0:80c39eb8f3ba 304 * @brief max17055 Constructor
fneirab 0:80c39eb8f3ba 305 * @details max17055 Constructor with battery and i2c as parameters
fneirab 0:80c39eb8f3ba 306 */
fneirab 0:80c39eb8f3ba 307 MAX17055(I2C &i2c);
fneirab 0:80c39eb8f3ba 308
fneirab 0:80c39eb8f3ba 309 /**
fneirab 0:80c39eb8f3ba 310 * @brief Fuel Gauge Destructor
fneirab 0:80c39eb8f3ba 311 */
fneirab 0:80c39eb8f3ba 312 ~MAX17055();
fneirab 4:a4d6ae2182c2 313
fneirab 5:a18a189588dc 314 ////////////////////////////////////////////////////////////////////////////
fneirab 5:a18a189588dc 315
fneirab 5:a18a189588dc 316 /**
fneirab 5:a18a189588dc 317 * \brief Poll Flag clear
fneirab 5:a18a189588dc 318 * \par Details
fneirab 5:a18a189588dc 319 * This function clears status flags for the MAX17055
fneirab 5:a18a189588dc 320 *
fneirab 5:a18a189588dc 321 * \param[in] reg_addr - register address
fneirab 5:a18a189588dc 322 * \param[in] mask - register address
fneirab 5:a18a189588dc 323 * \param[in] timeout - register data
fneirab 5:a18a189588dc 324 *
fneirab 5:a18a189588dc 325 * \retval 1 on success
fneirab 5:a18a189588dc 326 * -1 on Failure
fneirab 5:a18a189588dc 327 */
fneirab 9:f29d5e49b190 328
fneirab 9:f29d5e49b190 329
fneirab 5:a18a189588dc 330
fneirab 7:479a36909ced 331 int poll_flag_clear(Registers_e reg_addr, int mask, int timeout);
fneirab 5:a18a189588dc 332
fneirab 9:f29d5e49b190 333 ////////////////////////////////////////////////////////////////////////////////
fneirab 9:f29d5e49b190 334
fneirab 9:f29d5e49b190 335 /**
fneirab 9:f29d5e49b190 336 * \brief Check POR function
fneirab 9:f29d5e49b190 337 * \par Details
fneirab 9:f29d5e49b190 338 * This function check is there was a power on reset event for the MAX17055
fneirab 9:f29d5e49b190 339 *
fneirab 9:f29d5e49b190 340 * \retval 1 for no POR detected
fneirab 9:f29d5e49b190 341 * -1 for POR detected
fneirab 9:f29d5e49b190 342 */
fneirab 9:f29d5e49b190 343 int check_POR_func();
fneirab 9:f29d5e49b190 344
fneirab 9:f29d5e49b190 345 ////////////////////////////////////////////////////////////////////////////////
fneirab 9:f29d5e49b190 346
fneirab 9:f29d5e49b190 347 /**
fneirab 9:f29d5e49b190 348 * \brief clear POR bit function
fneirab 9:f29d5e49b190 349 * \par Details
fneirab 9:f29d5e49b190 350 * This function clear the idicating bit for POR - MAX17055
fneirab 9:f29d5e49b190 351 *
fneirab 9:f29d5e49b190 352 * \retval 1 for Success
fneirab 9:f29d5e49b190 353 * -1 for errors
fneirab 9:f29d5e49b190 354 */
fneirab 9:f29d5e49b190 355 int clear_POR_bit();
fneirab 4:a4d6ae2182c2 356
fneirab 2:ff7db397b70f 357 /**
fneirab 2:ff7db397b70f 358 * \brief Write and Verify a MAX17055 register
fneirab 2:ff7db397b70f 359 * \par Details
fneirab 2:ff7db397b70f 360 * This function wites and verifies if the writing process was successful
fneirab 2:ff7db397b70f 361 *
fneirab 2:ff7db397b70f 362 * \param[in] reg_addr - register address
fneirab 4:a4d6ae2182c2 363 * \param[out] reg_data - the variable that contains the data to write
fneirab 5:a18a189588dc 364 * to the register address
fneirab 2:ff7db397b70f 365 *
fneirab 4:a4d6ae2182c2 366 * \retval 1 on success
fneirab 2:ff7db397b70f 367 * -1 if write errors
fneirab 2:ff7db397b70f 368 * -2 if read errors
fneirab 2:ff7db397b70f 369 * -3 if data curruption
fneirab 4:a4d6ae2182c2 370 *
fneirab 2:ff7db397b70f 371 */
fneirab 4:a4d6ae2182c2 372
fneirab 4:a4d6ae2182c2 373
fneirab 2:ff7db397b70f 374 int write_and_verify_reg(Registers_e reg_addr, uint16_t reg_data);
fneirab 4:a4d6ae2182c2 375
fneirab 4:a4d6ae2182c2 376
fneirab 3:f77a8345b0e3 377 ///////////////////////////////////////////////////////////////////////////
fneirab 4:a4d6ae2182c2 378
fneirab 2:ff7db397b70f 379 /**
fneirab 2:ff7db397b70f 380 * \brief Initialise Function for MAX17055
fneirab 2:ff7db397b70f 381 * \par Details
fneirab 2:ff7db397b70f 382 * This function intitializes the MAX17055
fneirab 2:ff7db397b70f 383 *
fneirab 4:a4d6ae2182c2 384 * \retval 1 on success
fneirab 2:ff7db397b70f 385 * -1 if errors exist
fneirab 2:ff7db397b70f 386 */
fneirab 4:a4d6ae2182c2 387
fneirab 4:a4d6ae2182c2 388
fneirab 7:479a36909ced 389 int init(platform_data des_data);
fneirab 4:a4d6ae2182c2 390
fneirab 4:a4d6ae2182c2 391
fneirab 3:f77a8345b0e3 392 ////////////////////////////////////////////////////////////////////////////
fneirab 0:80c39eb8f3ba 393
fneirab 3:f77a8345b0e3 394 /**
fneirab 2:ff7db397b70f 395 * \brief Get Internal Temperature Function for MAX17055
fneirab 2:ff7db397b70f 396 * \par Details
fneirab 2:ff7db397b70f 397 * This function sends a request to access the internal
fneirab 2:ff7db397b70f 398 * of the MAX17055
fneirab 2:ff7db397b70f 399 *
fneirab 7:479a36909ced 400 *
fneirab 7:479a36909ced 401 * \retval temperature value
fneirab 2:ff7db397b70f 402 * -1 if errors exist
fneirab 2:ff7db397b70f 403 */
fneirab 4:a4d6ae2182c2 404
fneirab 4:a4d6ae2182c2 405
fneirab 7:479a36909ced 406 int get_temperature();
fneirab 4:a4d6ae2182c2 407
fneirab 4:a4d6ae2182c2 408
fneirab 4:a4d6ae2182c2 409 ////////////////////////////////////////////////////////////////////////////
fneirab 4:a4d6ae2182c2 410
fneirab 3:f77a8345b0e3 411 /**
fneirab 3:f77a8345b0e3 412 * \brief Forced Exit Hibernate Mode Function for MAX17055
fneirab 3:f77a8345b0e3 413 * \par Details
fneirab 4:a4d6ae2182c2 414 * This function executes a force exit from hibernate mode.
fneirab 3:f77a8345b0e3 415 *
fneirab 3:f77a8345b0e3 416 * \retval returns HibCFG original value before forced Exit Hybernate mode
fneirab 3:f77a8345b0e3 417 *
fneirab 3:f77a8345b0e3 418 */
fneirab 4:a4d6ae2182c2 419
fneirab 4:a4d6ae2182c2 420
fneirab 3:f77a8345b0e3 421 uint16_t forcedExitHyberMode();
fneirab 7:479a36909ced 422
fneirab 7:479a36909ced 423 /**
fneirab 7:479a36909ced 424 * \brief EZ COnfing Init function
fneirab 7:479a36909ced 425 * \par Details
fneirab 7:479a36909ced 426 * This function implements the steps for the EZ confing m5 FuelGauge
fneirab 7:479a36909ced 427 *
fneirab 7:479a36909ced 428 * \retval returns TBD
fneirab 7:479a36909ced 429 *
fneirab 7:479a36909ced 430 */
fneirab 7:479a36909ced 431
fneirab 7:479a36909ced 432
fneirab 7:479a36909ced 433 uint16_t EZconfig_init(platform_data des_data);
fneirab 7:479a36909ced 434
fneirab 7:479a36909ced 435 ///////////////////////////////////////////////////////////////////////////
fneirab 7:479a36909ced 436
fneirab 7:479a36909ced 437 /**
fneirab 7:479a36909ced 438 * \brief Get State Of Charge(SOC) Function for MAX17055
fneirab 7:479a36909ced 439 * \par Details
fneirab 7:479a36909ced 440 * This function sends a request to access the internal
fneirab 7:479a36909ced 441 * of the MAX17055
fneirab 7:479a36909ced 442 *
fneirab 7:479a36909ced 443 * \param[in] reg_addr - register address
fneirab 7:479a36909ced 444 * \param[out] reg_data - SOC data from the REPSOC_REG register
fneirab 7:479a36909ced 445 * \retval 1 on success
fneirab 7:479a36909ced 446 *
fneirab 7:479a36909ced 447 * -1 if errors exist
fneirab 7:479a36909ced 448 */
fneirab 7:479a36909ced 449
fneirab 7:479a36909ced 450
fneirab 7:479a36909ced 451 int get_SOC();
fneirab 8:ca8765c30ed2 452
fneirab 8:ca8765c30ed2 453 ///////////////////////////////////////////////////////////////////////////
fneirab 8:ca8765c30ed2 454
fneirab 8:ca8765c30ed2 455 /**
fneirab 8:ca8765c30ed2 456 * \brief Get Average State Of Charge(SOC) Function for MAX17055
fneirab 8:ca8765c30ed2 457 * \par Details
fneirab 8:ca8765c30ed2 458 * This function sends a request to access the internal
fneirab 8:ca8765c30ed2 459 * of the MAX17055
fneirab 8:ca8765c30ed2 460 *
fneirab 8:ca8765c30ed2 461 * \param[in] reg_addr - register address
fneirab 8:ca8765c30ed2 462 * \param[out] reg_data - SOC data from the REPSOC_REG register
fneirab 8:ca8765c30ed2 463 * \retval 1 on success
fneirab 8:ca8765c30ed2 464 *
fneirab 8:ca8765c30ed2 465 * -1 if errors exist
fneirab 8:ca8765c30ed2 466 */
fneirab 8:ca8765c30ed2 467
fneirab 8:ca8765c30ed2 468
fneirab 8:ca8765c30ed2 469 int get_avSOC();
fneirab 7:479a36909ced 470
fneirab 7:479a36909ced 471 ////////////////////////////////////////////////////////////////////////////
fneirab 7:479a36909ced 472
fneirab 7:479a36909ced 473 /**
fneirab 7:479a36909ced 474 * \brief Get the remaining Time to Empty(TTE) Function for MAX17055
fneirab 7:479a36909ced 475 * \par Details
fneirab 7:479a36909ced 476 * This function sends a request to access the internal register
fneirab 7:479a36909ced 477 * of the MAX17055
fneirab 7:479a36909ced 478 *
fneirab 7:479a36909ced 479 * \retval tte_data - Time to Empty data from the TTE_REG register
fneirab 7:479a36909ced 480 *
fneirab 7:479a36909ced 481 * -1 if errors exist
fneirab 9:f29d5e49b190 482 */
fneirab 7:479a36909ced 483
fneirab 9:f29d5e49b190 484 int get_atTTE();
fneirab 9:f29d5e49b190 485
fneirab 9:f29d5e49b190 486 /**
fneirab 9:f29d5e49b190 487 * \brief Get State Of Charge(SOC) Function for MAX17055
fneirab 9:f29d5e49b190 488 * \par Details
fneirab 9:f29d5e49b190 489 * This function sends a request to access the internal
fneirab 9:f29d5e49b190 490 * of the MAX17055
fneirab 9:f29d5e49b190 491 *
fneirab 9:f29d5e49b190 492 * \param[in] reg_addr - register address
fneirab 9:f29d5e49b190 493 * \param[out] reg_data - SOC data from the REPSOC_REG register
fneirab 9:f29d5e49b190 494 * \retval 1 on success
fneirab 9:f29d5e49b190 495 *
fneirab 9:f29d5e49b190 496 * -1 if errors exist
fneirab 9:f29d5e49b190 497 */
fneirab 9:f29d5e49b190 498
fneirab 9:f29d5e49b190 499
fneirab 9:f29d5e49b190 500 int get_mixSOC();
fneirab 8:ca8765c30ed2 501
fneirab 8:ca8765c30ed2 502 ////////////////////////////////////////////////////////////////////////////
fneirab 8:ca8765c30ed2 503
fneirab 8:ca8765c30ed2 504 /**
fneirab 8:ca8765c30ed2 505 * \brief Get the remaining Time to Full(TTE) Function for MAX17055
fneirab 8:ca8765c30ed2 506 * \par Details
fneirab 8:ca8765c30ed2 507 * This function sends a request to access the internal register
fneirab 8:ca8765c30ed2 508 * of the MAX17055
fneirab 8:ca8765c30ed2 509 *
fneirab 8:ca8765c30ed2 510 * \retval ttf_data - Time to Empty data from the TTF_REG register
fneirab 8:ca8765c30ed2 511 *
fneirab 8:ca8765c30ed2 512 * -1 if errors exist
fneirab 8:ca8765c30ed2 513 */
fneirab 8:ca8765c30ed2 514
fneirab 8:ca8765c30ed2 515
fneirab 8:ca8765c30ed2 516 int get_TTF();
fneirab 7:479a36909ced 517
fneirab 7:479a36909ced 518
fneirab 7:479a36909ced 519 ////////////////////////////////////////////////////////////////////////////
fneirab 7:479a36909ced 520
fneirab 7:479a36909ced 521 /**
fneirab 7:479a36909ced 522 * \brief Get voltage of the cell Function for MAX17055
fneirab 7:479a36909ced 523 * \par Details
fneirab 7:479a36909ced 524 * This function sends a request to access the internal register
fneirab 7:479a36909ced 525 * of the MAX17055 to read the voltage of the cell
fneirab 7:479a36909ced 526 *
fneirab 7:479a36909ced 527 * \retval vcell_data - vcell data from the VCELL_REG register
fneirab 7:479a36909ced 528 *
fneirab 7:479a36909ced 529 * -1 if errors exist
fneirab 7:479a36909ced 530 */
fneirab 7:479a36909ced 531
fneirab 7:479a36909ced 532
fneirab 7:479a36909ced 533 int get_Vcell();
fneirab 7:479a36909ced 534
fneirab 7:479a36909ced 535 ////////////////////////////////////////////////////////////////////////////
fneirab 7:479a36909ced 536
fneirab 7:479a36909ced 537 /**
fneirab 7:479a36909ced 538 * \brief Get current Function for MAX17055
fneirab 7:479a36909ced 539 * \par Details
fneirab 7:479a36909ced 540 * This function sends a request to access the internal register
fneirab 7:479a36909ced 541 * of the MAX17055 to read the current register.
fneirab 7:479a36909ced 542 *
fneirab 7:479a36909ced 543 * \retval curr_data - vcell data from the VCELL_REG register
fneirab 7:479a36909ced 544 *
fneirab 7:479a36909ced 545 * -1 if errors exist
fneirab 7:479a36909ced 546 */
fneirab 7:479a36909ced 547
fneirab 7:479a36909ced 548
fneirab 7:479a36909ced 549 int get_Current(platform_data des_data);
fneirab 7:479a36909ced 550
fneirab 7:479a36909ced 551 ////////////////////////////////////////////////////////////////////////////
fneirab 7:479a36909ced 552
fneirab 7:479a36909ced 553 /**
fneirab 7:479a36909ced 554 * \brief Get Average Current Function for MAX17055
fneirab 7:479a36909ced 555 * \par Details
fneirab 7:479a36909ced 556 * This function sends a request to access the internal register
fneirab 7:479a36909ced 557 * of the MAX17055 to read the average current register.
fneirab 7:479a36909ced 558 *
fneirab 7:479a36909ced 559 * \retval curr_data - vcell data from the AVGCURRENT_REG register
fneirab 7:479a36909ced 560 *
fneirab 7:479a36909ced 561 * -1 if errors exist
fneirab 7:479a36909ced 562 */
fneirab 7:479a36909ced 563
fneirab 7:479a36909ced 564
fneirab 7:479a36909ced 565 int get_AvgCurrent(platform_data des_data);
fneirab 7:479a36909ced 566
fneirab 7:479a36909ced 567 ////////////////////////////////////////////////////////////////////////////
fneirab 7:479a36909ced 568
fneirab 7:479a36909ced 569 /**
fneirab 7:479a36909ced 570 * \brief lsb_to_uvolts Converssion Function
fneirab 7:479a36909ced 571 * \par Details
fneirab 7:479a36909ced 572 * This function takes the lsb value of the register and convert it
fneirab 7:479a36909ced 573 * to uvolts
fneirab 7:479a36909ced 574 *
fneirab 7:479a36909ced 575 * \param[in] lsb - value of register lsb
fneirab 7:479a36909ced 576 * \retval lsb - converted lsb to uvolts
fneirab 7:479a36909ced 577 *
fneirab 7:479a36909ced 578 */
fneirab 7:479a36909ced 579
fneirab 7:479a36909ced 580 int lsb_to_uvolts(uint16_t lsb);
fneirab 7:479a36909ced 581
fneirab 7:479a36909ced 582
fneirab 7:479a36909ced 583 ///////////////////////////////////////////////////////////////////////////////
fneirab 7:479a36909ced 584
fneirab 7:479a36909ced 585 /**
fneirab 7:479a36909ced 586 * \brief raw_current_to_uamp Converssion Function
fneirab 7:479a36909ced 587 * \par Details
fneirab 7:479a36909ced 588 * This function takes the raw current value of the register and
fneirab 7:479a36909ced 589 * converts it to uamps
fneirab 7:479a36909ced 590 *
fneirab 7:479a36909ced 591 * \param[in] curr - raw current value of register
fneirab 7:479a36909ced 592 * \retval res - converted raw current to uamps - Signed 2's complement
fneirab 7:479a36909ced 593 *
fneirab 7:479a36909ced 594 */
fneirab 7:479a36909ced 595
fneirab 7:479a36909ced 596 int raw_current_to_uamps(uint32_t curr, int rsense_value);
fneirab 3:f77a8345b0e3 597
fneirab 9:f29d5e49b190 598 ///////////////////////////////////////////////////////////////////////////////
fneirab 4:a4d6ae2182c2 599
fneirab 9:f29d5e49b190 600 /**
fneirab 9:f29d5e49b190 601 * \brief Save Learned Parameters Function
fneirab 9:f29d5e49b190 602 * \par Details
fneirab 9:f29d5e49b190 603 * It is recommended to save the learned capacity parameters every
fneirab 9:f29d5e49b190 604 * time bit 2 of the Cycles register toggles
fneirab 9:f29d5e49b190 605 * (so that it is saved every 64% change in the battery)
fneirab 9:f29d5e49b190 606 * so that if power is lost the values can easily be restored.
fneirab 9:f29d5e49b190 607 *
fneirab 9:f29d5e49b190 608 * \param[in] struct saved_FG_params_t
fneirab 9:f29d5e49b190 609 * \retval void
fneirab 9:f29d5e49b190 610 *
fneirab 9:f29d5e49b190 611 */
fneirab 9:f29d5e49b190 612
fneirab 9:f29d5e49b190 613 int save_Params(saved_FG_params_t FG_params);
fneirab 9:f29d5e49b190 614
fneirab 9:f29d5e49b190 615 ///////////////////////////////////////////////////////////////////////////////
fneirab 9:f29d5e49b190 616
fneirab 9:f29d5e49b190 617 /**
fneirab 9:f29d5e49b190 618 * \brief Resotore Parameters Function
fneirab 9:f29d5e49b190 619 * \par Details
fneirab 9:f29d5e49b190 620 * If power is lost, then the capacity information
fneirab 9:f29d5e49b190 621 * can be easily restored with this function
fneirab 9:f29d5e49b190 622 *
fneirab 9:f29d5e49b190 623 * \param[in] struct saved_FG_params_t
fneirab 9:f29d5e49b190 624 * \retval void
fneirab 9:f29d5e49b190 625 *
fneirab 9:f29d5e49b190 626 */
fneirab 9:f29d5e49b190 627
fneirab 9:f29d5e49b190 628 int restore_Params(saved_FG_params_t FG_params);
fneirab 2:ff7db397b70f 629
fneirab 2:ff7db397b70f 630 protected:
fneirab 0:80c39eb8f3ba 631 /**
fneirab 0:80c39eb8f3ba 632 * @brief Write Register
fneirab 0:80c39eb8f3ba 633 * @details Writes data to max17055 Register
fneirab 0:80c39eb8f3ba 634 *
fneirab 0:80c39eb8f3ba 635 * @parameters reg_addr Registers to write
fneirab 0:80c39eb8f3ba 636 * reg_data Data to write
fneirab 0:80c39eb8f3ba 637 */
fneirab 0:80c39eb8f3ba 638 int writeReg(const Registers_e reg_addr, uint16_t reg_data);
fneirab 0:80c39eb8f3ba 639
fneirab 0:80c39eb8f3ba 640 /**
fneirab 0:80c39eb8f3ba 641 * @brief Read Register
fneirab 0:80c39eb8f3ba 642 * @details Reads data from max17055 register
fneirab 0:80c39eb8f3ba 643 *
fneirab 0:80c39eb8f3ba 644 * @parameters reg_addr Register to read
fneirab 0:80c39eb8f3ba 645 */
fneirab 1:a031f0c6a71e 646 int32_t readReg(Registers_e reg_addr, uint16_t &value);
fneirab 4:a4d6ae2182c2 647
fneirab 2:ff7db397b70f 648
fneirab 0:80c39eb8f3ba 649
fneirab 2:ff7db397b70f 650
fneirab 0:80c39eb8f3ba 651
fneirab 9:f29d5e49b190 652
fneirab 9:f29d5e49b190 653
fneirab 9:f29d5e49b190 654
fneirab 0:80c39eb8f3ba 655 private:
fneirab 0:80c39eb8f3ba 656
fneirab 0:80c39eb8f3ba 657 I2C &m_i2cBus; // I2C object
fneirab 0:80c39eb8f3ba 658
fneirab 0:80c39eb8f3ba 659 };
fneirab 0:80c39eb8f3ba 660
fneirab 0:80c39eb8f3ba 661 #endif /* _MAX17055_H_ */