hy4245.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, Linumiz GmbH
 * Copyright (c) 2026, Testo SE & Co. KGaA
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_FUEL_GAUGE_HY4245_H_
#define ZEPHYR_INCLUDE_DRIVERS_FUEL_GAUGE_HY4245_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include <zephyr/drivers/fuel_gauge.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


#define HY4245_CONTROL_STATUS_VOK       BIT(1)
#define HY4245_CONTROL_STATUS_SLEEP     BIT(4)
#define HY4245_CONTROL_STATUS_FULLSLEEP BIT(5)
#define HY4245_CONTROL_STATUS_HIBERNATE BIT(6)
#define HY4245_CONTROL_STATUS_SHUTDOWN  BIT(7)
#define HY4245_CONTROL_STATUS_1WR       BIT(8)
#define HY4245_CONTROL_STATUS_BCA       BIT(10)
#define HY4245_CONTROL_STATUS_CCA       BIT(11)
#define HY4245_CONTROL_STATUS_CSV       BIT(12)
#define HY4245_CONTROL_STATUS_SS        BIT(13)
#define HY4245_CONTROL_STATUS_FAS       BIT(14)
#define HY4245_CONTROL_STATUS_SE        BIT(15)

#define HY4245_FLAGS_DSG       BIT(0)
#define HY4245_FLAGS_SOCF      BIT(1)
#define HY4245_FLAGS_SOC1      BIT(2)
#define HY4245_FLAGS_BAT_DET   BIT(3)
#define HY4245_FLAGS_LRND      BIT(4)
#define HY4245_FLAGS_QSTART    BIT(5)
#define HY4245_FLAGS_EODCTAKEN BIT(6)
#define HY4245_FLAGS_OCVTAKEN  BIT(7)
#define HY4245_FLAGS_CHG       BIT(8)
#define HY4245_FLAGS_FC        BIT(9)
#define HY4245_FLAGS_CHGSUSP   BIT(10)
#define HY4245_FLAGS_XCHG      BIT(11)
#define HY4245_FLAGS_DOT       BIT(14)
#define HY4245_FLAGS_COT       BIT(15)

#define HY4245_SAFETY_STATUS_OV  BIT(6)
#define HY4245_SAFETY_STATUS_UV  BIT(7)
#define HY4245_SAFETY_STATUS_COC BIT(12)
#define HY4245_SAFETY_STATUS_DOC BIT(13)
#define HY4245_SAFETY_STATUS_COT BIT(14)
#define HY4245_SAFETY_STATUS_DOT BIT(15)

#define HY4245_OPERATION_CONFIG_A_TEMPS    BIT(0)
#define HY4245_OPERATION_CONFIG_A_SE_EN    BIT(1)
#define HY4245_OPERATION_CONFIG_A_SE_POL   BIT(3)
#define HY4245_OPERATION_CONFIG_A_RMFCC    BIT(4)
#define HY4245_OPERATION_CONFIG_A_SLEEP    BIT(5)
#define HY4245_OPERATION_CONFIG_A_UPIMP_B  BIT(6)
#define HY4245_OPERATION_CONFIG_A_CELL0    BIT(8)
#define HY4245_OPERATION_CONFIG_A_SMLSR    BIT(10)
#define HY4245_OPERATION_CONFIG_A_GNDSEL   BIT(11)
#define HY4245_OPERATION_CONFIG_A_NR       BIT(13)
#define HY4245_OPERATION_CONFIG_A_FACDC_EN BIT(14)
#define HY4245_OPERATION_CONFIG_A_UPD_EN   BIT(15)

#define HY4245_DATA_FLASH_BLOCK_SIZE 32U

#define HY4245_CONFIG_IMAGE_ELEMENT_SIZE (2U + HY4245_DATA_FLASH_BLOCK_SIZE)

enum hy4245_fuel_gauge_prop {
        HY4245_FUEL_GAUGE_FLASH_UPDATE_ENABLE = FUEL_GAUGE_CUSTOM_BEGIN,
        HY4245_FUEL_GAUGE_CONTROL_STATUS,
        HY4245_FUEL_GAUGE_OPERATION_CONFIG_A,
        HY4245_FUEL_GAUGE_FLAGS,
        HY4245_FUEL_GAUGE_SAFETY_STATUS,
        HY4245_FUEL_GAUGE_LIFETIME_OVER_TEMPERATURE_MINS,
        HY4245_FUEL_GAUGE_DATA_FLASH_CHECKSUM,
        HY4245_FUEL_GAUGE_DATA_FLASH_VERSION,
        HY4245_FUEL_GAUGE_FIRMWARE_VERSION,
        HY4245_FUEL_GAUGE_CALIBRATION_MODE,
        HY4245_FUEL_GAUGE_RESET,
        HY4245_FUEL_GAUGE_DATA_FLASH_BLOCK,
        HY4245_FUEL_GAUGE_MANUFACTURER_INFO_A,
        HY4245_FUEL_GAUGE_MANUFACTURER_INFO_B,
        HY4245_FUEL_GAUGE_MANUFACTURER_INFO_C,
        HY4245_FUEL_GAUGE_CONFIG_IMAGE,
        HY4245_FUEL_GAUGE_CONFIG_IMAGE_VERIFY,
        HY4245_FUEL_GAUGE_CLEAR_LEARNED,
        HY4245_FUEL_GAUGE_QUICK_START,
};

struct hy4245_data_flash_block {
        uint8_t subclass;
        uint8_t block;
        uint8_t len;
        uint8_t data[HY4245_DATA_FLASH_BLOCK_SIZE];
};

 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_FUEL_GAUGE_HY4245_H_ */