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 54 struct 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 android::String8 batteryFullChargePath; 69 android::String8 batteryCycleCountPath; 70 71 int (*energyCounter)(int64_t *); 72 int boot_min_cap; 73 bool (*screen_on)(android::BatteryProperties *props); 74 }; 75 76 enum EventWakeup { 77 EVENT_NO_WAKEUP_FD, 78 EVENT_WAKEUP_FD, 79 }; 80 81 // Global helper functions 82 83 int healthd_register_event(int fd, void (*handler)(uint32_t), EventWakeup wakeup = EVENT_NO_WAKEUP_FD); 84 void healthd_battery_update(); 85 android::status_t healthd_get_property(int id, 86 struct android::BatteryProperty *val); 87 void healthd_dump_battery_state(int fd); 88 89 struct healthd_mode_ops { 90 void (*init)(struct healthd_config *config); 91 int (*preparetowait)(void); 92 void (*heartbeat)(void); 93 void (*battery_update)(struct android::BatteryProperties *props); 94 }; 95 96 extern struct healthd_mode_ops *healthd_mode_ops; 97 98 // Charger mode 99 100 void healthd_mode_charger_init(struct healthd_config *config); 101 int healthd_mode_charger_preparetowait(void); 102 void healthd_mode_charger_heartbeat(void); 103 void healthd_mode_charger_battery_update( 104 struct android::BatteryProperties *props); 105 106 // The following are implemented in libhealthd_board to handle board-specific 107 // behavior. 108 // 109 // healthd_board_init() is called at startup time to modify healthd's 110 // configuration according to board-specific requirements. config 111 // points to the healthd configuration values described above. To use default 112 // values, this function can simply return without modifying the fields of the 113 // config parameter. 114 115 void healthd_board_init(struct healthd_config *config); 116 117 // Process updated battery property values. This function is called when 118 // the kernel sends updated battery status via a uevent from the power_supply 119 // subsystem, or when updated values are polled by healthd, as for periodic 120 // poll of battery state. 121 // 122 // props are the battery properties read from the kernel. These values may 123 // be modified in this call, prior to sending the modified values to the 124 // Android runtime. 125 // 126 // Return 0 to indicate the usual kernel log battery status heartbeat message 127 // is to be logged, or non-zero to prevent logging this information. 128 129 int healthd_board_battery_update(struct android::BatteryProperties *props); 130 131 #endif /* _HEALTHD_H_ */ 132