fuel_gauge.h

Go to the documentation of this file.

/*
 * Copyright 2022 Google LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_BATTERY_H_
#define ZEPHYR_INCLUDE_DRIVERS_BATTERY_H_
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include <zephyr/device.h>
 
/* Keep these alphabetized wrt property name */
 
#define FUEL_GAUGE_AVG_CURRENT 0
 
#define FUEL_GAUGE_CURRENT              FUEL_GAUGE_AVG_CURRENT + 1
#define FUEL_GAUGE_CHARGE_CUTOFF        FUEL_GAUGE_CURRENT + 1
#define FUEL_GAUGE_CYCLE_COUNT          FUEL_GAUGE_CHARGE_CUTOFF + 1
#define FUEL_GAUGE_CONNECT_STATE        FUEL_GAUGE_CYCLE_COUNT + 1
#define FUEL_GAUGE_FLAGS                FUEL_GAUGE_CONNECT_STATE + 1
#define FUEL_GAUGE_FULL_CHARGE_CAPACITY FUEL_GAUGE_FLAGS + 1
#define FUEL_GAUGE_PRESENT_STATE        FUEL_GAUGE_FULL_CHARGE_CAPACITY + 1
#define FUEL_GAUGE_REMAINING_CAPACITY   FUEL_GAUGE_PRESENT_STATE + 1
#define FUEL_GAUGE_RUNTIME_TO_EMPTY     FUEL_GAUGE_REMAINING_CAPACITY + 1
#define FUEL_GAUGE_RUNTIME_TO_FULL      FUEL_GAUGE_RUNTIME_TO_EMPTY + 1
#define FUEL_GAUGE_SBS_MFR_ACCESS       FUEL_GAUGE_RUNTIME_TO_FULL + 1
#define FUEL_GAUGE_STATE_OF_CHARGE      FUEL_GAUGE_SBS_MFR_ACCESS + 1
#define FUEL_GAUGE_TEMPERATURE          FUEL_GAUGE_STATE_OF_CHARGE + 1
#define FUEL_GAUGE_VOLTAGE              FUEL_GAUGE_TEMPERATURE + 1
 
#define FUEL_GAUGE_COMMON_COUNT FUEL_GAUGE_VOLTAGE + 1
#define FUEL_GAUGE_CUSTOM_BEGIN FUEL_GAUGE_COMMON_COUNT + 1
 
#define FUEL_GAUGE_PROP_MAX UINT16_MAX
 
struct fuel_gauge_get_property {
        uint16_t property_type;
 
        int status;
 
        union {
                /* Fields have the format: */
                /* FUEL_GAUGE_PROPERTY_FIELD */
                /* type property_field; */
 
                /* Dynamic Battery Info */
                int avg_current;
                bool cutoff;
                int current;
                uint32_t cycle_count;
                uint32_t flags;
                uint32_t full_charge_capacity;
                uint32_t remaining_capacity;
                uint32_t runtime_to_empty;
                uint32_t runtime_to_full;
                uint16_t sbs_mfr_access_word;
                uint8_t state_of_charge;
                uint16_t temperature;
                int voltage;
        } value;
};
 
struct fuel_gauge_set_property {
        uint16_t property_type;
 
        int status;
 
        union {
                /* Fields have the format: */
                /* FUEL_GAUGE_PROPERTY_FIELD */
                /* type property_field; */
 
                /* Writable Dynamic Battery Info */
                uint16_t sbs_mfr_access_word;
        } value;
};
 
typedef int (*fuel_gauge_get_property_t)(const struct device *dev,
                                         struct fuel_gauge_get_property *props, size_t props_len);
 
typedef int (*fuel_gauge_set_property_t)(const struct device *dev,
                                         struct fuel_gauge_set_property *props, size_t props_len);
 
/* Caching is entirely on the onus of the client */
 
__subsystem struct battery_driver_api {
        fuel_gauge_get_property_t get_property;
        fuel_gauge_set_property_t set_property;
};
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_BATTERY_H_ */