Statistics
| Branch: | Tag: | Revision:

amiro-lld / include / alld_bq27500.h @ ef078306

History | View | Annotate | Download (12.3 KB)

1 d6728c5b Thomas Schöpping
/*
2
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
3 f125ae07 Thomas Schöpping
Copyright (C) 2016..2019  Thomas Schöpping et al.
4 d6728c5b Thomas Schöpping

5
This program is free software: you can redistribute it and/or modify
6 f0ca400f Thomas Schöpping
it under the terms of the GNU Lesser General Public License as published by
7 d6728c5b Thomas Schöpping
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 f0ca400f Thomas Schöpping
GNU Lesser General Public License for more details.
14 d6728c5b Thomas Schöpping

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