include/TelSms.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 * @open
  23 * @ingroup              TelephonyAPI
  24 * @addtogroup   NetText_TAPI    NetText(SMS)
  25 * @{
  26 *
  27 * @file TelNetText.h
  28
  29      @brief This file serves as a "C" header file defines structures for Tapi Network Text Services. \n
  30       It contains a sample set of constants, enums, structs that would be required by applications.
  31
  32  */
  33 #ifndef _TEL_NETTEXT_H_
  34 #define _TEL_NETTEXT_H_
  35
  36 #include <TelSim.h>
  37
  38 #ifdef __cplusplus
  39 extern "C"
  40 {
  41 #endif
  42
  43 /* NetText */
  44 /** EF-SMSP digit length */
  45 #define TAPI_SIM_SMSP_ADDRESS_LEN               20
  46 /** EF-SMSP alpha id length */
  47 #define TAPI_SIM_SMSP_ALPHA_ID_LEN_MAX          128
  48
  49 #define TAPI_NETTEXT_MSG_SIZE_MAX               918 /**< Maximum Message Size */
  50 #define TAPI_NETTEXT_CB_SIZE_MAX                        93 /** Maximum CB Message Size */
  51 #define TAPI_NETTEXT_ADDRESS_LEN_MAX    20 /* Nettext Address Length */
  52 #define TAPI_NETTEXT_SCADDRESS_LEN_MAX  18 /* SC Address Length */
  53
  54 #define TAPI_NETTEXT_CB_PAGE_SIZE_MAX                            93    /**< CB maximum page size*/
  55 #define TAPI_NETTEXT_GSM_SMS_MSG_NUM_MAX                 90    /**< Maximum GSM SMS message number*/
  56 #define TAPI_NETTEXT_GSM_SMS_CBMI_LIST_SIZE_MAX      50    /**< Maximum GSM SMS CBMI list size*/
  57 #define TAPI_NETTEXT_SMDATA_SIZE_MAX                           165  /**< Maximum SMS data size that can be stored*/
  58 #define TAPI_NETTEXT_MAX_SMS_SERVICE_CENTER_ADDR   12    /**<Maximum SMS service center address*/
  59 #define TAPI_NETTEXT_MAX_INDEX                                        255 /**< Maximum index value for SMS */
  60
  61 #define TAPI_NETTEXT_SMSP_PARAMS_MAX_LEN                28
  62
  63 // ************************  CDMA Features  **************************//
  64 #define TAPI_NETTEXT_PARAM_TELESERVICE_MASK                     1 << 0                          /**< Teleservice parameter bit position */
  65 #define TAPI_NETTEXT_PARAM_SERVICE_CATEGORY_MASK                1 << 1                          /**< Service Category parameter bit position */
  66 #define TAPI_NETTEXT_PARAM_ADDRESS_MASK                         1 << 2                          /**< Address parameter bit position */
  67 #define TAPI_NETTEXT_PARAM_SUBADDRESS_MASK                      1 << 3                          /**< Subaddress parameter bit position */
  68 #define TAPI_NETTEXT_PARAM_BEARER_REPLY_MASK                    1 << 4                          /**< Bearer reply parameter bit position */
  69 #define TAPI_NETTEXT_PARAM_CAUSE_CODES_MASK                     1 << 5                          /**< Cause Code parameter bit position */
  70 #define TAPI_NETTEXT_PARAM_MESSAGE_ID_MASK                      1 << 6                          /**< Message ID parameter bit position */
  71 #define TAPI_NETTEXT_PARAM_USER_DATA_MASK                       1 << 7                          /**< User Data parameter bit position */
  72 #define TAPI_NETTEXT_PARAM_USER_RESPONSE_CODE_MASK              1 << 8                          /**< User Response Code parameter bit position */
  73 #define TAPI_NETTEXT_PARAM_MC_TIME_STAMP_MASK                   1 << 9                          /**< Message Center Timestamp parameter bit position */
  74 #define TAPI_NETTEXT_PARAM_VALIDITY_PERIOD_ABS_MASK             1 << 10                         /**< Valid period Absolute parameter bit position */
  75 #define TAPI_NETTEXT_PARAM_VALIDITY_PERIOD_REL_MASK                     1 << 11                         /**< Valid period Relative parameter bit position */
  76 #define TAPI_NETTEXT_PARAM_DEFERRED_DELIVERY_ABS_MASK           1 << 12                         /**< Deferred delivery absolute parameter bit position */
  77 #define TAPI_NETTEXT_PARAM_DEFERRED_DELIVERY_REL_MASK           1 << 13                         /**< Deferred delivery relative parameter bit position */
  78 #define TAPI_NETTEXT_PARAM_PRIORITY_MASK                                1 << 14                         /**< Priority parameter bit position */
  79 #define TAPI_NETTEXT_PARAM_PRIVACY_MASK                         1 << 15                         /**< Privacy parameter bit position */
  80 #define TAPI_NETTEXT_PARAM_REPLY_OPTION_MASK                    1 << 16                         /**< Reply Option parameter bit position */
  81 #define TAPI_NETTEXT_PARAM_NUMBER_OF_MESSAGE_MASK               1 << 17                         /**< Number of message parameter bit position */
  82 #define TAPI_NETTEXT_PARAM_ALERT_ON_DELIVERY_MASK                       1 << 18                         /**< Alert on delivery parameter bit position */
  83 #define TAPI_NETTEXT_PARAM_LANGUAGE_MASK                        1 << 19                         /**< Language parameter bit position */
  84 #define TAPI_NETTEXT_PARAM_CALLBACK_MASK                                1 << 20                         /**< Callback Number parameter bit position */
  85 #define TAPI_NETTEXT_PARAM_DISPLAY_MODE_MASK                    1 << 21                         /**< Display mode parameter bit position */
  86 #define TAPI_NETTEXT_PARAM_MULTI_ENCODING_USER_DATA_MASK        1 << 22                         /**< Multi Encoding user data parameter bit position */
  87
  88 #define TAPI_NETTEXT_MAXLENGTH_SMS_MT_USER_DATA                         160                                     /**< Maximum MT user data  size*/
  89 #define TAPI_NETTEXT_MAXLENGTH_SMS_MO_USER_DATA                         160                                     /**< Maximum MO user data  size*/
  90
  91 #define TAPI_NETTEXT_MAXLENGTH_SMS_ADDRESS                                              32                                      /**< MAX sms destination(or origination ) address /call back number */
  92
  93 #define TAPI_NETTEXT_ERR_CLASS0_STATUS_SEND_OK                                                          0       /**< send success */
  94 #define TAPI_NETTEXT_ERR_CLASS23_ADDRESS_VACANT                                                         0       /**< address vacant */
  95 #define TAPI_NETTEXT_ERR_CLASS23_ADDRESS_TRANSLATION_FAILURE                                    1       /**< address translation failure */
  96 #define TAPI_NETTEXT_ERR_CLASS23_NETWORK_RESOURCE_SHORTAGE                                      2       /**< network resource shortage */
  97 #define TAPI_NETTEXT_ERR_CLASS23_NETWORK_FAILURE                                                                3       /**< network failure */
  98 #define TAPI_NETTEXT_ERR_CLASS23_INVALID_TELESERVICE_ID                                                 4       /**< invalid teleservice id */
  99 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_NETWORK_PROBLEM                                          5       /**< other network problem */
 100 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_NETWORK_PROBLEM_MORE_FIRST                       6       /**< other network problem more first */
 101 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_NETWORK_PROBLEM_MORE_LAST                        31      /**< other network problem more last */
 102 #define TAPI_NETTEXT_ERR_CLASS23_NO_PAGE_RESPONSE                                                               32      /**< no page response */
 103 #define TAPI_NETTEXT_ERR_CLASS23_DESTINATION_BUSY                                                               33      /**< destination busy */
 104 #define TAPI_NETTEXT_ERR_CLASS23_NO_ACK                                                                                 34      /**< no ack */
 105 #define TAPI_NETTEXT_ERR_CLASS23_DESTINATION_RESOURCE_SHORTAGE                          35      /**< destination resource shortage */
 106 #define TAPI_NETTEXT_ERR_CLASS23_SMS_DELIVERY_POSTPONED                                         36      /**< sms delivery postponed */
 107 #define TAPI_NETTEXT_ERR_CLASS23_DESTINATION_OUT_OF_SERVICE                                     37      /**< destination out of service */
 108 #define TAPI_NETTEXT_ERR_CLASS23_DESTINATION_NO_LONGER_AT_THIS_ADDRESS          38      /**< destination no longer at this address */
 109 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_TERMINAL_PROBLEM                                         39      /**< other terminal problem */
 110 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_TERMINAL_PROBLEM_MORE_FIRST                      40      /**< other terminal problem more first */
 111 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_TERMINAL_PROBLEM_MORE_LAST                       47      /**< other terminal problem more last */
 112 #define TAPI_NETTEXT_ERR_CLASS23_SMS_DELIVERY_POSTPONED_MORE_FIRST                      48      /**< sms delivery postpone more first */
 113 #define TAPI_NETTEXT_ERR_CLASS23_SMS_DELIVERY_POSTPONED_MORE_LAST                       63      /**< sms delivery postpone more last */
 114 #define TAPI_NETTEXT_ERR_CLASS23_RADIO_IF_RESOURCE_SHORTAGE                                     64      /**< radio interface resource shortage */
 115 #define TAPI_NETTEXT_ERR_CLASS23_RADIO_IF_INCOMPATIBLE                                                  65      /**< radio interface incompatible */
 116 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_RADIO_IF_PROBLEM                                         66      /**< other radio interface problem */
 117 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_RADIO_IF_PROBLEM_MORE_FIRST                      67      /**< other radio interface problem more first */
 118 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_RADIO_IF_PROBLEM_MORE_LAST                       95      /**< other radio interface problem more last */
 119 #define TAPI_NETTEXT_ERR_CLASS23_UNEXPECTED_PARM_SIZE                                                   96      /**< unexpected parameter size */
 120 #define TAPI_NETTEXT_ERR_CLASS23_SMS_ORIGINATION_DENIED                                         97      /**< sms origination denied */
 121 #define TAPI_NETTEXT_ERR_CLASS23_SMS_TERMINATION_DENIED                                         98      /**< sms termination denied */
 122 #define TAPI_NETTEXT_ERR_CLASS23_SUPPL_SERVICE_NOT_SUPPORTED                                    99      /**< supplementary service not supported */
 123 #define TAPI_NETTEXT_ERR_CLASS23_SMS_NOT_SUPPORTED                                                              100     /**< sms not supported */
 124 #define TAPI_NETTEXT_ERR_CLASS23_RESERVED_101                                                                   101     /**< reserved 101 */
 125 #define TAPI_NETTEXT_ERR_CLASS23_MISSING_EXPECTED_PARM                                          102     /**< missing expected parameter */
 126 #define TAPI_NETTEXT_ERR_CLASS23_MISSING_MANDATORY_PARM                                         103     /**< missing mandatory parameter value */
 127 #define TAPI_NETTEXT_ERR_CLASS23_UNRECOGNIZED_PARM_VALUE                                                104     /**< unrecognized parameter value */
 128 #define TAPI_NETTEXT_ERR_CLASS23_UNEXPECTED_PARM_VALUE                                          105     /**< unexpected parameter value */
 129 #define TAPI_NETTEXT_ERR_CLASS23_USER_DATA_SIZE_ERROR                                                   106     /**< user data size error */
 130 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_GENERAL_PROBLEMS                                         107     /**< other general problem */
 131 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_GENERAL_PROBLEMS_MORE_FIRST                      108     /**< other general problem first */
 132 #define TAPI_NETTEXT_ERR_CLASS23_OTHER_GENERAL_PROBLEMS_MORE_LAST                       255     /**< other general problem last */
 133
 134 #define TAPI_NETTEXT_ERR_CLASS4_WAITING_FOR_TL_ACK                                                              1       /**< waiting for transport ack */
 135 #define TAPI_NETTEXT_ERR_CLASS4_OUT_OF_RESOURCES                                                                2       /**< out of resource */
 136 #define TAPI_NETTEXT_ERR_CLASS4_ACCESS_TOO_LARGE                                                                3       /**< access to large */
 137 #define TAPI_NETTEXT_ERR_CLASS4_DTC_TOO_LARGE                                                           4       /**< DTC too large */
 138 #define TAPI_NETTEXT_ERR_CLASS4_DTC_CONNECTED                                                                   5       /**< DTC connected */
 139 #define TAPI_NETTEXT_ERR_CLASS4_NETWORK_NOT_READY                                                               6       /**< network not ready */
 140 #define TAPI_NETTEXT_ERR_CLASS4_NO_SVC                                                                                  7       /**< no service */
 141 #define TAPI_NETTEXT_ERR_CLASS4_PHONE_NOT_READY                                                         8       /**< phone not ready */
 142 #define TAPI_NETTEXT_ERR_CLASS4_NOT_ALLOWED_IN_AMPS                                                     9       /**< fail to allowed in amps */
 143 #define TAPI_NETTEXT_ERR_CLASS4_CANNOT_SEND_BROADCAST                                                   10      /**< fail to send broadcast */
 144 #define TAPI_NETTEXT_ERR_CLASS4_INVALID_TRANSACTION_ID
 145 // ********************************************************************//
 146
 147 /**
 148  * @enum TelSmsMsgStatus_t
 149  * This enumeration defines the network text status type.
 150  */
 151 typedef enum
 152 {
 153         TAPI_NETTEXT_STATUS_READ,                                       /**< MT message, stored and read */
 154         TAPI_NETTEXT_STATUS_UNREAD,                                     /**< MT message, stored and unread */
 155         TAPI_NETTEXT_STATUS_SENT,                                       /**< MO message, stored and  sent */
 156         TAPI_NETTEXT_STATUS_UNSENT,                                     /**< MO message, stored but not sent */
 157         TAPI_NETTEXT_STATUS_DELIVERED,                         /**< delivered destination */
 158         TAPI_NETTEXT_STATUS_DELIVERY_UNCONFIRMED,  /**< Service centre forwarded message but is unable to confirm delivery*/
 159         TAPI_NETTEXT_STATUS_MESSAGE_REPLACED,          /**< Message has been replaced*/
 160         TAPI_NETTEXT_STATUS_RESERVED                            /**< Reserved for future use*/
 161 } TelSmsMsgStatus_t;
 162
 163 /**
 164  * @enum TelSmsMemStatusType
 165  * This enumeration defines the memory status type.
 166  */
 167 typedef enum
 168 {
 169         TAPI_NETTEXT_PDA_MEMORY_STATUS_AVAILABLE                = 0x01, /**< PDA Memory Available */
 170         TAPI_NETTEXT_PDA_MEMORY_STATUS_FULL                     = 0x02,  /**< PDAMemory is Full */
 171         TAPI_NETTEXT_PHONE_MEMORY_STATUS_AVAILABLE      = 0x03, /**< Phone memory Available */
 172         TAPI_NETTEXT_PHONE_MEMORY_STATUS_FULL                   = 0x04, /**< phone memory is full */
 173 }TelSmsMemStatusType;
 174
 175 /**
 176  * @enum TelSmsBearerType_t
 177  * This enum defines the different bearer types
 178  */
 179 typedef enum
 180 {
 181         TAPI_NETTEXT_BEARER_PS_ONLY = 0x01,       /**< Send SMS only on PS Bearer */
 182         TAPI_NETTEXT_BEARER_CS_ONLY,                  /**< Send SMS only on CS Bearer */
 183         TAPI_NETTEXT_BEARER_PS_PREFERRED,        /**<Send SMS preferably on PS Bearer*/
 184         TAPI_NETTEXT_BEARER_CS_PREFERRED ,       /**<Send SMS preferably on CS Bearer*/
 185         TAPI_NETTEXT_NO_PREFERRED_BEARER         /**<SMS is sent based on default preferred bearer set at OEM based on vendor/operator preference*/
 186 } TelSmsBearerType_t;
 187
 188
 189 /**
 190 * @enum TelSmsCbMsgType_t
 191 * This enumeration defines the different CB message types.
 192 */
 193 typedef enum
 194 {
 195            TAPI_NETTEXT_CB_MSG_CBS = 1,             /**< Cell broadcast message */
 196            TAPI_NETTEXT_CB_MSG_SCHEDULE,            /**< CB Schedule message  */
 197            TAPI_NETTEXT_CB_MSG_CBS41,               /**< CBS41 type message  */
 198            TAPI_NETTEXT_CB_MSG_INVALID            /**< Invalid  CB message */
 199 } TelSmsCbMsgType_t;
 200
 201
 202 /**
 203  * @enum TelSmsResponse_t
 204  * This enum defines the different response types that come in the
 205  * sent status acknowledgement/notification after sending a message to the network
 206  */
 207 typedef enum
 208 {
 209         TAPI_NETTEXT_SENDSMS_SUCCESS = 0x00,     /**<Message send success*/
 210         TAPI_NETTEXT_ROUTING_NOT_AVAILABLE,     /**< Message routing not available*/
 211         TAPI_NETTEXT_INVALID_PARAMETER,             /**< Invalid parameter present in TPDU*/
 212         TAPI_NETTEXT_DEVICE_FAILURE,                    /**< Device failure*/
 213         TAPI_NETTEXT_SERVICE_RESERVED,                /**< Reserved Service*/
 214         TAPI_NETTEXT_INVALID_LOCATION,                /**< Invalid location*/
 215         TAPI_NETTEXT_NO_SIM,                                    /**< No SIM error*/
 216         TAPI_NETTEXT_SIM_NOT_READY,            /**< SIM not ready error*/
 217         TAPI_NETTEXT_NO_NETWORK_RESP,          /**< No response from network*/
 218         TAPI_NETTEXT_DEST_ADDRESS_FDN_RESTRICTED,/**< Destination address restricted*/
 219         TAPI_NETTEXT_SCADDRESS_FDN_RESTRICTED,   /**< Service center address restricted*/
 220         TAPI_NETTEXT_RESEND_ALREADY_DONE,        /**< Resend a operation already done*/
 221         TAPI_NETTEXT_SCADDRESS_NOT_AVAILABLE,    /**< SCA address not available*/
 222         TAPI_NETTEXT_UNASSIGNED_NUMBER = 0x8001,          /**< Unassigned number*/
 223         TAPI_NETTEXT_OPERATOR_DETERMINED_BARRING = 0x8008,/**< Operator determined barring*/
 224         TAPI_NETTEXT_CALL_BARRED = 0x800A,                /**< Call barred*/
 225         TAPI_NETTEXT_MESSAGE_TRANSFER_REJECTED = 0x8015,  /**< Message transfer rejected*/
 226         TAPI_NETTEXT_MEMORY_CAPACITY_EXCEEDED = 0x8016,   /**< Memory capacity exceeded/memory full*/
 227         TAPI_NETTEXT_DESTINAITION_OUTOFSERVICE = 0x801B,  /**< Destination number/address out of service*/
 228         TAPI_NETTEXT_UNSPECIFIED_SUBSCRIBER = 0x801C,     /**< Unspecified subscriber*/
 229         TAPI_NETTEXT_FACILITY_REJECTED = 0x801D,          /**< Facility rejected*/
 230         TAPI_NETTEXT_UNKNOWN_SUBSCRIBER = 0x801E,         /**< Unknown subscriber*/
 231         TAPI_NETTEXT_NETWORK_OUTOFORDER = 0x8026,         /**< Network out of order*/
 232         TAPI_NETTEXT_TEMPORARY_FAILURE = 0x8029,          /**< Temporary failure*/
 233         TAPI_NETTEXT_CONGESTION = 0x802A,                 /**< Congestion happened*/
 234         TAPI_NETTEXT_RESOURCES_UNAVAILABLE = 0x802F,      /**< Resource unavailable*/
 235         TAPI_NETTEXT_FACILITY_NOT_SUBSCRIBED = 0x8032,    /**< Facility not subscribed by the user*/
 236         TAPI_NETTEXT_FACILITY_NOT_IMPLEMENTED = 0x8045,   /**< Facility not implemented*/
 237         TAPI_NETTEXT_INVALID_REF_VALUE = 0x8051,          /**< Invalid reference value*/
 238         TAPI_NETTEXT_INVALID_MSG = 0x805F,                /**< Invalid message*/
 239         TAPI_NETTEXT_INVALID_MANDATORY_INFO = 0x8060,     /**< Invalid Mandatory information*/
 240         TAPI_NETTEXT_MESSAGE_TYPE_NOT_IMPLEMENTED = 0x8061,/**< Message type not implemented*/
 241         TAPI_NETTEXT_MESSAGE_NOT_COMPAT_PROTOCOL = 0x8062, /**< Message not compact protocol*/
 242         TAPI_NETTEXT_IE_NOT_IMPLEMENTED = 0x8063,          /**< Information element not implemented*/
 243         TAPI_NETTEXT_PROTOCOL_ERROR = 0x806F,              /**< Protocol error*/
 244         TAPI_NETTEXT_INTERWORKING = 0x807F,              /**< Networking error*/
 245         TAPI_NETTEXT_ME_FULL = 0x8080,                     /**< SMS ME FULL */
 246         TAPI_NETTEXT_SIM_FULL = 0x8081,                     /**< SMS SIM FULL */
 247         TAPI_NETTEXT_TIMEOUT                                            /**< Timeout error */
 248 }TelSmsResponse_t;
 249
 250  /** @enum  TelSmsCause_t
 251  * This enum defines the different cause types that come in the
 252  * sent status acknowledgement/notification after sending a message to the network
 253  */
 254
 255 typedef enum
 256 {
 257
 258   TAPI_NETTEXT_SUCCESS,                     /**< SMS Operation successful*/
 259   TAPI_NETTEXT_INVALID_PARAMETER_FORMAT,    /**< Invalid format for some parameters passed in Data package information(TPDU)*/
 260   TAPI_NETTEXT_PHONE_FAILURE,               /**<SMS operation failed due to Modem failure*/
 261   TAPI_NETTEXT_SIM_BUSY,                    /**< SMS SIM operation cannot be performed as SIM is busy with some other operation*/
 262   TAPI_NETTEXT_SIM_FAILURE,                 /**< SMS SIM operation cannot be performed due to SIM failure */
 263   TAPI_NETTEXT_UNKNOWN,                     /**< unknown error*/
 264   TAPI_NETTEXT_MEMORY_FAILURE,              /**< Error while accessing memory or allocation of memory for SMS operation.*/
 265   TAPI_NETTEXT_OPERATION_NOT_SUPPORTED      /**< operation not allowed/supported*/
 266 }  TelSmsCause_t;
 267
 268 /**
 269  * @enum TelSmsSetResponse
 270  * This defines the response values
 271  */
 272 typedef enum
 273 {
 274         TAPI_NETTEXT_CBSETCONFIG_RSP,     /**<  cellbroadcast config response */
 275         TAPI_NETTEXT_SETPREFERREDBEARER_RSP,     /**<  set preferred bearer response */
 276         TAPI_NETTEXT_SETPARAMETERS_RSP,     /**<  set parameter response */
 277         TAPI_NETTEXT_SETMEMORYSTATUS_RSP,     /**<   set memory status response*/
 278         TAPI_NETTEXT_SETMESSAGESTATUS_RSP,     /**<   set message status response*/
 279         TAPI_NETTEXT_SETDEVICESTATUS_RSP,    /**<   set device status response*/
 280         TAPI_NETTEXT_SETSCADDR_RSP,     /**<   set SCA address response */
 281         TAPI_NETTEXT_SET_RSP_MAX     /**<   maximum limit*/
 282 }TelSmsSetResponse;
 283
 284 // ************************  CDMA Features  **************************//
 285  /** @enum  TelSmsIs637AlertPriority_t
 286  * This enum defines the type of alerts used to distinguish different priorities
 287  * of the message
 288  */
 289 typedef enum{
 290   TAPI_NETTEXT_ALERT_PRIORITY_DEFAULT = 0,      /**< Mobile default alert */
 291   TAPI_NETTEXT_ALERT_PRIORITY_LOW,                      /**< Low priority alert */
 292   TAPI_NETTEXT_ALERT_PRIORITY_MEDIUM,           /**< Medium priority alert */
 293   TAPI_NETTEXT_ALERT_PRIORITY_HIGH,                     /**< High priority alert */
 294 } TelSmsIs637AlertPriority_t;
 295
 296  /** @enum  TelSmsIs637Privacy_t
 297  * This enum defines the desired privacy level of the message
 298  */
 299 typedef enum{
 300   TAPI_NETTEXT_PRIVACY_NOT_RESTRICTED = 0,      /**< Not restricted */
 301   TAPI_NETTEXT_PRIVACY_RESTRICTED,                      /**< Restricted */
 302   TAPI_NETTEXT_PRIVACY_CONFIDENTIAL,                    /**< Confidential */
 303   TAPI_NETTEXT_PRIVACY_SECRET,                          /**< Secret */
 304 } TelSmsIs637Privacy_t;
 305
 306  /** @enum  TelSmsIs637Priority_t
 307  * This enum defines the priority level of the message
 308  */
 309 typedef enum{
 310   TAPI_NETTEXT_PRIORITY_NORMAL = 0,                     /**< Normal */
 311   TAPI_NETTEXT_PRIORITY_INTERACTIVE,                    /**< Interactive */
 312   TAPI_NETTEXT_PRIORITY_URGENT,                         /**< Urgent */
 313   TAPI_NETTEXT_PRIORITY_EMERGENCY,                      /**< Emergency */
 314 } TelSmsIs637Priority_t;
 315
 316  /** @enum  TelSmsIs637LangIndicator_t
 317  * This enum defines the language of the message so that the receiving mobile station can
 318  * discard those messages that are not in the user's preferred language
 319  */
 320 typedef enum{
 321   TAPI_NETTEXT_LANG_UNKNOWN = 0x0,                      /**< Unknown or unspecified */
 322   TAPI_NETTEXT_LANG_ENGLISH,                                    /**< English */
 323   TAPI_NETTEXT_LANG_FRENCH,                                     /**< French */
 324   TAPI_NETTEXT_LANG_SPANISH,                                    /**< Spanish */
 325   TAPI_NETTEXT_LANG_JAPANESE,                                   /**< Japanese */
 326   TAPI_NETTEXT_LANG_KOREAN,                                     /**< Korean */
 327   TAPI_NETTEXT_LANG_CHINESE,                                    /**< Chinese */
 328   TAPI_NETTEXT_LANG_HEBREW,                                     /**< Hebrew */
 329 } TelSmsIs637LangIndicator_t;
 330
 331  /** @enum  TelSmsIs637MsgDisplayMode_t
 332  * This enum defines the display mode to the mobile station when to display the received message
 333  */
 334 typedef enum{
 335   TAPI_NETTEXT_MSG_DISPLAY_IMMEDIATE = 0x0,     /**< The mobile station is to display the received message as soon as possible */
 336   TAPI_NETTEXT_MSG_DISPLAY_DEFAULT,                     /**< he mobile station is to display the received message based on a pre-defined mode in the mobile station. */
 337   TAPI_NETTEXT_MSG_DISPLAY_USER_INVOKE = 0x3, /**< The mobile station is to display the received message based on the mode selected by the user. */
 338   TAPI_NETTEXT_MSG_DISPLAY_RESERVED,                    /**< Reserved */
 339 } TelSmsIs637MsgDisplayMode_t;
 340
 341  /** @enum  TelSmsIs637ErrorClass_t
 342  * This enum defines the error report class
 343  */
 344 typedef enum{
 345   TAPI_NETTEXT_MSG_ERROR_CLASS_NONE = 0x0,                                      /**< None error(for SMS ack) */
 346   TAPI_NETTEXT_MSG_ERROR_CLASS_TEMPORARY_ERROR = 0x2,           /**< Temporary error(for SMS ack) */
 347   TAPI_NETTEXT_MSG_ERROR_CLASS_PERMANENT_ERROR = 0x3,           /**< Permanent error(for SMS ack) */
 348   TAPI_NETTEXT_MSG_ERROR_CLASS_PHONE_INTERNAL_ERROR = 0x4,      /**< Phone Internal Status (for Send status) */
 349 } TelSmsIs637ErrorClass_t;
 350
 351  /** @enum  TelSmsBroadCastCategory_t
 352  * This enum defines the Broadcast Service Category
 353  */
 354 typedef enum{
 355   TAPI_NETTEXT_CATEGORY_UNKNOWN                 = 0x00,                 /**< Unknown category */
 356   TAPI_NETTEXT_CATEGORY_EMERGENCY                       = 0x01,                 /**< Emergency category */
 357   TAPI_NETTEXT_CATEGORY_ADMIN                           = 0x02,                 /**< Admin category */
 358   TAPI_NETTEXT_CATEGORY_MAINTENANCE             = 0x03,                 /**< Maintenance category */
 359   TAPI_NETTEXT_CATEGORY_GEN_NEWS_LOC            = 0x04,                 /**< General News(Local) category */
 360   TAPI_NETTEXT_CATEGORY_GEN_NEWS_REG            = 0x05,                 /**< General News(Regional) category */
 361   TAPI_NETTEXT_CATEGORY_GEN_NEWS_NAT            = 0x06,                 /**< General News(National) category */
 362   TAPI_NETTEXT_CATEGORY_GEN_NEWS_INT            = 0x07,                 /**< General News(International) category */
 363   TAPI_NETTEXT_CATEGORY_FIN_NEWS_LOC            = 0x08,                 /**< Business/Financial News(Local) category */
 364   TAPI_NETTEXT_CATEGORY_FIN_NEWS_REG            = 0x09,                 /**< Business/Financial News(Regional) category */
 365   TAPI_NETTEXT_CATEGORY_FIN_NEWS_NAT            = 0x0A,                 /**< Business/Financial News(National) category */
 366   TAPI_NETTEXT_CATEGORY_FIN_NEWS_INT            = 0x0B,                 /**< Business/Financial News(International) category */
 367   TAPI_NETTEXT_CATEGORY_SPT_NEWS_LOC            = 0x0C,                 /**< Sports News(Local) category */
 368   TAPI_NETTEXT_CATEGORY_SPT_NEWS_REG            = 0x0D,                 /**< Sports News(Regional) category */
 369   TAPI_NETTEXT_CATEGORY_SPT_NEWS_NAT            = 0x0E,                 /**< Sports News(National) category */
 370   TAPI_NETTEXT_CATEGORY_SPT_NEWS_INT            = 0x0F,                 /**< Sports News(International) category */
 371   TAPI_NETTEXT_CATEGORY_ENT_NEWS_LOC            = 0x10,                 /**< Entertainment News(Local) category */
 372   TAPI_NETTEXT_CATEGORY_ENT_NEWS_REG            = 0x11,                 /**< Entertainment News(Regional) category */
 373   TAPI_NETTEXT_CATEGORY_ENT_NEWS_NAT            = 0x12,                 /**< Entertainment News(National) category */
 374   TAPI_NETTEXT_CATEGORY_ENT_NEWS_INT            = 0x13,                 /**< Entertainment News(International) category */
 375   TAPI_NETTEXT_CATEGORY_LOC_WEATHER             = 0x14,                 /**< Local Weather category */
 376   TAPI_NETTEXT_CATEGORY_AREA_TRAFFIC            = 0x15,                 /**< Area Traffic Reports category */
 377   TAPI_NETTEXT_CATEGORY_AIRPORT_SCHED           = 0x16,                 /**< Local Airport Flight Schedules category */
 378   TAPI_NETTEXT_CATEGORY_RESTAURANTS             = 0x17,                 /**< Restaurants category */
 379   TAPI_NETTEXT_CATEGORY_LODGINGS                        = 0x18,                 /**< Lodgings category */
 380   TAPI_NETTEXT_CATEGORY_RETAILS                 = 0x19,                 /**< Retail Directory category */
 381   TAPI_NETTEXT_CATEGORY_ADS                             = 0x1A,                 /**< Advertisements category */
 382   TAPI_NETTEXT_CATEGORY_STOCK_QUOTES            = 0x1B,                 /**< Stock Quotes category */
 383   TAPI_NETTEXT_CATEGORY_JOBS                            = 0x1C,                 /**< Employment Opportunities category */
 384   TAPI_NETTEXT_CATEGORY_MEDICAL                 = 0x1D,                 /**< Medical/Health/Hospitals category */
 385   TAPI_NETTEXT_CATEGORY_TECH_NEWS                       = 0x1E,                 /**< Technology News category */
 386   TAPI_NETTEXT_CATEGORY_MULTI                           =  0x1F,                        /**< Multi-category */
 387 } TelSmsBroadCastCategory_t;
 388
 389 /** @enum  TelSmsMsgType_t
 390  * This enum defines the type of IS637 message
 391  */
 392 typedef enum{
 393   TAPI_NETTEXT_MESSAGETYPE_DELIVER = 0x01,                                      /**< sms deliver message  */
 394   TAPI_NETTEXT_MESSAGETYPE_SUBMIT = 0x02,                                       /**< sms submit message  */
 395   TAPI_NETTEXT_MESSAGETYPE_CANCEL = 0x03,                                       /**< sms cancellation message  */
 396   TAPI_NETTEXT_MESSAGETYPE_DELIVERY_ACK = 0x04,                         /**< sms delivery acknowledgment message  */
 397   TAPI_NETTEXT_MESSAGETYPE_USER_ACK = 0x05,                                     /**< sms user acknowledgment message  */
 398 } TelSmsMsgType_t;
 399
 400 /** @enum  TelSmsIs637DigitMode_t
 401  * This enum defines the type of address whether it is 4-bit mode or 8-bit mode
 402  */
 403 typedef enum{
 404   TAPI_NETTEXT_DIGITMODE_4BITDTMF       = 0x00,                                 /**< 4-bit mode  */
 405   TAPI_NETTEXT_DIGITMODE_8BITCODE       = 0x01,                                 /**< 8-bit mode  */
 406 } TelSmsIs637DigitMode_t;
 407
 408 /** @enum  TelSmsIs637NumberMode_t
 409  * This enum defines the mode of address number to indicate whether the address type is as defined in ANSI TI.607 or is a data network address
 410  */
 411 typedef enum{
 412   TAPI_NETTEXT_NUMMODE_NONE_DATANETWORK =       0x00,           /**< in ANSI TI.607 */
 413   TAPI_NETTEXT_NUMMODE_DATANETWORK = 0x01,                                      /**< in Data Network */
 414 } TelSmsIs637NumberMode_t;
 415
 416 /** @enum  TelSmsIs637NumberType_t
 417  * This enum defines the type of address
 418  */
 419 typedef enum{
 420   TAPI_NETTEXT_NUMBER_TYPE_UNKNOWN          = 0x00,                             /**<  Unknown */
 421   TAPI_NETTEXT_NUMBER_TYPE_INTERNATIONAL    = 0x01,                     /**<  International number*/
 422   TAPI_NETTEXT_NUMBER_TYPE_NATIONAL         = 0x02,                             /**<  National number */
 423   TAPI_NETTEXT_NUMBER_TYPE_NETWORK          = 0x03,                             /**<  Abbreviated number */
 424   TAPI_NETTEXT_NUMBER_TYPE_SUBSCRIBER       = 0x04,                     /**< Abbreviated number */
 425   TAPI_NETTEXT_NUMBER_TYPE_RESERVED_5       = 0x05,                     /**<  Reserved */
 426   TAPI_NETTEXT_NUMBER_TYPE_ABBREVIATED       = 0x06,                    /**<  Abbreviated number */
 427   TAPI_NETTEXT_NUMBER_TYPE_RESERVED_7       = 0x07,                     /**<  Reserved */
 428   TAPI_NETTEXT_NUMBER_TYPE_IP                       = 0x11,                     /**<  Internet Protocol(RFC 791) */
 429   TAPI_NETTEXT_NUMBER_TYPE_EMAILADDR        = 0x12,                     /**<  Internet Email Address(RFC 822) */
 430 } TelSmsIs637NumberType_t;
 431
 432 /** @enum  TelSmsIs637NumberPlan_t
 433  * This enum defines the plan of address
 434  */
 435 typedef enum{
 436   TAPI_NETTEXT_NUMBER_PLAN_UNKNOWN                          = 0x00,             /**<  Unknown */
 437   TAPI_NETTEXT_NUMBER_PLAN_TELEPHONY                = 0x01,             /**< ISDN/Telephony numbering plan */
 438   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_2               = 0x02,             /**<  Reserved */
 439   TAPI_NETTEXT_NUMBER_PLAN_DATA                         = 0x03,                 /**< Data numbering plan */
 440   TAPI_NETTEXT_NUMBER_PLAN_TELEX                              = 0x04,           /**< CTelex numbering plan */
 441   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_5               = 0x05,             /**<  Reserved */
 442   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_6               = 0x06,             /**<  Reserved */
 443   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_7               = 0x07,             /**<  Reserved */
 444   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_8               = 0x08,             /**<  Reserved */
 445   TAPI_NETTEXT_NUMBER_PLAN_PRIVATE                          = 0x09,             /**<  Private numbering plan */
 446   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_10            = 0x0A,                       /**<  Reserved */
 447   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_11            = 0x0B,                       /**<  Reserved */
 448   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_12            = 0x0C,                       /**<  Reserved */
 449   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_13            = 0x0D,                       /**<  Reserved */
 450   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_14            = 0x0E,                       /**<  Reserved */
 451   TAPI_NETTEXT_NUMBER_PLAN_RESERVED_15            = 0x0F,                       /**<  Reserved */
 452 } TelSmsIs637NumberPlan_t;
 453
 454 /** @enum  TelSmsIs637SubAddressType_t
 455  * This enum defines the plan of address
 456  */
 457 typedef enum{
 458   TAPI_NETTEXT_SUBADDR_NSAP                                       = 0x00,       /**< NSAP ( CCITT Recommendation X.213 or ISO 8348 AD2 ) */
 459   TAPI_NETTEXT_SUBADDR_USER_SPECIFIED               = 0x01,     /**<  User-specified */
 460 } TelSmsIs637SubAddressType_t;
 461
 462 // ********************************************************************//
 463
 464 /**
 465  * This structure defines the different parameters of  CB configuration
 466  */
 467 typedef struct {
 468         int bCBEnabled; /**< CB service state. If cb_enabled is true then cell broadcast service will be enabled and underlying modem will enable CB Channel to receiving CB messages. Otherwise CB service will be disabled, underlying modem will deactivate the CB channel. (enabled/disabled) */
 469         unsigned char SelectedId; /**< CBMI Identifier selected (all or some)  */
 470         unsigned char MsgIdMaxCount; /**< CB Channel List Max Count */
 471         int MsgIdCount; /**< CB message ID count */
 472         unsigned short MsgIDs[TAPI_NETTEXT_GSM_SMS_CBMI_LIST_SIZE_MAX]; /**< CB message ID information */
 473 } TelSmsCbConfig_t;
 474
 475 /**
 476  * This structure defines the properties of a dialing number
 477  * Type of Number, Numbering Plan Indicator, length and the actual number.
 478  */
 479 typedef struct {
 480         unsigned int DialNumLen; /**< length of address. If Service center address is not set, then this will be zero */
 481         TelSimTypeOfNum_t Ton; /**< Type of number*/
 482         TelSimNumberingPlanIdentity_t Npi; /**<Numbering plan identification*/
 483         unsigned char szDiallingNum[TAPI_SIM_SMSP_ADDRESS_LEN + 1]; /**< destination address. If Address not set, then set to 0xFF */
 484 } TelSmsAddressInfo_t;
 485
 486 /**
 487  * This structure defines different fields involved in setting the parameters of
 488  * a particular sms in EFsmsp.
 489  */
 490 typedef struct {
 491
 492         unsigned char RecordIndex; /**< Index*/
 493         unsigned char RecordLen; /**< SMS Parameter Record length*/
 494         unsigned long AlphaIdLen; /**< Alpha id length */
 495         char szAlphaId[TAPI_SIM_SMSP_ALPHA_ID_LEN_MAX + 1]; /**< Alpha id .It is a unique identifier for each row/record in EFsmsp */
 496         unsigned char ParamIndicator; /**< SMS parameter indicator is a 1 byte value. Each bit in this value indicates the presence/absence of the sms header parameters.If the parameter is present the corresponding bit value is set to 0.If the parameter is absent then it is set as 1.Refer 3GPP TS 31.02 :4.4.23 */
 497         TelSmsAddressInfo_t TpDestAddr; /**< TP-destination address (TP-DA) */
 498         TelSmsAddressInfo_t TpSvcCntrAddr; /**< TP-service center address */
 499         unsigned short TpProtocolId; /**< TP-protocol Id */
 500         unsigned short TpDataCodingScheme; /**< TP-data coding scheme */
 501         unsigned short TpValidityPeriod; /**< TP-validity period */
 502 } TelSmsParams_t;
 503
 504 /**
 505  * This structure defines the fields related to an Sms like SIM index, TPDU  and length
 506  */
 507 typedef struct {
 508         unsigned char Sca[TAPI_SIM_SMSP_ADDRESS_LEN]; /**< Service Centre address - an optional parameter. If this parameter is not present, then this field will be Null.If present, the valid service centre address information is filled as per 3GPP TS23.040 9.1.2.5 Address fields */
 509         int MsgLength; /**< Size of array szData (which is actual TPDU message) */
 510         unsigned char szData[TAPI_NETTEXT_SMDATA_SIZE_MAX + 1]; /**<SMS TPDU message */
 511 } TelSmsDatapackageInfo_t;
 512
 513 /**
 514  *This structure defines the data Related to SimIndex,MessageStatus and SMS Data Stored.
 515  */
 516 typedef struct {
 517         int SimIndex; /**< Index where SMS is stored. */
 518         TelSmsMsgStatus_t MsgStatus; /**< Message status.*/
 519         TelSmsDatapackageInfo_t SmsData; /**<SMS message */
 520 } TelSmsData_t;
 521
 522 /**
 523  * This structure defines the different parameters that are related to the message count
 524  *in a particular memory(Phone/SIM)
 525  */
 526 typedef struct {
 527         unsigned int TotalCount; /**< Total count of messages stored in SIM*/
 528         int UsedCount; /**< Stored message count in SIM in SIM*/
 529         int IndexList[TAPI_NETTEXT_GSM_SMS_MSG_NUM_MAX]; /**< Message index list stored in SIM. And the maximum size of this array can be of totalCount.This array contains the list of index values in which the messages are stored.i.e. index_list[totalcount] = [2,3] denotes that indexs 2 and 3 are stored(valid) and others not(empty).*/
 530 } TelSmsStoredMsgCountInfo_t;
 531
 532 /**
 533  * This structure defines a cell broadcast message.
 534  */
 535 typedef struct {
 536
 537         TelSmsCbMsgType_t CbMsgType; /**< Cell Broadcast  message type */
 538         unsigned short Length; /**<Size of array szMsgData (which is actual TPDU message) */
 539         char szMsgData[TAPI_NETTEXT_CB_PAGE_SIZE_MAX + 1]; /**<Cell broadcast message data[Refer 3GPP TS 23.041 9.4.1]*/
 540 } TelSmsCbMsg_t;
 541
 542 // ************************  CDMA Features  **************************//
 543 /**
 544  *  This structure defines cause code as an indication whether an SMS error has occurred and
 545  *  if so, whether the condition is considered temporary or permanent
 546  **/
 547 typedef struct {
 548         unsigned char ReplySeqNumber; /**< Reply sequence number */
 549         TelSmsIs637ErrorClass_t ErrClass; /**< Error report class */
 550         unsigned char Cause; /**< Error cause identifier */
 551 } TelSmsIs637CauseCode_t;
 552
 553 /**
 554  * This structure defines the parameters of address and its type
 555  */
 556 typedef struct {
 557         TelSmsIs637DigitMode_t Digit; /**< Digit mode indicator (0x00:4bit_dtmf, 0x01:8bit_code) */
 558         TelSmsIs637NumberMode_t NumberMode; /**< Number mode indicator (0x00:ANSI TI607, 0x01:Data network) */
 559         TelSmsIs637NumberType_t NumberType; /**< Type of number */
 560         TelSmsIs637NumberPlan_t NumberPlan; /**< Numbering plan */
 561         unsigned char szAddrLength; /**< The number of CHARi */
 562         unsigned char szAddress[TAPI_NETTEXT_MAXLENGTH_SMS_ADDRESS]; /**< The address digit or character */
 563 } TelSmsIs637Address_t;
 564
 565 /**
 566  * This structure defines the parameters of subaddress of originator and destination
 567  */
 568 typedef struct {
 569         TelSmsIs637SubAddressType_t SubType; /**< Subaddress type */
 570         unsigned char Odd; /**< Odd/even indicator */
 571         unsigned char szAddrLength; /**< The number of CHARi */
 572         unsigned char szAddress[TAPI_NETTEXT_MAXLENGTH_SMS_ADDRESS]; /**< A subaddress octet */
 573 } TelSmsIs637SubAddress_t;
 574
 575 /**
 576  * This structure defines the message center time stamp may be include
 577  * with SMS message sent from a message center
 578  */
 579 typedef struct {
 580         unsigned int year; /**< Year - if the year is 2002, the year field contains 0x02 */
 581         unsigned int month; /**< Month (1 ~ 12) */
 582         unsigned int day; /**< Day (1 ~ 31) */
 583         unsigned int hours; /**< Hours (0 ~ 23) */
 584         unsigned int minutes; /**< Minute (0 ~ 59) */
 585         unsigned int seconds; /**< Seconds (0 ~ 59) */
 586 } TelSmsTimeStamp_t;
 587
 588 /**
 589  * The structure defines the parameter of SMS submit message
 590  */
 591 typedef struct {
 592         TelSmsIs637Address_t DstAddr; /**< Destination address */
 593         TelSmsIs637SubAddress_t DstSubAddr; /**< Destination subaddress */
 594         unsigned short TeleService; /**< Teleservice Identifier */
 595         int bBearerReplySeqRequest; /**< Bearer reply sequence request */
 596         unsigned char ReplySeqNumber; /**< Reply sequence number */
 597         unsigned short MsgId; /**< Message identifier */
 598         unsigned short MsgEncoding; /**< Message encoding (defined in TSB-58A) */
 599         unsigned short MsgLength; /**< Message length */
 600         unsigned char szData[TAPI_NETTEXT_MAXLENGTH_SMS_MO_USER_DATA]; /**< SMS user data */
 601         TelSmsTimeStamp_t ValidityPeriodAbs; /**< Validity period - Absolute (not supported) */
 602         unsigned char ValidityPeriodRel; /**< Validity period - Relative (not supported) */
 603         TelSmsTimeStamp_t DeferredDelTimeAbs; /**< Deferred delivery time - Absolute */
 604         unsigned char DeferredDelTimeRel; /**< Deferred delivery time - Relative */
 605         TelSmsIs637Priority_t Priority; /**< Priority indicator */
 606         TelSmsIs637Privacy_t Privacy; /**< Privacy indicator */
 607         int bUserAckRequest; /**< User acknowledge request */
 608         int bDeliveryAckRequest; /**< Delivery acknowledge request */
 609         TelSmsIs637AlertPriority_t AlertPriority; /**< Alert priority of message */
 610         TelSmsIs637LangIndicator_t MsgLang; /**< Language indicator */
 611         TelSmsIs637Address_t CallBackNumber; /**< Callback number address */
 612 } TelSmsIs637OutSubmit_t;
 613
 614 /**
 615  * The structure defines the parameter of SMS acknowledgement message for submit
 616  */
 617 typedef struct {
 618         TelSmsIs637Address_t DstAddr; /**< Destination address */
 619         TelSmsIs637SubAddress_t DstSubAddr; /**< Destination subaddress */
 620         unsigned short TeleService; /**< Teleservice Identifier */
 621         int bBearerReplySeqRequest; /**< Bearer reply sequence request */
 622         unsigned char ReplySeqNumber; /**< Reply sequence number */
 623         unsigned short MsgId; /**< Message identifier */
 624         unsigned short MsgEncoding; /**< Message encoding (defined in TSB-58A) */
 625         unsigned short MsgLength; /**< Message length */
 626         unsigned char szData[TAPI_NETTEXT_MAXLENGTH_SMS_MO_USER_DATA]; /**< SMS user data */
 627         unsigned char UserResponseCode; /**< User response code */
 628 } TelSmsIs637OutAck_t;
 629
 630 /**
 631  * The structure defines the parameter of SMS cancellation message
 632  */
 633 typedef struct {
 634         TelSmsIs637Address_t DstAddr; /**< Destination address */
 635         TelSmsIs637SubAddress_t DstSubAddr; /**< Destination subaddress */
 636         unsigned short TeleService; /**< Teleservice Identifier */
 637         int bBearerReplySeqRequest; /**< Bearer reply sequence request */
 638         unsigned char ReplySeqNumber; /**< Reply sequence number */
 639         unsigned short MsgId; /**< Message identifier */
 640 } TelSmsIs637OutCancel_t;
 641
 642 /**
 643  * The structure defines the parameter of SMS devivery message
 644  */
 645 typedef struct {
 646         TelSmsIs637Address_t OrigAddr; /**< Origination address */
 647         TelSmsIs637SubAddress_t OrigSubAddr; /**< Origination subaddress */
 648         unsigned short TeleService; /**< Teleservice Identifier */
 649         int bBearerReplySeqRequest; /**< Bearer reply sequence request */
 650         unsigned char ReplySeqNumber; /**< Reply sequence number */
 651         unsigned short MsgId; /**< Message identifier */
 652         unsigned short MsgEncoding; /**< Message encoding (defined in TSB-58A) */
 653         unsigned short MsgLength; /**< Message length */
 654         unsigned char szData[TAPI_NETTEXT_MAXLENGTH_SMS_MT_USER_DATA]; /**< SMS user data */
 655         TelSmsTimeStamp_t MessageCenterTimeStamp; /**< Message center time stamp */
 656         TelSmsTimeStamp_t ValidityPeriodAbs; /**< Validity period - Absolute */
 657         unsigned char ValidityPeriodRel; /**< Validity period - Relative */
 658         TelSmsTimeStamp_t DeferredDelTimeAbs; /**< Deferred delivery time - Absolute (not supported) */
 659         unsigned char DeferredDelTimeRel; /**< Deferred delivery time - Relative (not supported) */
 660         TelSmsIs637Priority_t Priority; /**< Priority indicator */
 661         TelSmsIs637Privacy_t Privacy; /**< Privacy indicator */
 662         unsigned char NumMsg; /**< Number of voice mail (0-99) */
 663         int bUserAckRequest; /**< User acknowledge request */
 664         int bDeliveryAckRequest; /**< Delivery acknowledge request */
 665         TelSmsIs637AlertPriority_t AlertPriorty; /**< Alert priority of message */
 666         TelSmsIs637LangIndicator_t MsgLang; /**< Language indicator */
 667         TelSmsIs637Address_t CallBackNumer; /**< Callback number address */
 668         TelSmsIs637MsgDisplayMode_t Display; /**< Message display mode */
 669 } TelSmsIs637InDeliver_t;
 670
 671 /**
 672  * The structure defines the parameter of SMS acknowledge message for deliver
 673  */
 674 typedef struct {
 675         TelSmsIs637Address_t OrigAddr; /**< Origination address */
 676         TelSmsIs637SubAddress_t OrigSubAddr; /**< Origination subaddress */
 677         unsigned short TeleService; /**< Teleservice Identifier */
 678         int bBearerReplySeqRequest; /**< Bearer reply sequence request */
 679         unsigned char ReplySeqNumber; /**< Reply sequence number */
 680         unsigned short MsgId; /**< Message identifier */
 681         unsigned short MsgEncoding; /**< Message encoding (defined in TSB-58A) */
 682         unsigned short MsgLength; /**< Message length */
 683         unsigned char szData[TAPI_NETTEXT_MAXLENGTH_SMS_MT_USER_DATA]; /**< SMS user data */
 684         unsigned char UserResponseCode; /**< User response code */
 685         TelSmsTimeStamp_t MessageCenterTimeStamp; /**< Message center time stamp */
 686 } TelSmsIs637InAck_t;
 687
 688 /**
 689  * The structure defines the parameter of SMS acknowledge message from message center
 690  */
 691 typedef struct {
 692         TelSmsIs637Address_t OrigAddr; /**< Origination address */
 693         TelSmsIs637SubAddress_t OrigSubAddr; /**< Origination subaddress */
 694         unsigned short TeleService; /**< Teleservice Identifier */
 695         int bBearerReplySeqRequest; /**< Bearer reply sequence request */
 696         unsigned char ReplySeqNumber; /**< Reply sequence number */
 697         unsigned short MsgId; /**< Message identifier */
 698         unsigned short MsgEncoding; /**< Message encoding (defined in TSB-58A) */
 699         unsigned short MsgLength; /**< Message length */
 700         unsigned char szData[TAPI_NETTEXT_MAXLENGTH_SMS_MT_USER_DATA]; /**< SMS user data */
 701         TelSmsTimeStamp_t MessageCenterTimeStamp; /**< Message center time stamp */
 702 } TelSmsIs637InDeliverAck_t;
 703
 704 /**
 705  * The structure defines the parameter of SMS broadcast message
 706  */
 707 typedef struct {
 708         TelSmsBroadCastCategory_t ServiceCategory; /**< Broadcast service category */
 709         unsigned short MsgId; /**< Message identifier */
 710         int bBearerReplySeqRequest; /**< Bearer reply sequence request */
 711         unsigned char ReplySeqNumber; /**< Reply sequence number */
 712         unsigned short MsgEncoding; /**< Message encoding (defined in TSB-58A) */
 713         unsigned short MsgLength; /**< Message length */
 714         unsigned char szData[TAPI_NETTEXT_MAXLENGTH_SMS_MT_USER_DATA]; /**< SMS user data */
 715         TelSmsTimeStamp_t MessageCenterTimeStamp; /**< Message center time stamp */
 716         TelSmsTimeStamp_t ValidityPeriodAbs; /**< Validity period - Absolute */
 717         unsigned char ValidityPeriodRel; /**< Validity period - Relative */
 718         TelSmsIs637Priority_t Priority; /**< Priority indicator */
 719         TelSmsIs637AlertPriority_t AlertPriorty; /**< Alert priority of message */
 720         TelSmsIs637LangIndicator_t MsgLang; /**< Language indicator */
 721         TelSmsIs637MsgDisplayMode_t Display; /**< Message display mode */
 722 } TelSmsIs637InBroadCast_t;
 723
 724 /**
 725  * The structure defines the type of SMS message as union
 726  */
 727 typedef union {
 728         TelSmsIs637OutSubmit_t OutSubmit; /**< Outgoing Submit message */
 729         TelSmsIs637OutAck_t OutAck; /**< Outgoing Acknowledge message */
 730         TelSmsIs637OutCancel_t OutCancel; /**< Outgoing Cancel message */
 731         TelSmsIs637InDeliver_t InDeliver; /**< Incoming Delivery message */
 732         TelSmsIs637InAck_t InAck; /**< Incoming Acknowledge message */
 733         TelSmsIs637InDeliverAck_t InDeliverAck; /**< Incoming Delivery Acknowledge message */
 734         TelSmsIs637InBroadCast_t InBc; /**< Incoming Broadcast message */
 735 } TelSmsMessage_t;
 736
 737 /**
 738  * The structure defines the parameter of entire SMS message of each type
 739  */
 740 typedef struct {
 741         int ParamMask; /**< Parameter ID mask */
 742         TelSmsMsgType_t MsgType; /**< Message type */
 743         TelSmsMessage_t MsgData; /**< Message data */
 744 } TelSmsMsgInfo_t;
 745 // ********************************************************************//
 746
 747 struct tel_noti_sms_incomming_msg {
 748         char Sca[TAPI_SIM_SMSP_ADDRESS_LEN];
 749         int MsgLength;
 750         char szData[TAPI_NETTEXT_SMDATA_SIZE_MAX + 1];
 751 };
 752
 753 struct tel_noti_sms_incomming_cb_msg {
 754         TelSmsCbMsgType_t CbMsgType; /**< Cell Broadcast  message type */
 755         short Length; /**<Size of array szMsgData (which is actual TPDU message) */
 756         char szMsgData[TAPI_NETTEXT_CB_PAGE_SIZE_MAX + 1]; /**<Cell broadcast message data[Refer 3GPP TS 23.041 9.4.1]*/
 757 };
 758
 759 #ifdef __cplusplus
 760 }
 761 #endif
 762
 763
 764 #endif  // _TEL_NETTEXT_H_
 765
 766 /**
 767  * @}
 768 */