include/legacy/TelUtility.h

   1 /*
   2  * tel-plugin-vmodem
   3  *
   4  * Copyright (c) 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Kyeongchul Kim <kyeongchul.kim@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 * @open
  23 * @ingroup              TelephonyAPI
  24 * @addtogroup   COMMON_TAPI     COMMON
  25 * @{
  26 *
  27 * @file TelUtility.h
  28
  29      @brief This file serves as a "C" header file defines structures for Utility Services. \n
  30       It contains a sample set of constants, enums, structs that would be required by applications.
  31  */
  32
  33 #ifndef _TEL_UTILITY_H_
  34 #define _TEL_UTILITY_H_
  35 /*==================================================================================================
  36                                          INCLUDE FILES
  37 ==================================================================================================*/
  38 #ifdef __cplusplus
  39 extern "C"
  40 {
  41 #endif
  42
  43 /*==================================================================================================
  44                                            CONSTANTS
  45 ==================================================================================================*/
  46
  47
  48 /*==================================================================================================
  49                                             MACROS
  50 ==================================================================================================*/
  51 #define INVALID_REQUEST_ID      -1    /**< Invalid RequestId Value */
  52
  53
  54 /*==================================================================================================
  55                                              ENUMS
  56 ==================================================================================================*/
  57 /**
  58 * @enum TapiResult_t
  59 * Below enumerations are the return codes of TAPI API's
  60 */
  61 typedef enum
  62 {
  63         TAPI_API_SUCCESS                                                =  0,   /**<No Error occurred */
  64         TAPI_API_INVALID_INPUT                                  = -1,   /**<input values are not correct in TAPI Library */
  65         TAPI_API_INVALID_PTR                    = -2,   /**<invalid pointer */
  66         TAPI_API_NOT_SUPPORTED                  = -3,   /**<The feature corresponding to requested API is not supported. This may be due to market/network/vendor reasons such as the feature is not available in the network. */
  67         TAPI_API_DEPRICATED                                             = -4,   /**<This API is deprecated and will be so in future also */
  68         TAPI_API_SYSTEM_OUT_OF_MEM                              = -5,   /**<Out of memory */
  69         TAPI_API_SYSTEM_RPC_LINK_DOWN                   = -6,   /**<RPC link down */
  70         TAPI_API_SERVICE_NOT_READY                              = -7,   /**<Phone was powered on, but yet to receive the power up completed notification */
  71         TAPI_API_SERVER_FAILURE         = -8,   /**<error occurred in Telephony server  */
  72         TAPI_API_OEM_PLUGIN_FAILURE     = -9,   /**<Plug-in layer failure */
  73         TAPI_API_TRANSPORT_LAYER_FAILURE                = -10,  /**<Transport layer Failure*/
  74         TAPI_API_INVALID_DATA_LEN                               = -11,  /**<Invalid data length */
  75         TAPI_API_REQUEST_MAX_IN_PROGRESS                = -12,  /**<Maximum number of API Request for the same service are already in progress */
  76         TAPI_API_OFFLINE_MODE_ERROR                     = -13,  /**<OEM Telephony Provider is in Offline mode. */
  77         TAPI_EVENT_CLASS_UNKNOWN                                = -14,  /**<Event class specified is not present in Event Class list. - 20*/
  78         TAPI_EVENT_UNKNOWN                              = -15,  /**<Event specified is not present in TAPI Unsolicited Event list. */
  79         TAPI_REGISTRATION_OP_FAILED                             = -16,  /**<Callback Registration/De-registration failed */
  80         TAPI_API_OPERATION_FAILED                               = -17,  /**<API operation failed*/
  81         TAPI_API_INVALID_OPERATION                              = -18,  /**<API Invalid Operation */
  82
  83         /*SAMSUNG specif*/
  84         TAPI_API_SYSTEM_RPC_LINK_NOT_EST                = -100, /**< RPC link down */
  85         TAPI_API_API_NOT_SUPPORTED                              = -101, /**<API not supported */
  86         TAPI_API_SERVER_LAYER_FAILURE                   = -102, /**< Server layer failure*/
  87
  88         /*      CALL */
  89         TAPI_API_INVALID_CALL_ID                                = -200, /**< Invalid call ID*/
  90         TAPI_API_CALL_CTXT_OVERFLOW                             = -201, /**<Call context overflow */
  91         TAPI_API_COULD_NOT_GET_CALL_CTXT                = -202, /**< Could not get call  context*/
  92         TAPI_API_CTXT_SEARCH_RET_NON_CALL_CTXT  = -203, /**< Context search returned non-call context*/
  93         TAPI_API_COULD_NOT_DESTROY_CTXT                 = -204, /**< could not destroy context*/
  94         TAPI_API_INVALID_LINE_ID                                = -205, /**< invalid line ID*/
  95         TAPI_API_INVALID_CALL_HANDLE                    = -206, /**<Invalid call handle  - 35*/
  96         TAPI_API_INVALID_CALL_STATE                             = -207, /**<Invalid call state- Newly added. Need to raise a CR for this */
  97         TAPI_API_CALL_PRE_COND_FAILED                   = -208, /**<Pre condition like MO call can not be established now.*/
  98         TAPI_API_CALL_SAME_REQ_PENDING                  = -209, /**<  Can not accept same request multiple times  */
  99
 100         /*      POWER   */
 101         TAPI_API_MODEM_POWERED_OFF                              = -300, /**<The Modem is powered off */
 102         TAPI_API_MODEM_ALREADY_ON                               = -301, /**<Modem already on */
 103         TAPI_API_MODEM_ALREADY_OFF                              = -302, /**<Modem already off */
 104
 105         /* NETTEXT */
 106         TAPI_API_NETTEXT_DEVICE_NOT_READY               = -400, /**<Nettext device not ready */
 107         TAPI_API_NETTEXT_SCADDR_NOT_SET                 = -401, /**<Nettext SCA address not set */
 108         TAPI_API_NETTEXT_INVALID_DATA_LEN               = -402, /**<Nettext Invalid data length */
 109         TAPI_NETTEXT_SCADDRESS_NOT_SET                  = -403, /**<Nettext SCA address not set*/
 110
 111         /* SIM  */
 112         TAPI_API_SIM_BUSY                                               = -500, /**<SIM is busy  */
 113         TAPI_API_SIM_CARD_PERMANENT_ERROR               = -501, /**<SIM error/blocked state */
 114         TAPI_API_SIM_NOT_INITIALIZED                    = -502, /**<SIM has not initialized yet (waiting for PIN verification, etc) */
 115         TAPI_API_SIM_NOT_FOUND                                  = -503, /**<SIM is not present / removed */
 116         TAPI_API_SIM_SIM_SESSION_FULL                   = -504, /**< SIM session full*/
 117         TAPI_API_SIM_INVALID_CARD_TYPE                  = -505, /**< SIM Invalid Application ID*/
 118         TAPI_API_SIM_INVALID_SESSION                    = -506, /**<SIM Invalid Session */
 119         TAPI_API_SIM_FILE_TYPE_WRONG                    = -507, /**<SIM file type wrong */
 120         TAPI_API_SIM_FILE_ENCODE_FAIL                   = -508, /**<SIM file encode fail */
 121         TAPI_API_SIM_FILE_DECODE_FAIL                   = -509, /**< SIM file decode fail*/
 122         TAPI_API_SIM_FILE_INVALID_ENCODE_LEN    = -510, /**< SIM invalid encode length*/
 123         TAPI_API_SIM_INVALID_RECORD_NUM         = -511, /**<SIM Invalid record number */
 124         TAPI_API_SIM_CASE_NOT_HANDLED                   = -512, /**< SIM case not handled*/
 125         TAPI_API_SIM_OEM_UNKNOWN_SIM_CARD               = -513, /**<SIM OEM unknown SIM card */
 126         TAPI_API_SIM_SEC_UKNOWN_PIN_TYPE                = -514, /**<SIM unknown pin type */
 127         TAPI_API_SIM_SEC_INVALID_PIN_TYPE               = -515, /**<SIM invalid pin type */
 128         TAPI_API_SIM_SEC_LOCK_PERS_ENABLED              = -516, /**<SIM Lock Personalization status(PN/PU/PP/PC) */
 129         TAPI_API_SIM_PB_INVALID_STORAGE_TYPE    = -517, /**<SIM phonebook invalid storage type */
 130
 131         /* SAT  */
 132         TAPI_API_SAT_INVALID_COMMAND_ID                 = -600, /**<Command Number Invalid      */
 133         TAPI_API_SAT_COMMAND_TYPE_MISMATCH              = -601, /**<    Command Type Mismatch   */
 134         TAPI_API_SAT_EVENT_NOT_REQUIRED_BY_USIM = -602, /**< Event Not Requested by USIM*/
 135
 136         /* Network */
 137         TAPI_API_NETWORK_INVALID_CTXT                   = -700, /**< Network invalid context*/
 138
 139         /*Misc */
 140         TAPI_API_MISC_RETURN_NULL                               = -800, /**< MISC return NULL*/
 141         TAPI_API_MISC_VALIDITY_ERROR                    = -801, /**< MISC validity error*/
 142         TAPI_API_MISC_INPUTPARM_ERROR                   = -802, /**< MISC input parameter error*/
 143         TAPI_API_MISC_OUTPARAM_NULL                             = -803, /**< MISC output parameter null*/
 144
 145 } TapiResult_t;
 146
 147 /*==================================================================================================
 148                                  STRUCTURES AND OTHER TYPEDEFS
 149 ==================================================================================================*/
 150
 151
 152 /*==================================================================================================
 153                                      FUNCTION PROTOTYPES
 154 ==================================================================================================*/
 155
 156 #ifdef __cplusplus
 157 }
 158 #endif
 159
 160 #endif //_TEL_UTILITY_H_
 161
 162 /**
 163 * @}
 164 */
 165