blob: a900071998b0039e3bc7b056cbae1b3fa0500093 [file] [log] [blame]
* Copyright (C) 2013 The Android Open Source Project
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#ifndef _HEALTHD_H_
#define _HEALTHD_H_
#include <batteryservice/BatteryService.h>
#include <sys/types.h>
#include <utils/Errors.h>
#include <utils/String8.h>
#include <vector>
// periodic_chores_interval_fast, periodic_chores_interval_slow: intervals at
// which healthd wakes up to poll health state and perform periodic chores,
// in units of seconds:
// periodic_chores_interval_fast is used while the device is not in
// suspend, or in suspend and connected to a charger (to watch for battery
// overheat due to charging). The default value is 60 (1 minute). Value
// -1 turns off periodic chores (and wakeups) in these conditions.
// periodic_chores_interval_slow is used when the device is in suspend and
// not connected to a charger (to watch for a battery drained to zero
// remaining capacity). The default value is 600 (10 minutes). Value -1
// tuns off periodic chores (and wakeups) in these conditions.
// power_supply sysfs attribute file paths. Set these to specific paths
// to use for the associated battery parameters. healthd will search for
// appropriate power_supply attribute files to use for any paths left empty:
// batteryStatusPath: charging status (POWER_SUPPLY_PROP_STATUS)
// batteryHealthPath: battery health (POWER_SUPPLY_PROP_HEALTH)
// batteryPresentPath: battery present (POWER_SUPPLY_PROP_PRESENT)
// batteryCapacityPath: remaining capacity (POWER_SUPPLY_PROP_CAPACITY)
// batteryVoltagePath: battery voltage (POWER_SUPPLY_PROP_VOLTAGE_NOW)
// batteryTemperaturePath: battery temperature (POWER_SUPPLY_PROP_TEMP)
// batteryTechnologyPath: battery technology (POWER_SUPPLY_PROP_TECHNOLOGY)
// batteryCurrentNowPath: battery current (POWER_SUPPLY_PROP_CURRENT_NOW)
// batteryChargeCounterPath: battery accumulated charge
struct healthd_config {
int periodic_chores_interval_fast;
int periodic_chores_interval_slow;
android::String8 batteryStatusPath;
android::String8 batteryHealthPath;
android::String8 batteryPresentPath;
android::String8 batteryCapacityPath;
android::String8 batteryVoltagePath;
android::String8 batteryTemperaturePath;
android::String8 batteryTechnologyPath;
android::String8 batteryCurrentNowPath;
android::String8 batteryCurrentAvgPath;
android::String8 batteryChargeCounterPath;
android::String8 batteryFullChargePath;
android::String8 batteryCycleCountPath;
int (*energyCounter)(int64_t *);
int boot_min_cap;
bool (*screen_on)(android::BatteryProperties *props);
std::vector<android::String8> ignorePowerSupplyNames;
enum EventWakeup {
// Global helper functions
int healthd_register_event(int fd, void (*handler)(uint32_t), EventWakeup wakeup = EVENT_NO_WAKEUP_FD);
struct healthd_mode_ops {
void (*init)(struct healthd_config *config);
int (*preparetowait)(void);
void (*heartbeat)(void);
void (*battery_update)(struct android::BatteryProperties *props);
extern struct healthd_mode_ops *healthd_mode_ops;
// Charger mode
void healthd_mode_charger_init(struct healthd_config *config);
int healthd_mode_charger_preparetowait(void);
void healthd_mode_charger_heartbeat(void);
void healthd_mode_charger_battery_update(
struct android::BatteryProperties *props);
// The following are implemented in libhealthd_board to handle board-specific
// behavior.
// healthd_board_init() is called at startup time to modify healthd's
// configuration according to board-specific requirements. config
// points to the healthd configuration values described above. To use default
// values, this function can simply return without modifying the fields of the
// config parameter.
void healthd_board_init(struct healthd_config *config);
// Process updated battery property values. This function is called when
// the kernel sends updated battery status via a uevent from the power_supply
// subsystem, or when updated values are polled by healthd, as for periodic
// poll of battery state.
// props are the battery properties read from the kernel. These values may
// be modified in this call, prior to sending the modified values to the
// Android runtime.
// Return 0 to indicate the usual kernel log battery status heartbeat message
// is to be logged, or non-zero to prevent logging this information.
int healthd_board_battery_update(struct android::BatteryProperties *props);
#endif /* _HEALTHD_H_ */