// Copyright (c) 2008-2010 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 <e32base.h>

#include "debug.h"

#include "msdebug.h"

#include "msctypes.h"

#include "shared.h"

#include "msgservice.h"

#include "mtransport.h"

#include "mprotocol.h"

#include "tscsiclientreq.h"

#include "tscsiprimarycmds.h"

#include "tscsiblockcmds.h"

#include "mblocktransferprotocol.h"

#include "tblocktransfer.h"

#include "tsbcclientinterface.h"

#include "tspcclientinterface.h"

#include "cmassstoragefsm.h"

#include "cscsiprotocol.h"

#include "usbmshostpanic.h"

/**

Create the CScsiProtocol object.

@param aLun The LUN for the device represented by this object

@param aTransport The transport interface

@param aStatusPollingInterval The polling interval

@return CScsiProtocol* A reference to the

*/

CScsiProtocol* CScsiProtocol::NewL(TLun aLun, MTransport& aTransport)

    {

	__MSFNSLOG

	CScsiProtocol* r = new (ELeave) CScsiProtocol(aTransport);

	CleanupStack::PushL(r);

	r->ConstructL(aLun);

	CleanupStack::Pop();

	return r;

    }

void CScsiProtocol::ConstructL(TLun aLun)

    {

	__MSFNLOG

	// iState = EEntry;

    iFsm = CMassStorageFsm::NewL(*this);

    const TInt blockLength = 0x200;

    iHeadbuf.CreateL(blockLength);

    iTailbuf.CreateL(blockLength);

    }

CScsiProtocol::CScsiProtocol(MTransport& aTransport)

:   iSpcInterface(aTransport),

    iSbcInterface(NULL)

    {

	__MSFNLOG

    }

CScsiProtocol::~CScsiProtocol()

    {

	__MSFNLOG

    delete iFsm;

    iHeadbuf.Close();

    iTailbuf.Close();

    delete iSbcInterface;

    }

void CScsiProtocol::InitialiseUnitL()

    {

	__MSFNLOG

    iState = EDisconnected;

	// A device may take time to mount the media. If the device fails attempt to

	// retry the connection for a number of seconds

    TInt retryCounter = 20;

    do

        {

        retryCounter--;

        TInt err = iFsm->ConnectLogicalUnitL();

        if (err == KErrNotSupported)

            {

            break;

            }

        if (iFsm->IsConnected())

            {

            iState = EConnected;

            break;

            }

        User::After(1000 * 200);    // 200 mS

        }

    while (retryCounter);

	}

void CScsiProtocol::UninitialiseUnitL()

    {

	__MSFNLOG

    iFsm->DisconnectLogicalUnitL();

    }

TBool CScsiProtocol::IsConnected()

    {

	__MSFNLOG

	return (iState == EConnected)? ETrue : EFalse;

    }

void CScsiProtocol::ReadL(TPos aPos,

                          TDes8& aBuf,

                          TInt aLength)

    {

	__MSFNLOG

    if (!iSbcInterface)

        User::Leave(KErrNotSupported);

    if(!IsConnected())

		User::Leave(KErrNotReady);

    iSbcInterface->iBlockTransfer.ReadL(*this, aPos, aLength, aBuf);

    }

void CScsiProtocol::BlockReadL(TPos aPos, TDes8& aCopybuf, TInt aLen)

    {

	__MSFNLOG

    if (!iSbcInterface)

        User::Leave(KErrNotSupported);

	__ASSERT_DEBUG(aPos % iSbcInterface->iBlockTransfer.BlockLength() == 0,

                   User::Panic(KUsbMsHostPanicCat, EBlockDevice));

    const TInt blockLen = iSbcInterface->iBlockTransfer.BlockLength();

    TInt len = aLen;

    TInt64 lba = aPos / static_cast<TInt64>(blockLen);

    if (I64HIGH(lba))

        {

        User::LeaveIfError(KErrOverflow);

        }

	TInt err = iSbcInterface->Read10L(I64LOW(lba), aCopybuf, len);

    if (err)

        {

        __SCSIPRINT1(_L("READ(10) Err=%d"), err);

        User::LeaveIfError(DoCheckConditionL());

        }

    // handle residue

    while (len != aLen)

        {

        __SCSIPRINT2(_L("SCSI Read Residue 0x%x bytes read (0x%x)"), len, aLen);

        __SCSIPRINT2(_L("Pos=0x%lx Len=0x%x"), aPos, aLen);

        // read next block

        // full blocks read in bytes

        TInt bytesRead = len/blockLen * blockLen;

        aPos += bytesRead;

        aLen -= bytesRead;

        len = aLen;

        __SCSIPRINT3(_L("New Pos=0x%lx Len=0x%x (bytes read = %x)"),

                     aPos, aLen, bytesRead);

        aCopybuf.SetLength(bytesRead);

        // read rest of the block

        TInt err = iSbcInterface->Read10L(aPos/blockLen, aCopybuf, len);

        if (err)

            {

            User::LeaveIfError(DoCheckConditionL());

            }

        }

    }

void CScsiProtocol::WriteL(TPos aPosition,

                           TDesC8& aBuf,

                           TInt aLength)

    {

	__MSFNLOG

    if (!iSbcInterface)

        User::Leave(KErrNotSupported);

    if(!IsConnected())

		User::Leave(KErrNotReady);

    iSbcInterface->iBlockTransfer.WriteL(*this, aPosition, aLength, aBuf);

    }

void CScsiProtocol::BlockWriteL(TPos aPos, TDesC8& aCopybuf, TUint aOffset, TInt aLen)

    {

	__MSFNLOG

    if (!iSbcInterface)

        User::Leave(KErrNotSupported);

	__ASSERT_DEBUG(aPos % iSbcInterface->iBlockTransfer.BlockLength() == 0,

                   User::Panic(KUsbMsHostPanicCat, EBlockDevice));

    const TInt blockLen = iSbcInterface->iBlockTransfer.BlockLength();

    TInt len = aLen;

	TInt err = iSbcInterface->Write10L(aPos/blockLen, aCopybuf, aOffset, len);

    if (err)

        {

        User::LeaveIfError(DoCheckConditionL());

        }

    while (len != aLen)

        {

        // handle residue

        __SCSIPRINT2(_L("SCSI Write Residue 0x%x bytes read (0x%x)"), len, aLen);

        __SCSIPRINT2(_L("Pos=0x%lx Len=0x%x"), aPos, aLen);

        // write next block

        // full blocks written in bytes

        TInt bytesWritten = len/blockLen * blockLen;

        aPos += bytesWritten;

        aLen -= bytesWritten;

        len = aLen;

        __SCSIPRINT2(_L("New Pos=0x%lx Len=0x%x"), aPos, aLen);

        TPtrC8 buf = aCopybuf.Mid(bytesWritten);

        // write rest of the block

        TInt err = iSbcInterface->Write10L(aPos/blockLen, buf, aOffset, len);

        if (err)

            {

            User::LeaveIfError(DoCheckConditionL());

            }

        }

    }

void CScsiProtocol::GetCapacityL(TCapsInfo& aCapsInfo)

    {

	__MSFNLOG

    if (!IsConnected())

        {

        if (!DoScsiReadyCheckEventL())

            return;

        }

    if (!iSbcInterface)

        {

        aCapsInfo.iMediaType = EMediaCdRom;

        aCapsInfo.iNumberOfBlocks = 0;

        aCapsInfo.iBlockLength = 0;

        aCapsInfo.iWriteProtect = ETrue;

        return;

        }

    aCapsInfo.iMediaType = EMediaHardDisk;

	TLba lastLba;

	TUint32 blockLength;

    // Retry ReadCapacity10L if stalled

    TInt stallCounter = 4;

    TInt err = KErrNone;

    do

        {

        err = iSbcInterface->ReadCapacity10L(lastLba, blockLength);

        } while (err == KErrCommandStalled && stallCounter-- > 0);

    if (err)

        {

        // DoCheckConditionL clears sense error

        // Media not present will return KErrNotReady so leave here

        User::LeaveIfError(DoCheckConditionL());

        }

    // update iWriteProtect

    err = MsModeSense10L();

    if (err)

        {

        if (err == KErrCommandFailed)

            {

            // Clear sense error

            err = DoCheckConditionL();

            // ignore error if unsupported

            if (err != KErrUnknown)

                {

                User::LeaveIfError(err);

                }

            }

        err = MsModeSense6L();

        if (err == KErrCommandFailed)

            {

            // Clear sense error

            err = DoCheckConditionL();

            // ignore error if unsupported

            if (err != KErrUnknown)

                {

                User::LeaveIfError(err);

                }

            }           

        }

    aCapsInfo.iNumberOfBlocks = lastLba + 1;

    aCapsInfo.iBlockLength = blockLength;

    aCapsInfo.iWriteProtect = iWriteProtect;

	__SCSIPRINT3(_L("numBlock = x%x , blockLength = %x wp = %d"),

                 lastLba + 1, blockLength, iWriteProtect);

    }

/**

Perform SCSI INQUIRY command. The function leaves if the device response is not

compliant with the protocol standard.

@return TInt KErrNone if successful otherwise KErrCommandFailed to indicate a

device status error

*/

TInt CScsiProtocol::MsInquiryL()

    {

	__MSFNLOG

    ResetSbc();

   /**

    INQUIRY

   */

   /**

    SPC states

    - the INQUIRY data should be returned even though the device server is not

      ready for other commands.

    - If the standard INQUIRY data changes for any reason, the device server

      shall generate a unit attention condition

   */

    TPeripheralInfo info;

    TInt err = iSpcInterface.InquiryL(info);

    if (err)

        {

        // KErrCommandFailed

        return err;

        }

    // print reponse

    __TESTREPORT1(_L("RMB = %d"), info.iRemovable);

    __TESTREPORT2(_L("PERIPHERAL DEVICE TYPE = %d PQ = %d"),

                 info.iPeripheralDeviceType,

                 info.iPeripheralQualifier);

    __TESTREPORT1(_L("VERSION = %d"), info.iVersion);

    __TESTREPORT1(_L("RESPONSE DATA FORMAT = %d"), info.iResponseDataFormat);

    __TESTREPORT3(_L("VENDOR ID %S PRODUCT ID %S REV %S"),

                 &info.iIdentification.iVendorId,

                 &info.iIdentification.iProductId,

                 &info.iIdentification.iProductRev);

    if (info.iPeripheralQualifier != 0 && info.iPeripheralQualifier != 1)

        {

        __HOSTPRINT(_L("Peripheral Qualifier[Unknown device type]"))

        err = KErrUnknown;

        }

    else if (info.iPeripheralDeviceType == 0)

        {

        // SCSI SBC Direct access device

        iRemovableMedia = info.iRemovable;

        // SCSI Block device

        iSbcInterface = new (ELeave) TSbcClientInterface(iSpcInterface.Transport());

        iSbcInterface->InitBuffers(&iHeadbuf, &iTailbuf);

        err = KErrNone;

        }

    else if (info.iPeripheralDeviceType == 5)

        {

        // SCSI MMC-2 CD-ROM device

        __HOSTPRINT(_L("Peripheral Device Type[CD-ROM]"))

        iRemovableMedia = info.iRemovable;

        // MMC-2 is not supported. A SCSI interface call will return 

        // KErrNotSupported. If SCSI support is extended in future then

        // TSbcInterface class should be replaced with a proper interface class.

        iSbcInterface = NULL;

        err = KErrNone;

        }

    else

        {

        __HOSTPRINT(_L("Peripheral Device Type[Unsupported device type]"))

        err = KErrUnknown;    

        }

    return err;

    }

/**

Perform SCSI TEST UNIT READY command. The function leaves if the device response

is not compliant with the protocol standard.

@return TInt KErrNone if successful or otherwise KErrCommandFailed to indicate a

device status error

*/

TInt CScsiProtocol::MsTestUnitReadyL()

    {

	__MSFNLOG

    /* TestUnitReady */

    return iSpcInterface.TestUnitReadyL();

    }

/**

Perform SCSI READ CAPACITY (10) command. The function leaves if the device

response is not compliant with the protocol standard.

Before a block device can be read or written the media's capacity (LAST LBA and

BLOCK SIZE) must be obtained. This function is used to initialise TBlockTransfer

with the capacity parameters via TSbcInterface::ReadCapcaityL().

@return TInt KErrNone if successful, KErrCommandFailed to indicate a

device status error, KErrCommandStalled to indicate a device stall

*/

TInt CScsiProtocol::MsReadCapacityL()

    {

	__MSFNLOG

    if (!iSbcInterface)

        {

        User::Leave(KErrNotSupported);

        }

    // READ CAPACITY

    TUint32 blockSize;

    TUint32 lastLba;

    TInt err = iSbcInterface->ReadCapacity10L(lastLba, blockSize);

    __TESTREPORT2(_L("CAPACITY: Block Size=0x%x Last LBA=0x%x"), blockSize, lastLba);

    return err;

    }

/**

Perform MODE SENSE (10) command. The function leaves if the device response is

not compliant with the protocol standard.

@return TInt KErrNone if successful, KErrCommandFailed to indicate a

device status error, KErrCommandStalled to indicate a device stall

*/

TInt CScsiProtocol::MsModeSense10L()

    {

	__MSFNLOG

    if (!iSbcInterface)

        User::Leave(KErrNotSupported);

    TBool writeProtected;

    TInt err = iSbcInterface->ModeSense10L(TSbcClientInterface::EReturnAllModePages, writeProtected);

    if (!err)

        {

        iWriteProtect = writeProtected;

        }

    return err;

    }

/**

Perform SCSI MODE SENSE (6) command. The function leaves if the device response

is not compliant with the protocol standard.

@return TInt KErrNone if successful, KErrCommandFailed to indicate a

device status error, KErrCommandStalled to indicate a device stall

*/

TInt CScsiProtocol::MsModeSense6L()

    {

	__MSFNLOG

    if (!iSbcInterface)

        User::Leave(KErrNotSupported);

    TBool writeProtected;

    TInt err = iSbcInterface->ModeSense6L(TSbcClientInterface::EReturnAllModePages, writeProtected);

    if (!err)

        {

        iWriteProtect = writeProtected;

        }

    return err;

    }

/**

Perform SCSI START STOP UNIT command. The function leaves if the device response

is not compliant with the protocol standard.

@return TInt KErrNone if successful otherwise KErrCommandFailed to indicate a

device status error

*/

TInt CScsiProtocol::MsStartStopUnitL(TBool aStart)