1 /*
2  * Copyright (C) 2019 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;
18 
19 import android.system.suspend.ISuspendCallback;
20 import android.system.suspend.WakeLockInfo;
21 
22 /**
23  * Interface exposed by the suspend hal that allows framework to toggle the suspend loop and
24  * monitor native wakelocks.
25  * @hide
26  */
27 interface ISuspendControlService
28 {
29     /**
30      * Starts automatic system suspendion.
31      *
32      * @return true on success, false otherwise.
33      */
enableAutosuspend()34     boolean enableAutosuspend();
35 
36     /**
37      * Registers a callback for suspend events.  ISuspendControlService must keep track of all
38      * registered callbacks unless the client process that registered the callback dies.
39      *
40      * @param callback the callback to register.
41      * @return true on success, false otherwise.
42      */
registerCallback(ISuspendCallback callback)43     boolean registerCallback(ISuspendCallback callback);
44 
45     /**
46      * Suspends the system even if there are wakelocks being held.
47      */
forceSuspend()48     boolean forceSuspend();
49 
50     /**
51      * Returns a list of wake lock stats.
52      */
getWakeLockStats()53     WakeLockInfo[] getWakeLockStats();
54 }
55