healthd.h revision c7464c9150eb63ad277cc5b5f704f4fd5e6678c5 
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 <utils/Errors.h>
22#include <utils/String8.h>
23
24// periodic_chores_interval_fast, periodic_chores_interval_slow: intervals at
25// which healthd wakes up to poll health state and perform periodic chores,
26// in units of seconds:
27//
28//    periodic_chores_interval_fast is used while the device is not in
29//    suspend, or in suspend and connected to a charger (to watch for battery
30//    overheat due to charging).  The default value is 60 (1 minute).  Value
31//    -1 turns off periodic chores (and wakeups) in these conditions.
32//
33//    periodic_chores_interval_slow is used when the device is in suspend and
34//    not connected to a charger (to watch for a battery drained to zero
35//    remaining capacity).  The default value is 600 (10 minutes).  Value -1
36//    tuns off periodic chores (and wakeups) in these conditions.
37//
38// power_supply sysfs attribute file paths.  Set these to specific paths
39// to use for the associated battery parameters.  healthd will search for
40// appropriate power_supply attribute files to use for any paths left empty:
41//
42//    batteryStatusPath: charging status (POWER_SUPPLY_PROP_STATUS)
43//    batteryHealthPath: battery health (POWER_SUPPLY_PROP_HEALTH)
44//    batteryPresentPath: battery present (POWER_SUPPLY_PROP_PRESENT)
45//    batteryCapacityPath: remaining capacity (POWER_SUPPLY_PROP_CAPACITY)
46//    batteryVoltagePath: battery voltage (POWER_SUPPLY_PROP_VOLTAGE_NOW)
47//    batteryTemperaturePath: battery temperature (POWER_SUPPLY_PROP_TEMP)
48//    batteryTechnologyPath: battery technology (POWER_SUPPLY_PROP_TECHNOLOGY)
49//    batteryCurrentNowPath: battery current (POWER_SUPPLY_PROP_CURRENT_NOW)
50//    batteryChargeCounterPath: battery accumulated charge
51//                                         (POWER_SUPPLY_PROP_CHARGE_COUNTER)
52
53struct healthd_config {
54    int periodic_chores_interval_fast;
55    int periodic_chores_interval_slow;
56
57    android::String8 batteryStatusPath;
58    android::String8 batteryHealthPath;
59    android::String8 batteryPresentPath;
60    android::String8 batteryCapacityPath;
61    android::String8 batteryVoltagePath;
62    android::String8 batteryTemperaturePath;
63    android::String8 batteryTechnologyPath;
64    android::String8 batteryCurrentNowPath;
65    android::String8 batteryCurrentAvgPath;
66    android::String8 batteryChargeCounterPath;
67};
68
69// Global helper functions
70
71int healthd_register_event(int fd, void (*handler)(uint32_t));
72void healthd_battery_update();
73android::status_t healthd_get_property(int id,
74    struct android::BatteryProperty *val);
75
76struct healthd_mode_ops {
77    void (*init)(struct healthd_config *config);
78    int (*preparetowait)(void);
79    void (*heartbeat)(void);
80    void (*battery_update)(struct android::BatteryProperties *props);
81};
82
83extern struct healthd_mode_ops *healthd_mode_ops;
84
85// The following are implemented in libhealthd_board to handle board-specific
86// behavior.
87//
88// healthd_board_init() is called at startup time to modify healthd's
89// configuration according to board-specific requirements.  config
90// points to the healthd configuration values described above.  To use default
91// values, this function can simply return without modifying the fields of the
92// config parameter.
93
94void healthd_board_init(struct healthd_config *config);
95
96// Process updated battery property values.  This function is called when
97// the kernel sends updated battery status via a uevent from the power_supply
98// subsystem, or when updated values are polled by healthd, as for periodic
99// poll of battery state.
100//
101// props are the battery properties read from the kernel.  These values may
102// be modified in this call, prior to sending the modified values to the
103// Android runtime.
104//
105// Return 0 to indicate the usual kernel log battery status heartbeat message
106// is to be logged, or non-zero to prevent logging this information.
107
108int healthd_board_battery_update(struct android::BatteryProperties *props);
109
110#endif /* _HEALTHD_H_ */
111