// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

// 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:

// (U)SAT API implementation - RSat

// 

//

/**

 @file

*/

#include <et_clsvr.h>

#include "etelext.h"

#include "Etelsat.h"

#include "Satptr.h"

#include <satcs.h>

_LIT(KSatToolkit,"TOOLKIT");

EXPORT_C RSat::RSat()

	: RTelSubSessionBase(),

	  iEtelSatPtrHolder(NULL)

/** Default constructor */

	{

	}

EXPORT_C void RSat::ConstructL()

/** Initialises RSat.  called as part of the two-phase construction (typical to Symbian OS). */

	{

	__ASSERT_ALWAYS(iEtelSatPtrHolder==NULL,PanicClient(EEtelPanicHandleNotClosed));

	iEtelSatPtrHolder = CSatPtrHolder::NewL(EMaxNumberSatPtrSlots, EMaxNumberSatCPtrSlots);

	__ASSERT_ALWAYS(iEtelSatPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	}

EXPORT_C void RSat::Destruct()

/** Default destructor */

	{

	delete iEtelSatPtrHolder;

	iEtelSatPtrHolder = NULL;

	}

EXPORT_C TInt RSat::Open(RPhone& aPhone)

/**

 * This method opens the RSat interface.

 *

 * You must have previously opened an interface to the phone (either an RPhone or EMobilePhone).

 * Pass the phone session to RSat::Open().

 *

 * After opening the RSat session:

 *

 * - Send your profile to the UICC (see RSat::GetMeSideSatProfile() )

 * - Request notification to receive proactive commands (see the RSat::Notify.... functions).

 * - Finally, indicate that you are ready to receive proactive commands from the UICC with RSat::UsatClientReadyIndication()

 *

 * @param aPhone A phone session (either an RPhone or EMobilePhone).

 * @see RSat::Close()

 * @capability None

 */

	{

	RSessionBase* session=&aPhone.SessionHandle();

	__ASSERT_ALWAYS(session!=NULL,PanicClient(EEtelPanicNullHandle));

	TInt subSessionHandle=aPhone.SubSessionHandle();

	__ASSERT_ALWAYS(subSessionHandle!=NULL,PanicClient(EEtelPanicNullHandle));

	TRAPD(ret,ConstructL());

	if (ret)

		return ret;

	TPtrC name(KSatToolkit);

	SetSessionHandle(*session);

	ret = CreateSubSession(*session,EEtelOpenFromSubSession,TIpcArgs(&name,TIpcArgs::ENothing,subSessionHandle));

	if (ret)

		Destruct();

	return ret;

	}

EXPORT_C void RSat::Close()

/**

 * This method closes RSat.

 * @see RSat::Open()

 * @capability None

 */

	{

	CloseSubSession(EEtelClose);

	Destruct();

	}

RSat::TSatBase::TSatBase()

	:iExtensionId(KSatVersionNotSet)

/** Default constructor */

	{

	}

EXPORT_C TInt RSat::TSatBase::ExtensionId() const

/**

 * This method returns the version number of the parameter.

 * It will be a value from RSat::TSatVersion.

 * The version number is also called the extension identifier.

 *

 * @return The API version number.

 *

 * @see RSat::TSatVersion

 */

	{

	return iExtensionId;

	}

RSat::TSatPCmdBase::TSatPCmdBase()

	: TSatBase(),

	  iPCmdNumber(0)

/** Default constructor */	  

	{

	}

EXPORT_C TUint8 RSat::TSatPCmdBase::PCmdNumber() const

/**

 * This method returns the value of iPCmdNumber for the associated proactive command class.

 * The PCmd Number is the one originally issued by the UICC card.

 *

 * @return The protected data member iPCmdNumber which specifies the proactive command number.

 */

	{

	return iPCmdNumber;

	}

EXPORT_C TInt RSat::TSatPCmdBase::SetPCmdNumber(TUint8 aNumber)

/**

 * This method sets iPCmdNumber for the associated proactive command class.

 * The PCmd Number is the one originally issued by the UICC card.

 *

 * @param aNumber PCmdNumber associated with the proactive command sent by the UICC card.

 * @return KErrNotSupported returned if aNumber is not within the valid range (1->254 inclusive).

 *         Otherwise, KErrNone returned.

 */

	{

	if ((aNumber<1) || aNumber>254)

		return KErrNotSupported;

	else

		{

		iPCmdNumber=aNumber;

		return KErrNone;

		}

	}

EXPORT_C void RSat::GetIcon(TRequestStatus& aReqStatus, TUint8 aRecordNumber, RSat::TIcon& aIconEf) const

/**

 * A proactive command may be accompanied by an icon to be displayed to the user;

 * see RSat::TIconId.  The command does not contain the icon.  Instead, it

 * contains an icon identifier, RSat::TIconId::iIdentifier. When you want to display an

 * icon, the first step is to pass RSat::TIconId::iIdentifier to

 * RSat::GetIcon() to retrieve the icon's EF record from the UICC.

 *

 * The EF record describes the icon.  The UICC may store several images that

 * represent the same icon.  Images can differ in size and coding scheme. Each is

 * listed and described in the EF record.  Analyse the EF record and choose a

 * suitable image, then call RSat::GetImageInstance() to retrieves

 * the actual image data to display.

 *

 * If none of the images are suitable then see the error conditions described in

 * RSat::TIconId.

 *

 * The EF record is described in ETSI TS 131 102; search for EFimg or "Contents

 * of files at the DFGRAPHICS level"

 *

 * To cancel an outstanding request, call

 * RTelSubSessionBase::CancelAsyncRequest( ESatGetIcon )

 *

 * @param aReqStatus This method is asynchronous.  aReqStatus indicates when the operation has completed.

 * @param aRecordNumber EF record number of the icon to get. This must be a value from RSat::TIconId::iIdentifier.

 * @param aIconEf The TSY fills this with the icon EF record retrieved from the UICC, specified by aRecordNumber.

 * @capability None

 * @see RSat::TIconId

 * @see RSat::GetImageInstance()

 */

 	{

	__ASSERT_ALWAYS(iEtelSatPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	iEtelSatPtrHolder->iGetIcon = aRecordNumber;

	TPtr8& ptr1=iEtelSatPtrHolder->Set(ESlot1GetIcon,iEtelSatPtrHolder->iGetIcon);

	TPtr8& ptr2=iEtelSatPtrHolder->Set(ESlot2GetIcon,aIconEf);

	Get(ESatGetIcon,aReqStatus, ptr1, ptr2);

	}

EXPORT_C void RSat::GetImageInstance(TRequestStatus& aReqStatus, const TDesC8& aInstanceInfo, TDes8& aInstance) const

/**

 * This method retrieves an icon's image data from the UICC.  The data is

 * returned in aInstance.

 *

 * For colour images, you will also need to retrieve a Colour LookUp Table (CLUT).

 * Use RSat::GetClut() for this.

 *

 * Before calling this method, you must have called RSat::GetIcon() to retrieve

 * the icon's EF record.

 *

 * aInstanceInfo is a RSat::TInstanceInfoV3Pckg (a packaged

 * RSat::TInstanceInfoV3) containing details of the image you would

 * like to get.  This includes the image's size.  aInstance should be the size of the image.

 *

 * The EF record is described in ETSI TS 131 102; search for EFimg or "Contents

 * of files at the DFGRAPHICS level".  The format of both image data and CLUT

 * is also described in ETSI TS 131 102; see Annex B.

 *

 * To cancel an outstanding request, call

 * RTelSubSessionBase::CancelAsyncRequest( ESatGetImageInstance )

 *

 * @param aReqStatus This method is asynchronous.  aReqStatus indicates when the operation has completed.

 * @param aInstanceInfo Specifies the instance number,

 *        offset and length of the image to retrieve from EF.

 * @param aInstance The TSY fills this with the image instance EF specified by aInstanceInfo, retrieved from the UICC.

 * @capability None

 * @see RSat::TIconId

 * @see RSat::GetIcon()

 * @see RSat::TInstanceInfoV3

 * @see RSat::TInstanceInfoV3Pckg

 */

	{

	SetAndGet(ESatGetImageInstance,aReqStatus, aInstanceInfo, aInstance);

	}

EXPORT_C RSat::TInstanceInfoV2::TInstanceInfoV2()

	: TSatPCmdBase(),

	  iInstanceNumber(0),

	  iOffset(0),

	  iLength(0)

/**

* Default constructor.

*/

	{

	iExtensionId = RSat::KSatV2;

	}

EXPORT_C RSat::TInstanceInfoV3::TInstanceInfoV3()

	: TInstanceInfoV2(),

	  iCoding(KBasic),

	  iImgWidth(0),

	  iImgHeight(0),

	  iFileId(0)

/**

* Default constructor.

*/	  

	{

	iExtensionId = RSat::KSatV3;

	}

EXPORT_C void RSat::GetClut(TRequestStatus& aReqStatus, TUint aInstanceNumber, TUint aOffset, TDes8& aClut) const

/**

 * This method retrieves the CLUT (Colour Lookup Table) for an image instance designated by aInstanceNumber.

 * This is used when displaying icons; see RSat::GetImageInstance().

 *

 * The format of the CLUT is described in ETSI TS 131 102; see Annex B.

 *

 * To cancel an outstanding request, call

 * RTelSubSessionBase::CancelAsyncRequest( ESatGetClut )

 *

 * @param aReqStatus This method is asynchronous.  aReqStatus indicates when the operation has completed.

 * @param aInstanceNumber Specifies which instance of an icon is to be retrieved.

 * @param aOffset Specifies the offset at which is located the clut within the image instance.

 * @param aClut The TSY fills this with the colour look up table specified by aInstance Number, retrieved from the UICC.

 * @capability None

 */

	{

	__ASSERT_ALWAYS(iEtelSatPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	iEtelSatPtrHolder->iGetClut.iInstanceNumber= aInstanceNumber;

	iEtelSatPtrHolder->iGetClut.iOffset= aOffset;

	TPtr8& ptr1=iEtelSatPtrHolder->Set(ESlot1GetClut,iEtelSatPtrHolder->iGetClut);

	Get(ESatGetClut,aReqStatus, ptr1, aClut);

	}

EXPORT_C void RSat::TerminalRsp(TRequestStatus& aReqStatus, TPCmd aPCmd, const TDesC8& aRsp) const

/**

 * This method replies to a proactive command.

 * The reply is sent to the UICC.

 * This is a generic method which replies to every proactive command.

 *

 * Each type of proactive command requires a different response. There are classes

 * to implement the responses for the different commands.  To respond to a command, create an instance

 * of the appropriate class, fill in the fields, and then package the object.  Then pass

 * the package and the associated proactive command type to RSat::TerminalRsp().

 *

 * @param aReqStatus This method is asynchronous.  aReqStatus indicates when the operation has completed.

 * @param aPCmd  The type of proactive command that you are responding to.

 * @param aRsp Packaged response object associated with the proactive command type.

 * @capability NetworkControl

 */

	{

	__ASSERT_ALWAYS(iEtelSatPtrHolder!=NULL,PanicClient(EEtelPanicNullHandle));

	iEtelSatPtrHolder->iPCmd=aPCmd;

	TPtr8& ptr1=iEtelSatPtrHolder->Set(ESlotPCmd,iEtelSatPtrHolder->iPCmd);

	Set(ESatTerminalRsp,aReqStatus,ptr1,aRsp);

	}

EXPORT_C RSat::TSatProfileV1::TSatProfileV1()

	: TSatBase(),

	  iSatProfileByte1(0),

	  iSatProfileByte2(0),

	  iSatProfileByte3(0),

	  iSatProfileByte4(0),

	  iSatProfileByte5(0),

	  iSatProfileByte6(0),

	  iSatProfileByte7(0),

	  iSatProfileByte8(0),

	  iSatProfileByte9(0)

/**

* Default constructor.

*/

	{

	iExtensionId=KSatV1;

	}

EXPORT_C RSat::TSatProfileV2::TSatProfileV2()

	: TSatProfileV1(), iSatProfileByte10(0), iSatProfileByte11(0), iSatProfileByte12(0),

	iSatProfileByte13(0), iNumOfChannels(0), iSatProfileByte14(0), iScreenHeight(0),

	iSatProfileByte15(0), iScreenWidth (0), iSatProfileByte16(0), iWidthReduction(0),

	iSatProfileByte17(0), iSatProfileByte18(0), iTiaEiaProtoVersion(0)

/**

* Default constructor.

*/

	{

	iExtensionId=KSatV2;

	}

EXPORT_C RSat::TSatProfileV5::TSatProfileV5()

	: TSatProfileV2(), iSatProfileByte28(0), iSatProfileByte29(0)

/**

* Default constructor.

*/

	{

	iExtensionId=KSatV5;

	}

EXPORT_C RSat::TSatProfileV6::TSatProfileV6()

	: TSatProfileV5(), iSatProfileByte21(0), iSatProfileByte22(0), iSatProfileByte23(0), 

	iSatProfileByte24(0), iSatProfileByte25(0)

/**

* Default constructor.

*/

	{

	iExtensionId=KSatV6;

	}

EXPORT_C TInt RSat::UsatClientReadyIndication() const

/**

 * Indicates that you are ready to receive proactive commands from the UICC.  Do not call this until:

 *

 * - You have sent your profile to the UICC (see RSat::GetMeSideSatProfile() )

 *

 * - You have requested notification to receive proactive commands (see the

 * RSat::Notify.... functions).

 *

 * @return KErrNone

 * @capability NetworkControl

 */

	{

	return Blank(ESatUsatClientReadyIndication);

	}

EXPORT_C void RSat::GetMeSideSatProfile(TRequestStatus& aReqStatus, TDes8& aMeSimSatProfile) const

/**

 * At the beginning of a ETelSat API session, you must tell the UICC what SAT

 * features the phone supports.  Do this after creating and opening an RSat

 * session. This is a three-part process:

 *

 * - Firstly, call RSat::GetMeSideSatProfile(). This returns a profile describing

 * the SAT features that are supported by the phone's hardware and the TSY. These

 * features are not under the ETelSat API control; they happen without your

 * involvement.

 *

 * - Modify the profile to include the SAT features that you support. The profile is

 * a RSat::TSatProfileV1 in Symbian OS v6.1 and v7.0.  Up to v8.1, it is a

 * RSat::TSatProfileV2.  For Symbian OS v9.2, it is a RSat::TSatProfileV5.

 * For Symbian OS v9.4, it is a RSat::TSatProfileV6. In later versions of Symbian OS, check for updated

 * class (RSat::TSatProfileV7 etc).

 *

 * - Finally, send the profile to the UICC by calling RSat::ClientSatProfileIndication()

 *

 * Once you have told the UICC of the profile:

 *

 * - Firstly, request notification of proactive commands with the RSat::Notify... functions.

 *

 * - Finally call RSat::UsatClientReadyIndication() to tell the UICC you are ready for its proactive commands.

 *

 * @see RSat::UsatClientReadyIndication()

 * @see RSat::ClientSatProfileIndication()

 * @see RSat::TSatProfileV1

 * @see RSat::TSatProfileV1Pckg

 * @see RSat::TSatProfileV2

 * @see RSat::TSatProfileV2Pckg

 * @see RSat::TSatProfileV5

 * @see RSat::TSatProfileV5Pckg

 * @see RSat::TSatProfileV6

 * @see RSat::TSatProfileV6Pckg

 *

 * @param aReqStatus This method is asynchronous.  aReqStatus indicates when the operation has completed.

 * @param aMeSimSatProfile The TSY fills this with the phone hardware and TSY's SAT profile, packaged in a RSat::TSatProfileV1Pckg or RSat::TSatProfileV2Pckg

 * @capability None

 */

	{

	Get(ESatGetMeSideSatProfile,aReqStatus,aMeSimSatProfile);

	}

EXPORT_C TInt RSat::ClientSatProfileIndication(const TDesC8& aClientSatProfile) const

/**

 * At the beginning of a ETelSat API session, you must tell the UICC what SAT

 * features the phone supports.  Do this after creating and opening an RSat

 * session. This is a three-part process:

 *

 * - Firstly, call RSat::GetMeSideSatProfile(). This returns a profile describing

 * the SAT features that are supported by the phone's hardware and the TSY. These

 * features are not under the ETelSat API control; they happen without your

 * involvement.

 *

 * - Modify the profile to include the SAT features that you support. The profile is

 * a RSat::TSatProfileV1 in Symbian OS v6.1 and v7.0.  Up to v8.1, it is a

 * RSat::TSatProfileV2.  For Symbian OS v9.2, it is a RSat::TSatProfileV5.

 * For Symbian OS v9.4, it is a RSat::TSatProfileV6. In later versions of Symbian OS, check for updated

 * class (RSat::TSatProfileV7 etc).

 *

 * - Finally, send the profile to the UICC by calling RSat::ClientSatProfileIndication()

 *

 * Once you have told the UICC of the profile:

 *

 * - Firstly, request notification of proactive commands with the RSat::Notify... functions.

 *

 * - Finally call RSat::UsatClientReadyIndication() to tell the UICC you are ready for its proactive commands.

 *

 * @see RSat::UsatClientReadyIndication()

 * @see RSat::GetMeSideSatProfile()

 * @see RSat::TSatProfileV1

 * @see RSat::TSatProfileV1Pckg

 * @see RSat::TSatProfileV2

 * @see RSat::TSatProfileV2Pckg

 * @see RSat::TSatProfileV5

 * @see RSat::TSatProfileV5Pckg

 * @see RSat::TSatProfileV6

 * @see RSat::TSatProfileV6Pckg

 *

 * @param aClientSatProfile  Client SAT profile. A packaged RSat::TSatProfileVx class. See above for which version to use.

 * @capability NetworkControl

 * @capability WriteDeviceData

 * @return KErrNone on success, other system-wide error code otherwise.

 */

	{

	return Set(ESatClientSatProfileIndication,aClientSatProfile);

	}

EXPORT_C RSat::TMenuSelectionV1::TMenuSelectionV1()

	: TSatBase(),

	  iItemId(0x00),

	  iHelp(EHelpRequestNotSet)

/**

* Default constructor.

*/

	{

	iExtensionId=KSatV1;

	iHelp=EHelpRequestNotSet;

	}

EXPORT_C void RSat::MenuSelection(TRequestStatus& aReqStatus, const TDesC8& aSelection) const

/**

 * Sends a MENU SELECTION envelope command to the UICC.  This is related to a SET

 * UP MENU proactive command.  SET UP MENU asks for a menu to be added to the

 * phone's menu system.  If a user chooses an item from this menu, then inform the

 * UICC of the user's selection with RSat::MenuSelection().

 *

 * @param aReqStatus This method is asynchronous.  aReqStatus indicates when the operation has completed.

 * @param aSelection Describes the menu item that the user selected.

 * Pass a packaged version of the  latest "TMenuSelection" class. For Symbian OS

 * versions up to and including v8.1a and 8.1b use RSat::TMenuSelectionV1Pckg, a

 * packaged RSat::TMenuSelectionV1.  For later versions of Symbian OS, check for an

 * updated API (RSat::TMenuSelectionV2 etc).

 *

 * @capability NetworkControl

 * @capability ReadDeviceData

 *

 * @see RSat::TMenuSelectionV1

 * @see RSat::NotifySetUpMenuPCmd()

 */

	{

	Set(ESatMenuSelection,aReqStatus,aSelection);

	}

EXPORT_C RSat::TCallControlV1::TCallControlV1()

	: TSatBase(),

	  iType(ECcTypeNotSet),

	  iCcp1(),

	  iSubAddress(),

	  iCcp2(),

	  iDcs(0),

	  iTypeOfNumber(ETypeOfNumberNotSet),

	  iNumberPlan(ENumberingPlanNotSet),

	  iBuf(),

	  iResult(EControlResultNotSet),

	  iValidity(EAlphaIdValidityNotSet),

	  iBCRepeatIndicator(EBCAlternateMode)

/**

* Default constructor.

*/

	{

	iExtensionId=KSatV1;

	iAlphaId.iStatus=EAlphaIdNotSet;

	}

EXPORT_C void RSat::TCallControlV1::SetCallSetUpDetails(const TCallSetUpParams& aParams)

/**

 * This method is used by the TSY to set the call set up details within the TCallControlV1 class