/*

* All rights reserved.

* This component and the accompanying materials are made available

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

* which accompanies this distribution, and is available

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

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/

/**

 @file

 @publishedPartner

 @deprecated

*/

#ifndef RMMCUSTOMAPI_H

#define RMMCUSTOMAPI_H

//  INCLUDES

#include <etelmm.h>

#include <et_clsvr.h>

#include <etelpckt.h>

// CONSTANTS

const TInt KIpcCustomExt = 1000000;

const TInt KIpcCustomMaxLimi = 1000299;

const TInt KIpcCustomAPIExtensionExt = 1000450;

_LIT(KCustomAPIName,"CUSTOMAPI");

_LIT(KTerminateAllCalls,"ALL_CALLS");

const TInt KSimCbTopicNameLength = 20;

const TInt KSubAddressSize = 20;

const TInt KBearerCapabilitySize = 14;

// alpha tag length is 124

const TInt KMaxOperatorNameLength = 124;

// max length of operator length

const TInt KMaxOperatorLogoLength = 6405;

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

const TUint8 KFlexibleLongNameMaxLength = 30;

const TUint8 KFlexibleShortNameMaxLength = 20;

// Sim file definitions

const TUint8 KSimFilePathLength = 8;

const TUint16 KSimFileMaxLength = 0xFFFF;

// Viag HomeZone setting flags

const TUint8 KUHziUeActive = 0x00001;

const TUint8 HCbHziUeActive = 0x00002;

// ADPU buffer maximum length 258 according to

// ISI ADPU server description

typedef TBuf8<258> TApduBuffer;

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

const TInt KErrPacketDataTsyInvalidAPN = -6001;

// Cell info constant

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

const TInt KMaxCellMeasuredResults = 32;

const TInt KMaxNetworkMeasureReports = 8;

const TInt KMaxNmrAmount = 15;

// DATA TYPES

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

enum TCustomIPC

    {

    /** Notify ss additional info */

    ECustomSsAdditionalInfoNotificationIPC = KIpcCustomExt,		//1000000

    /** Notify ss request complete */

    ECustomNotifySsRequestCompleteIPC,		//1000001

    /** Cancel USSD session */

    ECustomCancelUssdSessionIPC,			//1000002

    /** Start SIM CB topic browsing */

    ECustomStartSimCbTopicBrowsingIPC,		//1000003

    /** Get next SIM CB topic */

	ECustomGetNextSimCbTopicIPC,			//1000004

    /** Delete SIM DB topic */

    ECustomDeleteSimCbTopicIPC,				//1000005

    /** Read SIM File */

    ECustomReadSimFileIPC,					//1000006

    /** Get wlan sim authentication data */

    ECustomGetSimAuthenticationDataIPC,		//1000007

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

    ECustomSetSimMessageStatusReadIPC,		//1000008

    /** Notify Dtmf event */

    ECustomNotifyDtmfEventIPC,				//1000009

    /** Get Diagnostic Octets */

    ECustomGetDiagnosticOctetsIPC,			//1000010

    /** Set Als Blocked */

    ECustomSetAlsBlockedIPC,				//1000011

    /** Get Als Blocked */

    ECustomGetAlsBlockedIPC,				//1000012

    /** Check Als Pp Support */

    ECustomCheckAlsPpSupportIPC,			//1000013

    /** Remote Alerting Tone Status */

    ECustomGetRemoteAlertingToneStatusIPC,	//1000014

    /** Call Origin */

    ECustomCallOriginIPC,					//1000015

    /** Notify Als Blocked Change */

    ECustomNotifyAlsBlockedChangedIPC,		//1000016

    /** Terminate a Call */

    ECustomTerminateCallIPC,				//1000017

    /** Clear call blacklist */

    ECustomClearCallBlackListIPC,			//1000018

    /** Read HSxPA Status */

    ECustomReadHSxPAStatusIPC,				//1000019

    /** Write HSxPA Status */    

    ECustomWriteHSxPAStatusIPC,				//1000020

    /** Notify HSxPA Status change */    

    ECustomNotifyHSxPAStatusIPC,			//1000021

    /** Get cell(s) info */

    ECustomGetCellInfoIPC,					//1000022

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

    ECustomNotifyCellInfoChangeIPC,			//1000023

    /** Activate SIM Lock */

    ECustomSimLockActivateIPC,				//1000024

    /** Deactivate SIM Lock */

    ECustomSimLockDeActivateIPC,			//1000025

    /** Read VIAG Home Zone Parameters */

    EReadViagHomeZoneParamsIPC,				//1000026

    /** Read VIAG Home Zone Cache */

    EReadViagHomeZoneCacheIPC,				//1000027

    /** Write VIAG Home Zone Cache */

    EWriteViagHomeZoneCacheIPC,				//1000028

    /** Get ciphering information */

    ECustomGetCipheringInfoIPC,				//1000029

    /** Notify ciphering information */

    ECustomNotifyCipheringInfoChangeIPC,	//1000030

    /** Notify NSPS status */

    ECustomNotifyNSPSStatusIPC,				//1000031

    /** Wake net from NSPS */

    ECustomNetWakeupIPC,					//1000032

    /** Get network provider name */

    ECustomGetNetworkProviderNameIPC,		//1000033

    /** Get operator name */

    ECustomGetOperatorNameIPC,				//1000034

    /** Get programmable operator logo */

    ECustomGetProgrammableOperatorLogoIPC,	//1000035

    /** Reset the net server */

    ECustomResetNetServerIPC,				//1000036

    /** Notify programmable operator logo change */

    ECustomNotifyProgrammableOperatorLogoChangeIPC,		//1000037

    /** Notify network connection failure */

    ECustomNotifyNetworkConnectionFailureIPC,			//1000038

    /** Get Air time duration */

    ECustomGetAirTimeDurationIPC,			//1000039

    /** Notify phonebook cache ready */

    ECustomNotifyPndCacheReadyIPC,			//1000040

    /** Get phonebook cache status */

    ECustomGetPndCacheStatusIPC,			//1000041

    /** Notify SS network event */

    ECustomNotifySsNetworkEventIPC,			//1000042

    /** Check two digit dial support */

    ECustomCheckTwoDigitDialSupportIPC,		//1000043

    /** Send APDU request */

    ECustomSendAPDUReqIPC,					//1000044

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

    ECustomGetLifeTimeIPC,					//1000045

    /** Power SIM on */

    ECustomPowerSimOnIPC,					//1000046

    /** Power SIM off */

    ECustomPowerSimOffIPC,					//1000047

    /** Perform SIM warm reset */

    ECustomSimWarmResetIPC,					//1000048

    /** Get Answer To Reset */

    ECustomGetATRIPC,						//1000049

    /** Send APDU */

    ECustomSendAPDUReqV2IPC,				//1000050

    /** Get SIM card reader status */

    ECustomGetSimCardReaderStatusIPC,		//1000051

    /** Notify SIM card status */

    ECustomNotifySimCardStatusIPC,			//1000052

    /** Set Drive Mode status */

    ECustomSetDriveModeIPC,					//1000053

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

    ECustomIsBlockedIPC,					//1000054

    /** Check security code */

    ECustomCheckSecurityCodeIPC,			//1000055

    /** Check emergency number */

    ECustomCheckEmergencyNumberIPC,			//1000056

    /** SAT refresh complete notification */

    ECustomSatRefreshCompleteNotificationIPC,	//1000057

    /** Disable phone lock */

    ECustomDisablePhoneLockIPC,					//1000058

    /** Get currently active PIN */

    ECustomGetActivePinIPC,						//1000059

    /** Release CommDB file */

    ECustomReleaseFileIPC,						//1000060

    /** Restart reading CommDB */

    ECustomRestartFileIPC,						//1000061

    /** Notify GPRS connection change */

    ECustomNotifyEGprsInfoChange,				//1000062

    /** Get GPRS connection information */

    ECustomGetEGprsInfo,						//1000063

    /** Get phonebook 3G info */

    EGet3GPBInfoIPC,							//1000064

    /** Get system network modes */

    ECustomGetSystemNetworkModesIPC,			//1000065

    /** Set system network mode */

    ECustomSetSystemNetworkModeIPC,				//1000066

    /** Get current system network modes */

    ECustomGetCurrentSystemNetworkModesIPC,		//1000067

    /** Write WCDMA HomeZone */

    EWriteViagHomeZoneUHZIUESettingsIPC,		//1000068

    /** SetAlwaysOn Mode */

    ECustomSetAlwaysOnMode,						//1000069

    /** Notify Rau event */

    ECustomNotifyRauEventIPC,					//1000070

    /** Get Call forwarding info */

    ECustomGetIccCallForwardingStatusIPC,		//1000071

    /** Notify call forwarding info change */

    ECustomNotifyIccCallForwardingStatusChangeIPC,	//1000072

    /** Get 3G radio frequency band*/

    ECustomGetBandSelectionIPC,						//1000073

    /** Set 3G radio frequency band*/

    ECustomSetBandSelectionIPC,						//1000074

    /** Set 3G radio frequency band*/    

    ECustomGetServiceTableSupportbyApplicationIPC,	//1000075

    /* Notify remote alerting tone status change IPC */

    ECustomNotifyRemoteAlertingToneStatusChangeIPC, //1000076

    /** Maximum IPC enumeration value */

    ECustomMaxIpcLimit = KIpcCustomMaxLimi

    };

// FORWARD DECLARATIONS

class CMmCustomPtrHolder;

// CLASS DECLARATION

/**

 * RMmCustomAPI contains multimode API's vendor specific functionality.

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

 * from RtelSubSessionBase class.

 *

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

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

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

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

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

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

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

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

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

 * on DOS side has not been completed yet.

 *

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

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

 * activated only from an other instance of  RMmCustomAPI object.

 *

 * Consider carefully consequences and implications of request cancellations.

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

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

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

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

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

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

 * completed with error code KErrCancel.

 *

 * APDU functionality:

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

 * simultaneously.

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

 * a time.

 *

 * Packet data related functionality:

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

 *

 * Call realted functionality:

 * Custom TSY implements functionality that is not supported by the

 * MM ETEL API.

 *

 * @publishedPartner

 * @deprecated

 */

class RMmCustomAPI : public RTelSubSessionBase

    {

    public:

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

    enum TMultimodeETelCustomV1Api

        {

        /** Version of Custom API extension */

        KETelCustomExtMultimodeV1=10000,

        /** Version of TTCustomCallParams */

        KETelCustomExtCustomCallParamsV3

        };

    /** Defines SS statuses to be used */

    enum TSsStatus

        {

        /** Active status */

        KSsStatusGsmActive = 0x01,

        /** Registered status */

        KSsStatusGsmRegistered = 0x02,

        /** Provisioned status */

        KSsStatusGsmProvisioned = 0x04,

        /** Quiescent status */

        KSsStatusGsmQuiescent = 0x08,

        /** Error status */

        KSsStatusReturnError = 0xFFFF,

        /** Network failure */

        KSsStatusNetworkFailure = 0xFFFE

        };

    /**

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

     * CK, IK and AUTS

     */

    enum { KMaxParametersLength = 16 };

    /** Max length of ChipheringKey is 3 */

    enum { KMaxKCLength = 3 };

    /** Max length of RES is 4 */

    enum { KMaxRESLength = 4 };

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

    enum { KMaxAuthenticationParameterLength = 255 };

    // KMaxMikeyLength enum for maximum MIKEY protocol data length

	enum { KMaxMikeyLength = 255 };

	// KMaxKeyDomainIdLength enum for maximum key domain id length

	enum{ KMaxKeyDomainIdLength = 3 };

	// KMaxKeyGroupIdLength enum for maximum key group id length

	enum { KMaxKeyGroupIdLength = 2 };

    /** Parameter buffer */

    typedef TBuf8< KMaxParametersLength > TParameter;

	// GBA

    typedef TBuf8< KMaxAuthenticationParameterLength > TAuthenticationParameter;

	// TMikey datatype to be used for MIKEY data

    typedef TBuf8< KMaxMikeyLength > TMikey;

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

    typedef TBuf8< KMaxKeyDomainIdLength > TKeyDomainId;

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

    typedef TBuf8< KMaxKeyGroupIdLength > TKeyGroupId;

    // Datatype for parental rating data information

    typedef TBuf8< KMaxKeyGroupIdLength > TParentalRating;

    // Datatype for parental control operation information

    typedef TBuf8< KMaxKeyDomainIdLength > TParentalControl; 

    /**

     * Base class for TSimAuthenticationEapSim and

     * TSimAuthenticationEapAka 

     */

    class TSimAuthenticationBase

    {

    public:

    /** Possible values for the authentication method */

    enum

        {

        /** EAP-SIM authentication method */

        EEapSim = 0x01,

        /** EAP-AKA authentication method */

        EEapAka = 0x02,

        EGbaBootstrap = 0x03,

        EGbaBootstrapUpdate = 0x04, 

        EGbaBootstrapNafDerivation = 0x05, 

        EMgvMtkGeneration = 0x06, 

        EMgvMskDeletion = 0x07, 

        EMgvMskUpdate = 0x08 

        };

    /** Gets the value of iExtensionId 

     * @return iExtensionId */

    inline TInt ExtensionId() { return iExtensionId; };

    protected:

        TInt iExtensionId;

    };

// Class for holding GBA Bootstrap parameters

    class TSimAuthenticationGbaBootstrap : public TSimAuthenticationBase

        {

        public:

            IMPORT_C TSimAuthenticationGbaBootstrap ();

        public:

            // Random parameters from client

            TParameter iRandomParameters;

            // AUTN parameters from client

            TParameter iAUTN;

            // RES to client

            TParameter iRES;

            // AUTS to client

            TParameter iAUTS;

        };

    typedef TPckg< TSimAuthenticationGbaBootstrap > TGbaBootstrapDataPckg;

// Class for holding GBA Bootstrap updating parameters

    class TSimAuthenticationGbaBootstrapUpdate : public TSimAuthenticationBase

        {

        public:

            IMPORT_C TSimAuthenticationGbaBootstrapUpdate ();

        public:

            // B-TID from client 

            TAuthenticationParameter iBTid;

            // Key lifetime from client

            TAuthenticationParameter iKeyLifeTime;

            // Random parameters to client

            TParameter iRandomParameters;

        };

    typedef TPckg< TSimAuthenticationGbaBootstrapUpdate > TGbaBootstrapUpdateDataPckg;

// Class for holding GBA NAF Derivation parameters

    class TSimAuthenticationGbaNafDerivation : public TSimAuthenticationBase

        {

        public:

            IMPORT_C TSimAuthenticationGbaNafDerivation ();

        public:

            // Naf_id from client 

            TAuthenticationParameter iNafId;

            // Impi from client 

            TAuthenticationParameter iImpi;

            // Ks_ext_NAF to client 

            TBuf8 < 32 > iKsExtNaf;

        };

    typedef TPckg< TSimAuthenticationGbaNafDerivation > TGbaNafDerivationDataPckg;

// Class for holding MGV MSK update parameters

    class TSimAuthenticationMgvMskUpdate : public TSimAuthenticationBase

        {

        public:

            IMPORT_C TSimAuthenticationMgvMskUpdate ();

        public:

            // MIKEY to client 

            TMikey iMikey;

            // OMA BCAST management data object to client

            TParameter iBCASTManagement;

            // OMA BCAST SPE parental rating data operation to client

            TParentalRating iParentalRating;

            // Security Policy Extension to client

            TParameter iSecurityPolicyExt;

        };

     typedef TPckg< TSimAuthenticationMgvMskUpdate > TSimAuthenticationMgvMskUpdatePckg;

// Class for holding MGV MTK generation parameters

    class TSimAuthenticationMgvMtkGeneration : public TSimAuthenticationBase

        {

        public:

            IMPORT_C TSimAuthenticationMgvMtkGeneration ();

        public:

            // MIKEY from client 

            TMikey iMikey;

            // MTK salt to client 

            TMikey iMtkSalt;

            // Smartcard support for MobileTV

            // OMA BCAST management data object to client

            TParameter iBCASTManagement;

            // OMA BCAST SPE parental control operation to client

            TParentalControl iParentalControl;

            // TEK (Traffic Encryption Key) to client

            TParameter iTrafficEncryptionKey;   

        };

     typedef TPckg< TSimAuthenticationMgvMtkGeneration > TMgvMtkGenerationDataPckg;

// Class for holding MGV MSK deletion parameters

    class TSimAuthenticationMgvMskDeletion : public TSimAuthenticationBase

        {

        public:

            IMPORT_C TSimAuthenticationMgvMskDeletion ();

        public:

            // Key domain Id from client  

            TKeyDomainId iKeyDomainId;

            // Key Group Id from client 

            TKeyGroupId iKeyGroupIdPart;

        };

      typedef TPckg< TSimAuthenticationMgvMskDeletion > TMgvMskDeletionDataPckg;

    /**

    * Possible values for Multiple Subscriber Profile IDs

    */

    enum TMultipleSubscriberProfileID

        {

        /** Multiple Subscriber Profile ID 1 */

        KProfileIdentityOne = 0x01,

        /** Multiple Subscriber Profile ID 2 */

        KProfileIdentityTwo = 0x02,

        /** Multiple Subscriber Profile ID 3 */        

        KProfileIdentityThree = 0x03,

        /** Multiple Subscriber Profile ID 4 */