Files
OpenCellular/driver/battery/max17055.h
Philip Chen 1a38513538 battery/max17055: Report BP_NOT_SURE before battery detection finishes
After a POR, max17055 takes ~2.5 seconds to finish the detection
for battery absence.
Let's report BP_NOT_SURE instead of the default BP_YES when the battery
detection result is not settled yet.

BUG=b:72697658
BRANCH=scarlet
TEST=boot scarlet w/o battery and confirm battery_is_present()
never return BP_YES before reporting BP_NO

Change-Id: Ia549b4b78a7403ce2c82802841b78bdd514c6200
Signed-off-by: Philip Chen <philipchen@google.com>
Reviewed-on: https://chromium-review.googlesource.com/989313
Commit-Ready: Philip Chen <philipchen@chromium.org>
Tested-by: Philip Chen <philipchen@chromium.org>
Reviewed-by: Philip Chen <philipchen@chromium.org>
2018-03-31 01:56:30 -07:00

131 lines
4.4 KiB
C

/* 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.
*/
#ifndef __CROS_EC_MAX17055_H
#define __CROS_EC_MAX17055_H
#define MAX17055_ADDR 0x6c
#define MAX17055_DEVICE_ID 0x4010
#define REG_STATUS 0x00
#define REG_AT_RATE 0x04
#define REG_REMAINING_CAPACITY 0x05
#define REG_STATE_OF_CHARGE 0x06
#define REG_TEMPERATURE 0x08
#define REG_VOLTAGE 0x09
#define REG_CURRENT 0x0a
#define REG_AVERAGE_CURRENT 0x0b
#define REG_FULL_CHARGE_CAPACITY 0x10
#define REG_TIME_TO_EMPTY 0x11
#define REG_QR_TABLE00 0x12
#define REG_CONFIG 0x1D
#define REG_AVERAGE_TEMPERATURE 0x16
#define REG_CYCLE_COUNT 0x17
#define REG_DESIGN_CAPACITY 0x18
#define REG_AVERAGE_VOLTAGE 0x19
#define REG_CHARGE_TERM_CURRENT 0x1e
#define REG_TIME_TO_FULL 0x20
#define REG_DEVICE_NAME 0x21
#define REG_QR_TABLE10 0x22
#define REG_LEARNCFG 0x28
#define REG_QR_TABLE20 0x32
#define REG_RCOMP0 0x38
#define REG_TEMPCO 0x39
#define REG_EMPTY_VOLTAGE 0x3a
#define REG_FSTAT 0x3d
#define REG_TIMER 0x3e
#define REG_QR_TABLE30 0x42
#define REG_DQACC 0x45
#define REG_DPACC 0x46
#define REG_STATUS2 0xb0
#define REG_HIBCFG 0xba
#define REG_CONFIG2 0xbb
#define REG_TIMERH 0xbe
#define REG_MODELCFG 0xdb
/* Status reg (0x00) flags */
#define STATUS_POR 0x0002
#define STATUS_BST 0x0008
/* Config reg (0x1d) flags */
#define CONF_TSEL 0x8000
/* FStat reg (0x3d) flags */
#define FSTAT_DNR 0x0001
#define FSTAT_FQ 0x0080
/* ModelCfg reg (0xdb) flags */
#define MODELCFG_REFRESH 0x8000
#define MODELCFG_VCHG 0x0400
/* Smart battery status bits (sbs reg 0x16) */
#define BATTERY_DISCHARGING 0x40
#define BATTERY_FULLY_CHARGED 0x20
/*
* Before we have the battery fully characterized, we use these macros to
* convert basic battery parameters to max17055 reg values for ez config.
*/
/* Convert design capacity in mAh to max17055 0x18 reg value */
#define MAX17055_DESIGNCAP_REG(bat_cap_mah) \
(bat_cap_mah * BATTERY_MAX17055_RSENSE / 5)
/* Convert charge termination current in mA to max17055 0x1e reg value */
#define MAX17055_ICHGTERM_REG(term_cur_ma) \
(((term_cur_ma * BATTERY_MAX17055_RSENSE) << 4) / 25)
/*
* This macro converts empty voltage target (VE) and recovery voltage (VR)
* in mV to max17055 0x3a reg value. max17055 declares 0% (empty battery) at
* VE. max17055 reenables empty detection when the cell voltage rises above VR.
* VE ranges from 0 to 5110mV, and VR ranges from 0 to 5080mV.
*/
#define MAX17055_VEMPTY_REG(ve_mv, vr_mv) \
(((ve_mv / 10) << 7) | (vr_mv / 40))
/*
* max17055 needs some special battery parameters for fuel gauge
* learning algorithm. Maxim can help characterize the battery pack
* to get a full parameter list. We create a data structure to store
* the battery parameters in the format of max17055 register values.
*/
struct max17055_batt_profile {
/* Design capacity of the cell (LSB = 5uVH / Rsense) */
uint16_t design_cap;
/* Charge termination current (LSB = 1.5625uV / Rsense) */
uint16_t ichg_term;
/* The combination of empty voltage target and recovery voltage */
uint16_t v_empty_detect;
/*
* The parameters below are used for advanced (non-EZ) config
* (dpacc, learn_cfg, tempco, qr_table00, qr_table10,
* qr_table20, and qr_table30)
*/
/* Change in battery SOC between relaxation points (LSB = pct / 16) */
uint16_t dpacc;
/* Magic cell tuning parameters */
uint16_t learn_cfg;
uint16_t rcomp0;
uint16_t tempco;
uint16_t qr_table00;
uint16_t qr_table10;
uint16_t qr_table20;
uint16_t qr_table30;
/*
* If is_ez_config is nonzero, we only use design_cap, ichg_term,
* and v_empty_detect to config max17055 (a.k.a. EZ-config).
*/
uint8_t is_ez_config;
};
/* Return the special battery parameters max17055 needs. */
const struct max17055_batt_profile *max17055_get_batt_profile(void);
#endif /* __CROS_EC_MAX17055_H */