include/TelPower.h

   1 /*
   2  * libslp-tapi
   3  *
   4  * Copyright (c) 2014 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Ja-young Gu <jygu@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20
  21 /**
  22  * @file TelPower.h
  23  */
  24
  25 /**
  26  * @internal
  27  * @addtogroup CAPI_TELEPHONY_SERVICE_MODEM
  28  * @{
  29  */
  30
  31 #ifndef _TEL_POWER_H_
  32 #define _TEL_POWER_H_
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /**
  39  * @brief Enumeration for the phone power reset commands.
  40  * @since_tizen 2.3
  41  */
  42 typedef enum {
  43         TAPI_PHONE_POWER_ON = 0,
  44         TAPI_PHONE_POWER_OFF,
  45         TAPI_PHONE_POWER_RESET,
  46         TAPI_PHONE_POWER_LOW,
  47         TAPI_PHONE_POWER_MAX = TAPI_PHONE_POWER_LOW
  48 } tapi_power_phone_cmd_t;
  49
  50 /**
  51  * @brief Enumeration for the phone power status values.
  52  * @since_tizen 2.3
  53  */
  54 typedef enum {
  55         TAPI_PHONE_POWER_STATUS_UNKNOWN = -1,
  56         TAPI_PHONE_POWER_STATUS_ON,
  57         TAPI_PHONE_POWER_STATUS_OFF,
  58         TAPI_PHONE_POWER_STATUS_RESET,
  59         TAPI_PHONE_POWER_STATUS_LOW,
  60         TAPI_PHONE_POWER_STATUS_ERROR
  61 } tapi_power_phone_power_status_t;
  62
  63 /**
  64  * @details Enumeration for flight modes.
  65  * @since_tizen 2.3
  66  */
  67 typedef enum {
  68         TAPI_POWER_FLIGHT_MODE_ENTER = 0x01, /**< ONLINE OFF */
  69         TAPI_POWER_FLIGHT_MODE_LEAVE, /**< ONLINE ON */
  70         TAPI_POWER_FLIGHT_MODE_MAX              /**< TBD */
  71 } tapi_power_flight_mode_type_t;
  72
  73 typedef enum {
  74         TAPI_POWER_FLIGHT_MODE_RESP_ON = 0x01, /**< Flight Mode On Success */
  75         TAPI_POWER_FLIGHT_MODE_RESP_OFF, /**< Flight Mode Off Success */
  76         TAPI_POWER_FLIGHT_MODE_RESP_FAIL, /**< Flight Mode Request Fail */
  77         TAPI_POWER_FLIGHT_MODE_RESP_MAX         /**< TBD */
  78 } tapi_power_flight_mode_resp_type_t;
  79
  80 /**
  81  * @brief Enumeration for the phone battery status levels.
  82  *
  83  * @details
  84  * 0x01 : Power Off Level                     => PhoneLevel = power off
  85  * 0x02 : Critical-Low Battery Level          => PhoneLevel = 0
  86  * 0x03 : Low Battery Level                   => PhoneLevel = 1
  87  * 0x04 : Normal Level                        => PhoneLevel = 2,3,4
  88  * @since_tizen 2.3
  89  */
  90 typedef enum {
  91         TAPI_POWER_BATT_STAT_POWER_OFF_LEVEL = 0x01, /**< Power Off Level */
  92         TAPI_POWER_BATT_STAT_CRIT_LOW_LEVEL = 0x02, /**< Critical-Low Battery Level */
  93         TAPI_POWER_BATT_STAT_LOW_LEVEL = 0x03, /**< Low Battery Level */
  94         TAPI_POWER_BATT_STAT_NORMAL_LEVEL = 0x04 /**< Normal Level */
  95 } tapi_power_battery_status_level_t;
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101 #endif  /* _TEL_POWER_H_ */
 102
 103 /**
 104  * @}
 105  */