1 /*
2  * Copyright (c) 2021 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef POWERMGR_RUNNING_LOCK_H
17 #define POWERMGR_RUNNING_LOCK_H
18 
19 #include <stdint.h>
20 
21 #include <ohos_types.h>
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif // __cplusplus
26 
27 typedef enum {
28     /**
29      * RunningLock type: used to keep screen on.
30      */
31     RUNNINGLOCK_SCREEN,
32     /**
33      * RunningLock type: used to keep cpu running.
34      */
35     RUNNINGLOCK_BACKGROUND,
36     /**
37      * RunningLock type: used to keep the screen on/off when the proximity sensor is active.
38      */
39     RUNNINGLOCK_PROXIMITY_SCREEN_CONTROL,
40     RUNNINGLOCK_BUTT
41 } RunningLockType;
42 
43 typedef enum {
44     RUNNINGLOCK_FLAG_NONE = 0,
45 
46     /**
47      * Wakeup device when running lock is acquired.
48      */
49     RUNNINGLOCK_FLAG_WAKEUP_WHEN_ACQUIRED = 1 << 0,
50 } RunningLockFlag;
51 
52 #define RUNNING_LOCK_NAME_LEN   64
53 
54 typedef struct {
55     char name[RUNNING_LOCK_NAME_LEN];
56     RunningLockType type;
57     RunningLockFlag flag;
58 } RunningLock;
59 
60 const RunningLock *CreateRunningLock(const char *name, RunningLockType type, RunningLockFlag flag);
61 void DestroyRunningLock(const RunningLock *lock);
62 BOOL AcquireRunningLock(const RunningLock *lock);
63 BOOL ReleaseRunningLock(const RunningLock *lock);
64 BOOL IsRunningLockHolding(const RunningLock *lock);
65 
66 #ifdef __cplusplus
67 }
68 #endif // __cplusplus
69 #endif // POWERMGR_RUNNING_LOCK_H
70