1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
/* Copyright 2017 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*
* Battery driver for MAX17055.
*/
#include "battery.h"
#include "console.h"
#include "extpower.h"
#include "hooks.h"
#include "i2c.h"
#include "max17055.h"
#include "timer.h"
#include "util.h"
/* Console output macros */
#define CPRINTS(format, args...) cprints(CC_CHARGER, format, ## args)
/*
* For max17055 to finish battery presence detection, this is the minimal time
* we have to wait since the last POR. LSB = 175ms.
*/
#define RELIABLE_BATT_DETECT_TIME 0x10
/*
* Convert the register values to the units that match
* smart battery protocol.
*/
/* Voltage reg value to mV */
#define VOLTAGE_CONV(REG) ((REG * 5) >> 6)
/* Current reg value to mA */
#define CURRENT_CONV(REG) (((REG * 25) >> 4) / BATTERY_MAX17055_RSENSE)
/* Capacity reg value to mAh */
#define CAPACITY_CONV(REG) (REG * 5 / BATTERY_MAX17055_RSENSE)
/* Time reg value to minute */
#define TIME_CONV(REG) ((REG * 3) >> 5)
/* Temperature reg value to 0.1K */
#define TEMPERATURE_CONV(REG) (((REG * 10) >> 8) + 2731)
/* Percentage reg value to 1% */
#define PERCENTAGE_CONV(REG) (REG >> 8)
/* Cycle count reg value (LSB = 1%) to absolute count (100%) */
#define CYCLE_COUNT_CONV(REG) ((REG * 5) >> 9)
/* Useful macros */
#define MAX17055_READ_DEBUG(offset, ptr_reg) \
do { \
if (max17055_read(offset, ptr_reg)) { \
CPRINTS("%s: failed to read reg %02x", \
__func__, offset); \
return; \
} \
} while (0)
#define MAX17055_WRITE_DEBUG(offset, reg) \
do { \
if (max17055_write(offset, reg)) { \
CPRINTS("%s: failed to read reg %02x", \
__func__, offset); \
return; \
} \
} while (0)
static int fake_state_of_charge = -1;
static int max17055_read(int offset, int *data)
{
return i2c_read16(I2C_PORT_BATTERY, MAX17055_ADDR, offset, data);
}
static int max17055_write(int offset, int data)
{
return i2c_write16(I2C_PORT_BATTERY, MAX17055_ADDR, offset, data);
}
/* Return 1 if the device id is correct. */
static int max17055_probe(void)
{
int dev_id;
if (max17055_read(REG_DEVICE_NAME, &dev_id))
return 0;
if (dev_id == MAX17055_DEVICE_ID)
return 1;
return 0;
}
int battery_device_name(char *device_name, int buf_size)
{
strzcpy(device_name, "<BATT>", buf_size);
return EC_SUCCESS;
}
int battery_state_of_charge_abs(int *percent)
{
return EC_ERROR_UNIMPLEMENTED;
}
int battery_remaining_capacity(int *capacity)
{
int rv;
int reg;
rv = max17055_read(REG_REMAINING_CAPACITY, ®);
if (!rv)
*capacity = CAPACITY_CONV(reg);
return rv;
}
int battery_full_charge_capacity(int *capacity)
{
int rv;
int reg;
rv = max17055_read(REG_FULL_CHARGE_CAPACITY, ®);
if (!rv)
*capacity = CAPACITY_CONV(reg);
return rv;
}
int battery_time_to_empty(int *minutes)
{
int rv;
int reg;
rv = max17055_read(REG_TIME_TO_EMPTY, ®);
if (!rv)
*minutes = TIME_CONV(reg);
return rv;
}
int battery_time_to_full(int *minutes)
{
int rv;
int reg;
rv = max17055_read(REG_TIME_TO_FULL, ®);
if (!rv)
*minutes = TIME_CONV(reg);
return rv;
}
int battery_cycle_count(int *count)
{
int rv;
int reg;
rv = max17055_read(REG_CYCLE_COUNT, ®);
if (!rv)
*count = CYCLE_COUNT_CONV(reg);
return rv;
}
int battery_design_capacity(int *capacity)
{
int rv;
int reg;
rv = max17055_read(REG_DESIGN_CAPACITY, ®);
if (!rv)
*capacity = CAPACITY_CONV(reg);
return rv;
}
int battery_time_at_rate(int rate, int *minutes)
{
return EC_ERROR_UNIMPLEMENTED;
}
int battery_manufacturer_name(char *dest, int size)
{
strzcpy(dest, "<unkn>", size);
return EC_SUCCESS;
}
int battery_device_chemistry(char *dest, int size)
{
strzcpy(dest, "<unkn>", size);
return EC_SUCCESS;
}
int battery_serial_number(int *serial)
{
/* TODO(philipchen): Implement this function. */
*serial = 0xFFFFFFFF;
return EC_SUCCESS;
}
int battery_design_voltage(int *voltage)
{
*voltage = battery_get_info()->voltage_normal;
return EC_SUCCESS;
}
int battery_get_mode(int *mode)
{
return EC_ERROR_UNIMPLEMENTED;
}
int battery_status(int *status)
{
int rv;
int reg;
*status = 0;
rv = max17055_read(REG_FSTAT, ®);
if (rv)
return rv;
if (reg & FSTAT_FQ)
*status |= BATTERY_FULLY_CHARGED;
rv = max17055_read(REG_CURRENT, ®);
if (rv)
return rv;
if (reg >> 15)
*status |= BATTERY_DISCHARGING;
return EC_SUCCESS;
}
enum battery_present battery_is_present(void)
{
int reg = 0;
static uint8_t batt_pres_sure;
if (max17055_read(REG_STATUS, ®))
return BP_NOT_SURE;
if (reg & STATUS_BST)
return BP_NO;
if (!batt_pres_sure) {
/*
* The battery detection result is not reliable within
* ~2.8 secs since POR.
*/
if (!max17055_read(REG_TIMERH, ®)) {
/*
* The LSB of TIMERH reg is 3.2 hrs. If the reg has a
* nonzero value, battery detection must have been
* settled.
*/
if (reg) {
batt_pres_sure = 1;
return BP_YES;
}
if (!max17055_read(REG_TIMER, ®) &&
((uint32_t)reg > RELIABLE_BATT_DETECT_TIME)) {
batt_pres_sure = 1;
return BP_YES;
}
}
return BP_NOT_SURE;
}
return BP_YES;
}
void battery_get_params(struct batt_params *batt)
{
int reg = 0;
/* Reset flags */
batt->flags = 0;
if (max17055_read(REG_TEMPERATURE, ®))
batt->flags |= BATT_FLAG_BAD_TEMPERATURE;
batt->temperature = TEMPERATURE_CONV((int16_t)reg);
if (max17055_read(REG_STATE_OF_CHARGE, ®) &&
fake_state_of_charge < 0)
batt->flags |= BATT_FLAG_BAD_STATE_OF_CHARGE;
batt->state_of_charge = fake_state_of_charge >= 0 ?
fake_state_of_charge : PERCENTAGE_CONV(reg);
if (max17055_read(REG_VOLTAGE, ®))
batt->flags |= BATT_FLAG_BAD_VOLTAGE;
batt->voltage = VOLTAGE_CONV(reg);
if (max17055_read(REG_CURRENT, ®))
batt->flags |= BATT_FLAG_BAD_CURRENT;
batt->current = CURRENT_CONV((int16_t)reg);
batt->desired_voltage = battery_get_info()->voltage_max;
batt->desired_current = BATTERY_DESIRED_CHARGING_CURRENT;
if (battery_remaining_capacity(&batt->remaining_capacity))
batt->flags |= BATT_FLAG_BAD_REMAINING_CAPACITY;
if (battery_full_charge_capacity(&batt->full_capacity))
batt->flags |= BATT_FLAG_BAD_FULL_CAPACITY;
/*
* Assuming the battery is responsive as long as
* max17055 finds battery is present.
*/
batt->is_present = battery_is_present();
if (batt->is_present == BP_YES)
batt->flags |= BATT_FLAG_RESPONSIVE;
/*
* Charging allowed if both desired voltage and current are nonzero
* and battery isn't full (and we read them all correctly).
*/
if (!(batt->flags & BATT_FLAG_BAD_STATE_OF_CHARGE) &&
batt->desired_voltage &&
batt->desired_current &&
batt->state_of_charge < BATTERY_LEVEL_FULL)
batt->flags |= BATT_FLAG_WANT_CHARGE;
if (battery_status(&batt->status))
batt->flags |= BATT_FLAG_BAD_STATUS;
}
#ifdef CONFIG_CMD_PWR_AVG
int battery_get_avg_current(void)
{
/* TODO(crbug.com/752320) implement this */
return EC_ERROR_UNIMPLEMENTED;
}
int battery_get_avg_voltage(void)
{
/* TODO(crbug.com/752320) implement this */
return -EC_ERROR_UNIMPLEMENTED;
}
#endif /* CONFIG_CMD_PWR_AVG */
/* Wait until battery is totally stable. */
int battery_wait_for_stable(void)
{
/* TODO(philipchen): Implement this function. */
return EC_SUCCESS;
}
/* Configured MAX17055 with the battery parameters for optimal performance. */
static int max17055_init_config(void)
{
int reg;
int hib_cfg;
int dqacc;
int dpacc;
int retries = 50;
const struct max17055_batt_profile *config;
config = max17055_get_batt_profile();
if (config->is_ez_config) {
dqacc = config->design_cap / 32;
/* Choose the model for charge voltage > 4.275V. */
dpacc = dqacc * 51200 / config->design_cap;
} else {
dqacc = config->design_cap / 16;
dpacc = config->dpacc;
}
if (max17055_write(REG_DESIGN_CAPACITY, config->design_cap) ||
max17055_write(REG_DQACC, dqacc) ||
max17055_write(REG_CHARGE_TERM_CURRENT, config->ichg_term) ||
max17055_write(REG_EMPTY_VOLTAGE, config->v_empty_detect))
return EC_ERROR_UNKNOWN;
if (!config->is_ez_config) {
if (max17055_write(REG_LEARNCFG, config->learn_cfg))
return EC_ERROR_UNKNOWN;
}
/* Store the original HibCFG value. */
if (max17055_read(REG_HIBCFG, &hib_cfg))
return EC_ERROR_UNKNOWN;
/* Special sequence to exit hibernate mode. */
if (max17055_write(0x60, 0x90) ||
max17055_write(REG_HIBCFG, 0) ||
max17055_write(0x60, 0))
return EC_ERROR_UNKNOWN;
if (max17055_write(REG_DPACC, dpacc) ||
max17055_write(REG_MODELCFG, (MODELCFG_REFRESH | MODELCFG_VCHG)))
return EC_ERROR_UNKNOWN;
/* Delay up to 500 ms until MODELCFG.REFRESH bit == 0. */
while (--retries) {
if (max17055_read(REG_MODELCFG, ®))
return EC_ERROR_UNKNOWN;
if (!(MODELCFG_REFRESH & reg))
break;
msleep(10);
}
if (!retries)
return EC_ERROR_TIMEOUT;
if (!config->is_ez_config) {
if (max17055_write(REG_RCOMP0, config->rcomp0) ||
max17055_write(REG_TEMPCO, config->tempco) ||
max17055_write(REG_QR_TABLE00, config->qr_table00) ||
max17055_write(REG_QR_TABLE10, config->qr_table10) ||
max17055_write(REG_QR_TABLE20, config->qr_table20) ||
max17055_write(REG_QR_TABLE30, config->qr_table30))
return EC_ERROR_UNKNOWN;
}
/* Restore the original HibCFG value. */
if (max17055_write(REG_HIBCFG, hib_cfg))
return EC_ERROR_UNKNOWN;
return EC_SUCCESS;
}
static void max17055_init(void)
{
int reg;
int retries = 80;
if (!max17055_probe()) {
CPRINTS("Wrong max17055 id!");
return;
}
/*
* Set CONFIG.TSEL to measure temperature using external thermistor.
* Set it as early as possible because max17055 takes up to 1000ms to
* have the first reliable external temperature reading.
*/
MAX17055_READ_DEBUG(REG_CONFIG, ®);
MAX17055_WRITE_DEBUG(REG_CONFIG, (reg | CONF_TSEL));
MAX17055_READ_DEBUG(REG_STATUS, ®);
/* Check for POR */
if (STATUS_POR & reg) {
/* Delay up to 800 ms until FSTAT.DNR bit == 0. */
while (--retries) {
MAX17055_READ_DEBUG(REG_FSTAT, ®);
if (!(FSTAT_DNR & reg))
break;
msleep(10);
}
if (!retries) {
CPRINTS("%s: timeout waiting for FSTAT.DNR cleared",
__func__);
return;
}
if (max17055_init_config()) {
CPRINTS("max17055 configuration failed!");
return;
}
}
/* Clear POR bit */
MAX17055_READ_DEBUG(REG_STATUS, ®);
MAX17055_WRITE_DEBUG(REG_STATUS, (reg & ~STATUS_POR));
CPRINTS("max17055 configuration succeeded!");
}
DECLARE_HOOK(HOOK_INIT, max17055_init, HOOK_PRIO_DEFAULT);
|