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

// e32\include\drivers\locmedia.h

// 

//

#ifndef LOCMEDIA_H

#define LOCMEDIA_H

#include <plat_priv.h>

#include <d32locd.h>

#if defined(_DEBUG) && defined(__DEMAND_PAGING__)

#define __CONCURRENT_PAGING_INSTRUMENTATION__

#endif

#ifdef __DEMAND_PAGING__

#define __DEMAND_PAGING_BENCHMARKS__

#endif

#ifdef __WINS__

	#define __EMULATOR_DMA_SUMULATION__

#endif

/**

@publishedPartner

@released

A media driver priority value.

The value can be returned by a media driver's PDD factory Info() function,

and allows Symbian OS to decide the order in which media drivers are to be opened.

The value is relative to the other media driver priority values.

@see DPhysicalDevice::Info()

*/

const TInt KMediaDriverPriorityHigh=2;

/**

@publishedPartner

@released

A media driver priority value.

The value can be returned by a media driver's PDD factory Info() function,

and allows Symbian OS to decide the order in which media drivers are to be opened.

The value is relative to the other media driver priority values, and is

the one most commonly used.

@see DPhysicalDevice::Info()

*/

const TInt KMediaDriverPriorityNormal=1;

/**

@publishedPartner

@released

A media driver priority value.

The value can be returned by a media driver's PDD factory Info() function,

and allows Symbian OS to decide the order in which media drivers are to be opened.

The value is relative to the other media driver priority values.

@see DPhysicalDevice::Info()

*/

const TInt KMediaDriverPriorityLow=0;

/**

@publishedPartner

@released

Media driver interface major version number.

*/

const TInt KMediaDriverInterfaceMajorVersion=1;

/**

@publishedPartner

@released

Media driver interface minor version number.

*/

const TInt KMediaDriverInterfaceMinorVersion=0;

/**

@publishedPartner

@released

Media driver interface build number.

*/

const TInt KMediaDriverInterfaceBuildVersion=160;

/**

@publishedPartner

@released

*/

const TInt KMediaDriverDeferRequest=1;

/**

@internalTechnology

*/

#define __TRACE_TIMING(x)

//#define __TRACE_TIMING(x) *(TInt*)0x63000ff0=x

/**

@internalComponent

*/

NONSHARABLE_CLASS(DLocalDriveFactory) : public DLogicalDevice

	{

public:

	DLocalDriveFactory();

	virtual TInt Install();

	virtual void GetCaps(TDes8 &aDes) const;

	virtual TInt Create(DLogicalChannelBase*& aChannel);

	};

class TLocDrv;

class DLocalDrive;

/**

@internalComponent

*/

NONSHARABLE_CLASS(TLocalDriveCleanup) : public TThreadCleanup

	{

public:

	TLocalDriveCleanup();

	virtual void Cleanup();

	inline DLocalDrive& LocalDrive();

	};

class TLocDrvRequest;

class DPrimaryMediaBase;

/* 

TCallBackLink

@internalComponent

Internal class which allows a list of callbacks to be linked together.

*/

NONSHARABLE_CLASS(TCallBackLink)

	{

public:

	enum TObjectType

		{

		EDLocalDriveObject, // object containing this TCallBackLink is a DLocalDrive

		ETLocDrvObject,		// object containing this TCallBackLink is a TLocDrv

		};

public:

	TCallBackLink();

	TCallBackLink(TInt (*aFunction)(TAny* aPtr, TInt aParam),TAny* aPtr, TObjectType aObjectType);

	TInt CallBack(TInt aParam) const;

public:

	/**

	A pointer to the callback function.

	*/

	TInt (*iFunction)(TAny* aPtr, TInt aParam);

	/**

	A pointer that is passed to the callback function when

	the function is called.

	*/

	TAny* iPtr;

	TObjectType iObjectType;

	SDblQueLink iLink;

	};

/**

@publishedPartner

@released

This class is strictly internal to Symbian; the only part of this class that

is publicly exposed to partners is the TRequestId enum.

@see DLocalDrive::TRequestId

*/

NONSHARABLE_CLASS(DLocalDrive) : public DLogicalChannelBase

	{

public:

	/**

	Identifies the specific local drive operation.

	*/

	enum TRequestId

		{

		/**

		Requests information about the size, type, and attributes of the media.

		*/

		ECaps=0,

		/**

		Requests an asynchronous read from the media device.

		*/

		ERead=1,

		/**

		Requests an asynchronous write to the media device.

		*/

		EWrite=2,

		/**

		Requests the formatting of a section of the media

		*/

		EFormat=3,

		/**

		A request to expand the total size of the media.

		*/

		EEnlarge=4,

		/**

		A request to reduce the total size of the media.

		*/

		EReduce=5,

		/**

		A request to force a remount of the media.

		*/

		EForceMediaChange=6,

		/**

		Requests an attempt to lock the media with a password.

		*/

		EPasswordLock=7,

		/**

		Requests an attempt to unlock the media.

		*/

		EPasswordUnlock=8,

		/**

		Requests an attempt to remove the password from the media.

		*/

		EPasswordClear=9,

		/**

		Requests an read of the password store.

		*/

		EReadPasswordStore=10,

		/**

		Requests a write of the password store.

		*/

		EWritePasswordStore=11,

		/** 

		A request to get the length of the password store.

		*/

		EPasswordStoreLengthInBytes=12,

		/** 

		A Control IO request

		*/

		EControlIO=13,

		/** 

		A request to force an erase of the password from the media

		*/

		EPasswordErase=14,

		/** 

		A delete notification from the file system

		*/

		EDeleteNotify=15,

		/** 

		A request for information on the last error

		*/

		EGetLastErrorInfo=16,

		EFirstReqNumberReservedForPaging=17,

		// DO NOT REUSE ANY OF THE REQUEST NUMBERS BETWEEN THIS AND THE LAST RESERVED REQ NUMBER

		// ALSO DO NOT INSERT ANY REQUEST NUMBERS BEFORE THIS, AS THIS WILL BE A COMPATIBILITY BREEAK

		ELastReqNumberReservedForPaging=31,

		/**

		Query device 

		*/

		EQueryDevice=32,

		};

public:

	DLocalDrive(); 

	~DLocalDrive();

	virtual TInt DoCreate(TInt aUnit, const TDesC8* anInfo, const TVersion& aVer); /**< @internalComponent */

	virtual TInt Request(TInt aFunction, TAny* a1, TAny* a2);                      /**< @internalComponent */

	void NotifyChange();

	inline void Deque();                 /**< @internalComponent */

	static TInt MediaChangeCallback(TAny* aLocalDrive, TInt aNotifyType);	/**< @internalComponent */

	IMPORT_C static TInt Caps(TInt aDriveNumber, TDes8& aCaps);

private:

#ifdef __DEMAND_PAGING__

	TInt LockMountInfo(DPrimaryMediaBase& aPrimaryMedia, TLocDrvRequest& aReq);

	void UnlockMountInfo(DPrimaryMediaBase& aPrimaryMedia);

#endif

	TInt ReadPasswordData(TLocDrvRequest& aReq, TLocalDrivePasswordData& aPswData, TMediaPassword& aOldPasswd, TMediaPassword& aNewPasswd);

public:

	TLocDrv* iDrive;									/**< @internalComponent */

	TCallBackLink iMediaChangeObserver;					/**< @internalComponent */

	TClientDataRequest<TBool>* iNotifyChangeRequest;	/**< @internalComponent */

	TLocalDriveCleanup iCleanup;						/**< @internalComponent */

	};

/**

@internalComponent

*/

inline DLocalDrive& TLocalDriveCleanup::LocalDrive()

	{ return *_LOFF(this,DLocalDrive,iCleanup); }

/**

@publishedPartner

@released

A class that encapsulates the request information received from the client,

and gives the media driver access to the request ID and other associated

parameters, such as the request length, offset, the requesting thread,

source and destination address etc.

An object of this type is passed to DMediaDriver::Request().

@see DMediaDriver::Request()

*/

class TLocDrvRequest : public TThreadMessage

	{

public:

    /** 

	@internalComponent

    */

	enum TFlags

		{

		EWholeMedia=1,

		EAdjusted=2,

		EPhysAddr=0x04,

		EPaging=0x08,				// a paging request

		EBackgroundPaging=0x10,		// a background paging request. @see DMediaPagingDevice::Write()

		ECodePaging=0x20,			// a code paging request

		EDataPaging=0x40,			// a data paging request

		ETClientBuffer=0x80,		// RemoteDes() points to a TClientBuffer

		EKernelBuffer=0x100,		// RemoteDes() points to a kernel-side buffer : set for all paging requests and media extension requests

		EPhysAddrOnly=0x200,        // No virtual address is available. Data Paging requests Only. 

		};

public:

    /**

    Gets a reference to the object containing the request information.

    @return The request information.

    */

	inline static TLocDrvRequest& Get()

		{return (TLocDrvRequest&)Kern::Message();}

    /**

    Gets the request ID.

    For media drivers, this is one of the DLocalDrive::TRequestId enumerated values.

    @return The request ID.

    @see DLocalDrive::TRequestId

    */

	inline TInt& Id()

		{return *(TInt*)&iValue;}

    /**

    Gets the position on the media on which the request operates. 

    This applies to operations ERead, EWrite and EFormat.

    Note that the partition offset is taken into account by the underlying

    local media subsystem.

    @return The position on the media.

    @see TRequestId::ERead

    @see TRequestId::EWrite

    @see TRequestId::EFormat

    */		

	inline Int64& Pos()

		{return *(Int64*)&iArg[0];}

	/**

	Gets the length associated with the operation.

	This is the number of bytes associated with the media request.

	It applies to operations ERead, EWrite and EFormat.

	@return The length, in bytes.

    @see TRequestId::ERead

    @see TRequestId::EWrite

    @see TRequestId::EFormat

	*/

	inline Int64& Length()

		{return *(Int64*)&iArg[2];}

	/**

	Gets a pointer to the remote thread that requested the operation.

	This may be used to access the data to be read from the remote thread's process,

	or the area to which data is to be written in the remote thread's process.

	However, it is recommended that	such operations be performed

	using ReadRemote() and WriteRemote()

	@return A reference to a pointer to the remote thread.

	@see TLocDrvRequest::ReadRemote()

	@see TLocDrvRequest::WriteRemote()

	*/

	inline DThread*& RemoteThread()

		{return *(DThread**)&iArg[4];}

	/**

	Gets a pointer to the descriptor in the remote thread's process that

	contains the data to be read, or is the target for data to be written.

    However, it is recommended that such read or write operations be performed

    using ReadRemote() and WriteRemote().

    @return A reference to a pointer to the remote descriptor.

    @see TLocDrvRequest::ReadRemote()

	@see TLocDrvRequest::WriteRemote()

	*/	

	inline TAny*& RemoteDes()

		{return *(TAny**)&iArg[5];}

    /**

    Gets the offset within the descriptor in the remote thread's process.

    @return The offset within the descriptor.

    */

	inline TInt& RemoteDesOffset()

		{return *(TInt*)&iArg[6];}

	/**

	@internalComponent

	*/

	inline TInt& Flags()

		{return *(TInt*)&iArg[7];}

	/**

	@internalComponent

	*/

	inline TLocDrv*& Drive()

		{return *(TLocDrv**)&iArg[8];}

	/**

	@internalComponent

	*/

	inline TInt& DriverFlags()

		{return *(TInt*)&iArg[9];}

	/**

	Returns true if Physical memory addresses are available for this TLocDrvRequest.

	@return ETrue if a physical memory address is available.

	*/

	inline TBool IsPhysicalAddress()

		{return Flags() & EPhysAddr;}

public:

	TInt ProcessMessageData(TAny* args);

	void CloseRemoteThread();

	IMPORT_C TInt ReadRemote(TDes8* aDes, TInt anOffset);

	IMPORT_C TInt ReadRemote(const TAny* aSrc, TDes8* aDes);

	IMPORT_C TInt ReadRemoteRaw(TAny* aDes, TInt aSize);

	IMPORT_C TInt WriteRemote(const TDesC8* aDes, TInt anOffset);

	IMPORT_C TInt WriteRemoteRaw(const TAny* aSrc, TInt aSize);