amiro-lld / drivers / bq27500 / v1 / alld_bq27500.h @ f69ec051
History | View | Annotate | Download (12.864 KB)
| 1 |
/*
|
|---|---|
| 2 |
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
|
| 3 |
Copyright (C) 2016..2020 Thomas Schöpping et al.
|
| 4 |
|
| 5 |
This program is free software: you can redistribute it and/or modify
|
| 6 |
it under the terms of the GNU Lesser General Public License as published by
|
| 7 |
the Free Software Foundation, either version 3 of the License, or
|
| 8 |
(at your option) any later version.
|
| 9 |
|
| 10 |
This program is distributed in the hope that it will be useful,
|
| 11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 13 |
GNU Lesser General Public License for more details.
|
| 14 |
|
| 15 |
You should have received a copy of the GNU Lesser General Public License
|
| 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
| 17 |
*/
|
| 18 |
|
| 19 |
/**
|
| 20 |
* @file alld_bq27500.h
|
| 21 |
* @brief Fuel Gauge constants and structures.
|
| 22 |
*
|
| 23 |
* @addtogroup lld_gauge
|
| 24 |
* @{
|
| 25 |
*/
|
| 26 |
|
| 27 |
#ifndef AMIROLLD_BQ27500_H
|
| 28 |
#define AMIROLLD_BQ27500_H
|
| 29 |
|
| 30 |
#include <amiro-lld.h> |
| 31 |
|
| 32 |
/******************************************************************************/
|
| 33 |
/* CONSTANTS */
|
| 34 |
/******************************************************************************/
|
| 35 |
|
| 36 |
/**
|
| 37 |
* @brief Hardware version number.
|
| 38 |
* @details There are three different revisions of the bq27500 fuel gauge:
|
| 39 |
* 100, 120, and 130.
|
| 40 |
* If no version is set, it defaults to 100.
|
| 41 |
*/
|
| 42 |
#if !defined(BQ27500_LLD_HWVERSION)
|
| 43 |
#define BQ27500_LLD_HWVERSION 100 |
| 44 |
#endif
|
| 45 |
|
| 46 |
/* hardware version santity checks */
|
| 47 |
#if (BQ27500_LLD_HWVERSION != 100) && (BQ27500_LLD_HWVERSION != 120) && (BQ27500_LLD_HWVERSION != 130) |
| 48 |
#error "Invalid hardware version selected" |
| 49 |
#endif
|
| 50 |
|
| 51 |
/**
|
| 52 |
* @brief fixed I2C address
|
| 53 |
*/
|
| 54 |
#define BQ27500_LLD_I2C_ADDR 0x55u |
| 55 |
|
| 56 |
/**
|
| 57 |
* @brief maximum I2C frequency in Hz
|
| 58 |
*/
|
| 59 |
#if (BQ27500_LLD_HWVERSION == 100) |
| 60 |
#define BQ27500_LLD_I2C_MAXFREQUENCY 100000 |
| 61 |
#elif (BQ27500_LLD_HWVERSION == 120) |
| 62 |
#define BQ27500_LLD_I2C_MAXFREQUENCY 400000 |
| 63 |
#elif (BQ27500_LLD_HWVERSION == 130) |
| 64 |
#define BQ27500_LLD_I2C_MAXFREQUENCY 400000 |
| 65 |
#endif
|
| 66 |
|
| 67 |
/**
|
| 68 |
* @brief default key0 to get into unsealed mode
|
| 69 |
*/
|
| 70 |
#define BQ27500_LLD_DEFAULT_UNSEAL_KEY0 0x3672u |
| 71 |
|
| 72 |
/**
|
| 73 |
* @brief default key1 to get into unsealed mode
|
| 74 |
*/
|
| 75 |
#define BQ27500_LLD_DEFAULT_UNSEAL_KEY1 0x0414u |
| 76 |
|
| 77 |
/**
|
| 78 |
* @brief Active state of battery low gpio.
|
| 79 |
*/
|
| 80 |
#define BQ27500_LLD_BATLOW_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
| 81 |
|
| 82 |
/**
|
| 83 |
* @brief Active state of battery good gpio.
|
| 84 |
*/
|
| 85 |
#define BQ27500_LLD_BATGOOD_ACTIVE_STATE APAL_GPIO_ACTIVE_LOW
|
| 86 |
|
| 87 |
/******************************************************************************/
|
| 88 |
/* SETTINGS */
|
| 89 |
/******************************************************************************/
|
| 90 |
|
| 91 |
/******************************************************************************/
|
| 92 |
/* CHECKS */
|
| 93 |
/******************************************************************************/
|
| 94 |
|
| 95 |
/******************************************************************************/
|
| 96 |
/* DATA STRUCTURES AND TYPES */
|
| 97 |
/******************************************************************************/
|
| 98 |
|
| 99 |
/**
|
| 100 |
* @brief Possible standard commands.
|
| 101 |
*/
|
| 102 |
typedef enum { |
| 103 |
// unit | access
|
| 104 |
// | sealed | unsealed
|
| 105 |
// ---------+---------+----------
|
| 106 |
BQ27500_LLD_STD_CMD_Control = 0x00u, BQ27500_LLD_STD_CMD_CNTL = 0x00u, // N/A | R/W | R/W |
| 107 |
BQ27500_LLD_STD_CMD_AtRate = 0x02u, BQ27500_LLD_STD_CMD_AR = 0x02u, // mA | R/W | R/W |
| 108 |
BQ27500_LLD_STD_CMD_AtRateTimeToEmpty = 0x04u, BQ27500_LLD_STD_CMD_ARTTE = 0x04u, // minutes | R | R/W |
| 109 |
BQ27500_LLD_STD_CMD_Temperature = 0x06u, BQ27500_LLD_STD_CMD_TEMP = 0x06u, // 0.1 K | R | R/W |
| 110 |
BQ27500_LLD_STD_CMD_Voltage = 0x08u, BQ27500_LLD_STD_CMD_VOLT = 0x08u, // mV | R | R/W |
| 111 |
BQ27500_LLD_STD_CMD_Flags = 0x0Au, BQ27500_LLD_STD_CMD_FLAGS = 0x0Au, // N/A | R | R/W |
| 112 |
BQ27500_LLD_STD_CMD_NominalAvailableCapacity = 0x0Cu, BQ27500_LLD_STD_CMD_NAC = 0x0Cu, // mAh | R | R/W |
| 113 |
BQ27500_LLD_STD_CMD_FullAvailableCapacity = 0x0Eu, BQ27500_LLD_STD_CMD_FAC = 0x0Eu, // mAh | R | R/W |
| 114 |
BQ27500_LLD_STD_CMD_RemainingCapacity = 0x10u, BQ27500_LLD_STD_CMD_RM = 0x10u, // mAh | R | R/W |
| 115 |
BQ27500_LLD_STD_CMD_FullChargeCapacity = 0x12u, BQ27500_LLD_STD_CMD_FCC = 0x12u, // mAh | R | R/W |
| 116 |
BQ27500_LLD_STD_CMD_AverageCurrent = 0x14u, BQ27500_LLD_STD_CMD_AI = 0x14u, // mA | R | R/W |
| 117 |
BQ27500_LLD_STD_CMD_TimeToEmpty = 0x16u, BQ27500_LLD_STD_CMD_TTE = 0x16u, // minutes | R | R/W |
| 118 |
BQ27500_LLD_STD_CMD_TimeToFull = 0x18u, BQ27500_LLD_STD_CMD_TTF = 0x18u, // minutes | R | R/W |
| 119 |
BQ27500_LLD_STD_CMD_StandbyCurrent = 0x1Au, BQ27500_LLD_STD_CMD_SI = 0x1Au, // mA | R | R/W |
| 120 |
BQ27500_LLD_STD_CMD_StandbyTimeToEmpty = 0x1Cu, BQ27500_LLD_STD_CMD_STTE = 0x1Cu, // minutes | R | R/W |
| 121 |
BQ27500_LLD_STD_CMD_MaxLoadCurrent = 0x1Eu, BQ27500_LLD_STD_CMD_MLI = 0x1Eu, // mA | R | R/W |
| 122 |
BQ27500_LLD_STD_CMD_MaxLoadTimeToEmpty = 0x20u, BQ27500_LLD_STD_CMD_MLTTE = 0x20u, // minutes | R | R/W |
| 123 |
BQ27500_LLD_STD_CMD_AvailableEnergy = 0x22u, BQ27500_LLD_STD_CMD_AE = 0x22u, // mWh | R | R/W |
| 124 |
BQ27500_LLD_STD_CMD_AveragePower = 0x24u, BQ27500_LLD_STD_CMD_AP = 0x24u, // mW | R | R/W |
| 125 |
BQ27500_LLD_STD_CMD_TimeToEmptyAtConstantPower = 0x26u, BQ27500_LLD_STD_CMD_TTECP = 0x26u, // minutes | R | R/W |
| 126 |
BQ27500_LLD_STD_CMD_CycleCount = 0x2Au, BQ27500_LLD_STD_CMD_CC = 0x2Au, // counts | R | R/W |
| 127 |
BQ27500_LLD_STD_CMD_StateOfCharge = 0x2Cu, BQ27500_LLD_STD_CMD_SOC = 0x2Cu // % | R | R/W |
| 128 |
} bq27500_lld_std_command_t; |
| 129 |
|
| 130 |
/**
|
| 131 |
* @brief Subcommands of the control command.
|
| 132 |
*/
|
| 133 |
typedef enum { |
| 134 |
// sealed access
|
| 135 |
// -------------
|
| 136 |
BQ27500_LLD_SUB_CMD_CONTROL_STATUS = 0x0000u, // yes |
| 137 |
BQ27500_LLD_SUB_CMD_DEVICE_TYPE = 0x0001u, // yes |
| 138 |
BQ27500_LLD_SUB_CMD_FW_VERSION = 0x0002u, // yes |
| 139 |
BQ27500_LLD_SUB_CMD_HW_VERSION = 0x0003u, // yes |
| 140 |
BQ27500_LLD_SUB_CMD_DF_CHECKSUM = 0x0004u, // no |
| 141 |
BQ27500_LLD_SUB_CMD_RESET_DATA = 0x0005u, // yes |
| 142 |
BQ27500_LLD_SUB_CMD_PREV_MACWRITE = 0x0007u, // yes |
| 143 |
BQ27500_LLD_SUB_CMD_CHEM_ID = 0x0008u, // yes |
| 144 |
BQ27500_LLD_SUB_CMD_BOARD_OFFSET = 0x0009u, // no |
| 145 |
BQ27500_LLD_SUB_CMD_CC_INT_OFFSET = 0x000Au, // no |
| 146 |
BQ27500_LLD_SUB_CMD_WRITE_OFFSET = 0x000Bu, // no |
| 147 |
BQ27500_LLD_SUB_CMD_SET_HIBERNATE = 0x0011u, // yes |
| 148 |
BQ27500_LLD_SUB_CMD_CLEAR_HIBERNATE = 0x0012u, // yes |
| 149 |
BQ27500_LLD_SUB_CMD_SET_SLEEPp = 0x0013u, // yes |
| 150 |
BQ27500_LLD_SUB_CMD_CLEAR_SLEEPp = 0x0014u, // yes |
| 151 |
BQ27500_LLD_SUB_CMD_SEALED = 0x0020u, // no |
| 152 |
BQ27500_LLD_SUB_CMD_IT_ENABLE = 0x0021u, // no |
| 153 |
BQ27500_LLD_SUB_CMD_IF_CHECKSUM = 0x0022u, // no |
| 154 |
BQ27500_LLD_SUB_CMD_CAL_MODE = 0x0040u, // no |
| 155 |
BQ27500_LLD_SUB_CMD_RESET = 0x0041u, // no |
| 156 |
} bq27500_lld_control_subcmd_t; |
| 157 |
|
| 158 |
/**
|
| 159 |
* @brief Extended commands.
|
| 160 |
*/
|
| 161 |
typedef enum { |
| 162 |
// length | unit | sealed | unsealed
|
| 163 |
// -------+------+--------+----------
|
| 164 |
BQ27500_LLD_EXT_CMD_DesignCapacity = 0x3Cu, EXT_CMD_DCAP = 0x3Cu, // 2 | mAh | R | R |
| 165 |
BQ27500_LLD_EXT_CMD_DataFlashClass = 0x3Eu, EXT_CMD_DFCLS = 0x3Eu, // 1 | N/A | N/A | R/W |
| 166 |
BQ27500_LLD_EXT_CMD_DataFlashBlock = 0x3Fu, EXT_CMD_DFBLK = 0x3Fu, // 1 | N/A | R/W | R/W |
| 167 |
BQ27500_LLD_EXT_CMD_BlockData = 0x40u, EXT_CMD_DFD = 0x40u, // 32 | N/A | R | R/W |
| 168 |
BQ27500_LLD_EXT_CMD_BlockDataCheckSum = 0x60u,EXT_CMD_DFDCKS = 0x60u, // 1 | N/A | R/W | R/W |
| 169 |
BQ27500_LLD_EXT_CMD_BlockDataControl = 0x61u, EXT_CMD_DFDCNTL = 0x61u, // 1 | N/A | N/A | R/W |
| 170 |
BQ27500_LLD_EXT_CMD_DeviceNameLength = 0x62u, EXT_CMD_DNAMELEN = 0x62u, // 1 | N/A | R | R |
| 171 |
BQ27500_LLD_EXT_CMD_DeviceName = 0x63u, EXT_CMD_DNAME = 0x63u, // 7 | N/A | R | R |
| 172 |
BQ27500_LLD_EXT_CMD_ApplicationStatus = 0x6Au, EXT_CMD_APPSTAT = 0x6Au // 1 | N/A | R | R |
| 173 |
} bq27500_lld_ext_command_t; |
| 174 |
|
| 175 |
/**
|
| 176 |
* @brief Read or write access to extended commands.
|
| 177 |
*/
|
| 178 |
typedef enum { |
| 179 |
BQ27500_LLD_EXT_CMD_READ = 0,
|
| 180 |
BQ27500_LLD_EXT_CMD_WRITE = 1,
|
| 181 |
} bq27500_lld_ext_cmd_access_t; |
| 182 |
|
| 183 |
/**
|
| 184 |
* @brief Union to inspect the version value.
|
| 185 |
*/
|
| 186 |
typedef union { |
| 187 |
uint16_t value; |
| 188 |
struct {
|
| 189 |
uint16_t minor_low : 4;
|
| 190 |
uint16_t minor_high : 4;
|
| 191 |
uint16_t major_low : 4;
|
| 192 |
uint16_t major_high : 4;
|
| 193 |
} content; |
| 194 |
} bq27500_lld_version_t; |
| 195 |
|
| 196 |
/**
|
| 197 |
* @brief Union to inspect the flags register.
|
| 198 |
*/
|
| 199 |
typedef union { |
| 200 |
uint16_t value; |
| 201 |
struct {
|
| 202 |
uint16_t dsg : 1;
|
| 203 |
uint16_t socf : 1;
|
| 204 |
uint16_t soc1 : 1;
|
| 205 |
uint16_t bat_det : 1;
|
| 206 |
uint16_t wait_id : 1;
|
| 207 |
uint16_t ocv_gd : 1;
|
| 208 |
uint16_t rsvd_6_7 : 2;
|
| 209 |
uint16_t chg : 1;
|
| 210 |
uint16_t fc : 1;
|
| 211 |
uint16_t xchg : 1;
|
| 212 |
uint16_t chg_inh : 1;
|
| 213 |
uint16_t rsvd_12_13 : 2;
|
| 214 |
uint16_t otd : 1;
|
| 215 |
uint16_t otc : 1;
|
| 216 |
} content; |
| 217 |
} bq27500_lld_flags_t; |
| 218 |
|
| 219 |
/**
|
| 220 |
* @brief Union to inspect the control status.
|
| 221 |
*/
|
| 222 |
typedef union { |
| 223 |
uint16_t value; |
| 224 |
struct {
|
| 225 |
uint16_t qen : 1;
|
| 226 |
uint16_t vok : 1;
|
| 227 |
uint16_t rup_dis : 1;
|
| 228 |
uint16_t ldmd : 1;
|
| 229 |
uint16_t sleep : 1;
|
| 230 |
uint16_t snooze : 1;
|
| 231 |
uint16_t hibernate : 1;
|
| 232 |
uint16_t rsvd_7_8_9 : 3;
|
| 233 |
uint16_t bca : 1;
|
| 234 |
uint16_t cca : 1;
|
| 235 |
uint16_t csv : 1;
|
| 236 |
uint16_t ss : 1;
|
| 237 |
uint16_t fas : 1;
|
| 238 |
uint16_t rsvd_15 : 1;
|
| 239 |
} content; |
| 240 |
} bq27500_lld_control_status_t; |
| 241 |
|
| 242 |
/**
|
| 243 |
* @brief BQ27500 Driver struct.
|
| 244 |
*/
|
| 245 |
typedef struct { |
| 246 |
apalI2CDriver_t* i2cd; /**< @brief I2C driver to access the BQ27500 */
|
| 247 |
const apalControlGpio_t* gpio_batlow; /**< @brief Gpio to indicate whether the battery is low */ |
| 248 |
const apalControlGpio_t* gpio_batgood; /**< @brief Gpio to indicate whether the battery is good */ |
| 249 |
} BQ27500Driver; |
| 250 |
|
| 251 |
/**
|
| 252 |
* @brief Battery low enum.
|
| 253 |
*/
|
| 254 |
typedef enum { |
| 255 |
BQ27500_LLD_BATTERY_LOW = 0x01,
|
| 256 |
BQ27500_LLD_BATTERY_NOT_LOW = 0x00,
|
| 257 |
} bq27500_lld_batlow_t; |
| 258 |
|
| 259 |
/**
|
| 260 |
* @brief Battery good enum.
|
| 261 |
*/
|
| 262 |
typedef enum { |
| 263 |
BQ27500_LLD_BATTERY_GOOD = 0x01,
|
| 264 |
BQ27500_LLD_BATTERY_NOT_GOOD = 0x00,
|
| 265 |
} bq27500_lld_batgood_t; |
| 266 |
|
| 267 |
/******************************************************************************/
|
| 268 |
/* MACROS */
|
| 269 |
/******************************************************************************/
|
| 270 |
|
| 271 |
/******************************************************************************/
|
| 272 |
/* EXTERN DECLARATIONS */
|
| 273 |
/******************************************************************************/
|
| 274 |
|
| 275 |
#ifdef __cplusplus
|
| 276 |
extern "C" { |
| 277 |
#endif
|
| 278 |
apalExitStatus_t bq27500_lld_read_batlow(const BQ27500Driver* const bq27500, bq27500_lld_batlow_t* const batlow); |
| 279 |
apalExitStatus_t bq27500_lld_read_batgood(const BQ27500Driver* const bq27500, bq27500_lld_batgood_t* const batgood); |
| 280 |
apalExitStatus_t bq27500_lld_std_command(const BQ27500Driver* const bq27500, const bq27500_lld_std_command_t cmd, uint16_t* const dst, const apalTime_t timeout); |
| 281 |
apalExitStatus_t bq27500_lld_sub_command_call(const BQ27500Driver* const bq27500, const bq27500_lld_control_subcmd_t cmd, const apalTime_t timeout); |
| 282 |
apalExitStatus_t bq27500_lld_sub_command_read(const BQ27500Driver* const bq27500, uint16_t* const data, const apalTime_t timeout); |
| 283 |
apalExitStatus_t bq27500_lld_ext_command(const BQ27500Driver* const bq27500, const bq27500_lld_ext_command_t cmd, const bq27500_lld_ext_cmd_access_t rw, uint8_t* const buffer, const uint8_t length, const uint8_t offset, const apalTime_t timeout); |
| 284 |
apalExitStatus_t bq27500_lld_send_ctnl_data(const BQ27500Driver* const bq27500, const uint16_t data, const apalTime_t timeout); |
| 285 |
apalExitStatus_t bq27500_lld_compute_blockdata_checksum(const uint8_t* const blockdata, uint8_t* const sum); |
| 286 |
#ifdef __cplusplus
|
| 287 |
} |
| 288 |
#endif
|
| 289 |
|
| 290 |
/******************************************************************************/
|
| 291 |
/* INLINE FUNCTIONS */
|
| 292 |
/******************************************************************************/
|
| 293 |
|
| 294 |
#endif /* AMIROLLD_BQ27500_H */ |
| 295 |
|
| 296 |
/** @} */
|
| 297 |
|