include/TelPower.h

   1 /*
   2  * libslp-tapi
   3  *
   4  * Copyright (c) 2011 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  * @internal
  23  * @ingroup             TelephonyAPI
  24  * @addtogroup  POWER_TAPI      POWER
  25  * @{
  26  *
  27  * These APIs allow an application to accomplish the following services: @n
  28  * - Get current phone power status,  @n
  29  * - Reset the phone power (on / off), @n
  30  * - Get the Display Icon Information. @n
  31  */
  32
  33 #ifndef _TEL_POWER_H_
  34 #define _TEL_POWER_H_
  35
  36 #include <TelDefines.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /**
  43  * This defines the phone power reset commands.
  44  */
  45 typedef enum {
  46         TAPI_PHONE_POWER_OFF = 0, TAPI_PHONE_POWER_ON, TAPI_PHONE_POWER_RESET,
  47 } tapi_power_phone_cmd_t;
  48
  49 /**
  50  * This defines the phone power status values.
  51  */
  52 typedef enum {
  53         TAPI_PHONE_POWER_STATUS_ON = 0, TAPI_PHONE_POWER_STATUS_OFF, TAPI_PHONE_POWER_STATUS_ERROR,
  54 } tapi_power_phone_power_status_t;
  55
  56 /**
  57  * Use to Enter or Leave Flight Mode.
  58  *
  59  */
  60 typedef enum {
  61         TAPI_POWER_FLIGHT_MODE_ENTER = 0x01, /**< ONLINE OFF */
  62         TAPI_POWER_FLIGHT_MODE_LEAVE, /**< ONLINE ON */
  63         TAPI_POWER_FLIGHT_MODE_MAX
  64 } tapi_power_flight_mode_type_t;
  65
  66 typedef enum {
  67         TAPI_POWER_FLIGHT_MODE_RESP_ON = 0x01, /**< Flight Mode On Success */
  68         TAPI_POWER_FLIGHT_MODE_RESP_OFF, /**< Flight Mode Off Success */
  69         TAPI_POWER_FLIGHT_MODE_RESP_FAIL, /**< Flight Mode Request Fail */
  70         TAPI_POWER_FLIGHT_MODE_RESP_MAX
  71 } tapi_power_flight_mode_resp_type_t;
  72
  73 /**
  74  * This enum defines the phone battery status levels.
  75  *
  76  * 0x01 : Power Off Level                     => PhoneLevel = power off
  77  * 0x02 : Critical-Low Battery Level          => PhoneLevel = 0
  78  * 0x03 : Low Battery Level                   => PhoneLevel = 1
  79  * 0x04 : Normal Level                        => PhoneLevel = 2,3,4
  80  */
  81 typedef enum {
  82         TAPI_POWER_BATT_STAT_POWER_OFF_LEVEL = 0x01, /**< Power Off Level */
  83         TAPI_POWER_BATT_STAT_CRIT_LOW_LEVEL = 0x02, /**< Critical-Low Battery Level */
  84         TAPI_POWER_BATT_STAT_LOW_LEVEL = 0x03, /**< Low Battery Level */
  85         TAPI_POWER_BATT_STAT_NORMAL_LEVEL = 0x04 /**< Normal Level */
  86 } tapi_power_battery_status_level_t;
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92 #endif  /* _TEL_POWER_H_ */
  93
  94 /**
  95  * @}
  96  */