diff options
author | Sheng-Liang Song <ssl@chromium.org> | 2014-07-25 13:45:00 -0700 |
---|---|---|
committer | chrome-internal-fetch <chrome-internal-fetch@google.com> | 2014-09-03 22:49:28 +0000 |
commit | 51e48026c206688c3387c4b4f1d1c0ed42a959e1 (patch) | |
tree | ef432da8ab77758d741e4f91d6102b7c4d1bf2f3 /driver/battery/sb_fw_update.h | |
parent | 00816a1552db928f662119bf4562be19bb9274fe (diff) | |
download | chrome-ec-51e48026c206688c3387c4b4f1d1c0ed42a959e1.tar.gz |
EC: Add smart battery firmware update driver
Ref: Common Smart Battery System Inferface Specification v8.0.
- Added 2 new AP->EC Command APIs
EC_CMD_SB_FW_UPDATE, EC_CMD_ENTERING_MODE
- Implemented common smart battery update drivers.
BUG=chrome-os-partner:24741
CQ-DEPEND=CL:210032
CQ-DEPEND=CL:210033
CQ-DEPEND=CL:215720
BRANCH=ToT,glimmer
TEST=Verified on LGC & Simplo smart battery
Change-Id: Ice6e60b1b04762217ae7613356d6925777c06abf
Signed-off-by: Sheng-Liang Song <ssl@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/205323
Reviewed-by: Randall Spangler <rspangler@chromium.org>
Diffstat (limited to 'driver/battery/sb_fw_update.h')
-rw-r--r-- | driver/battery/sb_fw_update.h | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/driver/battery/sb_fw_update.h b/driver/battery/sb_fw_update.h new file mode 100644 index 0000000000..aaf2c88da0 --- /dev/null +++ b/driver/battery/sb_fw_update.h @@ -0,0 +1,114 @@ +/* Copyright (c) 2014 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. + * + * Smart battery Firmware Update driver. + * Ref: Common Smart Battery System Interface Specification v8.0. + * + * cmd.0x35, Write Word + * 0x1000: Prepare to Update + * 0x2000: End of Update + * 0xF000: Update Firmware + * + * cmd.0x35, Read Word + * Firmware Update Status + * + * cmd.0x36 Write Block + * Send 32 byte firmware image + * + * cmd.0x37 Read Word + * Get Battery Information + * sequence:=b1,b0,b3,b2,b5,b5,b7,b6 + * + * Command Sequence for Battery FW Update + * + * 0. cmd.0x35.read + * 1. cmd.0x37.read + * 2. cmd.0x35.write.0x1000 + * 3. cmd.0x35.read.status (optional) + * 4. cmd.0x35.write.0xF000 + * 5. cmd.0x35.read.status + * if bit8-0, go to step 2 + * 6. cmd.0x36.write.32byte + * 7. cmd.0x35.read.status + * if FEC.b13=1, go to step 6 + * if fatal.b12=1, go to step 2 + * if b11,b10,b9,b2,b1,b0; go to step 1 + * if b5,b3; go to step 8 + * (repeat 6,7) + * 8. cmd.0x36.write.0x2000 + * 9. cmd.0x35.read.status + */ + +#ifndef __EC_SB_FW_UPDATE__ +#define __EC_SB_FW_UPDATE__ + +#define SB_FW_UPDATE_CMD_WRITE_WORD 0x35 +#define SB_FW_UPDATE_CMD_WRITE_WORD_PREPARE 0x1000 +#define SB_FW_UPDATE_CMD_WRITE_WORD_END 0x2000 +#define SB_FW_UPDATE_CMD_WRITE_WORD_UPDATE 0xF000 + +#define SB_FW_UPDATE_CMD_READ_STATUS 0x35 /* len:0+data:2+pec:1 */ + +#define SB_FW_UPDATE_CMD_WRITE_BLOCK 0x36 /* len:1+data:32+pec:1 */ + +#define SB_FW_UPDATE_CMD_READ_INFO 0x37 /* len:1+data:8+pec:1 */ + +/** + * sb.fw.update.cmd.0x35, Read Word + * Firmware Update Status + */ +struct sb_fw_update_status { + uint16_t v_fail_maker_id:1; /* b0 */ + uint16_t v_fail_hw_id:1; /* b1 */ + uint16_t v_fail_fw_version:1; /* b2 */ + uint16_t v_fail_permanent:1; /* b3 */ + + uint16_t rsvd5:1; /* b4 */ + uint16_t permanent_failure:1; /* b5 */ + uint16_t abnormal_condition:1; /* b6 */ + uint16_t fw_update_supported:1; /* b7 */ + + uint16_t fw_update_mode:1; /* b8 */ + uint16_t fw_corrupted:1; /* b9 */ + uint16_t cmd_reject:1; /* b10 */ + uint16_t invalid_data:1; /* b11 */ + + uint16_t fw_fatal_error:1; /* b12 */ + uint16_t fec_error:1; /* b13 */ + uint16_t busy:1; /* b14 */ + uint16_t rsvd15:1; /* b15 */ +} __packed; + +/** + * sb.fw.update.cmd.0x37 Read Word + * Get Battery Information + * sequence:=b1,b0,b3,b2,b5,b5,b7,b6 + */ +struct sb_fw_update_info { + uint16_t maker_id; /* b0, b1 */ + uint16_t hardware_id; /* b2, b3 */ + uint16_t fw_version; /* b4, b5 */ + uint16_t data_version;/* b6, b7 */ +} __packed; + +/** + * smart.battery.maker.id + */ +enum sb_maker_id { + sb_maker_id_lgc = 0x0001, /* b0=0; b1=1 */ + sb_maker_id_panasonic = 0x0002, + sb_maker_id_sanyo = 0x0003, + sb_maker_id_sony = 0x0004, + sb_maker_id_simplo = 0x0005, + sb_maker_id_celxpert = 0x0006, +}; + +/** + * Check if a Smart Battery Firmware Update is inprogress. + * + * @return 1 if YES, 0 if NO. + */ +int sb_fw_update_in_progress(void); + +#endif |