mobile/include/TelSat.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   SAT_TAPI        SAT
  25 * @{
  26 *
  27 * @file TelSat.h
  28
  29      @brief This file serves as a "C" header file defines structures for Telephony SAT Services. \n
  30       It contains a sample set of constants, enums, structs that would be required by applications.
  31
  32
  33  */
  34
  35 #ifndef _TEL_SAT_H_
  36 #define _TEL_SAT_H_
  37
  38 #include <TelDefines.h>
  39 #include <TelCall.h>
  40 #include <TelSs.h>
  41 #include <TelSatObj.h>
  42 #include <TelSatProactvCmd.h>
  43 #include <TelSatEnvelope.h>
  44 #include <TelSim.h>
  45
  46 #ifdef __cplusplus
  47 extern "C"
  48 {
  49 #endif
  50
  51 #define TAPI_SAT_DEF_TITLE_LEN_MAX                      50 /**< max length for Menu Title */
  52 #define TAPI_SAT_DEF_ITEM_STR_LEN_MAX           50 /**< max length for Menu Item  */
  53 #define TAPI_SAT_DEF_TEXT_STRING_LEN_MAX        500 /**< max length for Text String  */
  54 #define TAPI_SAT_DEF_BIT_MASK_CONTACT           0x01 /**< Bit Mask for Contact */
  55 #define TAPI_SAT_DEF_BIT_MASK_MSG                       0x02 /**< Bit Mask for Msg */
  56 #define TAPI_SAT_DEF_BIT_MASK_OTHER                     0x04 /**< Bit Mask for Psh */
  57 #define TAPI_SAT_REFRESH_FILE_LIST                      20 /**< Refresh File List*/
  58 #define TAPI_SAT_DEF_SS_LEN_MAX             250
  59 #define TAPI_SAT_DEF_USSD_LEN_MAX           250
  60
  61 //      Telephony UI USER CONFIRM TYPE
  62 /**
  63  * @enum TelSatUiUserConfirmType_t
  64  * This enumeration defines the UI User Confirm Type.
  65  */
  66 typedef enum
  67 {
  68         TAPI_SAT_USER_CONFIRM_YES,                                              /**<This Enum Informs That user confirms yes */
  69         TAPI_SAT_USER_CONFIRM_NO_OR_CANCEL,                             /**<This enum informs that user confirms no/cancel */
  70         TAPI_SAT_USER_CONFIRM_HELP_INFO,                                /**<This enum informs that user wants help information */
  71         TAPI_SAT_USER_CONFIRM_END,                                              /**<This enum informs that user confirms end */
  72         TAPI_SAT_USER_CONFIRM_TIMEOUT,                                  /**<This enum informs that user did not respond */
  73 }TelSatUiUserConfirmType_t;
  74
  75 //      Telephony UI INKEY TYPE
  76 /**
  77  * @enum TelSatUiInkeyYesNoCaseType_t
  78  * This enumeration defines the UI Inkey Type Yes or No.
  79  */
  80 typedef enum
  81 {
  82         TAPI_SAT_INKEY_CONFIRM_NO                               = 0x00,                 /**<No*/
  83         TAPI_SAT_INKEY_CONFIRM_YES                              = 0x01,                 /**<Yes*/
  84 }TelSatUiInkeyYesNoCaseType_t;
  85
  86 //      Telephony UI DISPLAY STATUS
  87 /**
  88  * @enum TelSatUiDisplayStatusType_t
  89  * This enumeration defines the UI Display Status.
  90  */
  91 typedef enum
  92 {
  93         TAPI_SAT_DISPLAY_SUCCESS                                = 0x00,                                 /**<This enum informs  UI display success*/
  94         TAPI_SAT_DISPLAY_FAIL                                   = 0x01,                                 /**<This enum informs  UI display failure*/
  95 }TelSatUiDisplayStatusType_t;
  96
  97 //      TELEPHONY REFRESH APPLICATION TYPE
  98 /**
  99  * @enum TelSatRefreshAppType_t
 100  * This enumeration defines the Refresh Application Type.
 101  */
 102  typedef enum
 103 {
 104         TAPI_SAT_REFRESH_CONTACT = 0x00,                                /**<refresh application type - Phonebook*/
 105         TAPI_SAT_REFRESH_MSG,                                                   /**<refresh application type - SMS*/
 106         TAPI_SAT_REFRESH_OTHER,                                                 /**<refresh application type - other*/
 107         TAPI_SAT_REFRESH_MAX,                                                   /**<Maximum Enumeration Value*/
 108 }TelSatRefreshAppType_t;
 109
 110 //      Telephony COMMAND PERFORMED RESULT
 111 /**
 112  * @enum TelSatCommandPerformResultType_t
 113  * This enumeration defines the Result of Proactive Command execution.
 114  */
 115 typedef enum
 116 {
 117         TAPI_SAT_CMD_PERFORM_SUCCESS = 0x00,            /**<command performed successfully*/
 118         TAPI_SAT_CMD_PERFORM_FAIL,                                      /**<command execution failed*/
 119         TAPI_SAT_CMD_PERFORM_MAX,                                       /**<Maximum Enumeration Value*/
 120 }TelSatCommandPerformResultType_t;
 121
 122 //      Telephony CALL CONTROL TYPE
 123 /**
 124  * @enum TelSatCallCtrlType_t
 125  * This enumeration defines Call Control Type.
 126  */
 127 typedef enum
 128 {
 129         TAPI_SAT_CALL_CNF_NONE  = 0x00,         /**<call control confirm type - None*/
 130         TAPI_SAT_CALL_CNF_CALL,                 /**<call control confirm type - call*/
 131         TAPI_SAT_CALL_CNF_SS,                           /**<call control confirm type - ss*/
 132         TAPI_SAT_CALL_CNF_USSD,                         /**<call control confirm type - ussd*/
 133         TAPI_SAT_CALL_CNF_MAX,                          /**<Maximum Enumeration Value*/
 134 }TelSatCallCtrlType_t;
 135
 136 //      SAT UI USER CONFIRMATION INFO
 137 /**
 138  * This structure defines the user confirmation data.
 139  */
 140 typedef struct
 141 {
 142         int                                             commandId;                              /**<Proactive Command Number sent by USIM*/
 143         TelSatCommandType_t             commandType;                    /**<Proactive Command Type*/
 144         TelSatUiUserConfirmType_t       keyType;                                /**<User Response Type*/
 145         unsigned char*                          pAdditionalData;                /**<Additional Data*/
 146         int                                                     dataLen;                                /**<Additional Data Length*/
 147 }TelSatUiUserConfirmInfo_t;
 148
 149 //      Telephony TEXT INFO
 150 /**
 151  * This structure defines the character data for sat engine data structure.
 152  */
 153 typedef struct
 154 {
 155         unsigned short  stringLen;                                                                              /**<character data length*/
 156         unsigned char           string[TAPI_SAT_DEF_TEXT_STRING_LEN_MAX+1];             /**<character data*/
 157 }TelSatTextInfo_t;
 158
 159 //      Telephony MAIN MENU TITLE INFO
 160 /**
 161  * This structure defines the main menu title to check sat menu.
 162  */
 163 typedef struct
 164 {
 165         int                             bIsMainMenuPresent;             /**<flag to check sat main menu existence*/
 166         TelSatTextInfo_t        mainMenuTitle;                  /**<main menu title data*/
 167 }TelSatMainMenuTitleInfo_t;
 168
 169 //      Telephony DISPLAY TEXT DATA
 170 /**
 171  * This structure defines the display text proactive command for sat ui.
 172  */
 173 typedef struct
 174 {
 175         int                                                     commandId;                                      /**<Proactive Command Number sent by USIM*/
 176         TelSatTextInfo_t                                text;                                           /**<character data to display on screen*/
 177         unsigned int                                    duration;                                       /**<the duration of display */
 178         int                                                     bIsPriorityHigh;                        /**<indicates whether the text is to be displayed if some other app is using the screen.*/
 179         int                                                     bIsUserRespRequired;            /**<indicates whether user response required or Not*/
 180         int                                                     b_immediately_resp;
 181         TelSatIconIdentifierInfo_t      iconId;                                         /**< Icon Identifier */
 182 }TelSatDisplayTextInd_t;
 183
 184 //      Telephony INKEY DATA
 185 /**
 186  * This structure defines the get inkey proactive command data for sat ui.
 187  */
 188 typedef struct
 189 {
 190         int                                                     commandId;                              /**<Proactive Command Number sent by USIM*/
 191         TelSatInkeyType_t                               keyType;                                /**<input Type:Character Set or Yes/No*/
 192         TelSatUseInputAlphabetType_t    inputCharMode;                  /**<input character mode(SMS default, UCS2)*/
 193         int                                                     bIsNumeric;                             /**<is input character numeric(0-9, *, # and +)*/
 194         int                                                     bIsHelpInfoAvailable;   /**<help info request flag*/
 195         TelSatTextInfo_t                                text;                                   /**<character data to display on screen*/
 196         unsigned int                                    duration;                               /**<the duration of display*/
 197         TelSatIconIdentifierInfo_t              iconId;                                 /**<Icon Identifier*/
 198 }TelSatGetInkeyInd_t;
 199
 200 //      Telephony GET INPUT DATA
 201 /**
 202  * This structure defines the get input proactive command data for sat ui.
 203  */
 204 typedef struct
 205 {
 206         int                                                     commandId;                              /**<Proactive Command Number sent by USIM*/
 207         TelSatUseInputAlphabetType_t    inputCharMode;                  /**<input character mode(SMS default, UCS2)*/
 208         int                                                     bIsNumeric;                             /**<is input character numeric(0-9, *, # and +)*/
 209         int                                                     bIsHelpInfoAvailable;   /**<flag for help info request */
 210         int                                                     bIsEchoInput;                   /**<indicates whether to show input data on screen or not*/
 211         TelSatTextInfo_t                                text;                                   /**<character data to display on screen*/
 212         TelSatRespLenInfo_t                             respLen;                                /**<input data min, max length*/
 213         TelSatTextInfo_t                                defaultText;                    /**<default input character data*/
 214         TelSatIconIdentifierInfo_t              iconId;                                 /**<Icon Identifier*/
 215 }TelSatGetInputInd_t;
 216
 217 //      Telephony PLAY TONE DATA
 218 /**
 219  * This structure defines the play tone proactive command data for application.
 220  */
 221 typedef struct
 222 {
 223         int                                             commandId;      /**<Proactive Command Number sent by USIM*/
 224         TelSatTextInfo_t                        text;           /**<character data to display on screen*/
 225         TelSatToneInfo_t                        tone;           /**<tone info   */
 226         unsigned int                            duration;       /**<the duration for playing tone*/
 227         TelSatIconIdentifierInfo_t      iconId;         /**<Icon Identifier*/
 228 }TelSatPlayToneInd_t;
 229
 230 //      Telephony UI info
 231 /**
 232  * This structure defines the data for sat ui.
 233  */
 234 typedef struct
 235 {
 236         int                                             commandId;              /**<Proactive Command Number sent by USIM*/
 237         int                                             user_confirm;
 238         TelSatTextInfo_t                        text;                   /**<character data to display on screen*/
 239         TelSatIconIdentifierInfo_t      iconId;                 /**<Icon Identifier*/
 240 }TelSatSendUiInfo_t;
 241
 242 //      Telephony MENU ITEM DATA FOR SETUP MENU
 243 /**
 244  * This structure defines the menu item info for setup menu.
 245  */
 246 typedef struct
 247 {
 248         char itemString[TAPI_SAT_DEF_ITEM_STR_LEN_MAX + 6];     /**<menu item character data*/
 249         char itemId;                                                                                    /**<identifies the item on the menu that user selected*/
 250 }TelSatMenuInfo_t;
 251
 252 //      Telephony SETUP MENU INFO
 253 /**
 254  * This structure defines the sat main menu info.
 255  */
 256 typedef struct
 257 {
 258         int commandId;  /**<Proactive Command Number sent by USIM*/
 259         int     bIsMainMenuPresent;
 260         char satMainTitle[TAPI_SAT_DEF_TITLE_LEN_MAX + 1];      /**<menu title text*/
 261         TelSatMenuInfo_t satMainMenuItem[TAPI_SAT_MENU_ITEM_COUNT_MAX]; /**< menu items*/
 262         unsigned short satMainMenuNum;  /**<number of menu items*/
 263         int     bIsSatMainMenuHelpInfo; /**<flag for help information request */
 264         int     bIsUpdatedSatMainMenu;
 265         TelSatIconIdentifierInfo_t iconId;      /**<Icon Identifier*/
 266         TelSatIconIdentifierListInfo_t iconIdList;      /**<List of Icon Identifiers*/
 267 }TelSatSetupMenuInfo_t;
 268
 269 //      Telephony SELECT ITEM DATA
 270 /**
 271  * This structure defines the select item proactive command data for sat ui.
 272  */
 273 typedef struct
 274 {
 275         int                                                     commandId;                                                                      /**<Proactive Command Number sent by USIM*/
 276         int                                                     bIsHelpInfoAvailable;                                           /**<flag for help information request*/
 277         TelSatTextInfo_t                                text;                                                                           /**<menu title text*/
 278         char                                                    defaultItemIndex;                                                       /**<selected default item - default value is 0*/
 279         char                                                    menuItemCount;                                                          /**<number of menu items*/
 280         TelSatMenuItemInfo_t                    menuItem[TAPI_SAT_MENU_ITEM_COUNT_MAX];         /**<menu items*/
 281         TelSatIconIdentifierInfo_t              iconId;                                                                         /**<Icon Identifier*/
 282         TelSatIconIdentifierListInfo_t  iconIdList;                                                                     /**<List of Icon Identifiers*/
 283
 284 }TelSatSelectItemInd_t;
 285
 286 //      Telephony IDLE MODE TEXT DATA
 287 /**
 288  * This structure defines the setup idle mode text proactive command for idle application.
 289  */
 290 typedef struct
 291 {
 292         int                                             commandId;                      /**<Proactive Command Number sent by USIM*/
 293         TelSatTextInfo_t                        text;                           /**<character data to display on screen*/
 294         TelSatIconIdentifierInfo_t      iconId;
 295 } TelSatSetupIdleModeTextInd_t;
 296
 297 //      Telephony REFRESH DATA
 298 /**
 299  * This structure defines the refresh proactive command data for sat ui.
 300  */
 301 typedef struct
 302 {
 303         int                                                     commandId;                      /**<Proactive Command Number sent by USIM*/
 304         unsigned int                            duration;                       /**<the duration of display*/
 305         TelSatCmdQualiRefresh_t         refreshType;            /**<refresh mode*/
 306 }TelSatRefreshIndUiInfo_t;
 307
 308 //      Telephony REFRESH DATA
 309 /**
 310  * This structure defines the refresh proactive command data for applications which are concerned with files resident on USIM .
 311  */
 312 typedef struct
 313 {
 314         int                                             commandId;                                                              /**<Proactive Command Number sent by USIM*/
 315         TelSatRefreshAppType_t          appType;                                                                /**<concerned application type */
 316         TelSatCmdQualiRefresh_t         refreshMode;                                                    /**<refresh mode*/
 317         unsigned char                                   fileCount;                                                              /**<refresh file count*/
 318         TelSimFileID_t                          fileId[TAPI_SAT_REFRESH_FILE_LIST];             /**<refresh file identifier*/
 319 }TelSatRefreshInd_t;
 320
 321 //      Telephony END PROACTIVE COMMAND INFO
 322 /**
 323  * This structure defines the data objects to indicate to sat ui, the end of execution of a specific proactive command by other application.
 324  */
 325 typedef struct
 326 {
 327         int                                                                     commandId;                      /**<Proactive Command Number sent by USIM*/
 328         char                                                                    commandType;            /**< Command Type*/
 329         TelSatCommandPerformResultType_t                result;                         /**<result of command execution by application*/
 330 }TelSatProactiveCmdEndIndInfo_t;
 331
 332 //      Telephony SEND SMS DATA
 333 /**
 334  * This structure defines the send sms proactive command data for sms application.
 335  */
 336 typedef struct
 337 {
 338         int                                     commandId;                              /**<Proactive Command Number sent by USIM*/
 339         int                                     bIsPackingRequired;             /**<flag to check if packing required for sms tpdu*/
 340         TelSatAddressInfo_t     address;                                /**<destination address*/
 341         TelSatSmsTpduInfo_t     smsTpdu;                                /**<SMS TPDU data*/
 342 } TelSatSendSmsIndSmsData_t;
 343
 344 //      Telephony SEND SS DATA
 345 /**
 346  * This structure defines the send ss proactive command data for ss application.
 347  */
 348 typedef struct
 349 {
 350         int                                     commandId;              /**<Proactive Command Number sent by USIM*/
 351         unsigned short          ssStringLen;
 352         unsigned char           ssString[TAPI_SAT_DEF_SS_LEN_MAX+1];
 353 }TelSatSendSsIndSsData_t;
 354
 355 //      Telephony USSD DATA
 356 /**
 357  * This structure defines the send ussd proactive command data for ussd application.
 358  */
 359 typedef struct
 360 {
 361         int                     commandId;              /**<Proactive Command Number sent by USIM*/
 362         unsigned char           rawDcs;                 /**<data coding scheme*/
 363         unsigned short          ussdStringLen;
 364         unsigned char           ussdString[TAPI_SAT_DEF_USSD_LEN_MAX+1];
 365 }TelSatSendUssdIndUssdData_t;
 366
 367 //      Telephony SEND DTMF DATA
 368 /**
 369  * This structure defines the send dtmf proactive command data for dtmf application.
 370  */
 371 typedef struct
 372 {
 373         int                                     commandId;                      /**<Proactive Command Number sent by USIM*/
 374         int                                     bIsHiddenMode;          /**<hidden mode flag*/
 375         TelSatTextInfo_t                dtmfString;                     /**<dtmf string data*/
 376 }TelSatSendDtmfIndDtmfData_t;
 377
 378 //      Telephony SETUP CALL  DATA
 379 /**
 380  * This structure defines the setup call proactive command data for call application.
 381  */
 382 typedef struct
 383 {
 384         int                                                     commandId;              /**<Proactive Command Number sent by USIM*/
 385         TelSatCmdQualiSetupCall_t               calltype;                       /**<call type*/
 386         TelSatTextInfo_t                                dispText;                       /**<display data for calling*/
 387         TelSatTextInfo_t                                callNumber;             /**<call number*/
 388         unsigned int                                    duration;                       /**<maximum repeat duration*/
 389         TelSatIconIdentifierInfo_t              iconId;                 /**<icon identifier for call application*/
 390 }TelSatSetupCallIndCallData_t;
 391
 392 //      Telephony LAUNCH BROWSER DATA
 393 /**
 394  * This structure defines the launch browser proactive command data for browser application.
 395  */
 396 typedef struct
 397 {
 398         int                                                     commandId;              /**<Proactive Command Number sent by USIM*/
 399         TelSatUrlInfo_t                                 url;                    /**<url to connect*/
 400         TelSatCmdQualiLaunchBrowser_t   launchType;             /**<launch type*/
 401         TelSatBrowserIdentityType_t     IdentityType;   /**<Browser Identity -default, html, etc*/
 402 }TelSatLaunchBrowserIndBrowserData_t;
 403
 404 //      Telephony PROVIDE LOCAL INFO DATA
 405 /**
 406  * This structure defines the provide local info proactive command data for application.
 407  */
 408 typedef struct
 409 {
 410         int commandId;                                                                          /**<Proactive Command Number sent by USIM*/
 411         TelSatCmdQualiProvideLocalInfo_t localInfoType;         /**<Provide Local Information Type*/
 412 }TelSatProvideLocalInfoInd_t;
 413
 414 //      Telephony LANGUAGE NOTIFICATION DATA
 415 /**
 416  * This structure defines the language notification proactive command data for application.
 417  */
 418 typedef struct
 419 {
 420         int                                                     commandId;                                              /**<Proactive Command Number sent by USIM*/
 421         int                                                     bSpecificLanguageNotification;  /**<flag for checking specific language notification. if FALSE, non-specific language notification      */
 422         TelSatLanguageInfo_t                    language;                                       /**<language info from USIM application */
 423 }TelSatLanguageNotiInfoInd_t;
 424
 425 //      Telephony PLAY TONE RETURN INFO
 426 /**
 427  * This structure defines the return result data for Play Tone proactive command.
 428  */
 429 typedef struct
 430 {
 431         TelSatResultType_t      resp;                   /**<result response value*/
 432 }TelSatSetupMenuRetInfo_t;
 433
 434 //      Telephony REFRESH RETURN INFO
 435 /**
 436  * This structure defines the return result data for refresh proactive command.
 437  */
 438 typedef struct
 439 {
 440         TelSatRefreshAppType_t  appType;                        /**<application type*/
 441         TelSatResultType_t              resp;                           /**<result response value*/
 442 }TelSatRefreshRetInfo_t;
 443
 444 //      Telephony CALL RETURN INFO
 445 /**
 446  * This structure defines the return result data for setup call proactive command.
 447  */
 448 typedef struct
 449 {
 450         TelSatResultType_t                              resp;                                                   /**<result response value*/
 451         int                                                     bIsTapiCauseExist;                              /**<flag for checking tapi error cause */
 452         TelCallCause_t                                  tapiCause;                                              /**<tapi call error cause*/
 453         TelSsCause_t                                            ssCause;                                                /**<tapi ss error cause*/
 454         TelSatMeProblemType_t                           meProblem;                                              /**<me problem error cause*/
 455         int                                                             bIsOtherInfoExist;                              /**<call control result existence flag*/
 456         TelSatCallCtrlProblemType_t             permanentCallCtrlProblem;               /**<call control problem type*/
 457         TelSatCallCtrlRequestedActionInfo_t     callCtrlRequestedAction;                /**<call control request data*/
 458         TelSatResultInfo_t                      result2;                                                /**<call control envelope result value*/
 459         TelSatTextTypeInfo_t                    text;                                                   /**<call control envelope display data*/
 460 }TelSatCallRetInfo_t;
 461
 462 //      Telephony SS RETURN INFO
 463 /**
 464  * This structure defines the return result data for send ss proactive command.
 465  */
 466 typedef struct
 467 {
 468         TelSatResultType_t                              resp;                                                   /**<result response value*/
 469         TelSsCause_t                                            ssCause;                                                /**<error - ss cause*/
 470         TelSatTextInfo_t                                        ssString;                                               /**<ss result string*/
 471         TelSatMeProblemType_t                   meProblem;                                              /**<error - me problem*/
 472         int                                                             bIsOtherInfoExist;                              /**<call control result exist flag*/
 473         TelSatCallCtrlProblemType_t                     additionalCallCtrlProblemInfo;  /**<call control problem*/
 474         TelSatCallCtrlRequestedActionInfo_t     callCtrlRequestedAction;                /**<call control request data*/
 475         TelSatResultInfo_t                                      result2;                                                /**<call control envelope result value*/
 476 }TelSatSsRetInfo_t;
 477
 478 //      Telephony USSD RETURN INFO
 479 /**
 480  * This structure defines the return result data for send ussd proactive command.
 481  */
 482 typedef struct
 483 {
 484         TelSatResultType_t                                      resp;                                                   /**<result response value*/
 485         TelSsCause_t                                            ssCause;                                                /**<error - ss cause*/
 486         TelSatTextInfo_t                                        ussdString;                                             /**<ussd result string*/
 487         TelSatDataCodingSchemeInfo_t            dcsUssdString;                                  /**<dcs of ussd result string */
 488         TelSatMeProblemType_t                           meProblem;                                              /**<error - me problem*/
 489         int                                                             bIsOtherInfoExist;                              /**<call control result exist flag*/
 490         TelSatCallCtrlProblemType_t                     additionalCallCtrlProblemInfo;  /**<call control problem*/
 491         int                                                             bCallCtrlHasModification;               /**<call control request modification flag*/
 492         TelSatCallCtrlRequestedActionInfo_t     callCtrlRequestedAction;                /**<call control request data*/
 493         TelSatResultInfo_t                                      result2;                                                /**<call control envelope result value*/
 494         TelSatTextTypeInfo_t                            text2;                                                  /**<cc envelope display data */
 495 }TelSatUssdRetInfo_t;
 496
 497 //      Telephony SMS RETURN INFO
 498 /**
 499  * This structure defines the return result data for send sms proactive command.
 500  */
 501 typedef struct
 502 {
 503         TelSatResultType_t      resp;                   /**<result response value*/
 504 }TelSatSmsRetInfo_t;
 505
 506 //      Telephony DTMF RETUEN INFO
 507 /**
 508  * This structure defines the return result data for send dtmf proactive command.
 509  */
 510 typedef struct
 511 {
 512         TelSatResultType_t      resp;                   /**<result response value*/
 513 }TelSatDtmfRetInfo_t;
 514
 515 //      Telephony BROWSER RETURN INFO
 516 /**
 517  * This structure defines the return result data for launch browser proactive command.
 518  */
 519 typedef struct
 520 {
 521         TelSatResultType_t                                      resp;                   /**<result response value*/
 522         TelSatLaunchBrowserProblemType_t    browserProblem;     /**<specific browser problem*/
 523 }TelSatBrowserRetInfo_t;
 524
 525 //      Telephony SETUP IDLE MODE TEXT RETURN INFO
 526 /**
 527  * This structure defines the return result data for setup idle mode text proactive command.
 528  */
 529 typedef struct
 530 {
 531         TelSatResultType_t      resp;                   /**<result response value*/
 532 }TelSatIdleTextRetInfo_t;
 533
 534 //      Telephony PLAY TONE RETURN INFO
 535 /**
 536  * This structure defines the return result data for Play Tone proactive command.
 537  */
 538 typedef struct
 539 {
 540         TelSatResultType_t      resp;                   /**<result response value*/
 541 }TelSatPlayToneRetInfo_t;
 542
 543 //      Telephony  PROVIDE LOCAL INFO RETURN INFO
 544 /**
 545  * This structure defines the return result data for setup idle mode text proactive command.
 546  */
 547 typedef struct
 548 {
 549         TelSatResultType_t                                      resp;                   /**<result response value*/
 550         int                                                             bOtherInfo;             /**<flag to check whether other information are required or not */
 551         TelSatCmdQualiProvideLocalInfo_t        infoType;               /**<local info type - e.g. time zone or language info, etc      */
 552         union
 553         {
 554                 TelSatDataTimeZoneInfo_t                timeZoneInfo;   /**<    current time zone info  */
 555                 TelSatLanguageInfo_t                    languageInfo;   /**<    current ME language setting info        */
 556         }u;                                                                                                     /**<    Union*/
 557 }TelSatProvideLocalRetInfo_t;
 558
 559 //      Telephony LANGUAGE NOTI RETURN INFO
 560 /**
 561  * This structure defines the return result data for setup idle mode text proactive command.
 562  */
 563 typedef struct
 564         {
 565                 TelSatResultType_t               resp;                          /**<result response value*/
 566         }TelSatLanguageNotiRetInfo_t;
 567
 568 //      Telephony DISPLAY TEXT RETURN INFO
 569 /**
 570  * This structure defines the return result data for setup idle mode text proactive command.
 571  */
 572 typedef struct
 573         {
 574                 TelSatResultType_t               resp;                          /**<result response value*/
 575                 TelSatMeProblemType_t    meProblem;                     /**<Me Problem Type */
 576         }TelSatDiplayTextRetInfo_t;
 577
 578 //      Telephony APPLICATIONS RETURN DATA
 579 /**
 580  * This structure defines the common return result data for applications proactive command.
 581  */
 582 typedef struct
 583 {
 584         TelSatCommandType_t     commandType;                                            /**<Proactive Command type*/
 585         int commandId;                                                                                  /**<Proactive Command Number sent by USIM*/
 586         union
 587                 {
 588                         TelSatSetupMenuRetInfo_t        setupMenu;                      /**<result response value for setup menu*/
 589                         TelSatRefreshRetInfo_t          refresh;                                /**<result response value for refresh*/
 590                         TelSatCallRetInfo_t                     setupCall;                              /**<result response value for setup call*/
 591                         TelSatSsRetInfo_t                       sendSs;                                 /**<result response value for send ss*/
 592                         TelSatUssdRetInfo_t                     sendUssd;                               /**<result response value for send ussd*/
 593                         TelSatSmsRetInfo_t                      sendSms;                                /**<result response value for send sms*/
 594                         TelSatDtmfRetInfo_t                     sendDtmf;                               /**<result response value for send dtmf*/
 595                         TelSatBrowserRetInfo_t          launchBrowser;                  /**<result response value for launch browser*/
 596                         TelSatIdleTextRetInfo_t         setupIdleModeText;              /**<result response value for setup idle mode text*/
 597                         TelSatLanguageNotiRetInfo_t     languageNoti;                   /**<result response value for language notification*/
 598                         TelSatProvideLocalRetInfo_t provideLocalInfo;           /**<result response value for provide local info*/
 599                         TelSatDiplayTextRetInfo_t   displayText;                        /**<result response value for dsiplay text*/
 600                         TelSatPlayToneRetInfo_t     playTone;                           /**<result response value for play tone*/
 601                 }appsRet;                                                                                               /**< common union result value */
 602 }TelSatAppsRetInfo_t;
 603
 604 //      Telephony CALL CONTROL CONFIRM  DATA FOR CALL
 605 /**
 606  * This structure defines the call control confirm data for call.
 607  */
 608 typedef struct
 609 {
 610         TelSatTextInfo_t                                address;                                        /**< call destination address*/
 611         TelSatTextInfo_t                                subAddress;                                     /**< call SUB address*/
 612         TelSatBcRepeatIndicatorType_t   bcRepeatIndicator;                      /**< bc repeat indicator*/
 613         TelSatTextInfo_t                                ccp1;                                           /**< Configuration Capability Parameter 1*/
 614         TelSatTextInfo_t                                ccp2;                                           /**< Configuration Capability Parameter 2*/
 615 } TelSatCallCtrlIndCallData_t;
 616
 617 //      Telephony CALL CONTROL CONFIRM  DATA FOR SS
 618 /**
 619  * This structure defines the call control confirm data for ss.
 620  */
 621 typedef struct
 622 {
 623         TelSatTextInfo_t                                ssString;                                       /**< ss destination address*/
 624         TelSatTextInfo_t                                subAddress;                                     /**< call SUB address*/
 625         TelSatBcRepeatIndicatorType_t   bcRepeatIndicator;                      /**< bc repeat indicator*/
 626         TelSatTextInfo_t                                ccp1;                                           /**< Configuration Capability Parameter 1*/
 627         TelSatTextInfo_t                                ccp2;                                           /**< Configuration Capability Parameter 2*/
 628 } TelSatCallCtrlIndSsData_t;
 629
 630 //      Telephony CALL CONTROL CONFIRM  DATA FOR USSD
 631 /**
 632  * This structure defines the call control confirm data for ussd.
 633  */
 634 typedef struct
 635 {
 636         TelSatTextInfo_t                ussdString;                     /**< ussd destination address*/
 637 } TelSatCallCtrlIndUssdData_t;
 638
 639 //      Telephony READ FILE REQUEST DATA
 640 /**
 641  * This structure defines the common call control confirm data.
 642  */
 643 typedef struct
 644 {
 645         TelSatCallType_t                        callCtrlCnfType;                                /**<call control confirm type - call, ss or ussd*/
 646         TelSatCallCtrlResultType_t      callCtrlResult;                                 /**<call control result*/
 647         TelSatTextInfo_t                        dispData;                                               /**<call control display data*/
 648         int                                             bIsUserInfoDisplayEnabled;              /**<flag for checking existence of call control display */
 649
 650         union
 651                 {
 652                         TelSatCallCtrlIndCallData_t             callCtrlCnfCallData;    /**<call control call address*/
 653                         TelSatCallCtrlIndSsData_t               callCtrlCnfSsData;              /**<call control ss string*/
 654                         TelSatCallCtrlIndUssdData_t             callCtrlCnfUssdData;    /**<call control ussd string*/
 655                 }u;                                                                                                                             /**<   Union*/
 656 } TelSatCallCtrlIndData_t;
 657
 658 //      Telephony MO SMS CONTROL CONFIRMATION DATA
 659 /**
 660  * This structure defines the mo sms control confirm data.
 661  */
 662 typedef struct
 663 {
 664         TelSatCallCtrlResultType_t              moSmsCtrlResult;                        /**<envelope result*/
 665         int                                                             bIsUserInfoDisplayEnabled;      /**<display present flag*/
 666         TelSatTextTypeInfo_t                    dispData;                                       /**<display data for sending SMS*/
 667         TelSatTextTypeInfo_t                    rpDestAddr;                             /**<the RP_Destination_Address of the Service Center */
 668         TelSatTextTypeInfo_t                    tpDestAddr;                                     /**<the TP_Destination_Address */
 669 } TelSatMoSmCtrlIndData_t;
 670
 671 //      Telephony EVENT LIST INFO
 672 /**
 673  * This structure defines the Event List Info.
 674  */
 675 typedef struct
 676 {
 677         int bIsEventDownloadActive;                     /**<Is Event Download Active*/
 678         int bIsMtCallEvent;                                     /**<Is Mt Call Event*/
 679         int bIsCallConnected;                           /**<Is Call Connected*/
 680         int bIsCallDisconnected;                        /**<Is Call Disconnected*/
 681         int bIsLocationStatus;                          /**<Is Location Status*/
 682         int bIsUserActivity;                            /**<Is User Activity*/
 683         int bIsIdleScreenAvailable;                     /**<Is Idle Screen Available*/
 684         int bIsCardReaderStatus;                        /**<Is Card Reader Status*/
 685         int bIsLanguageSelection;                       /**<Is Language Selection*/
 686         int bIsBrowserTermination;                      /**<Is Browser Termination*/
 687         int bIsDataAvailable;                           /**<Is Data Available*/
 688         int bIsChannelStatus;                           /**<Is Channel Status*/
 689 }       TelSatEventListData_t;
 690
 691 /**
 692  * This is the structure to be used by the Application to send envelope/event download data.
 693  * This contains the data structures to be used to send any envelope/event download data.
 694  */
 695 typedef struct
 696 {
 697         TelSatEventDownloadType_t                                       eventDownloadType;                              /**<    eventDownload Type      */
 698
 699         union
 700         {
 701                 int                                                                     bIdleScreenAvailable;                   /**<flag to specify whether Idle Screen is Available or not*/
 702                 TelSatLanguageSelectionEventReqInfo_t   languageSelectionEventReqInfo;  /**<Selected Language Information*/
 703                 TelSatBrowserTerminationEventReqInfo_t  browserTerminationEventReqInfo; /**<BrowserTermination Event Information        */
 704                 TelSatDataAvailableEventReqInfo_t               dataAvailableEventReqInfo;              /**<dataAvailableEventReqInfo   */
 705                 TelSatChannelStatusEventReqInfo_t               channelStatusEventReqInfo;              /**<channelStatusEventReqInfo   */
 706         } u;                                                                                                                                            /**<Union*/
 707 } TelSatEventDownloadReqInfo_t;
 708
 709 #ifdef __cplusplus
 710 }
 711 #endif
 712
 713 #endif /* _TEL_SAT_H_ */
 714
 715 /**
 716 * @}
 717 */