1 /*

     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 /**

    22  @file

    23  @publishedPartner

    24  @deprecated

    25 */

    26 #ifndef RMMCUSTOMAPI_H

    27 #define RMMCUSTOMAPI_H

    28 

    29 //  INCLUDES

    30 #include <etelmm.h>

    31 #include <et_clsvr.h>

    32 #include <etelpckt.h>

    33 

    34 // CONSTANTS

    35 const TInt KIpcCustomExt = 1000000;

    36 const TInt KIpcCustomMaxLimi = 1000299;

    37 const TInt KIpcCustomAPIExtensionExt = 1000450;

    38 

    39 _LIT(KCustomAPIName,"CUSTOMAPI");

    40 _LIT(KTerminateAllCalls,"ALL_CALLS");

    41 const TInt KSimLockMaxPasswordSize = 15;

    42 const TInt KSimCbTopicNameLength = 20;

    43 const TInt KSubAddressSize = 20;

    44 const TInt KBearerCapabilitySize = 14;

    45 

    46 // alpha tag length is 124

    47 const TInt KMaxOperatorNameLength = 124;

    48 // max length of operator length

    49 const TInt KMaxOperatorLogoLength = 6405;

    50 

    51 const TUint16 KFlexibleNameSeparator = 0x007C;  // '|'

    52 const TUint8 KFlexibleLongNameMaxLength = 30;

    53 const TUint8 KFlexibleShortNameMaxLength = 20;

    54 

    55 // Sim file definitions

    56 const TUint8 KSimFilePathLength = 8;

    57 const TUint16 KSimFileMaxLength = 0xFFFF;

    58 

    59 // Viag HomeZone setting flags

    60 const TUint8 KUHziUeActive = 0x00001;

    61 const TUint8 HCbHziUeActive = 0x00002;

    62 

    63 // ADPU buffer maximum length 258 according to

    64 // ISI ADPU server description

    65 typedef TBuf8<258> TApduBuffer;

    66 

    67 // PDP context activation failure in case of APN not in EFACL

    68 const TInt KErrPacketDataTsyInvalidAPN = -6001;

    69 

    70 // Cell info constant

    71 const TInt KMaxTimeSlotIscpAmount = 1; //14; Changed from 14 to 1. Memory problem!!

    72 const TInt KMaxCellMeasuredResults = 32;

    73 const TInt KMaxNetworkMeasureReports = 8;

    74 const TInt KMaxNmrAmount = 15;

    75 

    76 // DATA TYPES

    77 /** Enumerates IPC values used by Custom API. */

    78 enum TCustomIPC

    79     {

    80     /** Notify ss additional info */

    81     ECustomSsAdditionalInfoNotificationIPC = KIpcCustomExt,		//1000000

    82     /** Notify ss request complete */

    83     ECustomNotifySsRequestCompleteIPC,		//1000001

    84     /** Cancel USSD session */

    85     ECustomCancelUssdSessionIPC,			//1000002

    86     /** Start SIM CB topic browsing */

    87     ECustomStartSimCbTopicBrowsingIPC,		//1000003

    88     /** Get next SIM CB topic */

    89 	ECustomGetNextSimCbTopicIPC,			//1000004

    90     /** Delete SIM DB topic */

    91     ECustomDeleteSimCbTopicIPC,				//1000005

    92     /** Read SIM File */

    93     ECustomReadSimFileIPC,					//1000006

    94     /** Get wlan sim authentication data */

    95     ECustomGetSimAuthenticationDataIPC,		//1000007

    96     /** Set SIM SMS to "read" */

    97     ECustomSetSimMessageStatusReadIPC,		//1000008

    98     /** Notify Dtmf event */

    99     ECustomNotifyDtmfEventIPC,				//1000009

   100     /** Get Diagnostic Octets */

   101     ECustomGetDiagnosticOctetsIPC,			//1000010

   102     /** Set Als Blocked */

   103     ECustomSetAlsBlockedIPC,				//1000011

   104     /** Get Als Blocked */

   105     ECustomGetAlsBlockedIPC,				//1000012

   106     /** Check Als Pp Support */

   107     ECustomCheckAlsPpSupportIPC,			//1000013

   108     /** Remote Alerting Tone Status */

   109     ECustomGetRemoteAlertingToneStatusIPC,	//1000014

   110     /** Call Origin */

   111     ECustomCallOriginIPC,					//1000015

   112     /** Notify Als Blocked Change */

   113     ECustomNotifyAlsBlockedChangedIPC,		//1000016

   114     /** Terminate a Call */

   115     ECustomTerminateCallIPC,				//1000017

   116     /** Clear call blacklist */

   117     ECustomClearCallBlackListIPC,			//1000018

   118     /** Read HSxPA Status */

   119     ECustomReadHSxPAStatusIPC,				//1000019

   120     /** Write HSxPA Status */    

   121     ECustomWriteHSxPAStatusIPC,				//1000020

   122     /** Notify HSxPA Status change */    

   123     ECustomNotifyHSxPAStatusIPC,			//1000021

   124     /** Get cell(s) info */

   125     ECustomGetCellInfoIPC,					//1000022

   126     /** Notify cell(s) info change */

   127     ECustomNotifyCellInfoChangeIPC,			//1000023

   128     /** Activate SIM Lock */

   129     ECustomSimLockActivateIPC,				//1000024

   130     /** Deactivate SIM Lock */

   131     ECustomSimLockDeActivateIPC,			//1000025

   132     /** Read VIAG Home Zone Parameters */

   133     EReadViagHomeZoneParamsIPC,				//1000026

   134     /** Read VIAG Home Zone Cache */

   135     EReadViagHomeZoneCacheIPC,				//1000027

   136     /** Write VIAG Home Zone Cache */

   137     EWriteViagHomeZoneCacheIPC,				//1000028

   138     /** Get ciphering information */

   139     ECustomGetCipheringInfoIPC,				//1000029

   140     /** Notify ciphering information */

   141     ECustomNotifyCipheringInfoChangeIPC,	//1000030

   142     /** Notify NSPS status */

   143     ECustomNotifyNSPSStatusIPC,				//1000031

   144     /** Wake net from NSPS */

   145     ECustomNetWakeupIPC,					//1000032

   146     /** Get network provider name */

   147     ECustomGetNetworkProviderNameIPC,		//1000033

   148     /** Get operator name */

   149     ECustomGetOperatorNameIPC,				//1000034

   150     /** Get programmable operator logo */

   151     ECustomGetProgrammableOperatorLogoIPC,	//1000035

   152     /** Reset the net server */

   153     ECustomResetNetServerIPC,				//1000036

   154     /** Notify programmable operator logo change */

   155     ECustomNotifyProgrammableOperatorLogoChangeIPC,		//1000037

   156     /** Notify network connection failure */

   157     ECustomNotifyNetworkConnectionFailureIPC,			//1000038

   158     /** Get Air time duration */

   159     ECustomGetAirTimeDurationIPC,			//1000039

   160     /** Notify phonebook cache ready */

   161     ECustomNotifyPndCacheReadyIPC,			//1000040

   162     /** Get phonebook cache status */

   163     ECustomGetPndCacheStatusIPC,			//1000041

   164     /** Notify SS network event */

   165     ECustomNotifySsNetworkEventIPC,			//1000042

   166     /** Check two digit dial support */

   167     ECustomCheckTwoDigitDialSupportIPC,		//1000043

   168     /** Send APDU request */

   169     ECustomSendAPDUReqIPC,					//1000044

   170     /** Get the life timer's info */

   171     ECustomGetLifeTimeIPC,					//1000045

   172     /** Power SIM on */

   173     ECustomPowerSimOnIPC,					//1000046

   174     /** Power SIM off */

   175     ECustomPowerSimOffIPC,					//1000047

   176     /** Perform SIM warm reset */

   177     ECustomSimWarmResetIPC,					//1000048

   178     /** Get Answer To Reset */

   179     ECustomGetATRIPC,						//1000049

   180     /** Send APDU */

   181     ECustomSendAPDUReqV2IPC,				//1000050

   182     /** Get SIM card reader status */

   183     ECustomGetSimCardReaderStatusIPC,		//1000051

   184     /** Notify SIM card status */

   185     ECustomNotifySimCardStatusIPC,			//1000052

   186     /** Set Drive Mode status */

   187     ECustomSetDriveModeIPC,					//1000053

   188     /** Check if security code is blocked or not */

   189     ECustomIsBlockedIPC,					//1000054

   190     /** Check security code */

   191     ECustomCheckSecurityCodeIPC,			//1000055

   192     /** Check emergency number */

   193     ECustomCheckEmergencyNumberIPC,			//1000056

   194     /** SAT refresh complete notification */

   195     ECustomSatRefreshCompleteNotificationIPC,	//1000057

   196     /** Disable phone lock */

   197     ECustomDisablePhoneLockIPC,					//1000058

   198     /** Get currently active PIN */

   199     ECustomGetActivePinIPC,						//1000059

   200     /** Release CommDB file */

   201     ECustomReleaseFileIPC,						//1000060

   202     /** Restart reading CommDB */

   203     ECustomRestartFileIPC,						//1000061

   204     /** Notify GPRS connection change */

   205     ECustomNotifyEGprsInfoChange,				//1000062

   206     /** Get GPRS connection information */

   207     ECustomGetEGprsInfo,						//1000063

   208     /** Get phonebook 3G info */

   209     EGet3GPBInfoIPC,							//1000064

   210     /** Get system network modes */

   211     ECustomGetSystemNetworkModesIPC,			//1000065

   212     /** Set system network mode */

   213     ECustomSetSystemNetworkModeIPC,				//1000066

   214     /** Get current system network modes */

   215     ECustomGetCurrentSystemNetworkModesIPC,		//1000067

   216     /** Write WCDMA HomeZone */

   217     EWriteViagHomeZoneUHZIUESettingsIPC,		//1000068

   218     /** SetAlwaysOn Mode */

   219     ECustomSetAlwaysOnMode,						//1000069

   220     /** Notify Rau event */

   221     ECustomNotifyRauEventIPC,					//1000070

   222     /** Get Call forwarding info */

   223     ECustomGetIccCallForwardingStatusIPC,		//1000071

   224     /** Notify call forwarding info change */

   225     ECustomNotifyIccCallForwardingStatusChangeIPC,	//1000072

   226     /** Get 3G radio frequency band*/

   227     ECustomGetBandSelectionIPC,						//1000073

   228     /** Set 3G radio frequency band*/

   229     ECustomSetBandSelectionIPC,						//1000074

   230     /** Set 3G radio frequency band*/    

   231     ECustomGetServiceTableSupportbyApplicationIPC,	//1000075

   232     /* Notify remote alerting tone status change IPC */

   233     ECustomNotifyRemoteAlertingToneStatusChangeIPC, //1000076

   234     /** Maximum IPC enumeration value */

   235     ECustomMaxIpcLimit = KIpcCustomMaxLimi

   236     };

   237 

   238 // FORWARD DECLARATIONS

   239 class CMmCustomPtrHolder;

   240 

   241 // CLASS DECLARATION

   242 

   243 /**

   244  * RMmCustomAPI contains multimode API's vendor specific functionality.

   245  * RMmCustomAPI is a subsession extension i.e. it derives

   246  * from RtelSubSessionBase class.

   247  *

   248  * Notice that Custom TSY is able to handle only one instance of each

   249  * Custom API Set-method call at a time. Overlapping Set-method calls occurs

   250  * if same Set-method is called from an other instance of  RMmCustomAPI

   251  * object. Through one RMmCustomAPI object overlapping calls are not allowed

   252  * - trying this will panic Etel Server. For each overlapping request to the

   253  * client is returned error code KErrServerBusy either as a return value in

   254  * case of synchronous call or in a variable of type TRequestStatus in case of

   255  * an asynchronous call. This rule applies also in a situation where previous

   256  * identical request has been cancelled by client but the triggered operation

   257  * on DOS side has not been completed yet.

   258  *

   259  * On the other hand Custom TSY is able to handle several instances of each

   260  * Get-method call at a time. Again overlapping Get-method call can be

   261  * activated only from an other instance of  RMmCustomAPI object.

   262  *

   263  * Consider carefully consequences and implications of request cancellations.

   264  * If a request has triggered an operation on DOS side, the subsequent

   265  * calcellation of the request will not undo the operation on DOS side. It is

   266  * the responsibility of the Custom API's client to undo the operation if

   267  * necessary. Cancel request completes only when awaited DOS side response

   268  * arrives. Then if it is an OK-response, the request is completed normally

   269  * with error code KErrNone. . Or if the response is a FAILURE, the request is

   270  * completed with error code KErrCancel.

   271  *

   272  * APDU functionality:

   273  * Etel Server and Custom TSY are able to handle multiple SendAPDUReq calls

   274  * simultaneously.

   275  * However each RMmCustoAPI instance can have only one request active at

   276  * a time.

   277  *

   278  * Packet data related functionality:

   279  * Custom TSY implements functionality that is not supported by the packetAPI.

   280  *

   281  * Call realted functionality:

   282  * Custom TSY implements functionality that is not supported by the

   283  * MM ETEL API.

   284  *

   285  * @publishedPartner

   286  * @deprecated

   287  */

   288 class RMmCustomAPI : public RTelSubSessionBase

   289     {

   290     public:

   291 

   292     /** Enumerates the Custom API version number.*/

   293     enum TMultimodeETelCustomV1Api

   294         {

   295         /** Version of Custom API extension */

   296         KETelCustomExtMultimodeV1=10000,

   297         /** Version of TTCustomCallParams */

   298         KETelCustomExtCustomCallParamsV3

   299         };

   300 

   301     /** Defines SS statuses to be used */

   302     enum TSsStatus

   303         {

   304         /** Active status */

   305         KSsStatusGsmActive = 0x01,

   306         /** Registered status */

   307         KSsStatusGsmRegistered = 0x02,

   308         /** Provisioned status */

   309         KSsStatusGsmProvisioned = 0x04,

   310         /** Quiescent status */

   311         KSsStatusGsmQuiescent = 0x08,

   312         /** Error status */

   313         KSsStatusReturnError = 0xFFFF,

   314         /** Network failure */

   315         KSsStatusNetworkFailure = 0xFFFE

   316         };

   317 

   318 

   319     /**

   320      * Maximum length of parameter data is 16 for Random parameter, SRES, AUTN,

   321      * CK, IK and AUTS

   322      */

   323     enum { KMaxParametersLength = 16 };

   324     /** Max length of ChipheringKey is 3 */

   325     enum { KMaxKCLength = 3 };

   326     /** Max length of RES is 4 */

   327     enum { KMaxRESLength = 4 };

   328     

   329     //Max length of iBTid, iKeyLifeTime, iNafId, iImpi, iMikey, iMtkSalt

   330     enum { KMaxAuthenticationParameterLength = 255 };

   331    

   332     // KMaxMikeyLength enum for maximum MIKEY protocol data length

   333 	enum { KMaxMikeyLength = 255 };

   334 

   335 	// KMaxKeyDomainIdLength enum for maximum key domain id length

   336 	enum{ KMaxKeyDomainIdLength = 3 };

   337 

   338 	// KMaxKeyGroupIdLength enum for maximum key group id length

   339 	enum { KMaxKeyGroupIdLength = 2 };

   340 	

   341 	

   342     /** Parameter buffer */

   343     typedef TBuf8< KMaxParametersLength > TParameter;

   344 	

   345 	// GBA

   346     typedef TBuf8< KMaxAuthenticationParameterLength > TAuthenticationParameter;

   347     

   348 	// TMikey datatype to be used for MIKEY data

   349     typedef TBuf8< KMaxMikeyLength > TMikey;

   350 	

   351 	// TKeyDomainId datatype to be used for key domain id information	

   352     typedef TBuf8< KMaxKeyDomainIdLength > TKeyDomainId;

   353 	

   354 	// TKeyGroupId datatype to be used for key group id information

   355     typedef TBuf8< KMaxKeyGroupIdLength > TKeyGroupId;

   356 

   357     // Datatype for parental rating data information

   358     typedef TBuf8< KMaxKeyGroupIdLength > TParentalRating;

   359 

   360     // Datatype for parental control operation information

   361     typedef TBuf8< KMaxKeyDomainIdLength > TParentalControl; 

   362     /**

   363      * Base class for TSimAuthenticationEapSim and

   364      * TSimAuthenticationEapAka 

   365      */

   366     class TSimAuthenticationBase

   367     {

   368     public:

   369 

   370     /** Possible values for the authentication method */

   371     enum

   372         {

   373         /** EAP-SIM authentication method */

   374         EEapSim = 0x01,

   375         /** EAP-AKA authentication method */

   376         EEapAka = 0x02,

   377         EGbaBootstrap = 0x03,

   378         EGbaBootstrapUpdate = 0x04, 

   379         EGbaBootstrapNafDerivation = 0x05, 

   380         EMgvMtkGeneration = 0x06, 

   381         EMgvMskDeletion = 0x07, 

   382         EMgvMskUpdate = 0x08 

   383         };

   384 

   385     /** Gets the value of iExtensionId 

   386      * @return iExtensionId */

   387     inline TInt ExtensionId() { return iExtensionId; };

   388     protected:

   389         TInt iExtensionId;

   390     };

   391 

   392 // Class for holding GBA Bootstrap parameters

   393     class TSimAuthenticationGbaBootstrap : public TSimAuthenticationBase

   394         {

   395         public:

   396 

   397             IMPORT_C TSimAuthenticationGbaBootstrap ();

   398 

   399         public:

   400 

   401             // Random parameters from client

   402             TParameter iRandomParameters;

   403             // AUTN parameters from client

   404             TParameter iAUTN;

   405             // RES to client

   406             TParameter iRES;

   407             // AUTS to client

   408             TParameter iAUTS;

   409         };

   410     typedef TPckg< TSimAuthenticationGbaBootstrap > TGbaBootstrapDataPckg;

   411 

   412 

   413 // Class for holding GBA Bootstrap updating parameters

   414     class TSimAuthenticationGbaBootstrapUpdate : public TSimAuthenticationBase

   415         {

   416         public:

   417 

   418             IMPORT_C TSimAuthenticationGbaBootstrapUpdate ();

   419 

   420         public:

   421 

   422             // B-TID from client 

   423             TAuthenticationParameter iBTid;

   424             // Key lifetime from client

   425             TAuthenticationParameter iKeyLifeTime;

   426             // Random parameters to client

   427             TParameter iRandomParameters;

   428         };

   429     typedef TPckg< TSimAuthenticationGbaBootstrapUpdate > TGbaBootstrapUpdateDataPckg;

   430 

   431 

   432 // Class for holding GBA NAF Derivation parameters

   433     class TSimAuthenticationGbaNafDerivation : public TSimAuthenticationBase

   434         {

   435         public:

   436 

   437             IMPORT_C TSimAuthenticationGbaNafDerivation ();

   438 

   439         public:

   440 

   441             // Naf_id from client 

   442             TAuthenticationParameter iNafId;

   443             // Impi from client 

   444             TAuthenticationParameter iImpi;

   445             // Ks_ext_NAF to client 

   446             TBuf8 < 32 > iKsExtNaf;

   447         

   448         };

   449     typedef TPckg< TSimAuthenticationGbaNafDerivation > TGbaNafDerivationDataPckg;

   450 

   451       

   452 // Class for holding MGV MSK update parameters

   453     class TSimAuthenticationMgvMskUpdate : public TSimAuthenticationBase

   454         {

   455         public:

   456 

   457             IMPORT_C TSimAuthenticationMgvMskUpdate ();

   458 

   459         public:

   460 

   461             // MIKEY to client 

   462             TMikey iMikey;

   463             // OMA BCAST management data object to client

   464             TParameter iBCASTManagement;

   465             // OMA BCAST SPE parental rating data operation to client

   466             TParentalRating iParentalRating;

   467             // Security Policy Extension to client

   468             TParameter iSecurityPolicyExt;

   469         

   470         };

   471      typedef TPckg< TSimAuthenticationMgvMskUpdate > TSimAuthenticationMgvMskUpdatePckg;

   472            

   473       

   474 // Class for holding MGV MTK generation parameters

   475     class TSimAuthenticationMgvMtkGeneration : public TSimAuthenticationBase

   476         {

   477         public:

   478 

   479             IMPORT_C TSimAuthenticationMgvMtkGeneration ();

   480 

   481         public:

   482 

   483             // MIKEY from client 

   484             TMikey iMikey;

   485             // MTK salt to client 

   486             TMikey iMtkSalt;

   487         

   488             // Smartcard support for MobileTV

   489             // OMA BCAST management data object to client

   490             TParameter iBCASTManagement;

   491             // OMA BCAST SPE parental control operation to client

   492             TParentalControl iParentalControl;

   493             // TEK (Traffic Encryption Key) to client

   494             TParameter iTrafficEncryptionKey;   

   495         };

   496      typedef TPckg< TSimAuthenticationMgvMtkGeneration > TMgvMtkGenerationDataPckg;

   497 

   498 

   499 // Class for holding MGV MSK deletion parameters

   500     class TSimAuthenticationMgvMskDeletion : public TSimAuthenticationBase

   501         {

   502         public:

   503 

   504             IMPORT_C TSimAuthenticationMgvMskDeletion ();

   505 

   506         public:

   507 

   508             // Key domain Id from client  

   509             TKeyDomainId iKeyDomainId;

   510             // Key Group Id from client 

   511             TKeyGroupId iKeyGroupIdPart;

   512         

   513         };

   514       typedef TPckg< TSimAuthenticationMgvMskDeletion > TMgvMskDeletionDataPckg;

   515 

   516       

   517     /**

   518     * Possible values for Multiple Subscriber Profile IDs

   519     */

   520     enum TMultipleSubscriberProfileID

   521         {

   522         /** Multiple Subscriber Profile ID 1 */

   523         KProfileIdentityOne = 0x01,

   524         /** Multiple Subscriber Profile ID 2 */

   525         KProfileIdentityTwo = 0x02,

   526         /** Multiple Subscriber Profile ID 3 */        

   527         KProfileIdentityThree = 0x03,

   528         /** Multiple Subscriber Profile ID 4 */        

   529         KProfileIdentityFour = 0x04,

   530         };

   531 

   532     /** Class for holding Call Forwarding parameters */

   533     class TCFIndicators: public RMobilePhone::TMobilePhoneCFUIndicatorV3

   534         {

   535         public:

   536         	/** Default constructor */

   537             IMPORT_C TCFIndicators();

   538 

   539         public:

   540 

   541 	        /** CFU number . */ 

   542 		    RMobilePhone::TMobileAddress iCFNumber; 

   543 		 

   544 		    /** MSP Profile ID */

   545        	    TMultipleSubscriberProfileID iMultipleSubscriberProfileID;

   546         };

   547 

   548     /** Package buffer to hold TCFIndicators objects */

   549     typedef TPckg<TCFIndicators> TCFIndicatorsPckg;

   550 

   551     /** Class for holding EAP SIM authentication parameters  */

   552     class TSimAuthenticationEapSim : public TSimAuthenticationBase

   553         {

   554     public:

   555     	/** Default constructor */

   556         IMPORT_C TSimAuthenticationEapSim();

   557 

   558     public:

   559 

   560         /** Random parameters from client */

   561         TParameter iRandomParameters;

   562         /** SRES to client */

   563         TParameter iSRES;

   564         /** Ciphering Key to Client */

   565         TParameter iKC;

   566         };

   567 

   568     /** Package buffer to hold TSimAuthenticationEapSim objects */

   569     typedef TPckg<TSimAuthenticationEapSim> TSimDataPckg;

   570 

   571     /** Class for holding EAP AKA authentication parameters */

   572     class TSimAuthenticationEapAka : public TSimAuthenticationBase

   573         {

   574     public:

   575     	/** Default constructor */

   576         IMPORT_C TSimAuthenticationEapAka();

   577 

   578     public:

   579 

   580         /** Random parameters from client */

   581         TParameter iRandomParameters;

   582         /** AUTN parameters from client */

   583         TParameter iAUTN;

   584         /** RES to client */

   585         TParameter iRES;

   586         /** UMTS Ciphering Key to client */

   587         TParameter iCK;

   588         /** UMTS Integrity Key to client */

   589         TParameter iIK;

   590         /** AUTS to client */

   591         TParameter iAUTS;

   592         };

   593 

   594     /** Package buffer to hold TSimAuthenticationEapAka objects */

   595     typedef TPckg<TSimAuthenticationEapAka> TAkaDataPckg;

   596 

   597     /**

   598      * TTApdu defines the pointers to the Send APDU request details

   599      */

   600     class TApdu

   601         {

   602     public:

   603 

   604         TApdu()

   605             {

   606             iInfo = 0;

   607             iData = 0;

   608             }

   609 

   610         TApdu

   611             (

   612             TDes8& aInfo,

   613             TDes8& aData

   614             )

   615             {

   616             iInfo = &aInfo;

   617             iData = &aData;

   618             }

   619 

   620     public:

   621 

   622         TDes8* iInfo; // Servicetype, Card Reader number, Application

   623                       // Type, Padding Byte

   624         TDes8* iData; // Transparent data

   625         };

   626 

   627     /**

   628      * TApduParameters 

   629      */

   630     class TApduParameters

   631         {

   632     public:

   633 

   634       TApduParameters()

   635             {

   636             iCardReaderId = 0;

   637             }

   638 

   639     public:  // Data

   640     	/** Card Reader ID */

   641         TUint8 iCardReaderId;

   642         /** Cmd Data */

   643         TApduBuffer iCmdData;

   644         /** RSP data */

   645         TApduBuffer iRspData;

   646         };

   647 

   648     /**

   649      * TSimCardReaderStatus

   650      */

   651     class TSimCardReaderStatus

   652         {

   653     public:

   654 

   655         /**

   656          * Default constructor

   657          */

   658         TSimCardReaderStatus() { iSimCardReaderStatus = 0; }

   659 

   660         /**

   661          * Constructor

   662          *

   663          * @param status Reader status

   664          * @return None

   665          */

   666         TSimCardReaderStatus( TUint8 aStatus )

   667             {

   668             iSimCardReaderStatus = aStatus;

   669             }

   670 

   671         /**

   672          * Set Card Status

   673          *

   674          * @param newStatus new reader status

   675          */

   676         IMPORT_C void SetStatus( TUint8 aNewStatus );

   677 

   678         /**

   679          * Get Card Status

   680          *

   681          * @return Reader status

   682          */

   683         IMPORT_C TUint8 GetStatus();

   684 

   685         /**

   686          * Get Card Reader ID.

   687          *

   688          * @return Reader ID

   689          */

   690         IMPORT_C TUint8 GetCardReaderID();

   691 

   692         /**

   693          * Is Card Reader Removable

   694          *

   695          * @return Is Card Reader Removable

   696          */

   697         IMPORT_C TBool IsCardReaderRemovable();

   698 

   699         /**

   700          * Is Card Reader Present

   701          *

   702          * @return Is Card Reader Present

   703          */

   704         IMPORT_C TBool IsCardReaderPresent();

   705 

   706         /**

   707          * Is Card Present

   708          *

   709          * @return Is Card Present

   710          */

   711         IMPORT_C TBool IsCardPresent();

   712 

   713         /**

   714          * Is Card Powered

   715          *

   716          * @return Is Card Powered

   717          */

   718         IMPORT_C TBool IsCardPowered();

   719         

   720     private:

   721     	TUint8 iSimCardReaderStatus; // Reader status

   722         };

   723 

   724     /** TLockNumber defines SIMLock types to be used */

   725     enum TLockNumber

   726         {

   727         /** Operator */

   728         EOperator = 1,

   729         /** GID1 */

   730         EGid1,

   731         /** GID2 */

   732         EGid2,

   733         /** IMSI */

   734         EImsi,

   735         /** Operator GID1 */

   736         EOperator_Gid1,

   737         /** Operator GID2 */

   738         EOperator_Gid2,

   739         /** Global unlock */

   740         EGlobalUnlock

   741         };

   742 

   743     /** Package buffer to hold TSimLockPassword objects */

   744     typedef TBuf<KSimLockMaxPasswordSize> TSimLockPassword;

   745 

   746     /** Constants for VIAG Home Zone data */

   747     enum TViagDataType

   748         {

   749         /** NBR size */

   750         KViagParamNbrSize = 15,

   751         /** Name size */

   752         KViagElemNameSize = 13,

   753         /** Element count */

   754         KViagElementCount = 4

   755         };

   756 

   757     /** VIAG parameter data structure */

   758     struct TViagParams

   759         {

   760         TBuf<KViagParamNbrSize> iSmsC;

   761         TBuf<KViagParamNbrSize> iScp;

   762         TUint8 iSubscribedZoneAndVersion;

   763         };

   764 

   765     /** Coordinates */

   766     struct TCoordinates

   767         {

   768         /** X */

   769         TUint32 iX;

   770         /** Y */

   771         TUint32 iY;

   772         /** R2 */

   773         TUint32 iR2;

   774         /** Zone ID */

   775         TUint iZoneId;

   776         };

   777 

   778     /** Active Flag values */

   779     enum TActiveFlag

   780         {

   781         /** Not active */

   782         ENotActive,

   783         /** Home Zone */

   784         EHomeZone,

   785         /** City Zone */

   786         ECityZone

   787         };

   788 

   789     /** VIAG Element data structure */

   790     struct TViagElement

   791         {

   792         /** Coordinates */

   793         TCoordinates iCoordinates;

   794         /** Name */

   795         TBuf<KViagElemNameSize> iName;

   796         /** Active flag */

   797         TActiveFlag iActiveFlag;

   798         };

   799 

   800     /** Array of TViagElement objects */

   801     typedef CArrayFixFlat <TViagElement> TViagElements;

   802 

   803     /** VIAG Cache Record ID data structure */

   804     struct TViagCacheRecordId

   805         {

   806         /** Cache ID */

   807         TInt iCacheId;

   808         /** Record ID */

   809         TInt iRecordId;

   810         };

   811 

   812     /** VIAG Cache Record Content data structure */ 

   813     struct TViagCacheRecordContent

   814         {

   815         /** LAC */

   816         TUint16 iLac;

   817         /** Cell ID */

   818         TUint16 iCellId;

   819         };

   820 

   821     /** VIAG UHZIUE settings data structure */

   822     struct TViagUHZIUESettings

   823         {

   824         /** Settings */

   825         TUint8 iSettings;

   826         /** Version */

   827         TUint8 iVersion;

   828         };

   829 

   830     /** Security code types */

   831     enum TSecurityCodeType

   832         {

   833         /** PIN1 code */

   834         ESecurityCodePin1,

   835         /** PIN2 code */

   836         ESecurityCodePin2,

   837         /** Universal PIN code */

   838         ESecurityUniversalPin,

   839         /** PUK1 code */

   840         ESecurityCodePuk1,

   841         /** PUK2 code */

   842         ESecurityCodePuk2,

   843         /** Phone SIM lock and phone device lock codes */

   844         ESecurityCodePassPhrase

   845         };

   846 

   847     /** Emergency number check modes */

   848     enum TCheckMode

   849         {

   850         /** Normal */

   851         EEmerNumberCheckNormal,

   852         /** Advanced */

   853         EEmerNumberCheckAdvanced

   854         };

   855 

   856     /** Caching status */

   857     enum TPndCacheStatus

   858         {

   859         /** Not ready */

   860         ECacheNotReady,

   861         /** Ready */

   862         ECacheReady,

   863         /** Not used */

   864         ECacheNotUsed,

   865         /** Failed */

   866         ECacheFailed

   867         };

   868 

   869     /** CB SIM Topics data type */

   870     struct TSimCbTopic

   871         {

   872         /** Number */

   873         TUint iNumber;

   874         /** Name */

   875         TBuf<KSimCbTopicNameLength> iName;

   876         };

   877 

   878     /** Buffer for telephone number */

   879     typedef TBuf<RMobilePhone::KMaxMobileTelNumberSize> TMobileTelNumber;

   880 

   881     /** Emergency number check mode data structure */

   882     struct TEmerNumberCheckMode

   883         {

   884         /** Check mode */

   885         TCheckMode iCheckMode;

   886         /** Telephone number */

   887         TMobileTelNumber iNumber;

   888         };

   889 

   890 	// Service availability on service table on USIM 		

   891 	struct TAppSupport

   892 		{

   893 		TInt iAppNum;	

   894 		TBool iSupported;

   895 		};

   896 

   897     public:

   898     	/** Default constructor */

   899         IMPORT_C RMmCustomAPI();

   900 

   901     public:

   902 

   903         /** DTMF Event types */

   904         enum TDtmfEventType

   905             {

   906             /** Manual */

   907             EDtmfManual,

   908             /** Sequence */

   909             EDtmfSequence

   910             };

   911 

   912         /** DTMF events */

   913         enum TDtmfEvent

   914             {

   915             /** Start */

   916             EDtmfStart,

   917             /** Stop */

   918             EDtmfStop,

   919             /** Abort */

   920             EDtmfAbort

   921             };

   922 

   923         /** DTMF information data structure */

   924         struct TDtmfInfo

   925             {

   926             /** Event type */

   927             TDtmfEventType iType;

   928             /** Event */

   929             TDtmfEvent iEvent;

   930             /** Tone */

   931             TChar iTone;

   932             };

   933 

   934         /** ALS block status values */

   935         enum TSetAlsBlock

   936             {

   937             /** Deactivate */

   938             EDeactivateBlock,

   939             /** Activate */

   940             EActivateBlock

   941             };

   942 

   943         /** Always On modes */

   944         enum TSetAlwaysOnMode

   945             {

   946             /** HPLMN */

   947             EAlwaysModeHPLMN,

   948             /** VPLMN */

   949             EAlwaysModeVPLMN,

   950             /** Both modes (HPLMN/VPLMN) */

   951             EAlwaysModeBoth,

   952             /** Neither mode */

   953             EAlwaysModeNeither

   954             };

   955 

   956         /** RAU event status values */

   957         enum TRauEventStatus

   958             {

   959             /** Active */

   960             ERauEventActive,

   961             /** Resumed */

   962             ERauEventResumed,

   963             };

   964 

   965         /** ALS block status values */

   966         enum TGetAlsBlockStatus

   967             {

   968             /** Not supported */

   969             EBlockStatusNotSupported,

   970             /** Active */

   971             EBlockStatusActive,

   972             /** Inactive */

   973             EBlockStatusInactive,

   974             /** Unknown */

   975             EBlockStatusUnknown

   976             };

   977 

   978         /** ALS Support values */

   979         enum TAlsSupport

   980             {

   981             /** ALS Support is On */

   982             EAlsSupportOn,

   983             /** ALS Support if Off */

   984             EAlsSupportOff

   985             };

   986 

   987         /** Remote alerting tone status */

   988         enum TRemoteAlertingToneStatus

   989             {

   990             /** No Tone */

   991             EUiNoTone,

   992             /** RBT Tone */

   993             EUiRbtTone,

   994             /** Stop Tone */

   995             EUiStopTone

   996             };

   997 

   998         /** Origin of the call */

   999         enum TCallOrigin

  1000             {

  1001             /** Unknown */

  1002             EUnknown,

  1003             /** ETel call */

  1004             EETelCall,

  1005             /** Outside */

  1006             EOutsider

  1007             };

  1008 

  1009         /** Status of the No Service Power Save state */

  1010         enum TNspsStatus

  1011             {

  1012             /** No Service Power Save is ON */

  1013             ENspsOn,

  1014             /** No Service Power Save is OFF */

  1015             ENspsOff

  1016             };

  1017 

  1018         /** Ciphering Information data structure */

  1019         struct TCipheringInfo

  1020             {

  1021             /** ciphering Indicator status */

  1022             TBool   iIndStatus;

  1023             /** ciphering status */

  1024             TBool   iCiphStatus;

  1025             };

  1026 

  1027         /** Additional info size */

  1028         enum { KAdditionalInfoSize = 255 };

  1029 

  1030         /** Additional information data structure */

  1031         struct TSsAdditionalInfo

  1032             {

  1033             /** Operation code */

  1034             TUint8 iOperationCode;

  1035             /** Additional information */

  1036             TBuf8<KAdditionalInfoSize> iAdditionalInfo;

  1037             };

  1038 

  1039         /** Operator name types */

  1040         enum TOperatorNameType

  1041             {

  1042             /** NITZ Full */

  1043             EOperatorNameNitzFull,

  1044             /** NITZ Short */

  1045             EOperatorNameNitzShort,

  1046             /** Programmable UCS2 */

  1047             EOperatorNameProgrammableUcs2,

  1048             /** Programmable Latin */

  1049             EOperatorNameProgrammableLatin,

  1050             /** Hardcoded UCS2 */

  1051             EOperatorNameHardcodedUcs2,

  1052             /** Hardcoded Latin */

  1053             EOperatorNameHardcodedLatin,

  1054             /** Country MNC */

  1055             EOperatorNameCountryMcn,

  1056             /** MCC MNC */

  1057             EOperatorNameMccMnc,

  1058             /** Flexible PLMN */

  1059             EOperatorNameFlexiblePlmn,

  1060             /** Highest Priority */

  1061             EOperatorNameHighestPriority

  1062             };

  1063 

  1064         /** Operator name info structure */

  1065         struct TOperatorNameInfo

  1066             {

  1067             /** Name type */

  1068             TOperatorNameType iType;

  1069             /** Name */

  1070             TBuf<KMaxOperatorNameLength> iName;

  1071             };

  1072 

  1073         /** Programmable operator Id */

  1074         struct TOperatorId

  1075             {

  1076             /** MCC */

  1077             TInt iMcc;

  1078             /** MNC */

  1079             TInt iMnc;

  1080             };

  1081 

  1082         /** Programmable operator logo depth */

  1083         enum TProgrammableOperatorLogoDepth

  1084             {

  1085             /** 1 bit per pixel */

  1086             EBitPerPixel1,

  1087             /** 2 bits per pixel */

  1088             EBitPerPixel2,

  1089             /** 4 bits per pixel */

  1090             EBitPerPixel4,

  1091             /** 8 bits per pixel */

  1092             EBitPerPixel8

  1093             };

  1094 

  1095         /** Programmable operator logo info */

  1096         struct TProgrammableOperatorLogoInfo

  1097             {

  1098             /** Operator logo width */

  1099             TInt iLogoWidth;

  1100             /** Operator logo height */

  1101             TInt iLogoHeight;

  1102             /** Compression (yes/no) */

  1103             TBool iCompression;

  1104             /** Operator logo depth (bits per pixel) */

  1105             TProgrammableOperatorLogoDepth iDepth;

  1106             };

  1107 

  1108         /** Programmable operator logo structure */

  1109         struct TOperatorLogo

  1110             {

  1111             /** Operator logo information */

  1112             TProgrammableOperatorLogoInfo iLogoInfo;

  1113             /** Operator logo buffer */

  1114             TDes8* iOperatorLogo;

  1115             };

  1116 

  1117         /** Two Digit Dial Support values */

  1118         enum TTwoDigitDialSupport

  1119             {

  1120             /** On */

  1121             ETwoDigitDialSupportOn,

  1122             /** Off */

  1123             ETwoDigitDialSupportOff

  1124             };

  1125 

  1126         /** Custom call parameter class for calling party subaddress delivering */

  1127         class TCustomCallParams : public RMobileCall::TMobileCallParamsV2

  1128             {

  1129         public:

  1130         	/** Default constructor */

  1131             IMPORT_C TCustomCallParams();

  1132 

  1133         public:

  1134