// Copyright (c) 2008-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:

//

/**

 @internalComponent

*/

// System includes

#include "e32base.h"

#include "ptpippanic.h"

#include "e32property.h" 

// MTP includes

#include <mtp/mtpprotocolconstants.h>

#include <mtp/tmtptyperesponse.h>

// Plugin includes

#include "mtpdebug.h"

#include "cptpipcommandhandler.h"

#include "cptpipeventhandler.h"

#include "cptpipconnection.h"

#include "ptpipsocketpublish.h"

#include "OstTraceDefinitions.h"

#ifdef OST_TRACE_COMPILER_IN_USE

#include "cptpipconnectionTraces.h"

#endif

// File type constants.

const TInt KMTPNullChunkSize(0x00020000); // 100KB

const TUint32 KPTPIPDataHeaderSize = 12;  // Size of len, type and tran id. 

#define UNUSED_VAR(a) (a) = (a)

/**

 PTPIP device class connection factory method.

 @param aConnectionMgr The MTP connection manager interface.

 @return A pointer to an PTPIP device class connection. Ownership IS transfered.

 @leave One of the system wide error codes, if a processing failure occurs.

 */

CPTPIPConnection* CPTPIPConnection::NewL(MMTPConnectionMgr& aConnectionMgr )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_NEWL_ENTRY );

	CPTPIPConnection* self = new(ELeave) CPTPIPConnection(aConnectionMgr);

	CleanupStack::PushL (self );

	self->ConstructL ( );

	CleanupStack::Pop (self );

	OstTraceFunctionExit0( CPTPIPCONNECTION_NEWL_EXIT );

	return self;

	}

/**

 Destructor

 */

CPTPIPConnection::~CPTPIPConnection( )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_CPTPIPCONNECTION_ENTRY );

	StopConnection ( );

	// Delete all the handlers which will close the sockets.

	delete iCommandHandler;

	delete iEventHandler;

	delete iPTPIPCommandContainer;

	delete iPTPIPDataContainer;

	delete iPTPIPEventContainer;

        if (iProtocolLayer != NULL)

           {

           iProtocolLayer->Unbind(*this);

           }

	iNullBuffer.Close();

	OstTraceFunctionExit0( CPTPIPCONNECTION_CPTPIPCONNECTION_EXIT );

	}

/**

 Second phase constructor

 @leave One of the system wide error codes, if a processing failure occurs.

 */

void CPTPIPConnection::ConstructL( )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_CONSTRUCTL_ENTRY );

	// Construct the Command and event handlers

	iCommandHandler = CPTPIPCommandHandler::NewL (*this );

	iEventHandler = CPTPIPEventHandler::NewL (*this );

	iPTPIPCommandContainer = CPTPIPGenericContainer::NewL ( );

	iPTPIPDataContainer = CPTPIPDataContainer::NewL ( );

	iPTPIPEventContainer = CPTPIPGenericContainer::NewL ( );

	// Transfer the sockets

	TransferSocketsL();

	SetConnectionState (EInitialising );

	CompleteSelf (KErrNone );

	OstTraceFunctionExit0( CPTPIPCONNECTION_CONSTRUCTL_EXIT );

	}

/**

 Constructor

 */

CPTPIPConnection::CPTPIPConnection(MMTPConnectionMgr& aConnectionMgr ) :

									CActive(EPriorityStandard), 

									iConnectionMgr(&aConnectionMgr)

	{

	OstTraceFunctionEntry0( DUP1_CPTPIPCONNECTION_CPTPIPCONNECTION_ENTRY );

	CActiveScheduler::Add (this );

	OstTraceFunctionExit0( DUP1_CPTPIPCONNECTION_CPTPIPCONNECTION_EXIT );

	}

//

// MMTPTransportConnection functions

//

/**

 Binds the protocol layer. 

 @param aProtocol - The connectionProtocol provides the SPI or the observer

 for the communication to happen from the transport to the framework. 

 */

void CPTPIPConnection::BindL(MMTPConnectionProtocol& aProtocol )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_BINDL_ENTRY );

	iProtocolLayer = &aProtocol;

	OstTraceFunctionExit0( CPTPIPCONNECTION_BINDL_EXIT );

	}

/**

 Returns the protocol layer.

 @return The SPI or the observer protocol layer

 */

MMTPConnectionProtocol& CPTPIPConnection::BoundProtocolLayer( )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_BOUNDPROTOCOLLAYER_ENTRY );

	__ASSERT_ALWAYS(iProtocolLayer, Panic(EPTPIPBadState));

	OstTraceFunctionExit0( CPTPIPCONNECTION_BOUNDPROTOCOLLAYER_EXIT );

	return *iProtocolLayer;

	}

/**

 Close the connection, stop all data transfer activity and and wait for the host 

 to issue a Device Reset Request.

 */

void CPTPIPConnection::CloseConnection( )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_CLOSECONNECTION_ENTRY );

	StopConnection ( );

	OstTraceFunctionExit0( CPTPIPCONNECTION_CLOSECONNECTION_EXIT );

	}

/**

 A transaction is one set of request, data transfer and response phases. 

 The fw calls this to mark the end of an MTP transaction. 

 */

void CPTPIPConnection::TransactionCompleteL(const TMTPTypeRequest& /*aRequest*/)

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_TRANSACTIONCOMPLETEL_ENTRY );

	OstTrace0( TRACE_NORMAL, CPTPIPCONNECTION_TRANSACTIONCOMPLETEL, "******** Transaction Complete **************" );

	SetTransactionPhase (EIdlePhase );

	// Clear the cancel flag.

	iCancelOnCommandState = ECancelNotReceived;

	iCancelOnEventState = ECancelNotReceived;

	// Again start listening for the command request. 

	InitiateCommandRequestPhaseL( );

	OstTraceFunctionExit0( CPTPIPCONNECTION_TRANSACTIONCOMPLETEL_EXIT );

	}

/**

 Called by the fw to indicate that protocol layer is not using this transport anymore 

 and so we will not have any callback/SPI funtions to the fw any more

 */

void CPTPIPConnection::Unbind(MMTPConnectionProtocol& /*aProtocol*/)

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_UNBIND_ENTRY );

	__ASSERT_DEBUG(iProtocolLayer, Panic(EPTPIPBadState));

	// Protocol will no longer be bound to the transport

	iProtocolLayer = NULL;

	OstTraceFunctionExit0( CPTPIPCONNECTION_UNBIND_EXIT );

	}

/**

 Not used

 */

TAny* CPTPIPConnection::GetExtendedInterface(TUid /*aInterfaceUid*/)

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_GETEXTENDEDINTERFACE_ENTRY );

	OstTraceFunctionExit0( CPTPIPCONNECTION_GETEXTENDEDINTERFACE_EXIT );

	return NULL;

	}

/*

 * return PTPIP transport implementation UID

 */

TUint CPTPIPConnection::GetImplementationUid()

    {

    OstTraceFunctionEntry0( CPTPIPCONNECTION_GETIMPLEMENTATIONUID_ENTRY );

    OstTraceFunctionExit0( CPTPIPCONNECTION_GETIMPLEMENTATIONUID_EXIT );

    return KMTPPTPIPTransportImplementationUid;

    }

//

// Active Object functions

//

/**

 Used to cancel the outstanding requests, and reset internal states as appropriate. 

 */

void CPTPIPConnection::DoCancel( )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_DOCANCEL_ENTRY );

	iCommandHandler->Cancel( );

	iEventHandler->Cancel( );

	SetConnectionState(ECancelled );

	OstTraceFunctionExit0( CPTPIPCONNECTION_DOCANCEL_EXIT );

	}

/**

The connection behaves as an active object during the PTPIP connection establishment phase.

Subsequently, it behaves as a normal object whose functions are invoked by the MTP framework

or by the SocketHandler on sending/ receiving data. 

Thus the runl is not hit after the initial connection establishment. 

 */

void CPTPIPConnection::RunL( )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_RUNL_ENTRY );

	OstTraceExt2( TRACE_NORMAL, CPTPIPCONNECTION_RUNL, "Current State is %d, and status is %d", iState, iStatus.Int() );

	if(iStatus != KErrNone )

		{

		CloseConnection( );

		}

	else 

		{

		switch(iState )

		{

		// ConstructL is complete, 

		// the PTPIP connection establishment will be complete after the init ack is sent.

		case EInitialising:

			SendInitAckL( );

			break;

			// Now the PTPIP connection has been established. 

		case EInitialisationComplete:

			SetConnectionState(EStartListening );

			CompleteSelf(KErrNone );

			break;

			// Start listeing for requests on the 2 channels

		case EStartListening:

			InitiateEventRequestPhaseL( );

			InitiateCommandRequestPhaseL( );

			break;

		default:

			OstTrace0( TRACE_NORMAL, DUP1_CPTPIPCONNECTION_RUNL, "PTPIP ERROR: Invalid  connection state" );

			Panic(EPTPIPBadState );

			break;

		}

		}

	OstTraceFunctionExit0( CPTPIPCONNECTION_RUNL_EXIT );

	}

/**

 Called when an error occurs in the RunL 

 */

TInt CPTPIPConnection::RunError(TInt aError )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_RUNERROR_ENTRY );

	OstTrace1( TRACE_NORMAL, CPTPIPCONNECTION_RUNERROR, "PTPIP ERROR: Error received is %d", aError );

	// Cancel all the outstanding requests.

	Cancel( );

	// Stop the connection, if necessary.

	StopConnection( );

	OstTraceFunctionExit0( CPTPIPCONNECTION_RUNERROR_EXIT );

	return KErrNone;

	}

//

// Receive data functions

//

/**

 Called internally to recevive the commands over the command channel. 

 This will invoke the command handler 

 to listen on the socket and get the data into the buffers passed. 

 */

void CPTPIPConnection::InitiateCommandRequestPhaseL( )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_INITIATECOMMANDREQUESTPHASEL_ENTRY );

	OstTrace0( TRACE_NORMAL, CPTPIPCONNECTION_INITIATECOMMANDREQUESTPHASEL, "******** Phase 1 - Request **************" );

	// Set current state to request phase

	SetTransactionPhase(ERequestPhase );

	// The PTPIP data buffer is a member of connection.  

	// Since we are expecting a request now, set the payload to request type

	iPTPIPRequestPayload.Reset( );

	iPTPIPCommandContainer->SetPayloadL(&iPTPIPRequestPayload );

	// Call the CommandHandler to get the request in the container

	iCommandHandler->ReceiveCommandRequestL(*iPTPIPCommandContainer );

	OstTraceFunctionExit0( CPTPIPCONNECTION_INITIATECOMMANDREQUESTPHASEL_EXIT );

	}

/** 

 Called to indicate completion of receive of data started by InitiateCommandRequestPhaseL.

 There is no point in reporting the error up to the f/w since no transaction has started.

 USB does nothing at this stage. In PTP , the connection is closed.

 @param aError - The error if any, received from socket.

 */

void CPTPIPConnection::ReceiveCommandCompleteL(TInt aError )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_RECEIVECOMMANDCOMPLETEL_ENTRY );

	if(KErrNone != aError )

		{

		OstTrace1( TRACE_NORMAL, CPTPIPCONNECTION_RECEIVECOMMANDCOMPLETEL, "PTPIP Error: Received error=%d in request phase, closing  connection", aError );

		CloseConnection( );

		}

	else if(ValidateTransactionPhase(ERequestPhase ) )

		{

		// Request block received.

		TPTPIPTypeRequestPayload* pRequest = static_cast<TPTPIPTypeRequestPayload*>(iPTPIPCommandContainer->Payload());

		TUint16 op(pRequest->Uint16(TPTPIPTypeRequestPayload::EOpCode ));

		TUint32	tran(pRequest->Uint32(TPTPIPTypeRequestPayload::ETransactionId ));

		TUint32 sessionId = KMTPSessionNone;

		OstTraceExt2( TRACE_NORMAL, DUP1_CPTPIPCONNECTION_RECEIVECOMMANDCOMPLETEL, "Command block received with op = 0x%04X ,transId = %d", static_cast<TUint32>(op), tran );

		// Reset the iMTPRequest.

		iMTPRequest.Reset( );

		// Setup the MTP request dataset buffer. Set Operation Code and TransactionID

		iMTPRequest.SetUint16(TMTPTypeRequest::ERequestOperationCode, op );

		iMTPRequest.SetUint32(TMTPTypeRequest::ERequestTransactionID, tran );

		// Set SessionID.

		if(op == EMTPOpCodeOpenSession )

			{

			OstTrace0( TRACE_NORMAL, DUP2_CPTPIPCONNECTION_RECEIVECOMMANDCOMPLETEL, "Processing OpenSession request" );

			}

		else if(op == EMTPOpCodeCloseSession || op == EMTPOpCodeResetDevice )

			{

			OstTrace0( TRACE_NORMAL, DUP3_CPTPIPCONNECTION_RECEIVECOMMANDCOMPLETEL, "Processing CloseSession or the ResetDevice request" );

			// Force CloseSession requests to be processed outside an active session. 

			// ResetDevice currently behaves the same way as CloseSession. 

			iMTPRequest.SetUint32(TMTPTypeRequest::ERequestParameter1,

					iMTPSessionId );

			}

		else

			{

			sessionId = iMTPSessionId;

			OstTrace1( TRACE_NORMAL, DUP4_CPTPIPCONNECTION_RECEIVECOMMANDCOMPLETEL, "Processing general request on session %d", sessionId );

			}

		iMTPRequest.SetUint32(TMTPTypeRequest::ERequestSessionID,sessionId );

		// Set Parameter 1 .. Parameter 5.

		pRequest->CopyOut(iMTPRequest, TMTPTypeRequest::ERequestParameter1,	TMTPTypeRequest::ERequestParameter5 );

		pRequest->Reset( );

		// Notify the protocol layer.

		BoundProtocolLayer().ReceivedRequestL(iMTPRequest );

		}

	OstTraceFunctionExit0( CPTPIPCONNECTION_RECEIVECOMMANDCOMPLETEL_EXIT );

	}

/**

 Called to get data over the command channel,( in turn its called by f/ws ReceiveData)

 @param aData - The buffer provided by the F/w in which to receive data.

 */

void CPTPIPConnection::ReceiveCommandDataL(MMTPType& aData )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_RECEIVECOMMANDDATAL_ENTRY );

	iRecvData = 0;

	iTotalRecvData = 0;

	// First we will receive a PTPIP start data packet which is stored in the commandContainer

	iPTPIPCommandContainer->SetPayloadL(&iPTPIPStartDataPayload );

	// The mtp buffer is passed from the framework and will be passed on as the payload.

	// in the next ptpip data packet.

	iPTPIPDataContainer->SetPayloadL(&aData );

	iCommandHandler->ReceiveCommandDataL(*iPTPIPCommandContainer );

	OstTraceFunctionExit0( CPTPIPCONNECTION_RECEIVECOMMANDDATAL_EXIT );

	}

/**

 Called to indicate completion of receive of data started by ReceiveCommandDataL.

 Any errors received are sent back up to the framework. 

 */

void CPTPIPConnection::ReceiveCommandDataCompleteL(TInt aError )

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_RECEIVECOMMANDDATACOMPLETEL_ENTRY );

	if(ValidateTransactionPhase(EDataIToRPhase ) )

		{

		// Data block received, notify the protocol layer.

		iPTPIPDataContainer->SetUint32L(CPTPIPDataContainer::EPacketType, 0 );

		BoundProtocolLayer().ReceiveDataCompleteL(aError, *iPTPIPDataContainer->Payload(), iMTPRequest );

		}

	OstTraceFunctionExit0( CPTPIPCONNECTION_RECEIVECOMMANDDATACOMPLETEL_EXIT );

	}

/**

 Called by the command handler to indicate completion of receive on the command channel.

 Now check whether it was commands or data completion and call the appropriate function. 

 */

void CPTPIPConnection::ReceiveCommandChannelCompleteL(TInt aError, MMTPType& /*aSource*/)

	{

	OstTraceFunctionEntry0( CPTPIPCONNECTION_RECEIVECOMMANDCHANNELCOMPLETEL_ENTRY );

	OstTrace0( TRACE_NORMAL, CPTPIPCONNECTION_RECEIVECOMMANDCHANNELCOMPLETEL, "******** Receiving 1 ptpip packet on command/data channel complete **************" );

	HandleTCPError(aError );

	TUint32	typeCommand = iPTPIPCommandContainer->Uint32L(CPTPIPGenericContainer::EPacketType );

	TUint32	typeData = iPTPIPDataContainer->Uint32L(CPTPIPGenericContainer::EPacketType );

	OstTraceExt2( TRACE_NORMAL, DUP1_CPTPIPCONNECTION_RECEIVECOMMANDCHANNELCOMPLETEL, "type on the command buffer is %d and type on the data buffer is %d", typeCommand, typeData );

	switch (typeCommand)

	{

	case EPTPIPPacketTypeOperationRequest:

		ReceiveCommandCompleteL(aError );

		break;

	case EPTPIPPacketTypeStartData:

		if(aError != KErrNone )

			{

			ReceiveCommandCompleteL(aError );

			}

		else

			{

			// Save the total data expected. 

			iTotalRecvData =(static_cast<TPTPIPTypeStartDataPayload*>(iPTPIPCommandContainer->Payload()))->Uint64(TPTPIPTypeStartDataPayload::ETotalSize );

			OstTrace1( TRACE_NORMAL, DUP2_CPTPIPCONNECTION_RECEIVECOMMANDCHANNELCOMPLETEL, "Total data to receive in data phase is %ld", iTotalRecvData );

			//reset the command container 

			iPTPIPCommandContainer->SetUint32L(CPTPIPGenericContainer::EPacketType, 0 );

			iCommandHandler->ReceiveCommandDataL(*iPTPIPDataContainer );

			}

		break;

	case EPTPIPPacketTypeCancel:

		{

		TMTPTypeInt32* pTransId;

		pTransId = static_cast<TMTPTypeInt32*>(iPTPIPCommandContainer->Payload());

		iCancelOnCommandState = ECancelCmdReceived;

		HandleCommandCancelL(pTransId->Value());

		}

		break;

	default:

		// No known types came on the command container, now check the data container.

		switch (typeData)

		{

		case EPTPIPPacketTypeData:

			// One PTPIP packet has been received. We will now continue getting the next PTPIP packets. 

			iRecvData += iPTPIPDataContainer->Uint32L(CPTPIPDataContainer::EPacketLength );

			iRecvData -= KPTPIPDataHeaderSize; // The header size is not included in the total size sent. 

			//If more data is expected,then set the flag to use the current offset

			//in the chunk

			if (iRecvData < iTotalRecvData)

			{

			iCommandHandler->iUseOffset = ETrue;	

			}

			OstTrace1( TRACE_NORMAL, DUP3_CPTPIPCONNECTION_RECEIVECOMMANDCHANNELCOMPLETEL, "Data received so far in data phase is %ld", iRecvData );

			if(iRecvData <= iTotalRecvData )

				{