/*

* Copyright (c) 1997-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:

*

*/

#include "CdcAcmClass.h"

#include "CdcControlInterface.h"

#include "CdcDataInterface.h"

#include "AcmPanic.h"

#include "AcmUtils.h"

#include "HostPushedChangeObserver.h"

#include "BreakController.h"

#include <usb/usblogger.h>

#ifdef __FLOG_ACTIVE

_LIT8(KLogComponent, "ECACM");

#endif

CCdcAcmClass::CCdcAcmClass()

/**

 * Constructor.

 */

	{

	SetDefaultAcm();

	}

CCdcAcmClass* CCdcAcmClass::NewL(const TUint8 aProtocolNum, const TDesC16& aAcmControlIfcName, const TDesC16& aAcmDataIfcName)

/**

 * Create a new CCdcAcmClass object

 *

 * @return Ownership of a new CCdcAcmClass object

 */

	{

	LOG_STATIC_FUNC_ENTRY

	CCdcAcmClass* self = new(ELeave) CCdcAcmClass;

	CleanupStack::PushL(self);

	self->ConstructL(aProtocolNum, aAcmControlIfcName, aAcmDataIfcName);

	CLEANUPSTACK_POP(self);

	return self;

	}

void CCdcAcmClass::ConstructL(const TUint8 aProtocolNum, const TDesC16& aControlIfcName, const TDesC16& aDataIfcName)

/**

 * 2nd-phase construction. Creates both the control and data objects.

 * @param aProtocolNum contains the Table 17 protocol number.

 * @param aControlIfcName contains the interface name

 * @param aDataIfcName contains the interface name

 */

	{

	TUint8 interfaceNumber;

	TInt res;

	LOGTEXT(_L8("\tabout to create control interface with name"));

	iControl = CCdcControlInterface::NewL(*this, aProtocolNum, aControlIfcName);

	LOGTEXT(_L8("\tabout to create data interface with name"));

	iData = CCdcDataInterface::NewL(aDataIfcName);

	iBreakController = CBreakController::NewL(*this);

	LOGTEXT(_L8("\tabout to call GetInterfaceNumber"));

	res = iData->GetInterfaceNumber(interfaceNumber);

	if ( res )

		{

		LOGTEXT2(_L8("\tGetInterfaceNumber=%d"), res);

		LEAVEIFERRORL(res);

		}

	LOGTEXT(_L8("\tabout to call SetupClassSpecificDescriptor"));

	res = iControl->SetupClassSpecificDescriptor(interfaceNumber);

	if ( res )

		{

		LOGTEXT2(_L8("\tSetupClassSpecificDescriptor=%d"), res);

		LEAVEIFERRORL(res);

		}

	}

CCdcAcmClass::~CCdcAcmClass()

/**

 * Destructor.

 */

	{

	LOG_FUNC

	delete iControl;

	delete iData;

	delete iBreakController;

	}

void CCdcAcmClass::SetCallback(MHostPushedChangeObserver* aCallback)

/**

 * Set the ACM class callback object. This cannot be done at construction 

 * because the ACM class and the port have different lifetimes.

 */

	{

	LOGTEXT2(_L8(">>CCdcAcmClass::SetCallback aCallback=0x%08x"), aCallback);

	iCallback = aCallback;

	// remember that this function can also be called to

	// unset the callback when it is given a NULL pointer

	if ( iCallback )

		{

		// send off whatever has been seen from Host

		// requests to change the line coding

		TCommConfigV01 epocConfig;

		ConvertUsbConfigCodingToEpoc(iUsbConfig,epocConfig);

		iCallback->HostConfigChange(epocConfig);

		// send off whatever has been seen from Host

		// requests to set the control line state

		iCallback->HostSignalChange(iDtrState,iRtsState);

		}

	LOGTEXT(_L8("<<CCdcAcmClass::SetCallback"));

	}

void CCdcAcmClass::SetBreakCallback(MBreakObserver* aBreakCallback)

/**

 * Set the observer for break events. This cannot be done at construction 

 * because the ACM class and the port have different lifetimes.

 */

	{

	LOGTEXT2(_L8(">>CCdcAcmClass::SetBreakCallback aBreakCallback=0x%08x"), 

		aBreakCallback);

	iBreakCallback = aBreakCallback;

	LOGTEXT(_L8("<<CCdcAcmClass::SetBreakCallback"));

	}

void CCdcAcmClass::ReadOneOrMore(MReadOneOrMoreObserver& aObserver, TDes8& aDes)

/**

 * Read from the bus a specified amount but complete if any data arrives.

 *

 * @param aObserver The observer to notify completion to.

 * @param aDes Descriptor to read into

 */

	{

	LOGTEXT2(_L8(">>CCdcAcmClass::ReadOneOrMore aObserver=0x%08x"), 

		&aObserver);

	ReadOneOrMore(aObserver, aDes, aDes.Length());

	LOGTEXT(_L8("<<CCdcAcmClass::ReadOneOrMore"));

	}

void CCdcAcmClass::ReadOneOrMore(MReadOneOrMoreObserver& aObserver, 

								 TDes8& aDes, 

								 TInt aLength)

/**

 * Read from the bus a specified amount but complete if any data arrives.

 *

 * @param aObserver The observer to notify completion to.

 * @param aDes Descriptor to read into

 * @param aLength Amount of data to read

 */

	{

	LOGTEXT3(_L8(">>CCdcAcmClass::ReadOneOrMore aObserver=0x%08x, "

		"aLength=%d"), 

			&aObserver, aLength);

	__ASSERT_DEBUG(iData, _USB_PANIC(KAcmPanicCat, EPanicInternalError));

	iData->ReadOneOrMore(aObserver, aDes, aLength);

	LOGTEXT(_L8("<<CCdcAcmClass::ReadOneOrMore"));

	}

void CCdcAcmClass::Read(MReadObserver& aObserver, TDes8& aDes)

/**

 * Read from the bus

 *

 * @param aObserver The observer to notify completion to.

 * @param aDes Descriptor to read into.

 */

	{

	LOGTEXT2(_L8(">>CCdcAcmClass::Read aObserver=0x%08x"), &aObserver);

	Read(aObserver, aDes, aDes.Length());

	LOGTEXT(_L8("<<CCdcAcmClass::Read"));

	}

void CCdcAcmClass::Read(MReadObserver& aObserver, TDes8& aDes, TInt aLength)

/**

 * Read from the bus a specified amount.

 *

 * @param aObserver The observer to notify completion to.

 * @param aDes Descriptor to read into.

 * @param aLength Amount of data to read.

 */

	{

	LOGTEXT3(_L8(">>CCdcAcmClass::Read aObserver=0x%08x, aLength=%d"), 

		&aObserver, aLength);

	__ASSERT_DEBUG(iData, _USB_PANIC(KAcmPanicCat, EPanicInternalError));

	iData->Read(aObserver, aDes, aLength);

	LOGTEXT(_L8("<<CCdcAcmClass::Read"));

	}

void CCdcAcmClass::ReadCancel()

/**

 * Cancel a read request.

 */

	{

	LOG_FUNC

	__ASSERT_DEBUG(iData, _USB_PANIC(KAcmPanicCat, EPanicInternalError));

	iData->CancelRead();

	}

void CCdcAcmClass::Write(MWriteObserver& aObserver, const TDesC8& aDes)

/**

 * Write to the bus.

 *

 * @param aObserver The observer to notify completion to.

 * @param aDes Descriptor containing the data to be written.

 */

	{

	LOGTEXT2(_L8(">>CCdcAcmClass::Write aObserver=0x%08x"), 

		&aObserver);

	Write(aObserver, aDes, aDes.Length());

	LOGTEXT(_L8("<<CCdcAcmClass::Write"));

	}

void CCdcAcmClass::Write(MWriteObserver& aObserver, 

						 const TDesC8& aDes, 

						 TInt aLength)

/**

 * Write to the bus the specified ammount.

 *

 * @param aObserver The observer to notify completion to.

 * @param aDes Descriptor containing the data to be written.

 * @param aLength The amount of data to write.

 */

	{

	LOGTEXT3(_L8(">>CCdcAcmClass::Write aObserver=0x%08x, aLength=%d"), 

		&aObserver, aLength);

	__ASSERT_DEBUG(iData, _USB_PANIC(KAcmPanicCat, EPanicInternalError));

	iData->Write(aObserver, aDes, aLength);

	LOGTEXT(_L8("<<CCdcAcmClass::Write"));

	}

void CCdcAcmClass::WriteCancel()

/**

 * Cancel the write request.

 */

	{

	LOG_FUNC

	__ASSERT_DEBUG(iData, _USB_PANIC(KAcmPanicCat, EPanicInternalError));

	iData->CancelWrite();

	}

TInt CCdcAcmClass::HandleGetCommFeature(const TUint16 aSelector, 

										TDes8& aReturnData)

/**

 * Callback for Get Comm Feature requests.

 *

 * @param aSelector Multiplex control for the feature is held in wValue field

 * @param aReturnData Descriptor containing the multiplexed and idle state of 

 *					the ACM device or the country code from ISO 3166.

 */

	{

	LOGTEXT2(_L8(">>CCdcAcmClass::HandleGetCommFeature aSelector=%d"), 

		aSelector); 

	TInt ret = KErrNone;

	// check the feature selector from the header and reject if invalid,

	// otherwise deal with it.

	switch ( aSelector )

		{

	case EUsbCommFeatureSelectAbstractState:

		{

		aReturnData.SetLength(2);

		TUint8* pbuffer;

		TUint8** ppbuffer;

		pbuffer = &aReturnData[0];

		ppbuffer = &pbuffer;

		CCdcControlInterface::PutU16(ppbuffer,iAcmState);

		LOGTEXT2(_L8("\tAbstract State [0x%04X]"), iAcmState);

		}

		break;

	case EUsbCommFeatureSelectCountryCode:

		{

#if defined(DISABLE_ACM_CF_COUNTRY_SETTING)

		aReturnData.SetLength(0);

		LOGTEXT(_L8("\tCountry Code Not Supported"));

		ret = KErrNotSupported;

#elif defined(ENABLE_ACM_CF_COUNTRY_SETTING)

		aReturnData.SetLength(2);

		TUint8* pbuffer;

		TUint8** ppbuffer;

		pbuffer = &aReturnData[0];

		ppbuffer = &pbuffer;

		CCdcControlInterface::PutU16(ppbuffer,iCountryCode);

		LOGTEXT2(_L8("\tCountry Code [0x%04X]"), iCountryCode);

#endif

		}

		break;

	default:

		aReturnData.SetLength(0);

		LOGTEXT(_L8("\tBad Selector"));

		ret = KErrUnknown;

		}

	LOGTEXT2(_L8("<<CCdcAcmClass::HandleGetCommFeature ret=%d"), ret); 

	return ret;

	}

TInt CCdcAcmClass::HandleClearCommFeature(const TUint16 aSelector)

/**

 * Callback for Clear Comm Feature requests

 * @param aSelector Multiplex control for the feature is held in wValue field

 */

	{

	LOGTEXT2(_L8(">>CCdcAcmClass::HandleClearCommFeature aSelector=%d"), 

		aSelector);

	TInt ret = KErrNone;

	// check the feature selector from the header and reject if invalid,

	// otherwise deal with it.

	switch ( aSelector )

		{

	case EUsbCommFeatureSelectAbstractState:

		{

		// reset to guaranteed-success default, so ignore return value

		static_cast<void>(HandleNewAbstractState(EUsbAbstractStateDataMultiplex));

		LOGTEXT2(_L8("\tAbstract State [0x%04X]"), iAcmState);

		}

		break;

	case EUsbCommFeatureSelectCountryCode:

		{

#if defined(DISABLE_ACM_CF_COUNTRY_SETTING)

		LOGTEXT(_L8("\tCountry Code Not Supported"));

		ret = KErrNotSupported;

#elif defined(ENABLE_ACM_CF_COUNTRY_SETTING)

		HandleNewCountryCode(KUsbCommCountryCode0);

		LOGTEXT2(_L8("\tCountry Code [0x%04X]"), iCountryCode);

#endif

		}

		break;

	default:

		{

		LOGTEXT(_L8("\tBad Selector"));

		ret = KErrUnknown;

		}

		}

	LOGTEXT2(_L8("<<CCdcAcmClass::HandleClearCommFeature ret=%d"), ret);

	return ret;

	}

TInt CCdcAcmClass::HandleSetLineCoding(const TDesC8& aData)

/**

 * Callback for Set Line Coding requests.

 * This function extracts the parameters from the host packet, stores them 

 * locally, then converts them to an EPOC format and passes them up to the CSY 

 * class.

 * Note that we are intentionally keeping two copies of the settings in the 

 * CSY: the "host pushed" settings and the "client pushed" settings.  Since 

 * the EPOC machine is a "device" rather than a "host", it can't push 

 * configuration changes to the host. We are therefore propagating host-pushed 

 * configuration changes to the C32 client, but not propagating C32 client 

 * configuration requests back to the host.

 * 

 * @param aData Descriptor containing the new data rate, stop bits, parity and 

 * data bit settings.

 */

	{

	LOG_FUNC

	if (aData.Length() != 7) // TODO: magic number?

		{

		LOGTEXT(_L8("\t***buffer too small"));

		return KErrGeneral;

		}

	TUint8*  pbuffer;

	TUint8** ppbuffer;

	pbuffer = const_cast<TUint8*>(&aData[0]);

	ppbuffer = &pbuffer;

	iUsbConfig.iRate	 =				  CCdcControlInterface::GetU32(ppbuffer);

	iUsbConfig.iStopBits = static_cast<TUsbStopBits>(CCdcControlInterface::GetU08(ppbuffer));

	iUsbConfig.iParity	 = static_cast<TUsbParity>(CCdcControlInterface::GetU08(ppbuffer));

	iUsbConfig.iDataBits = static_cast<TUsbDataBits>(CCdcControlInterface::GetU08(ppbuffer));

	if ( iCallback )

		{

		TCommConfigV01 epocConfig;

		ConvertUsbConfigCodingToEpoc(iUsbConfig, epocConfig);

		iCallback->HostConfigChange(epocConfig);

		}

	return KErrNone;

	}

void CCdcAcmClass::SetDefaultAcm()

/**

 * Reset the data fields to a set of known default values. Will be used when 

 * we implement restart, which involves a host re-enumeration without 

 * destroying the ACM class, so we need a function to reset the ACM to 

 * defaults.

 */

	{

	iUsbConfig.iRate	 = 115200;

	iUsbConfig.iStopBits = EUsbStopBitOne;

	iUsbConfig.iParity	 = EUsbParityNone;

	iUsbConfig.iDataBits = EUsbDataBitsEight;

	iAcmState	 = EUsbAbstractStateDataMultiplex;

	iCountryCode = 0x2A2A;	// 0x2A2A is "**"- just an invalid code

	iAcmDataMultiplex = (iAcmState & EUsbAbstractStateDataMultiplex) 

		? ETrue : EFalse;

	iAcmIdleSetting   = (iAcmState & EUsbAbstractStateIdleSetting) 

		? ETrue : EFalse;

	iRtsState = EFalse;

	iDtrState = EFalse;

	iRingState = EFalse;

	iDsrState  = EFalse;

	iDcdState  = EFalse;

	iBreakActive = EFalse;

	}

void CCdcAcmClass::ConvertUsbConfigCodingToEpoc(const TUsbConfig& aUsbConfig, 

								  TCommConfigV01& aEpocConfig)

/**

 * Convert configuration information received from a Host in "USB" format to 

 * the native "EPOC" configuration format.

 *

 * @param aUsbConfig	The USB configuration to be converted from.

 * @param aEpocConfig	The EPOC configuration to be converted to.

 */

	{

	switch ( aUsbConfig.iDataBits )

		{

	case EUsbDataBitsFive:

		aEpocConfig.iDataBits = EData5;

		break;

	case EUsbDataBitsSix:

		aEpocConfig.iDataBits = EData6;

		break;

	case EUsbDataBitsSeven:

		aEpocConfig.iDataBits = EData7;

		break;

	case EUsbDataBitsEight:

		aEpocConfig.iDataBits = EData8;

		break;

	// EPOC doesn't support this, so map it to "8" for the time being...

	case EUsbDataBitsSixteen:		

		aEpocConfig.iDataBits = EData8;

		break;

	// Map any other signals to "8"...

	default:						

		aEpocConfig.iDataBits = EData8;

		break;

		}

	switch ( aUsbConfig.iStopBits )

		{

	case EUsbStopBitOne:

		aEpocConfig.iStopBits = EStop1;

		break;

	// EPOC doesn't have any "1.5" setting, so go for "1".

	case EUsbStopBitOnePtFive:		

		aEpocConfig.iStopBits = EStop1;

		break;

	case EUsbStopBitTwo:

		aEpocConfig.iStopBits = EStop2;

		break;

	// Map any other signals to "1"...

	default:						

		aEpocConfig.iStopBits = EStop1;

		break;

		}