Add internal api for power off
[platform/core/api/device.git] / include / power-internal.h
1 /*
2  * Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved
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 #ifndef __TIZEN_SYSTEM_POWER_INTERNAL_H__
18 #define __TIZEN_SYSTEM_POWER_INTERNAL_H__
19
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23
24 /**
25  * @platform
26  * @brief Power off the device.
27  * @details It operates synchronously.
28  * @since_tizen 6.5
29  * @privlevel platform
30  * @privilege %http://tizen.org/privilege/reboot
31  * @return @c 0 on success,
32  *         otherwise a negative error value
33  * @retval #DEVICE_ERROR_NONE Successful
34  * @retval #DEVICE_ERROR_INVALID_PARAMETER Invalid parameter
35  * @retval #DEVICE_ERROR_PERMISSION_DENIED Permission denied
36  * @retval #DEVICE_ERROR_OPERATION_FAILED Operation failed
37  */
38 int device_power_poweroff(void);
39
40 #ifdef __cplusplus
41 }
42 #endif
43
44 #endif