/*

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

* Implements the main object of Usbman that manages all the USB Classes

* and the USB Logical Device (via CUsbDeviceStateWatcher).

*

*/

/**

 @file

*/

#include "CUsbDevice.h"

#include "CUsbDeviceStateWatcher.h"

#include <cusbclasscontrolleriterator.h>

#include "MUsbDeviceNotify.h"

#include "UsbSettings.h"

#include "CUsbServer.h"

#include <cusbclasscontrollerbase.h>

#include <cusbclasscontrollerplugin.h>

#include "UsbUtils.h"

#include <cusbmanextensionplugin.h>

#ifdef USE_DUMMY_CLASS_CONTROLLER

#include "CUsbDummyClassController.h"

#endif

#include <bafl/sysutil.h>

#include <usb/usblogger.h>

#include <e32svr.h>

#include <e32base.h>

#include <e32std.h>

#include <usbman.rsg>

#include <f32file.h>

#include <barsc.h>

#include <barsread.h>

#include <bautils.h>

#include <e32property.h> //Publish & Subscribe header

#include "CPersonality.h"

_LIT(KUsbLDDName, "eusbc"); //Name used in call to User::LoadLogicalDevice

_LIT(KUsbLDDFreeName, "Usbc"); //Name used in call to User::FreeLogicalDevice

#ifdef __FLOG_ACTIVE

_LIT8(KLogComponent, "USBSVR");

#endif

// Panic category only used in debug builds

#ifdef _DEBUG

_LIT(KUsbDevicePanicCategory, "UsbDevice");

#endif

/**

 * Panic codes for the USB Device Class

 */

enum TUsbDevicePanic

	{

	/** Class called while in an illegal state */

	EBadAsynchronousCall = 0,

	EConfigurationError,

	EResourceFileNotFound,

	/** ConvertUidsL called with an array that is not empty */

	EUidArrayNotEmpty,

	};

CUsbDevice* CUsbDevice::NewL(CUsbServer& aUsbServer)

/**

 * Constructs a CUsbDevice object.

 *

 * @return	A new CUsbDevice object

 */

	{

	LOG_STATIC_FUNC_ENTRY

	CUsbDevice* r = new (ELeave) CUsbDevice(aUsbServer);

	CleanupStack::PushL(r);

	r->ConstructL();

	CleanupStack::Pop(r);

	return r;

	}

CUsbDevice::~CUsbDevice()

/**

 * Destructor.

 */

	{

	LOG_FUNC

	// Cancel any outstanding asynchronous operation.

	Cancel();

	delete iUsbClassControllerIterator;

	iSupportedClasses.ResetAndDestroy();

	iSupportedPersonalities.ResetAndDestroy();

	iSupportedClassUids.Close();

	iExtensionPlugins.ResetAndDestroy();

	if(iEcom)

		iEcom->Close();

	REComSession::FinalClose();

	// Free any memory allocated to the list of observers. Note that

	// we don't want to call ResetAndDestroy, because we don't own

	// the observers themselves.

	iObservers.Reset();

#ifndef __WINS__

	LOGTEXT2(_L8("about to delete device state watcher @ %08x"), (TUint32) iDeviceStateWatcher);

	delete iDeviceStateWatcher;

	LOGTEXT(_L8("deleted device state watcher"));

	iLdd.Close();

	LOGTEXT(_L8("Freeing logical device"));

	TInt err = User::FreeLogicalDevice(KUsbLDDFreeName);

	//Putting the LOGTEXT2 inside the if statement prevents a compiler

	//warning about err being unused in UREL builds.

	if(err)

		{

		LOGTEXT2(_L8("     User::FreeLogicalDevice returned %d"),err);

		}

#endif	

	delete iDefaultSerialNumber;

	}

CUsbDevice::CUsbDevice(CUsbServer& aUsbServer)

	: CActive(EPriorityStandard)

	, iDeviceState(EUsbDeviceStateUndefined)

	, iServiceState(EUsbServiceIdle)

	, iUsbServer(aUsbServer)

	, iPersonalityCfged(EFalse)

/**

 * Constructor.

 */

	{

	CActiveScheduler::Add(this);

	}

void CUsbDevice::ConstructL()

/**

 * Performs 2nd phase construction of the USB device.

 */

	{

	LOG_FUNC

	iEcom = &(REComSession::OpenL());

	iUsbClassControllerIterator = new(ELeave) CUsbClassControllerIterator(iSupportedClasses);

#ifndef __WINS__

	LOGTEXT(_L8("About to load LDD"));

	TInt err = User::LoadLogicalDevice(KUsbLDDName);

	if (err != KErrNone && err != KErrAlreadyExists)

		{

		LEAVEL(err);

		}

	LOGTEXT(_L8("About to open LDD"));

	LEAVEIFERRORL(iLdd.Open(0));

	LOGTEXT(_L8("LDD opened"));

	// hide bus from host while interfaces are being set up

	iLdd.DeviceDisconnectFromHost();

	// Does the USC support cable detection while powered off? If no, then 

	// call PowerUpUdc when RUsb::Start finishes, as is obvious. If yes, we 

	// delay calling PowerUpUdc until both the service state is 'started' and 

	// the device state is not undefined. This is to save power in the UDC 

	// when there's no point it being powered.

	TUsbDeviceCaps devCapsBuf;

	LEAVEIFERRORL(iLdd.DeviceCaps(devCapsBuf));

	if ( devCapsBuf().iFeatureWord1 & KUsbDevCapsFeatureWord1_CableDetectWithoutPower )

		{

		LOGTEXT(_L8("\tUDC supports cable detect when unpowered"));

		iUdcSupportsCableDetectWhenUnpowered = ETrue;

		}

	else

		{

		LOGTEXT(_L8("\tUDC does not support cable detect when unpowered"));

		}

	TUsbcDeviceState deviceState;

	LEAVEIFERRORL(iLdd.DeviceStatus(deviceState));

	SetDeviceState(deviceState);

	LOGTEXT(_L8("Got device state"));

	iDeviceStateWatcher = CUsbDeviceStateWatcher::NewL(*this, iLdd);

	iDeviceStateWatcher->Start();

	// Get hold of the default serial number in the driver

	// This is so it can be put back in place when a device that sets a

	// different serial number (through the P&S key) is stopped

	iDefaultSerialNumber = HBufC16::NewL(KUsbStringDescStringMaxSize);

	TPtr16 serNum = iDefaultSerialNumber->Des();

	err = iLdd.GetSerialNumberStringDescriptor(serNum);

	if (err == KErrNotFound)

		{

		delete iDefaultSerialNumber;

		iDefaultSerialNumber = NULL;

		LOGTEXT(_L8("No default serial number"));

		}

	else

		{

		LEAVEIFERRORL(err);

#ifdef __FLOG_ACTIVE

		TBuf8<KUsbStringDescStringMaxSize> narrowString;

		narrowString.Copy(serNum);

		LOGTEXT2(_L8("Got default serial number %S"), &narrowString);

#endif //__FLOG_ACTIVE		

		}

	LOGTEXT(_L8("UsbDevice::ConstructL() finished"));

#endif

#ifndef __OVER_DUMMYUSBDI__

	InstantiateExtensionPluginsL();

#endif

	}

void CUsbDevice::InstantiateExtensionPluginsL()

	{

	LOGTEXT(_L8(">>CUsbDevice::InstantiateExtensionPluginsL"));

	const TUid KUidExtensionPluginInterface = TUid::Uid(KUsbmanExtensionPluginInterfaceUid);

	RImplInfoPtrArray implementations;

	const TEComResolverParams noResolverParams;

	REComSession::ListImplementationsL(KUidExtensionPluginInterface, noResolverParams, KRomOnlyResolverUid, implementations);

	CleanupResetAndDestroyPushL(implementations);

	LOGTEXT2(_L8("Number of implementations of extension plugin interface: %d"), implementations.Count());

	for (TInt i=0; i<implementations.Count(); i++)

		{

		CUsbmanExtensionPlugin* plugin = CUsbmanExtensionPlugin::NewL(implementations[i]->ImplementationUid(), *this);

		CleanupStack::PushL(plugin);

		iExtensionPlugins.AppendL(plugin); // transfer ownership to iExtensionPlugins

		CleanupStack::Pop(plugin);

		LOGTEXT2(_L8("Added extension plugin with UID 0x%08x"),

			implementations[i]->ImplementationUid());

		}

	CleanupStack::PopAndDestroy(&implementations);

	LOGTEXT(_L8("<<CUsbDevice::InstantiateExtensionPluginsL"));

	}

void CUsbDevice::EnumerateClassControllersL()

/**

 * Loads all USB class controllers at startup.

 *

 */

	{

	LOG_FUNC

#ifdef USE_DUMMY_CLASS_CONTROLLER

	//create a TLinearOrder to supply the comparison function, Compare(), to be used  

	//to determine the order to add class controllers

	TLinearOrder<CUsbClassControllerBase> order(CUsbClassControllerBase::Compare);

	// For GT171 automated tests, create three instances of the dummy class 

	// controller, which will read their behaviour from an ini file. Do not 

	// make any other class controllers.

	for ( TUint ii = 0 ; ii < 3 ; ii++ )

		{

		AddClassControllerL(CUsbDummyClassController::NewL(*this, ii), order);	

		}

	LEAVEIFERRORL(iUsbClassControllerIterator->First());

#else

	// Add a class controller statically.

	// The next line shows how to add a class controller, CUsbExampleClassController,

	// statically

	// AddClassControllerL(CUsbExampleClassController::NewL(*this),order);

	// Load class controller plug-ins

	RImplInfoPtrArray implementations;

	const TEComResolverParams noResolverParams;

	REComSession::ListImplementationsL(KUidUsbPlugIns, noResolverParams, KRomOnlyResolverUid, implementations);

  	CleanupResetAndDestroyPushL(implementations);

	LOGTEXT2(_L8("Number of implementations to load  %d"), implementations.Count());

	for (TInt i=0; i<implementations.Count(); i++)

		{

		LOGTEXT2(_L8("Adding class controller with UID %x"),

			implementations[i]->ImplementationUid());

		const TUid uid = implementations[i]->ImplementationUid();

		LEAVEIFERRORL(iSupportedClassUids.Append(uid));

		}	

	CleanupStack::PopAndDestroy(&implementations);

#endif // USE_DUMMY_CLASS_CONTROLLER

	}

void CUsbDevice::AddClassControllerL(CUsbClassControllerBase* aClassController, 

									TLinearOrder<CUsbClassControllerBase> aOrder)

/**

 * Adds a USB class controller to the device. The controller will now be

 * managed by this device. Note that the class controller, aClassController, is now

 * owned by this function and can be destroyed by it.  Calling functions do not need to 

 * destroy the class controller. 

 *

 * @param	aClassController	Class to be managed

 * @param   aOrder              Specifies order CUsbClassControllerBase objects are to be

 *                              added

 */

	{

	LOG_FUNC

	TInt rc = KErrNone;	

	if(isPersonalityCfged()) // do not take into account priorities

		{

		rc = iSupportedClasses.Append(aClassController);	

		}

	else

		{

		rc = iSupportedClasses.InsertInOrderAllowRepeats(

		aClassController, aOrder);

		} 

	if (rc != KErrNone) 

		{

		// Avoid memory leak by deleting class controller if the append fails.

		delete aClassController;

		LEAVEL(rc);

		}

	}

void CUsbDevice::RegisterObserverL(MUsbDeviceNotify& aObserver)

/**

 * Register an observer of the device.

 * Presently, the device supports watching state.

 *

 * @param	aObserver	New Observer of the device

 */

	{

	LOG_FUNC

	LEAVEIFERRORL(iObservers.Append(&aObserver));

	}

void CUsbDevice::DeRegisterObserver(MUsbDeviceNotify& aObserver)

/**

 * De-registers an existing device observer.

 *

 * @param	aObserver	The existing device observer to be de-registered

 */

	{

	LOG_FUNC

	TInt index = iObservers.Find(&aObserver);

	if (index >= 0)

		iObservers.Remove(index);

	}

void CUsbDevice::StartL()

/**

 * Start the USB Device and all its associated USB classes.

 * Reports errors and state changes via observer interface.

 */

	{

	LOG_FUNC

	Cancel();

	SetServiceState(EUsbServiceStarting);

	TRAPD(err, SetDeviceDescriptorL());

	if ( err != KErrNone )

		{

		SetServiceState(EUsbServiceIdle);

		LEAVEL(err);		

		}

	iLastError = KErrNone;

	StartCurrentClassController();

	}

void CUsbDevice::Stop()

/**

 * Stop the USB device and all its associated USB classes.

 */

	{

	LOG_FUNC

	Cancel();

	SetServiceState(EUsbServiceStopping);

	iLastError = KErrNone;

	StopCurrentClassController();

	}

void CUsbDevice::SetServiceState(TUsbServiceState aState)

/**

 * Change the device's state and report the change to the observers.

 *

 * @param	aState	New state that the device is moving to

 */

	{

	LOGTEXT3(_L8("Calling: CUsbDevice::SetServiceState [iServiceState=%d,aState=%d]"),

		iServiceState, aState);

	if (iServiceState != aState)

		{

		// Change state straight away in case any of the clients check it

		TUsbServiceState oldState = iServiceState;

		iServiceState = aState;

		TUint length = iObservers.Count();

		for (TUint i = 0; i < length; i++)

			{

			iObservers[i]->UsbServiceStateChange(LastError(), oldState,

				iServiceState);

			}

		if (iServiceState == EUsbServiceIdle)

			iUsbServer.LaunchShutdownTimerIfNoSessions();

		}

	LOGTEXT(_L8("Exiting: CUsbDevice::SetServiceState"));

	}

void CUsbDevice::SetDeviceState(TUsbcDeviceState aState)

/**

 * The CUsbDevice::SetDeviceState method

 *

 * Change the device's state and report the change to the observers

 *

 * @internalComponent

 * @param	aState	New state that the device is moving to

 */

	{

	LOG_FUNC

	LOGTEXT3(_L8("\taState = %d, iDeviceState = %d"), aState, iDeviceState);

	TUsbDeviceState state;

	switch (aState)

		{

	case EUsbcDeviceStateUndefined:

		state = EUsbDeviceStateUndefined;

		break;

	case EUsbcDeviceStateAttached:

		state = EUsbDeviceStateAttached;

		break;

	case EUsbcDeviceStatePowered:

		state = EUsbDeviceStatePowered;

		break;

	case EUsbcDeviceStateDefault:

		state = EUsbDeviceStateDefault;

		break;

	case EUsbcDeviceStateAddress:

		state = EUsbDeviceStateAddress;

		break;

	case EUsbcDeviceStateConfigured:

		state = EUsbDeviceStateConfigured;

		break;

	case EUsbcDeviceStateSuspended:

		state = EUsbDeviceStateSuspended;

		break;

	default:

		return;

		}

	if (iDeviceState != state)

		{

#ifndef __WINS__

		if (iDeviceState == EUsbDeviceStateUndefined &&

			iUdcSupportsCableDetectWhenUnpowered &&

			iServiceState == EUsbServiceStarted)

			{

			// We just changed state away from undefined. Hence the cable must

			// now be attached (if it wasn't before). If the UDC supports

			// cable detection when unpowered, NOW is the right time to power

			// it up (so long as usbman is fully started).

			(void)PowerUpAndConnect(); // We don't care about any errors here.

			}

#endif // __WINS__

		// Change state straight away in case any of the clients check it

		TUsbDeviceState oldState = iDeviceState;

		iDeviceState = state;

		TUint length = iObservers.Count();

		for (TUint i = 0; i < length; i++)

			{

			iObservers[i]->UsbDeviceStateChange(LastError(), oldState, iDeviceState);

			}

		}

	}

/**

 * Callback called by CDeviceHandler when the USB bus has sucessfully

 * completed a ReEnumeration (restarted all services).

 */

void CUsbDevice::BusEnumerationCompleted()

	{

	LOG_FUNC

	// Has the start been cancelled?

	if (iServiceState == EUsbServiceStarting)

		{