summaryrefslogtreecommitdiff
path: root/include/battery.h
diff options
context:
space:
mode:
authorBill Richardson <wfrichar@chromium.org>2014-03-27 11:10:46 -0700
committerBill Richardson <wfrichar@chromium.org>2014-03-28 15:23:01 +0000
commit91a5fa01940764832c1b974d2022bee4e744f09c (patch)
tree3a772b75245da7c02cc4ddfa01752168577eee82 /include/battery.h
parentb2d87dc18ad0c6049a48959f4c2d7dfddaf301f1 (diff)
downloadchrome-ec-91a5fa01940764832c1b974d2022bee4e744f09c.tar.gz
Add more fields and error flags to struct batt_params
This adds two battery parameters that need to be monitored constantly: remaining_capacity and full_capacity (that one only changes occasionally, but we have to notify the AP when it does). It also adds the is_present field to indicate whether the battery is physically present or not (when we can tell), so we know whether to try to wake up a deep-discharged battery. Along with that, we clean up the error flags to provide indication of which fields were unable to be read, and replace the manual logical-or of all errors as they were set with a bitmask (BATT_FLAG_BAD_ANY). No functionality is changed, only new & better information is provided for use in the upcoming cleanup of the charge state machine. BUG=chrome-os-partner:20881 BRANCH=ToT TEST=make buildall -j All targets build; all tests pass. Change-Id: I4312c2fdd3cf2dd9570718e90571eff796b269db Signed-off-by: Bill Richardson <wfrichar@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/191917 Reviewed-by: Randall Spangler <rspangler@chromium.org>
Diffstat (limited to 'include/battery.h')
-rw-r--r--include/battery.h42
1 files changed, 28 insertions, 14 deletions
diff --git a/include/battery.h b/include/battery.h
index 202148559e..61c9dee20f 100644
--- a/include/battery.h
+++ b/include/battery.h
@@ -33,6 +33,16 @@
*/
#define BATTERY_LEVEL_SHUTDOWN 3
+/*
+ * Sometimes we have hardware to detect battery present, sometimes we have to
+ * wait until we've been able to talk to the battery.
+ */
+enum battery_present {
+ BP_NO = 0,
+ BP_YES = 1,
+ BP_NOT_SURE,
+};
+
/* Battery parameters */
struct batt_params {
int temperature; /* Temperature in 0.1 K */
@@ -41,23 +51,31 @@ struct batt_params {
int current; /* Battery current (mA); negative=discharging */
int desired_voltage; /* Charging voltage desired by battery (mV) */
int desired_current; /* Charging current desired by battery (mA) */
+ int remaining_capacity; /* Remaining capacity in mAh */
+ int full_capacity; /* Capacity in mAh (might change occasionally) */
+ enum battery_present is_present; /* Is the battery physically present */
int flags; /* Flags */
};
/* Flags for batt_params */
/* Battery wants to be charged */
-#define BATT_FLAG_WANT_CHARGE (1 << 0)
+#define BATT_FLAG_WANT_CHARGE 0x00000001
/* Battery is responsive (talking to us via I2C) */
-#define BATT_FLAG_RESPONSIVE (1 << 1)
-
-/* Able to talk to battery, but it won't tell us voltage or charge percent */
-#define BATT_FLAG_BAD_VOLTAGE (1 << 2)
-#define BATT_FLAG_BAD_CHARGE_PERCENT (1 << 3)
-
-/* Battery couldn't tell us every params we want */
-#define BATT_FLAG_BAD_ANY (1 << 4)
+#define BATT_FLAG_RESPONSIVE 0x00000002
+
+/* Bits to indicate which parameter(s) could not be read */
+#define BATT_FLAG_BAD_TEMPERATURE 0x00000004
+#define BATT_FLAG_BAD_STATE_OF_CHARGE 0x00000008
+#define BATT_FLAG_BAD_VOLTAGE 0x00000010
+#define BATT_FLAG_BAD_CURRENT 0x00000020
+#define BATT_FLAG_BAD_DESIRED_VOLTAGE 0x00000040
+#define BATT_FLAG_BAD_DESIRED_CURRENT 0x00000080
+#define BATT_FLAG_BAD_REMAINING_CAPACITY 0x00000100
+#define BATT_FLAG_BAD_FULL_CAPACITY 0x00000200
+/* All of the above BATT_FLAG_BAD_* bits */
+#define BATT_FLAG_BAD_ANY 0x000003fc
/* Battery constants */
struct battery_info {
@@ -102,11 +120,7 @@ void battery_vendor_params(struct batt_params *batt);
*
* @return Whether there is a battery attached or not, or if we can't tell.
*/
-enum battery_present {
- BP_NO = 0,
- BP_YES = 1,
- BP_NOT_SURE,
-} battery_is_present(void);
+enum battery_present battery_is_present(void);
/**
* Get battery mode.