amiro-lld / include / alld_bq27500.h @ 11500ad8
History | View | Annotate | Download (10.6 KB)
1 |
/*
|
---|---|
2 |
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
|
3 |
Copyright (C) 2016..2018 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 |
#if defined(AMIROLLD_CFG_USE_BQ27500) || defined(__DOXYGEN__)
|
33 |
|
34 |
/**
|
35 |
* @brief fixed I2C address
|
36 |
*/
|
37 |
#define BQ27500_LLD_I2C_ADDR 0x55u |
38 |
|
39 |
/**
|
40 |
* @brief maximum I2C frequency in Hz
|
41 |
*/
|
42 |
#define BQ27500_LLD_I2C_MAXFREQUENCY 100000 |
43 |
|
44 |
/**
|
45 |
* @brief default key0 to get into unsealed mode
|
46 |
*/
|
47 |
#define BQ27500_LLD_DEFAULT_UNSEAL_KEY0 0x3672u |
48 |
|
49 |
/**
|
50 |
* @brief default key1 to get into unsealed mode
|
51 |
*/
|
52 |
#define BQ27500_LLD_DEFAULT_UNSEAL_KEY1 0x0414u |
53 |
|
54 |
/**
|
55 |
* @brief Active state of battery low gpio.
|
56 |
*/
|
57 |
#define BQ27500_LLD_BATLOW_ACTIVE_STATE APAL_GPIO_ACTIVE_HIGH
|
58 |
|
59 |
/**
|
60 |
* @brief Active state of battery good gpio.
|
61 |
*/
|
62 |
#define BQ27500_LLD_BATGOOD_ACTIVE_STATE APAL_GPIO_ACTIVE_LOW
|
63 |
|
64 |
/**
|
65 |
* @brief Possible standard commands.
|
66 |
*/
|
67 |
typedef enum { |
68 |
// unit | access
|
69 |
// | sealed | unsealed
|
70 |
// ---------+---------+----------
|
71 |
BQ27500_LLD_STD_CMD_Control = 0x00u, BQ27500_LLD_STD_CMD_CNTL = 0x00u, // N/A | R/W | R/W |
72 |
BQ27500_LLD_STD_CMD_AtRate = 0x02u, BQ27500_LLD_STD_CMD_AR = 0x02u, // mA | R/W | R/W |
73 |
BQ27500_LLD_STD_CMD_AtRateTimeToEmpty = 0x04u, BQ27500_LLD_STD_CMD_ARTTE = 0x04u, // minutes | R | R/W |
74 |
BQ27500_LLD_STD_CMD_Temperatur = 0x06u, BQ27500_LLD_STD_CMD_TEMP = 0x06u, // 0.1 K | R | R/W |
75 |
BQ27500_LLD_STD_CMD_Voltage = 0x08u, BQ27500_LLD_STD_CMD_VOLT = 0x08u, // mV | R | R/W |
76 |
BQ27500_LLD_STD_CMD_Flags = 0x0Au, BQ27500_LLD_STD_CMD_FLAGS = 0x0Au, // N/A | R | R/W |
77 |
BQ27500_LLD_STD_CMD_NominalAvailableCapacity = 0x0Cu, BQ27500_LLD_STD_CMD_NAC = 0x0Cu, // mAh | R | R/W |
78 |
BQ27500_LLD_STD_CMD_FullAvailableCapacity = 0x0Eu, BQ27500_LLD_STD_CMD_FAC = 0x0Eu, // mAh | R | R/W |
79 |
BQ27500_LLD_STD_CMD_RemainingCapacity = 0x10u, BQ27500_LLD_STD_CMD_RM = 0x10u, // mAh | R | R/W |
80 |
BQ27500_LLD_STD_CMD_FullChargeCapacity = 0x12u, BQ27500_LLD_STD_CMD_FCC = 0x12u, // mAh | R | R/W |
81 |
BQ27500_LLD_STD_CMD_AverageCurrent = 0x14u, BQ27500_LLD_STD_CMD_AI = 0x14u, // mA | R | R/W |
82 |
BQ27500_LLD_STD_CMD_TimeToEmpty = 0x16u, BQ27500_LLD_STD_CMD_TTE = 0x16u, // minutes | R | R/W |
83 |
BQ27500_LLD_STD_CMD_TimeToFull = 0x18u, BQ27500_LLD_STD_CMD_TTF = 0x18u, // minutes | R | R/W |
84 |
BQ27500_LLD_STD_CMD_StandbyCurrent = 0x1Au, BQ27500_LLD_STD_CMD_SI = 0x1Au, // mA | R | R/W |
85 |
BQ27500_LLD_STD_CMD_StandbyTimeToEmpty = 0x1Cu, BQ27500_LLD_STD_CMD_STTE = 0x1Cu, // minutes | R | R/W |
86 |
BQ27500_LLD_STD_CMD_MaxLoadCurrent = 0x1Eu, BQ27500_LLD_STD_CMD_MLI = 0x1Eu, // mA | R | R/W |
87 |
BQ27500_LLD_STD_CMD_MaxLoadTimeToEmpty = 0x20u, BQ27500_LLD_STD_CMD_MLTTE = 0x20u, // minutes | R | R/W |
88 |
BQ27500_LLD_STD_CMD_AvailableEnergy = 0x22u, BQ27500_LLD_STD_CMD_AE = 0x22u, // mWh | R | R/W |
89 |
BQ27500_LLD_STD_CMD_AveragePower = 0x24u, BQ27500_LLD_STD_CMD_AP = 0x24u, // mW | R | R/W |
90 |
BQ27500_LLD_STD_CMD_TimeToEmptyAtConstantPower = 0x26u, BQ27500_LLD_STD_CMD_TTECP = 0x26u, // minutes | R | R/W |
91 |
BQ27500_LLD_STD_CMD_CycleCount = 0x2Au, BQ27500_LLD_STD_CMD_CC = 0x2Au, // counts | R | R/W |
92 |
BQ27500_LLD_STD_CMD_StateOfCharge = 0x2Cu, BQ27500_LLD_STD_CMD_SOC = 0x2Cu // % | R | R/W |
93 |
} bq27500_lld_std_command_t; |
94 |
|
95 |
/**
|
96 |
* @brief Subcommands of the control command.
|
97 |
*/
|
98 |
typedef enum { |
99 |
// sealed access
|
100 |
// -------------
|
101 |
BQ27500_LLD_SUB_CMD_CONTROL_STATUS = 0x0000u, // yes |
102 |
BQ27500_LLD_SUB_CMD_DEVICE_TYPE = 0x0001u, // yes |
103 |
BQ27500_LLD_SUB_CMD_FW_VERSION = 0x0002u, // yes |
104 |
BQ27500_LLD_SUB_CMD_HW_VERSION = 0x0003u, // yes |
105 |
BQ27500_LLD_SUB_CMD_DF_CHECKSUM = 0x0004u, // no |
106 |
BQ27500_LLD_SUB_CMD_RESET_DATA = 0x0005u, // yes |
107 |
BQ27500_LLD_SUB_CMD_PREV_MACWRITE = 0x0007u, // yes |
108 |
BQ27500_LLD_SUB_CMD_CHEM_ID = 0x0008u, // yes |
109 |
BQ27500_LLD_SUB_CMD_BOARD_OFFSET = 0x0009u, // no |
110 |
BQ27500_LLD_SUB_CMD_CC_INT_OFFSET = 0x000Au, // no |
111 |
BQ27500_LLD_SUB_CMD_WRITE_OFFSET = 0x000Bu, // no |
112 |
BQ27500_LLD_SUB_CMD_SET_HIBERNATE = 0x0011u, // yes |
113 |
BQ27500_LLD_SUB_CMD_CLEAR_HIBERNATE = 0x0012u, // yes |
114 |
BQ27500_LLD_SUB_CMD_SET_SLEEPp = 0x0013u, // yes |
115 |
BQ27500_LLD_SUB_CMD_CLEAR_SLEEPp = 0x0014u, // yes |
116 |
BQ27500_LLD_SUB_CMD_SEALED = 0x0020u, // no |
117 |
BQ27500_LLD_SUB_CMD_IT_ENABLE = 0x0021u, // no |
118 |
BQ27500_LLD_SUB_CMD_IF_CHECKSUM = 0x0022u, // no |
119 |
BQ27500_LLD_SUB_CMD_CAL_MODE = 0x0040u, // no |
120 |
BQ27500_LLD_SUB_CMD_RESET = 0x0041u, // no |
121 |
} bq27500_lld_control_subcmd_t; |
122 |
|
123 |
/**
|
124 |
* @brief Extended commands.
|
125 |
*/
|
126 |
typedef enum { |
127 |
// length | unit | sealed | unsealed
|
128 |
// -------+------+--------+----------
|
129 |
BQ27500_LLD_EXT_CMD_DesignCapacity = 0x3Cu, EXT_CMD_DCAP = 0x3Cu, // 2 | mAh | R | R |
130 |
BQ27500_LLD_EXT_CMD_DataFlashClass = 0x3Eu, EXT_CMD_DFCLS = 0x3Eu, // 1 | N/A | N/A | R/W |
131 |
BQ27500_LLD_EXT_CMD_DataFlashBlock = 0x3Fu, EXT_CMD_DFBLK = 0x3Fu, // 1 | N/A | R/W | R/W |
132 |
BQ27500_LLD_EXT_CMD_BlockData = 0x40u, EXT_CMD_DFD = 0x40u, // 32 | N/A | R | R/W |
133 |
BQ27500_LLD_EXT_CMD_BlockDataCheckSum = 0x60u,EXT_CMD_DFDCKS = 0x60u, // 1 | N/A | R/W | R/W |
134 |
BQ27500_LLD_EXT_CMD_BlockDataControl = 0x61u, EXT_CMD_DFDCNTL = 0x61u, // 1 | N/A | N/A | R/W |
135 |
BQ27500_LLD_EXT_CMD_DeviceNameLength = 0x62u, EXT_CMD_DNAMELEN = 0x62u, // 1 | N/A | R | R |
136 |
BQ27500_LLD_EXT_CMD_DeviceName = 0x63u, EXT_CMD_DNAME = 0x63u, // 7 | N/A | R | R |
137 |
BQ27500_LLD_EXT_CMD_ApplicationStatus = 0x6Au, EXT_CMD_APPSTAT = 0x6Au // 1 | N/A | R | R |
138 |
} bq27500_lld_ext_command_t; |
139 |
|
140 |
/**
|
141 |
* @brief Read or write access to extended commands.
|
142 |
*/
|
143 |
typedef enum { |
144 |
BQ27500_LLD_EXT_CMD_READ = 0,
|
145 |
BQ27500_LLD_EXT_CMD_WRITE = 1,
|
146 |
} bq27500_lld_ext_cmd_access_t; |
147 |
|
148 |
/**
|
149 |
* @brief Union to inspect the version value.
|
150 |
*/
|
151 |
typedef union { |
152 |
uint16_t value; |
153 |
struct {
|
154 |
uint16_t minor_low : 4;
|
155 |
uint16_t minor_high : 4;
|
156 |
uint16_t major_low : 4;
|
157 |
uint16_t major_high : 4;
|
158 |
} content; |
159 |
} bq27500_lld_version_t; |
160 |
|
161 |
/**
|
162 |
* @brief Union to inspect the flags register.
|
163 |
*/
|
164 |
typedef union { |
165 |
uint16_t value; |
166 |
struct {
|
167 |
uint16_t dsg : 1;
|
168 |
uint16_t socf : 1;
|
169 |
uint16_t soc1 : 1;
|
170 |
uint16_t bat_det : 1;
|
171 |
uint16_t wait_id : 1;
|
172 |
uint16_t ocv_gd : 1;
|
173 |
uint16_t rsvd_6_7 : 2;
|
174 |
uint16_t chg : 1;
|
175 |
uint16_t fc : 1;
|
176 |
uint16_t xchg : 1;
|
177 |
uint16_t chg_inh : 1;
|
178 |
uint16_t rsvd_12_13 : 2;
|
179 |
uint16_t otd : 1;
|
180 |
uint16_t otc : 1;
|
181 |
} content; |
182 |
} bq27500_lld_flags_t; |
183 |
|
184 |
/**
|
185 |
* @brief Union to inspect the control status.
|
186 |
*/
|
187 |
typedef union { |
188 |
uint16_t value; |
189 |
struct {
|
190 |
uint16_t qen : 1;
|
191 |
uint16_t vok : 1;
|
192 |
uint16_t rup_dis : 1;
|
193 |
uint16_t ldmd : 1;
|
194 |
uint16_t sleep : 1;
|
195 |
uint16_t snooze : 1;
|
196 |
uint16_t hibernate : 1;
|
197 |
uint16_t rsvd_7_8_9 : 3;
|
198 |
uint16_t bca : 1;
|
199 |
uint16_t cca : 1;
|
200 |
uint16_t csv : 1;
|
201 |
uint16_t ss : 1;
|
202 |
uint16_t fas : 1;
|
203 |
uint16_t rsvd_15 : 1;
|
204 |
} content; |
205 |
} bq27500_lld_control_status_t; |
206 |
|
207 |
/**
|
208 |
* @brief BQ27500 Driver struct.
|
209 |
*/
|
210 |
typedef struct { |
211 |
apalI2CDriver_t* i2cd; /**< @brief I2C driver to access the BQ27500 */
|
212 |
const apalControlGpio_t* gpio_batlow; /**< @brief Gpio to indicate whether the battery is low */ |
213 |
const apalControlGpio_t* gpio_batgood; /**< @brief Gpio to indicate whether the battery is good */ |
214 |
} BQ27500Driver; |
215 |
|
216 |
/**
|
217 |
* @brief Battery low enum.
|
218 |
*/
|
219 |
typedef enum { |
220 |
BQ27500_LLD_BATTERY_LOW = 0x01,
|
221 |
BQ27500_LLD_BATTERY_NOT_LOW = 0x00,
|
222 |
} bq27500_lld_batlow_t; |
223 |
|
224 |
/**
|
225 |
* @brief Battery good enum.
|
226 |
*/
|
227 |
typedef enum { |
228 |
BQ27500_LLD_BATTERY_GOOD = 0x01,
|
229 |
BQ27500_LLD_BATTERY_NOT_GOOD = 0x00,
|
230 |
} bq27500_lld_batgood_t; |
231 |
|
232 |
#ifdef __cplusplus
|
233 |
extern "C" { |
234 |
#endif
|
235 |
apalExitStatus_t bq27500_lld_read_batlow(const BQ27500Driver* const bq27500, bq27500_lld_batlow_t* const batlow); |
236 |
apalExitStatus_t bq27500_lld_read_batgood(const BQ27500Driver* const bq27500, bq27500_lld_batgood_t* const batgood); |
237 |
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); |
238 |
apalExitStatus_t bq27500_lld_sub_command_call(const BQ27500Driver* const bq27500, const bq27500_lld_control_subcmd_t cmd, const apalTime_t timeout); |
239 |
apalExitStatus_t bq27500_lld_sub_command_read(const BQ27500Driver* const bq27500, uint16_t* const data, const apalTime_t timeout); |
240 |
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); |
241 |
apalExitStatus_t bq27500_lld_send_ctnl_data(const BQ27500Driver* const bq27500, const uint16_t data, const apalTime_t timeout); |
242 |
apalExitStatus_t bq27500_lld_compute_blockdata_checksum(const uint8_t* const blockdata, uint8_t* const sum); |
243 |
#ifdef __cplusplus
|
244 |
} |
245 |
#endif
|
246 |
|
247 |
#endif /* defined(AMIROLLD_CFG_USE_BQ27500) */ |
248 |
|
249 |
#endif /* _AMIROLLD_BQ27500_H_ */ |
250 |
|
251 |
/** @} */
|