healthd.h revision bdf11c76a39d979abd105a4f27bc1973b88893ad 
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef _HEALTHD_H_
18#define _HEALTHD_H_
19
20#include <batteryservice/BatteryService.h>
21#include <sys/types.h>
22#include <utils/Errors.h>
23#include <utils/String8.h>
24
25// periodic_chores_interval_fast, periodic_chores_interval_slow: intervals at
26// which healthd wakes up to poll health state and perform periodic chores,
27// in units of seconds:
28//
29//    periodic_chores_interval_fast is used while the device is not in
30//    suspend, or in suspend and connected to a charger (to watch for battery
31//    overheat due to charging).  The default value is 60 (1 minute).  Value
32//    -1 turns off periodic chores (and wakeups) in these conditions.
33//
34//    periodic_chores_interval_slow is used when the device is in suspend and
35//    not connected to a charger (to watch for a battery drained to zero
36//    remaining capacity).  The default value is 600 (10 minutes).  Value -1
37//    tuns off periodic chores (and wakeups) in these conditions.
38//
39// power_supply sysfs attribute file paths.  Set these to specific paths
40// to use for the associated battery parameters.  healthd will search for
41// appropriate power_supply attribute files to use for any paths left empty:
42//
43//    batteryStatusPath: charging status (POWER_SUPPLY_PROP_STATUS)
44//    batteryHealthPath: battery health (POWER_SUPPLY_PROP_HEALTH)
45//    batteryPresentPath: battery present (POWER_SUPPLY_PROP_PRESENT)
46//    batteryCapacityPath: remaining capacity (POWER_SUPPLY_PROP_CAPACITY)
47//    batteryVoltagePath: battery voltage (POWER_SUPPLY_PROP_VOLTAGE_NOW)
48//    batteryTemperaturePath: battery temperature (POWER_SUPPLY_PROP_TEMP)
49//    batteryTechnologyPath: battery technology (POWER_SUPPLY_PROP_TECHNOLOGY)
50//    batteryCurrentNowPath: battery current (POWER_SUPPLY_PROP_CURRENT_NOW)
51//    batteryChargeCounterPath: battery accumulated charge
52//                                         (POWER_SUPPLY_PROP_CHARGE_COUNTER)
53
54struct healthd_config {
55    int periodic_chores_interval_fast;
56    int periodic_chores_interval_slow;
57
58    android::String8 batteryStatusPath;
59    android::String8 batteryHealthPath;
60    android::String8 batteryPresentPath;
61    android::String8 batteryCapacityPath;
62    android::String8 batteryVoltagePath;
63    android::String8 batteryTemperaturePath;
64    android::String8 batteryTechnologyPath;
65    android::String8 batteryCurrentNowPath;
66    android::String8 batteryCurrentAvgPath;
67    android::String8 batteryChargeCounterPath;
68
69    int (*energyCounter)(int64_t *);
70    bool (*screen_on)(android::BatteryProperties *props);
71};
72
73// Global helper functions
74
75int healthd_register_event(int fd, void (*handler)(uint32_t));
76void healthd_battery_update();
77android::status_t healthd_get_property(int id,
78    struct android::BatteryProperty *val);
79void healthd_dump_battery_state(int fd);
80
81struct healthd_mode_ops {
82    void (*init)(struct healthd_config *config);
83    int (*preparetowait)(void);
84    void (*heartbeat)(void);
85    void (*battery_update)(struct android::BatteryProperties *props);
86};
87
88extern struct healthd_mode_ops *healthd_mode_ops;
89
90// Charger mode
91
92void healthd_mode_charger_init(struct healthd_config *config);
93int healthd_mode_charger_preparetowait(void);
94void healthd_mode_charger_heartbeat(void);
95void healthd_mode_charger_battery_update(
96    struct android::BatteryProperties *props);
97
98// The following are implemented in libhealthd_board to handle board-specific
99// behavior.
100//
101// healthd_board_init() is called at startup time to modify healthd's
102// configuration according to board-specific requirements.  config
103// points to the healthd configuration values described above.  To use default
104// values, this function can simply return without modifying the fields of the
105// config parameter.
106
107void healthd_board_init(struct healthd_config *config);
108
109// Process updated battery property values.  This function is called when
110// the kernel sends updated battery status via a uevent from the power_supply
111// subsystem, or when updated values are polled by healthd, as for periodic
112// poll of battery state.
113//
114// props are the battery properties read from the kernel.  These values may
115// be modified in this call, prior to sending the modified values to the
116// Android runtime.
117//
118// Return 0 to indicate the usual kernel log battery status heartbeat message
119// is to be logged, or non-zero to prevent logging this information.
120
121int healthd_board_battery_update(struct android::BatteryProperties *props);
122
123#endif /* _HEALTHD_H_ */
124