1 /*
2  * Copyright (C) 2014 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 package android.os;
18 
19 /**
20  * Battery manager local system service interface.
21  *
22  * @hide Only for use within the system server.
23  */
24 public abstract class BatteryManagerInternal {
25     /**
26      * Returns true if the device is plugged into any of the specified plug types.
27      *
28      * This is a simple accessor that's safe to be called from any locks, but internally it may
29      * wait on the battery service lock.
30      */
isPowered(int plugTypeSet)31     public abstract boolean isPowered(int plugTypeSet);
32 
33     /**
34      * Returns the current plug type.
35      *
36      * This is a simple accessor that's safe to be called from any locks, but internally it may
37      * wait on the battery service lock.
38      */
getPlugType()39     public abstract int getPlugType();
40 
41     /**
42      * Returns battery level as a percentage.
43      *
44      * This is a simple accessor that's safe to be called from any locks, but internally it may
45      * wait on the battery service lock.
46      */
getBatteryLevel()47     public abstract int getBatteryLevel();
48 
49     /**
50      * Returns battery health status as an integer representing the current battery health constant.
51      *
52      * This is a simple accessor that's safe to be called from any locks, but internally it may
53      * wait on the battery service lock.
54      */
getBatteryHealth()55     public abstract int getBatteryHealth();
56 
57     /**
58      * Instantaneous battery capacity in uA-h, as defined in the HealthInfo HAL struct.
59      * Please note apparently it could be bigger than {@link #getBatteryFullCharge}.
60      *
61      * This is a simple accessor that's safe to be called from any locks, but internally it may
62      * wait on the battery service lock.
63      *
64      * @see android.hardware.health.V1_0.HealthInfo#batteryChargeCounter
65      */
getBatteryChargeCounter()66     public abstract int getBatteryChargeCounter();
67 
68     /**
69      * Battery charge value when it is considered to be "full" in uA-h , as defined in the
70      * HealthInfo HAL struct.
71      *
72      * This is a simple accessor that's safe to be called from any locks, but internally it may
73      * wait on the battery service lock.
74      *
75      * @see android.hardware.health.V1_0.HealthInfo#batteryFullCharge
76      */
getBatteryFullCharge()77     public abstract int getBatteryFullCharge();
78 
79     /**
80      * Returns whether we currently consider the battery level to be low.
81      *
82      * This is a simple accessor that's safe to be called from any locks, but internally it may
83      * wait on the battery service lock.
84      */
getBatteryLevelLow()85     public abstract boolean getBatteryLevelLow();
86 
87     /**
88      * Returns a non-zero value if an unsupported charger is attached.
89      *
90      * This is a simple accessor that's safe to be called from any locks, but internally it may
91      * wait on the battery service lock.
92      */
getInvalidCharger()93     public abstract int getInvalidCharger();
94 
95     /**
96      * Sets battery AC charger to enabled/disabled, and freezes the battery state.
97      */
setChargerAcOnline(boolean online, boolean forceUpdate)98     public abstract void setChargerAcOnline(boolean online, boolean forceUpdate);
99 
100     /**
101      * Sets battery level, and freezes the battery state.
102      */
setBatteryLevel(int level, boolean forceUpdate)103     public abstract void setBatteryLevel(int level, boolean forceUpdate);
104 
105     /**
106      * Unplugs battery, and freezes the battery state.
107      */
unplugBattery(boolean forceUpdate)108     public abstract void unplugBattery(boolean forceUpdate);
109 
110     /**
111      * Unfreezes battery state, returning to current hardware values.
112      */
resetBattery(boolean forceUpdate)113     public abstract void resetBattery(boolean forceUpdate);
114 
115     /**
116      * Suspend charging even if plugged in.
117      */
suspendBatteryInput()118     public abstract void suspendBatteryInput();
119 }
120