Improve explanation in cpu boosting API specification
[platform/core/api/resource.git] / include / cpu-boosting-type.h
1 /* MIT License
2  *
3  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy
6  * of this software and associated documentation files (the "Software"), to deal
7  * in the Software without restriction, including without limitation the rights
8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9  * copies of the Software, and to permit persons to whom the Software is furnished
10  * to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21  * THE SOFTWARE. */
22
23 #ifndef __TIZEN_SYSTEM_CPU_BOOSTING_TYPE_H__
24 #define __TIZEN_SYSTEM_CPU_BOOSTING_TYPE_H__
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 typedef enum resource_cpu_boosting_level {
31         CPU_BOOSTING_LEVEL_NONE = 0,
32         CPU_BOOSTING_LEVEL_STRONG = 1,
33         CPU_BOOSTING_LEVEL_MEDIUM,
34         CPU_BOOSTING_LEVEL_WEAK,
35         CPU_BOOSTING_LEVEL_END,
36 } cpu_boosting_level_e;
37
38 typedef struct resource_pid_info {
39         int pid;
40         int *tid;
41         int tid_count;
42 } resource_pid_t;
43
44 typedef struct resource_cpu_boosting_level_info {
45         int *tid_level;
46         int tid_count;
47 } cpu_boosting_level_info_t;
48
49 #ifdef __cplusplus
50 }
51 #endif
52
53 #endif  // __TIZEN_SYSTEM_CPU_BOOSTING_TYPE_H__