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

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "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

 @internalTechnology

*/

#include "cbulkonlytransport.h"

#include "cbulkonlytransportusbcldd.h"

#include "cbulkonlytransportusbcscldd.h"

#include "usbmsshared.h"

#include "massstoragedebug.h"

#include "cusbmassstorageserver.h"

//CBW offsets

LOCAL_D const TInt KCbwSignatureOffset 			= 0;

LOCAL_D const TInt KCbwTagOffset 				= 4;

LOCAL_D const TInt KCbwDataTransferLengthOffset = 8;

LOCAL_D const TInt KCbwFlagOffset 				= 12;

LOCAL_D const TInt KCbwLunOffset				= 13;

LOCAL_D const TInt KCbwCbLengthOffset  			= 14;

LOCAL_D const TInt KMaxCbwcbLength 				= 16;

// CSW offsets

LOCAL_D const TInt KCswSingnatureOffset 		= 0;

LOCAL_D const TInt KCswTagOffset 				= 4;

LOCAL_D const TInt KCswDataResidueOffset 		= 8;

LOCAL_D const TInt KCswStatusOffset 			= 12;

/**

 This function unpacks into the TUsbRequestHdr class from a descriptor with

 the alignment that would be introduced on the USB bus.

 @param aBuffer Input buffer

 @param aTarget Unpacked header.

 @return Error.

 */

TInt TUsbRequestHdr::Decode(const TDesC8& aBuffer)

	{

	if (aBuffer.Length() < static_cast<TInt>(KRequestHdrSize))

		{

        __PRINT1(_L("TUsbRequestHdr::Decode buffer invalid length %d"), aBuffer.Length());

		return KErrGeneral;

		}

	iRequestType = aBuffer[0];

	iRequest = static_cast<TEp0Request>(aBuffer[1]);

	iValue	 = static_cast<TUint16>(aBuffer[2] + (aBuffer[3] << 8));

	iIndex	 = static_cast<TUint16>(aBuffer[4] + (aBuffer[5] << 8));

	iLength  = static_cast<TUint16>(aBuffer[6] + (aBuffer[7] << 8));

    __PRINT5(_L("type=%d request=%d value=%d index=%d length=%d"), iRequestType,iRequest,iValue,iIndex,iLength);

	return KErrNone;

	}

/**

This function determines whether data is required by the host in response

to a message header.

@return TBool	Flag indicating whether a data response required.

*/

TBool TUsbRequestHdr::IsDataResponseRequired() const

	{

	return (iRequestType & 0x80) ? (TBool)ETrue : (TBool)EFalse;

	}

//-------------------------------------

/**

Create an object of a class derived from CBulkOnlyTransport (default to CBulkOnlyTransportUsbcLdd object)

@param aNumDrives - The number of drives available for MS

@param aController - reference to the parent

@return pointer to newly created derived class object

*/

CBulkOnlyTransport* CBulkOnlyTransport::NewL(TInt aNumDrives,CUsbMassStorageController& aController)

	{

	__FNLOG("CBulkOnlyTransport::NewL()");

	return NewL(aNumDrives,aController, (CUsbMassStorageController::TTransportldd) 1);

	}

/**

Create an object of a class derived from CBulkOnlyTransport 

@param aNumDrives - The number of drives available for MS

@param aController - reference to the parent

@param aTransportLddFlag - Type of usb client ldd

@return pointer to newly created derived class object

*/

CBulkOnlyTransport* CBulkOnlyTransport::NewL(TInt aNumDrives,CUsbMassStorageController& aController, CUsbMassStorageController::TTransportldd aTransportLddFlag)

	{

	__FNLOG("CBulkOnlyTransport::NewL()");

	if (aNumDrives <=0 || static_cast<TUint>(aNumDrives) > KUsbMsMaxDrives)

		{

		User::Leave(KErrArgument);

		}

	CBulkOnlyTransportUsbcScLdd* scTransport;

	CBulkOnlyTransportUsbcLdd* nonscTransport;

	switch (aTransportLddFlag)

		{

		case 1: 

				nonscTransport = new(ELeave) CBulkOnlyTransportUsbcLdd(aNumDrives, aController);

				return nonscTransport;

		case 2: 

				scTransport = new(ELeave) CBulkOnlyTransportUsbcScLdd(aNumDrives, aController);

				return scTransport;

		default:

				return NULL;

		}

	}

TInt CBulkOnlyTransport::InitialiseTransportL(TInt aTransportLddFlag)

	{

	__FNLOG("CBulkOnlyTransportUsbcScLdd::InitialiseTransportL()");

	TInt ret = KErrNone;

	MTransportBase* transport;

	iController.GetTransport(transport);

	switch (aTransportLddFlag)

		{

		case 2: 

				ret = ((CBulkOnlyTransportUsbcScLdd*) transport)->Ldd().Open(0);

				if (ret != KErrNone)

					{

					return ret;

					}

				else

					{

					((CBulkOnlyTransportUsbcScLdd*) transport)->Ldd().Close();		

					CleanupStack::PushL(transport);

					((CBulkOnlyTransportUsbcScLdd*) transport)->ConstructL();

					CleanupStack::Pop(transport);

					return ret;

					}

		case 1:

				ret = ((CBulkOnlyTransportUsbcLdd*) transport)->Ldd().Open(0);

				if (ret != KErrNone)

					{

					return ret;

					}

				else

					{

					((CBulkOnlyTransportUsbcLdd*) transport)->Ldd().Close();

					CleanupStack::PushL(transport);

					((CBulkOnlyTransportUsbcLdd*) transport)->ConstructL();

					CleanupStack::Pop(transport);

					return ret;

					}

		default:

				return KErrNotFound;

		}

	}	

/**

c'tor

@param aNumDrives - The number of drives available for MS

@param aController - reference to the parent

*/

CBulkOnlyTransport::CBulkOnlyTransport(TInt aNumDrives,CUsbMassStorageController& aController):

	CActive(EPriorityStandard),

	iMaxLun(aNumDrives-1),

	iController(aController),

	iStallAllowed(ETrue),

	iInterfaceConfigured(EFalse),

	iCommandBufPtr(NULL,0),

	iDataBufPtr(NULL,0),

	iCswBufPtr(NULL,0),

	iPaddingBufPtr(NULL,0),

	iWriteBufPtr(NULL,0),

	iReadBufPtr(NULL, 0),

	iCbwBufPtr(NULL,0)

	{

	__FNLOG("CBulkOnlyTransport::CBulkOnlyTransport");

	}

/**

Destructor

*/

CBulkOnlyTransport::~CBulkOnlyTransport()

	{

	__FNLOG("CBulkOnlyTransport::~CBulkOnlyTransport");

	if (iInterfaceConfigured)

		{

		Stop();

		}

	}

/**

Called by the protocol after processing the packet to indicate that more data is required.

@param aData reference to the data buffer.

*/

void CBulkOnlyTransport::SetupReadData(TUint aLength)

	{

	__FNLOG("CBulkOnlyTransport::SetupReadData");

	__PRINT1(_L("Length = %d  (bytes)\n"), aLength);

	iBufSize = aLength;

	iReadSetUp = ETrue;

	}

/**

Called by the protocol after processing the packet to indicate that data should be written to the host.

@param aData reference to the data buffer.

*/

void CBulkOnlyTransport::SetupWriteData(TPtrC8& aData)

	{

	__FNLOG("CBulkOnlyTransport::SetupWriteData");

	__PRINT1(_L("Length = %d  (bytes)\n"), aData.Length());

	iWriteBufPtr.Set(aData);

	iWriteSetUp = ETrue;

	}

TInt CBulkOnlyTransport::Start()

	{

	__FNLOG("CBulkOnlyTransport::Start");

	TInt err = KErrNone;

	if (!iProtocol)

		{

		return KErrBadHandle;   //protocol should be set up before start

		}

	if (IsActive())

		{

		__PRINT(_L("CBulkOnlyTransport::Start  - active before start!\n"));

		return KErrInUse;

		}

	if ((err = SetupConfigurationDescriptor()) 	!= KErrNone ||

		(err = SetupInterfaceDescriptors())		!= KErrNone )

		{

		__PRINT(_L("CBulkOnlyTransport::Start  - Error during descriptors setup!\n"));

		return err;

		}

	AllocateEndpointResources();

	ActivateDeviceStateNotifier();  // activate notifier wich will wait until USB became configured

	TUsbcDeviceState deviceStatus = EUsbcDeviceStateDefault;

	err = GetDeviceStatus(deviceStatus);

	__PRINT1(_L("CBulkOnlyTransport::Start - Device status = %d\n"), deviceStatus);

	if (err == KErrNone && deviceStatus == EUsbcDeviceStateConfigured)

		{

		__PRINT(_L("CBulkOnlyTransport::Start  - Starting bulk only transport\n"));

		err = HwStart();

		}

#ifdef MSDC_MULTITHREADED

	TPtr8 aDes1(NULL,0);

	TPtr8 aDes2(NULL,0);

	GetBufferPointers(aDes1, aDes2);

	iProtocol->InitializeBufferPointers(aDes1, aDes2); // have to pass pointer to memory not offsets to initialise TPtr, and lengths

#endif

	iInterfaceConfigured = ETrue;

	return err;

	}

TInt CBulkOnlyTransport::HwStart(TBool aDiscard)

	{

	__FNLOG("CBulkOnlyTransport::HwStart");

    TInt lun = MaxLun();

    do

        {

        Controller().DriveManager().Connect(lun);

        }

    while(--lun >= 0);

	TInt res = StartControlInterface();

	iCurrentState = ENone;

	iWriteSetUp=EFalse;

	iReadSetUp=EFalse;

	iStarted = ETrue;

    if (aDiscard)

		{

		FlushData();

		}

	ReadCBW();

	return res;

	}

TInt CBulkOnlyTransport::HwStop()

	{

	__FNLOG("CBulkOnlyTransport::HwStop");

	if (iStarted)

		{

        StopBulkOnlyEndpoint();

		CancelControlInterface();

		iStarted = EFalse;

		}

	return KErrNone;

	}

void CBulkOnlyTransport::StopBulkOnlyEndpoint()

	{

	__FNLOG("CBulkOnlyTransport::StopBulkOnlyEndpoint");

    TInt lun = MaxLun();

    do

        {

        Controller().DriveManager().Disconnect(lun);

        }

    while(--lun >= 0);

	Cancel();

	iProtocol->Cancel();

	}

TInt CBulkOnlyTransport::HwSuspend()

	{

	__FNLOG("CBulkOnlyTransport::HwSuspend");

	TInt lun = MaxLun();

	do

		{

		Controller().DriveManager().Disconnect(lun);

		}

	while(--lun >= 0);

	return KErrNone;

	}

TInt CBulkOnlyTransport::HwResume()

	{

	__FNLOG("CBulkOnlyTransport::HwResume");

    TInt lun = MaxLun();

    do

        {

        Controller().DriveManager().Connect(lun);

        }

    while(--lun >= 0);

	return KErrNone;

	}

/**

Stops the Bulk Only Transport

*/

TInt CBulkOnlyTransport::Stop()

	{

	__FNLOG("CBulkOnlyTransport::Stop");

	CancelControlInterface();

	CancelDeviceStateNotifier();

	Cancel();

	if  (iInterfaceConfigured)

		{

		ReleaseInterface();

		SetupConfigurationDescriptor(ETrue);

		}

	iCurrentState = ENone;

	iInterfaceConfigured = EFalse;

	return KErrNone;

	}

void CBulkOnlyTransport::DoCancel()

	{

	__FNLOG("CBulkOnlyTransport::DoCancel");

	CancelReadWriteRequests();

	}

void CBulkOnlyTransport::Activate(TInt aReason)

    {

    SetActive();

    TRequestStatus* r = &iStatus;

    User::RequestComplete(r, aReason);

    }

void CBulkOnlyTransport::RunL()

	{

	__FNLOG("CBulkOnlyTransport::RunL");

	if (iStatus != KErrNone)

		{

		__PRINT1(_L("Error %d in RunL, halt endpoints \n"), iStatus.Int());

		SetPermError(); //halt endpoints for reset recovery

		return;

		}

	switch (iCurrentState)

		{

		case EWaitForCBW:

			__PRINT(_L("EWaitForCBW"));

			ProcessCbwEvent();

			break;

		case EWritingData:

            __PRINT(_L("EWritingData"));

			iWriteSetUp = EFalse;  //the buffer was used

			if (iDataResidue && iStallAllowed)

				{

				StallEndpointAndWaitForClear();

				}

			SendCSW(iCbwTag, iDataResidue, iCmdStatus);

			break;

		case EReadingData:

			{

			__PRINT(_L("EReadingData"));

			ProcessReadingDataEvent();

			}

			break;

		case ESendingCSW:

			__PRINT(_L("ESendingCSW"));

			ReadCBW();

			break;

        case EPermErr:

			__PRINT(_L("EPermErr"));

			StallEndpointAndWaitForClear();

            break;

        default:

			SetPermError();		// unexpected state

		}

	}

/**

Decode the CBW received from the host via OutEndpoint

- If the header is valid, the data content is passed to the parser.

- Depending on the command, more data may be transmitted/received.

- ...or the CSW is sent (if not a data command).

*/

void CBulkOnlyTransport::DecodeCBW()

	{

	__FNLOG("CBulkOnlyTransport::DecodeCBW");

	SetCbwPtr();

	if (!CheckCBW())  //check if CBW valid and meaningful

		{

        // CBW not valid or meaningful

        // Specification says: "If the CBW is not valid, the device shall STALL

        // the Bulk-In pipe. Also, the device shall either STALL the Bulk-Out pipe,

        // or the device shall accept and discard any Bulk-Out data. The device

        // shall maintain this state until a Reset Recovery."

        // Here we keep bulk-in ep stalled and ignore bulk-out ep.

		SetPermError();

		ExpireData((TAny*) (iCbwBufPtr.Ptr()));

		return;

		}

	TPtrC8 aData;

	aData.Set(&iCbwBufPtr[KCbwCbLengthOffset], KMaxCbwcbLength+1);    //prepare data for protocol starting form Length

	TUint8 lun = static_cast<TUint8>(iCbwBufPtr[13] & 0x0f);

	iCbwTag  =	static_cast<TUint32>(iCbwBufPtr[KCbwTagOffset])		|

				static_cast<TUint32>(iCbwBufPtr[KCbwTagOffset+1])	<<8 |

				static_cast<TUint32>(iCbwBufPtr[KCbwTagOffset+2])	<<16|

				static_cast<TUint32>(iCbwBufPtr[KCbwTagOffset+3])	<<24;

	TInt i = KCbwDataTransferLengthOffset;

	TUint hostDataLength = 	static_cast<TUint32>(iCbwBufPtr[i  ])		|

							static_cast<TUint32>(iCbwBufPtr[i+1]) <<8 	|

							static_cast<TUint32>(iCbwBufPtr[i+2]) <<16	|

							static_cast<TUint32>(iCbwBufPtr[i+3]) <<24;

	TBool dataToHost = iCbwBufPtr[KCbwFlagOffset] & 0x80;

	__PRINT4(_L("lun =%d, hostDataLength=%d, CBWtag = 0x%x, dataToHost=%d\n"), lun, hostDataLength, iCbwTag, dataToHost);

	//////////////////////////////////////////////

	TBool ret = iProtocol->DecodePacket(aData, lun);

	//////////////////////////////////////////////

	ExpireData((TAny*) (iCbwBufPtr.Ptr()));

	iStallAllowed = ETrue;

	if (!ret)

		{

		__PRINT(_L("Command Failed\n"));

		iCmdStatus = ECommandFailed;

		}

	else

		{

		__PRINT(_L("Command Passed\n"));

		iCmdStatus = ECommandPassed;

		}

	if (hostDataLength)    // Host  expected data transfer

		{

		if (dataToHost)  // send data to host

			{

			if (!iWriteSetUp) //write buffer was not set up

				{

				__PRINT(_L("Write buffer was not setup\n"));