1 /*
2  * Copyright (C) 2020 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.system.suspend.internal;
18 
19 import android.system.suspend.internal.SuspendInfo;
20 import android.system.suspend.internal.WakeLockInfo;
21 import android.system.suspend.internal.WakeupInfo;
22 
23 /**
24  * Interface exposed by the suspend hal that allows framework to toggle the suspend loop and
25  * monitor native wakelocks.
26  * @hide
27  */
28 interface ISuspendControlServiceInternal {
29     /**
30      * Starts automatic system suspension.
31      *
32      * @param token token registering automatic system suspension.
33      * When all registered tokens die automatic system suspension is disabled.
34      * @return true on success, false otherwise.
35      */
enableAutosuspend(IBinder token)36     boolean enableAutosuspend(IBinder token);
37 
38     /**
39      * Suspends the system even if there are wakelocks being held.
40      */
forceSuspend()41     boolean forceSuspend();
42 
43     /**
44      * Returns a list of wake lock stats.
45      */
getWakeLockStats()46     WakeLockInfo[] getWakeLockStats();
47 
48     /**
49      * Returns a list of wakeup stats.
50      */
getWakeupStats()51     WakeupInfo[] getWakeupStats();
52 
53     /**
54      * Returns stats related to suspend.
55      */
getSuspendStats()56     SuspendInfo getSuspendStats();
57 }
58