include/common/TelSatProactvCmd.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 TelSatProactvCmd.h
  28
  29  @brief This file serves as a "C" header file defines structures for Tapi SAT Proactive commands and terminal response Services. \n
  30  It contains a sample set of constants, enums, structs that would be required by applications.
  31  */
  32
  33 #ifndef _TEL_SAT_PROACTV_CMD_H_
  34 #define _TEL_SAT_PROACTV_CMD_H_
  35
  36 #include <TelSatObj.h>
  37
  38 #ifdef __cplusplus
  39 extern "C"
  40 {
  41 #endif
  42
  43 #define TAPI_SAT_MENU_ITEM_COUNT_MAX                    40      /**<    max count of sat menu items     */
  44 #define TAPI_SAT_PROVISIONING_REF_MAX_COUNT             10      /**<    max count of sat provisioning reference */
  45
  46 /**
  47  * This structure contains the data objects for DISPLAY TEXT proactive command indication.
  48  */
  49 typedef struct {
  50         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
  51         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
  52 } TelSatMoreTimeIndInfo_t;
  53
  54 /**
  55  * This structure contains the data objects for DISPLAY TEXT proactive command indication.
  56  */
  57 typedef struct {
  58         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
  59         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
  60         TelSatTextTypeInfo_t text; /**< display text info       */
  61         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
  62         int bImmediateRespRequested; /**<       flag for checking whether immediate response required or not    */
  63         TelSatDurationInfo_t duration; /**<     duration for which text should be displayed     */
  64         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
  65 } TelSatDisplayTextIndInfo_t;
  66
  67 /**
  68  * This structure contains the data objects for GET INKEY proactive command indication.
  69  */
  70 typedef struct {
  71         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
  72         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
  73         TelSatTextTypeInfo_t text; /**< display text info       */
  74         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
  75         TelSatDurationInfo_t duration; /**<     duration for which text should be displayed     */
  76         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
  77 } TelSatGetInkeyIndInfo_t;
  78
  79 /**
  80  * This structure contains the data objects for GET INPUT proactive command indication.
  81  */
  82 typedef struct {
  83         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
  84         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
  85         TelSatTextTypeInfo_t text; /**< display text info       */
  86         TelSatRespLenInfo_t respLen; /**<       input response length   */
  87         TelSatTextTypeInfo_t defaultText; /**<  default text info       */
  88         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
  89         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
  90 } TelSatGetInputIndInfo_t;
  91
  92 /**
  93  * This structure contains the data objects for PLAY TONE proactive command indication.
  94  */
  95 typedef struct {
  96         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
  97         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
  98         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
  99         TelSatToneInfo_t tone; /**<     tone info       */
 100         TelSatDurationInfo_t duration; /**<     duration for which tone should be played        */
 101         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 102         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 103 } TelSatPlayToneIndInfo_t;
 104
 105 /**
 106  * This structure contains the data objects for SETUP MENU proactive command indication.
 107  */
 108 typedef struct {
 109         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 110         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 111         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 112         unsigned char menuItemCount; /**<       count of menu items     */
 113         TelSatMenuItemInfo_t menuItem[TAPI_SAT_MENU_ITEM_COUNT_MAX]; /**<       menu item data  */
 114         TelSatItemsNextActionIndiListInfo_t itemNextActionIndList; /**< next action indication list     */
 115         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 116         TelSatIconIdentifierListInfo_t iconIdList; /**< icon identifier list info       */
 117         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 118         TelSatTextAttributeListInfo_t itemTextAttributeList; /**<       item text attribute list        */
 119 } TelSatSetupMenuIndInfo_t;
 120
 121 /**
 122  * This structure contains the data objects for SELECT ITEM proactive command indication data.
 123  */
 124 typedef struct {
 125         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 126         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 127         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 128         TelSatItemsNextActionIndiListInfo_t itemNextActionIndList; /**< next action indication list     */
 129         unsigned char defaultItemIdentifier; /**<       default item identifier(default selected item id)       */
 130         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 131         TelSatIconIdentifierListInfo_t iconIdList; /**< icon identifier list info       */
 132         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 133         TelSatTextAttributeListInfo_t itemTextAttributeList; /**<       item text attribute list        */
 134         unsigned char menuItemCount; /**<       count of menu items     */
 135         TelSatMenuItemInfo_t menuItem[TAPI_SAT_MENU_ITEM_COUNT_MAX]; /**<       menu item data  */
 136 } TelSatSelectItemIndInfo_t;
 137
 138 /**
 139  * This structure contains the data objects for SEND SHORT MESSAGE proactive command indication.
 140  */
 141 typedef struct {
 142         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 143         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 144         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 145         TelSatAddressInfo_t address; /**<       address for sending sms */
 146         TelSatSmsTpduInfo_t smsTpdu; /**<       sms tpdu info   */
 147         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 148         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 149 } TelSatSendSmsIndInfo_t;
 150
 151 /**
 152  * This structure contains the data objects for SEND SS proactive command indication.
 153  */
 154 typedef struct {
 155         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 156         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 157         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 158         TelSatSsStringInfo_t ssString; /**<     ss string       */
 159         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 160         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 161 } TelSatSendSsIndInfo_t;
 162
 163 /**
 164  * This structure contains the data objects for SEND USSD proactive command indication.
 165  */
 166 typedef struct {
 167         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 168         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 169         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 170         TelSatUssdStringInfo_t ussdString; /**< ussd string info        */
 171         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 172         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 173 } TelSatSendUssdIndInfo_t;
 174
 175 /**
 176  * This structure contains the data objects for SETUP CALL proactive command indication.
 177  */
 178 typedef struct {
 179         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 180         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 181         TelSatAddressInfo_t address; /**<       setup call address info*/
 182         TelSatCapaConfigParamInfo_t ccp; /**<   capability configuration parameter      */
 183         TelSatSubAddressInfo_t subAddress; /**< setup call sub address  */
 184         TelSatDurationInfo_t duration; /**<     command execution time duration */
 185         TelSatAlphaIdentifierInfo_t userConfirmPhaseAlphaId;/**<        user Confirmation Phase AlphaId */
 186         TelSatAlphaIdentifierInfo_t callSetupPhaseAlphaId; /**< call Setup Phase AlphaId        */
 187         TelSatIconIdentifierInfo_t userConfirmPhaseIconId; /**< user Confirmation Phase IconId  */
 188         TelSatIconIdentifierInfo_t callSetupPhaseIconId; /**<   call Setup Phase IconId */
 189         TelSatTextAttributeInfo_t userConfirmPhaseTextAttribute; /**<   user Confirmation Phase Text Attribute  */
 190         TelSatTextAttributeInfo_t callSetupPhaseTextAttribute; /**<     call Setup PhaseText Attribute  */
 191 } TelSatSetupCallIndInfo_t;
 192
 193 /**
 194  * This structure contains the data objects for REFRESH proactive command indication.
 195  */
 196 typedef struct {
 197         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 198         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 199         TelSatFileListInfo_t fileList; /**<     file list for refresh   */
 200         TelSatAidInfo_t aid; /**<       application Id  */
 201 } TelSatRefreshIndInfo_t;
 202
 203 /**
 204  * This structure contains the data objects for PROVIDE LOCAL INFO proactive command indication.
 205  */
 206 typedef struct {
 207         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 208         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 209
 210 } TelSatProvideLocalInfoIndInfo_t;
 211
 212 /**
 213  * This structure contains the data objects for SETUP EVENT LIST proactive command indication data.
 214  */
 215 typedef struct {
 216         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 217         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 218         TelSatEventListInfo_t eventList; /**<   event list contains events which are required by USIM application       */
 219
 220 } TelSatSetupEventListIndInfo_t;
 221
 222 /**
 223  * This structure contains the data objects for SETUP IDLE MODE TEXT proactive command indication.
 224  */
 225 typedef struct {
 226         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 227         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 228         TelSatTextTypeInfo_t text; /**< text to be shown on idle screen */
 229         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 230         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 231 } TelSatSetupIdleModeTextIndInfo_t;
 232
 233 /**
 234  * This structure contains the data objects for SEND DTMF COMMAND proactive command indication.
 235  */
 236 typedef struct {
 237         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 238         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 239         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 240         TelSatDtmfStringInfo_t dtmfString; /**< dtmf string     */
 241         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 242         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 243 } TelSatSendDtmfIndInfo_t;
 244
 245 /**
 246  * This structure contains the data objects for LANGUAGE NOTIFICATION proactive command indication.
 247  */
 248 typedef struct {
 249         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 250         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 251         TelSatLanguageInfo_t language; /**<     language info from USIM application     */
 252 } TelSatLanguageNotificationIndInfo_t;
 253
 254 /**
 255  * This structure contains the data objects for LAUNCH BROWSER proactive command indication.
 256  */
 257 typedef struct {
 258         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 259         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 260         TelSatBrowserIdentitiesInfo_t browserId; /**<   browser identity        */
 261         TelSatUrlInfo_t url; /**<       url     */
 262         TelSatBearerInfo_t bearer; /**< bearer which is used by browser */
 263         unsigned char provisioningRefCount; /**<        provisioning reference count    */
 264         TelSatProvisioningRefInfo_t provisioningRef[TAPI_SAT_PROVISIONING_REF_MAX_COUNT]; /**<  provisioning reference data     */
 265         TelSatTextTypeInfo_t text; /**< display text info       */
 266         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 267         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 268         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 269 } TelSatLaunchBrowserIndInfo_t;
 270
 271 /**
 272  * This structure contains the data objects for OPEN CHANNEL CSB proactive command indication data.
 273  */
 274 typedef struct {
 275         TelSatAddressInfo_t address; /**<       channel address */
 276         TelSatSubAddressInfo_t subAddress; /**< channel sub address     */
 277         TelSatDurationInfo_t duration1; /**<    connection require time */
 278         TelSatDurationInfo_t duration2; /**<    connection require time2        */
 279         TelSatBearerParametersCsdInfo_t bearerParamsCsd; /**<   csd info        */
 280         TelSatBufferSizeInfo_t bufferSize; /**< bufferSize      */
 281         TelSatOtherAddressInfo_t otherAddress; /**<     otherAddress    */
 282         TelSatTextTypeInfo_t userLogin; /**<    userLogin       */
 283         TelSatTextTypeInfo_t userPassword; /**< userPassword    */
 284         TelSatSimMeInterfaceTransportLevelInfo_t simMeInterfaceTransportLevel; /**<     simMeInterfaceTransportLevel    */
 285         TelSatOtherAddressInfo_t dataDestinationAddress; /**<   dataDestinationAddress  */
 286 } TelSatOpenChannelCsbInfo_t;
 287
 288 /**
 289  * This structure contains the data objects for OPEN CHANNEL (packet) proactive command indication data.
 290  */
 291 typedef struct {
 292         TelSatBearerParametersGprsInfo_t bearerParamsGprs; /**< gprs info       */
 293         TelSatBufferSizeInfo_t bufferSize; /**< bufferSize      */
 294         TelSatnetworkAccessNameInfo_t networkAccessName; /**<   networkAccessName       */
 295         TelSatOtherAddressInfo_t otherAddress; /**<     otherAddress    */
 296         TelSatTextTypeInfo_t userLogin; /**<    userLogin       */
 297         TelSatTextTypeInfo_t userPassword; /**< userPassword    */
 298         TelSatSimMeInterfaceTransportLevelInfo_t simMeInterfaceTransportLevel; /**<     simMeInterfaceTransportLevel    */
 299         TelSatOtherAddressInfo_t dataDestinationAddress; /**<   dataDestinationAddress  */
 300         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 301 } TelSatOpenChannelpdbInfo_t;
 302
 303 /**
 304  * This structure contains the data objects for OPEN CHANNEL LOCAL LINK proactive command indication data.
 305  */
 306 typedef struct {
 307         TelSatDurationInfo_t duration1; /**<    command execution time duration1        */
 308         TelSatDurationInfo_t duration2; /**<    command execution time duration2        */
 309         TelSatBearerParametersLocalLinksInfo_t bearerParamsLocalLinks; /**<     local link info */
 310         TelSatBufferSizeInfo_t bufferSize; /**< bufferSize      */
 311         TelSatTextTypeInfo_t userPassword; /**< userPassword    */
 312         TelSatSimMeInterfaceTransportLevelInfo_t simMeInterfaceTransportLevel; /**<     simMeInterfaceTransportLevel    */
 313         TelSatOtherAddressInfo_t dataDestinationAddress; /**<   dataDestinationAddress  */
 314         TelSatRemoteEntityAddressInfo_t remoteEntityAddress; /**<       remoteEntityAddress     */
 315         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 316 } TelSatOpenChannelLocalBearerInfo_t;
 317
 318 /**
 319  * This structure contains the data objects for OPEN CHANNEL (DEFAULT BEARER) proactive command indication data.
 320  */
 321 typedef struct {
 322         TelSatBufferSizeInfo_t bufferSize; /**< bufferSize      */
 323         TelSatOtherAddressInfo_t otherAddress; /**<     otherAddress    */
 324         TelSatTextTypeInfo_t userLogin; /**<    userLogin       */
 325         TelSatTextTypeInfo_t userPassword; /**< userPassword    */
 326         TelSatSimMeInterfaceTransportLevelInfo_t simMeInterfaceTransportLevel;/**<      simMeInterfaceTransportLevel    */
 327         TelSatOtherAddressInfo_t dataDestinationAddress; /**<   dataDestinationAddress  */
 328 } TelSatOpenChannelDefaultBearerInfo_t;
 329
 330 /**
 331  * This structure contains the data objects for OPEN CHANNEL (UICC Server Mode) proactive command indication data.
 332  */
 333 typedef struct {
 334         TelSatBufferSizeInfo_t bufferSize; /**< bufferSize      */
 335         TelSatSimMeInterfaceTransportLevelInfo_t simMeInterfaceTransportLevel; /**<     simMeInterfaceTransportLevel    */
 336 } TelSatOpenChannelUiccServerModeInfo_t;
 337
 338 /**
 339  * This structure contains the data objects for OPEN CHANNEL proactive command indication data.
 340  */
 341 typedef struct {
 342         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 343         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 344         int bIsUiccServerMode; /**<     flag whether UICC server mode or not    */
 345         TelSatBearerDescType_t bearerType; /**< bearer destination type */
 346         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 347         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 348         union {
 349                 TelSatOpenChannelCsbInfo_t csBearer; /**<       cs info */
 350                 TelSatOpenChannelpdbInfo_t pdBearer; /**<       pbd info        */
 351                 TelSatOpenChannelLocalBearerInfo_t locBearer; /**<      local link info */
 352                 TelSatOpenChannelDefaultBearerInfo_t defaultBearer; /**<        defaultBearer   */
 353                 TelSatOpenChannelUiccServerModeInfo_t uiccServerMode; /**<      uiccServerMode  */
 354         } details; /**< Open Channel Details */
 355 } TelSatOpenChannelIndInfo_t;
 356
 357 /**
 358  * This structure contains the data objects for CLOSE CHANNEL proactive command indication data.
 359  */
 360 typedef struct {
 361         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 362         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 363         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 364         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 365         TelSatTextAttributeInfo_t textAttribute; /**<   text attribute info -e.g. bold, center align    */
 366 } TelSatCloseChannelIndInfo_t;
 367
 368 /**
 369  * This structure contains the data objects for RECEIVE DATA proactive command indication data.
 370  */
 371 typedef struct {
 372         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 373         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 374         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 375         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 376         TelSatChannelDataLengthInfo_t channelDataLen; /**<      channel data length     */
 377 } TelSatReceiveDataIndInfo_t;
 378
 379 /**
 380  * This structure contains the data objects for SEND DATA proactive command indication data.
 381  */
 382 typedef struct {
 383         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 384         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 385         TelSatAlphaIdentifierInfo_t alphaId; /**<       alpha identifier(string) info   */
 386         TelSatIconIdentifierInfo_t iconId; /**< icon identifier info    */
 387         TelSatChannelDataInfo_t channel_data; /**<      channel data for sending        */
 388 } TelSatSendDataIndInfo_t;
 389
 390 /**
 391  * This structure contains the data objects for GET CHANNEL STATUS proactive command indication data.
 392  */
 393 typedef struct {
 394         TelSatCommandDetailInfo_t commandDetail; /**<   command detail info. includes command number, type, qualifier   */
 395         TelSatDeviceIdentitiesInfo_t deviceIdentities; /**<     device identities info. includes source and destination devices */
 396 } TelSatGetChannelStatusIndInfo_t;
 397
 398 /**
 399  * This structure contains the data object for END PROACTIVE SESSION command indication.
 400  */
 401 typedef struct {
 402         TelSatCommandType_t commandType; /**<   proactive command type  */
 403 } TelSatEndProactiveSessionIndInfo_t;
 404
 405 /**
 406  * This structure contains the data objects for PROACTIVE command indication union data.
 407  */
 408 typedef struct {
 409         union {
 410                 TelSatMoreTimeIndInfo_t moreTime;
 411                 TelSatDisplayTextIndInfo_t displayText; /**<    Parsed proactive command info from TLV to Telephony data type - display text    */
 412                 TelSatGetInkeyIndInfo_t getInkey; /**<  Parsed proactive command info from TLV to Telephony data type - getInkey        */
 413                 TelSatGetInputIndInfo_t getInput; /**<  Parsed proactive command info from TLV to Telephony data type - getInput        */
 414                 TelSatPlayToneIndInfo_t playTone; /**<  Parsed proactive command info from TLV to Telephony data type - play tone       */
 415                 TelSatSetupMenuIndInfo_t setupMenu; /**<        Parsed proactive command info from TLV to Telephony data type - setup menu      */
 416                 TelSatSelectItemIndInfo_t selectItem; /**<      Parsed proactive command info from TLV to Telephony data type - select item     */
 417                 TelSatSendSmsIndInfo_t sendSms; /**<    Parsed proactive command info from TLV to Telephony data type - send sms        */
 418                 TelSatSendSsIndInfo_t sendSs; /**<      Parsed proactive command info from TLV to Telephony data type - send ss */
 419                 TelSatSendUssdIndInfo_t sendUssd; /**<  Parsed proactive command info from TLV to Telephony data type - send  ussd      */
 420                 TelSatSetupCallIndInfo_t setupCall; /**<        Parsed proactive command info from TLV to Telephony data type - setup call      */
 421                 TelSatRefreshIndInfo_t refresh; /**<    Parsed proactive command info from TLV to Telephony data type - refresh */
 422                 TelSatProvideLocalInfoIndInfo_t provideLocInfo; /**<    Parsed proactive command info from TLV to Telephony data type - provide local info      */
 423                 TelSatLaunchBrowserIndInfo_t launchBrowser; /**<        Parsed proactive command info from TLV to Telephony data type - launch browser  */
 424                 TelSatSetupIdleModeTextIndInfo_t idleText; /**< Parsed proactive command info from TLV to Telephony data type - setup idle mode text    */
 425                 TelSatSendDtmfIndInfo_t sendDtmf; /**<  Parsed proactive command info from TLV to Telephony data type - send dtmf       */
 426                 TelSatLanguageNotificationIndInfo_t languageNotification;/**<   Parsed proactive command info from TLV to Telephony data type - language notification   */
 427                 TelSatSetupEventListIndInfo_t setupEventList; /**<      Parsed proactive command info from TLV to Telephony data type - setup event list        */
 428                 TelSatOpenChannelIndInfo_t openChannel; /**<    Parsed proactive command info from TLV to Telephony data type - open channel    */
 429                 TelSatCloseChannelIndInfo_t closeChannel; /**<  Parsed proactive command info from TLV to Telephony data type - close channel   */
 430                 TelSatReceiveDataIndInfo_t receiveData; /**<    Parsed proactive command info from TLV to Telephony data type - receive data    */
 431                 TelSatSendDataIndInfo_t sendData; /**<  Parsed proactive command info from TLV to Telephony data type - send data       */
 432                 TelSatGetChannelStatusIndInfo_t getChannelStatus; /**<  Parsed proactive command info from TLV to Telephony data type - get channel status      */
 433         } cmdInfo; /**< Union   */
 434 } TelSatProactiveCmdData_t;
 435
 436 /**
 437  * This structure contains the data objects for the Terminal Response of DISPLAY TEXT proactive command.
 438  */
 439 typedef struct {
 440         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 441 } TelSatDisplayTextRespInfo_t;
 442
 443 /**
 444  * This structure contains the data objects for the Terminal Response of GET INKEY proactive command.
 445  */
 446 typedef struct {
 447         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 448         TelSatTextTypeInfo_t text; /**< inserted key info       */
 449         TelSatDurationInfo_t duration;
 450 } TelSatGetInkeyRespInfo_t;
 451
 452 /**
 453  * This structure contains the data objects for the Terminal Response of PLAY TONE proactive command.
 454  */
 455 typedef struct {
 456         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 457 } TelSatPlayToneRespInfo_t;
 458
 459 /**
 460  * This structure contains the data objects for the Terminal Response of MORE TIME proactive command.
 461  */
 462 typedef struct {
 463         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 464 } TelSatMoreTimeRespInfo_t;
 465
 466 /**
 467  * This structure contains the data objects for the Terminal Response of SETUP MENU proactive command.
 468  */
 469 typedef struct {
 470         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 471 } TelSatSetupMenuRespInfo_t;
 472
 473 /**
 474  * This structure contains the data objects for the Terminal Response of GET INPUT proactive command.
 475  */
 476 typedef struct {
 477         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 478         TelSatTextTypeInfo_t text; /**< inserted string info    */
 479 } TelSatGetInputRespInfo_t;
 480
 481 /**
 482  * This structure contains the data objects for the Terminal Response of SELECT ITEM proactive command.
 483  */
 484 typedef struct {
 485         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 486         int bOtherInfo; /**<    flag to check whether other information is required or not      */
 487         unsigned char itemIdentifier; /**<      item identifier */
 488 } TelSatSelectItemRespInfo_t;
 489
 490 /**
 491  * This structure contains the data objects for the Terminal Response of PROVIDE LOCAL INFORMATION proactive command.
 492  */
 493 typedef struct {
 494         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 495         int bOtherInfo; /**<    flag to check whether other information is required or not      */
 496         TelSatCmdQualiProvideLocalInfo_t infoType; /**< local info type - e.g. time zone or language info, etc  */
 497         union {
 498                 TelSatDataTimeZoneInfo_t timeZoneInfo; /**<     current time zone info  */
 499                 TelSatLanguageInfo_t languageInfo; /**< current ME language setting info        */
 500         } u; /**<       Union   */
 501 } TelSatProvideLocalInfoRespInfo_t;
 502
 503 /**
 504  * This structure contains the data objects for the Terminal Response of SETUP EVENT LIST proactive command.
 505  */
 506 typedef struct {
 507         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 508 } TelSatSetupEventListRespInfo_t;
 509
 510 /**
 511  * This structure contains the data objects for the Terminal Response of SEND SMS proactive command.
 512  */
 513 typedef struct {
 514         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 515         TelSatCallCtrlProblemType_t additionalCallCtrlProblemInfo; /**< call control problem    */
 516 } TelSatSendSmsRespInfo_t;
 517
 518 /**
 519  * This structure contains the data objects for the Terminal Response of SET UP CALL proactive command.
 520  */
 521 typedef struct {
 522         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 523         int bOtherInfo; /**<    flag to check whether other information are required or not     */
 524         TelSatNetworkProblemType_t networkProblem; /**< network problem during setup call       */
 525         TelSatCallCtrlProblemType_t permanentCallCtrlProblem; /**<      permanent call control problem  */
 526         TelSatCallCtrlRequestedActionInfo_t callCtrlRequestedAction; /**<       call control requested action info      */
 527         TelSatResultInfo_t result2; /**<        additional response on general result   */
 528         TelSatTextTypeInfo_t text; /**< text string info        */
 529         int bIsTapiCause; /**<  flag to check whether tapi makes problem or not */
 530         unsigned long tapiCause; /**<   tapi call level cause   */
 531         unsigned long tapiSsCause; /**< tapi ss level cause     */
 532 } TelSatSetupCallRespInfo_t;
 533
 534 /**
 535  * This structure contains the data objects for the Terminal Response of SEND SS proactive command.
 536  */
 537 typedef struct {
 538         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 539         int bOtherInfo; /**<    flag to check whether whether other information is required or not      */
 540         TelSatSsProblemType_t additionalSsProblemInfo; /**<     additional ss problem */
 541         TelSatCallCtrlProblemType_t additionalCallCtrlProblemInfo; /**< additional call control problem */
 542         TelSatCallCtrlRequestedActionInfo_t callCtrlRequestedAction; /**<       call control requested action info      */
 543         TelSatResultInfo_t result2; /**<        additional response on general result   */
 544         TelSatTextTypeInfo_t text; /**< text string info        */
 545 } TelSatSendSsRespInfo_t;
 546
 547 /**
 548  * This structure contains the data objects for the Terminal Response of SEND USSD proactive command.
 549  */
 550 typedef struct {
 551         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 552         int bOtherInfo; /**<    flag to check whether other information is required or not      */
 553         TelSatUssdProblemType_t additionalUssdProblemInfo; /**< additional ussd problem */
 554         TelSatCallCtrlProblemType_t additionalCallCtrlProblemInfo; /**< additional call control problem */
 555         int bCallCtrlHasModification; /**<      flag to check whether modification happens during call control  */
 556         TelSatTextTypeInfo_t text; /**< text string info        */
 557         TelSatCallCtrlRequestedActionInfo_t callCtrlRequestedAction; /**<       call control requested action info      */
 558         TelSatResultInfo_t result2; /**<        additional response on general result   */
 559         TelSatTextTypeInfo_t text2; /**<        text string info        */
 560 } TelSatSendUssdRespInfo_t;
 561
 562 /**
 563  * This structure contains the data objects for the Terminal Response of REFRESH proactive command.
 564  */
 565 typedef struct {
 566         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 567 } TelSatRefreshRespInfo_t;
 568
 569 /**
 570  * This structure contains the data objects for the Terminal Response of GET CHANNEL STATUS proactive command.
 571  */
 572 typedef struct {
 573         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 574         int bOtherInfo; /**<    flag whether other information are required or not      */
 575         TelSatBipProblemType_t additionalProblemInfo; /**<      bip specific problem info       */
 576         TelSatChannelStatusInfo_t channelStatus; /**<   channel Status  */
 577 } TelSatGetChannelStatusRespInfo_t;
 578
 579 /**
 580  * This structure contains the data objects for the Terminal Response of CLOSE CHANNEL proactive command.
 581  */
 582 typedef struct {
 583         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 584         TelSatBipProblemType_t additionalProblemInfo; /**<      bip specific problem info       */
 585 } TelSatCloseChannelRespInfo_t;
 586
 587 /**
 588  * This structure contains the data objects for the Terminal Response of OPEN CHANNEL proactive command.
 589  */
 590 typedef struct {
 591         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 592         int bOtherInfo; /**<    flag whether other information are required or not */
 593         TelSatBearerDescriptionInfo_t bearerDescription; /**<   bearerDescription       */
 594         TelSatBipProblemType_t additionalProblemInfo; /**<      bip specific problem info       */
 595         TelSatChannelStatusInfo_t channelStatus; /**<   channelStatus   */
 596         TelSatBufferSizeInfo_t bufferSize; /**< bufferSize      */
 597 } TelSatOpenChannelRespInfo_t;
 598
 599 /**
 600  * This structure contains the data objects for the Terminal Response of LANGAUGE NOTIFICATION proactive command.
 601  */
 602 typedef struct {
 603         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 604 } TelSatLanguageNotificationRespInfo_t;
 605
 606 /**
 607  * This structure contains the data objects for the Terminal Response of LAUNCH BROWSER proactive command.
 608  */
 609 typedef struct {
 610         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 611         TelSatLaunchBrowserProblemType_t additionalProblemInfo; /**<    browser specific problem info   */
 612 } TelSatLaunchBrowserRespInfo_t;
 613
 614 /**
 615  * This structure contains the data objects for the Terminal Response of RECEIVE DATA proactive command.
 616  */
 617 typedef struct {
 618         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 619         TelSatBipProblemType_t additionalProblemInfo; /**<      bip specific problem info       */
 620         int bOtherInfo; /**<    flag whether other information are required or not      */
 621         TelSatChannelDataInfo_t channel_data; /**<      channel data    */
 622         unsigned char channelDataLen; /**<      channel data length     */
 623 } TelSatReceiveDataRespInfo_t;
 624
 625 /**
 626  * This structure contains the data objects for the Terminal Response of SEND DATA proactive command.
 627  */
 628 typedef struct {
 629         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 630         TelSatBipProblemType_t additionalProblemInfo; /**<      bip specific problem info       */
 631         unsigned char channelDataLen; /**<      channel data length     */
 632 } TelSatSendDataRespInfo_t;
 633
 634 /**
 635  * This structure contains the data objects for the Terminal Response of SETUP IDLE MODE TEXT proactive command.
 636  */
 637 typedef struct {
 638         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 639 } TelSatSetupIdlemodeTextRespInfo_t;
 640
 641 /**
 642  * This structure contains the data objects for the Terminal Response of SEND DTMF proactive command.
 643  */
 644 typedef struct {
 645         TelSatResultInfo_t result; /**< result whether current proactive command request was executed successfully or not       */
 646 } TelSatSendDtmfRespInfo_t;
 647
 648 /**
 649  * This contains the data structures to be used to send proactive command response.
 650  */
 651 typedef struct {
 652         unsigned char commandNumber; /**<         proactive command number      */
 653         TelSatCommandType_t commandType; /**<     proactive command type        */
 654         union {
 655                 TelSatMoreTimeRespInfo_t moreTime;
 656                 TelSatDisplayTextRespInfo_t displayText; /**<   terminal response info from displayText proactive command       */
 657                 TelSatGetInkeyRespInfo_t getInkey; /**< terminal response info from getInkey proactive command  */
 658                 TelSatGetInputRespInfo_t getInput; /**< terminal response info from getInput proactive command  */
 659                 TelSatPlayToneRespInfo_t playTone; /**< terminal response info from playTone proactive command  */
 660                 TelSatSetupMenuRespInfo_t setupMenu; /**<       terminal response info from setupMenu proactive command */
 661                 TelSatSelectItemRespInfo_t selectItem; /**<     terminal response info from selectItem proactive command        */
 662                 TelSatSendSmsRespInfo_t sendSms; /**<   terminal response info from sendSms proactive command   */
 663                 TelSatSendSsRespInfo_t sendSs; /**<     terminal response info from sendSs proactive command    */
 664                 TelSatSendUssdRespInfo_t sendUssd; /**< terminal response info from sendUssd proactive command  */
 665                 TelSatSetupCallRespInfo_t setupCall; /**<       terminal response info from setupCall proactive command */
 666                 TelSatRefreshRespInfo_t refresh; /**<   terminal response info from refresh proactive command   */
 667                 TelSatProvideLocalInfoRespInfo_t provideLocInfo; /**<   terminal response info from provide Local Info proactive command        */
 668                 TelSatLaunchBrowserRespInfo_t launchBrowser; /**<       terminal response info from launch Browser proactive command    */
 669                 TelSatSetupIdlemodeTextRespInfo_t idleText; /**<        terminal response info from setup idle mode text proactive command      */
 670                 TelSatSendDtmfRespInfo_t sendDtmf; /**< terminal response info from send Dtmf proactive command */
 671                 TelSatLanguageNotificationRespInfo_t languageNotification; /**< terminal response info from language Notification proactive command     */
 672                 TelSatSetupEventListRespInfo_t setupEventList; /**<     terminal response info from setup Event List proactive command  */
 673                 TelSatOpenChannelRespInfo_t openChannel; /**<   terminal response info from openChannel proactive command       */
 674         } terminalRespInfo; /**<        Union   */
 675 } TelSatRespInfo_t;
 676
 677 /*
 678  *SAT Icon Data
 679  */
 680
 681 typedef struct {
 682         unsigned char iconId;
 683         unsigned char imgType;
 684         unsigned char imgLen;
 685         unsigned char imgData[256];
 686 } TelSatIconDataResp_t;
 687
 688 typedef struct {
 689         unsigned char iconId;
 690         unsigned char imgType;
 691         unsigned char fileId[2];
 692         unsigned char reqDataLen[2];
 693         unsigned char offset[2];
 694 } TelsatIconDataGet_t;
 695
 696 #ifdef __cplusplus
 697 }
 698 #endif
 699
 700 #endif  /* _TEL_SAT_PROACTV_CMD_H_ */
 701
 702 /**
 703  * @}
 704  */