sl@0: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Shared Chunks in its implementation.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file Kernel side interfaces to example data converter device driver which uses
sl@0:  @publishedPartner
sl@0:  @prototype 9.1
sl@0: */
sl@0: 
sl@0: #ifndef __CONVERT1_DEV_H__
sl@0: #define __CONVERT1_DEV_H__
sl@0: 
sl@0: /**
sl@0:   Logical Device (factory class) for 'Convert1'
sl@0: */
sl@0: class DConvert1Factory : public DLogicalDevice
sl@0: 	{
sl@0: public:
sl@0: 	DConvert1Factory();
sl@0: 	~DConvert1Factory();
sl@0: 	//	Inherited from DLogicalDevice
sl@0: 	virtual TInt Install();
sl@0: 	virtual void GetCaps(TDes8& aDes) const;
sl@0: 	virtual TInt Create(DLogicalChannelBase*& aChannel);
sl@0: 	// Resource handling methods
sl@0: 	TInt ClaimResource(TInt& aResourceId);
sl@0: 	void ReleaseResource(TInt aResourceId);
sl@0: private:
sl@0: 	NFastMutex iResourceMutex;	/**< Mutex to protect access to iResourceFlags */
sl@0: 	TUint iResourceFlags;		/**< Bitfield of flags representing device resources available for use.
sl@0: 								     I.e. iResourceFlags&(1<<resourceId) is true if resource 'resourceId' is free. */
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:   Class representing a buffer of data
sl@0: */
sl@0: class DChunkBuffer
sl@0: 	{
sl@0: public:
sl@0: 	DChunkBuffer();
sl@0: 	~DChunkBuffer();
sl@0: 	TInt Create(TInt aSize);
sl@0: 	void Destroy();
sl@0: 	TInt SetMaxSize(TInt aMaxSize);
sl@0: 	TInt Open(TAny* aAddress, TInt aSize, TBool aWrite=EFalse);
sl@0: 	TInt Open(TInt aChunkHandle, TInt aOffset, TInt aSize, TBool aWrite=EFalse);
sl@0: 	void Close();
sl@0: 	TInt Copy(TAny* aAddress, TInt aSize);
sl@0: private:
sl@0: 	TInt SetPhysicalAddresses(TInt aSize);
sl@0: public:
sl@0: 	DChunk* iChunk;				/**< The chunk which contains the buffer */
sl@0: 	TInt iChunkOffset;			/**< Offset, in bytes, of buffer start within the chunk */
sl@0: 	TInt iMaxSize;				/**< Maximum size of buffer n bytes */
sl@0: 	TLinAddr iChunkBase;		/**< Linear address in kernel process for the start of the chunk  */
sl@0: 	TUint32 iChunkMapAttr;		/**< MMU mapping attributes for chunk */
sl@0: 	TPhysAddr iPhysicalAddress;	/**< Physical address of buffer. KPhysAddrInvalid if buffer not physically contiguous */
sl@0: 	TPhysAddr* iPhysicalPages;	/**< List of physical addresses for buffer pages. 0 if buffer is physically contiguous */
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:   Logical Channel class for 'Convert1'
sl@0: */
sl@0: class DConvert1Channel : public DLogicalChannelBase
sl@0: 	{
sl@0: public:
sl@0: 	DConvert1Channel(DConvert1Factory* aFactory);
sl@0: 	virtual ~DConvert1Channel();
sl@0: 	//	Inherited from DObject
sl@0: 	virtual TInt RequestUserHandle(DThread* aThread, TOwnerType aType);
sl@0: 	// Inherited from DLogicalChannelBase
sl@0: 	virtual TInt DoCreate(TInt aUnit, const TDesC8* anInfo, const TVersion& aVer);
sl@0: 	virtual TInt Request(TInt aReqNo, TAny* a1, TAny* a2);
sl@0: private:
sl@0: 	// Panic reasons
sl@0: 	enum TPanic
sl@0: 		{
sl@0: 		ERequestFromWrongThread=1,
sl@0: 		ERequestAlreadyPending
sl@0: 		};
sl@0: 	// Implementation for the differnt kinds of messages sent through RBusLogicalChannel
sl@0: 	TInt DoControl(TInt aFunction, TAny* a1, TAny* a2);
sl@0: 	TInt DoRequest(TInt aNotReqNo, TAny* a1, TAny* a2);
sl@0: 	TInt DoCancel(TUint aMask);
sl@0: 	// Methods for configuration
sl@0: 	TInt GetConfig(TDes8* aConfigBuf);
sl@0: 	TInt SetConfig(const TDesC8* aConfigBuf,RConvert1::TBufferInfo* aBufferInfo);
sl@0: 	// Methods for capturing images
sl@0: 	void ConvertDes(const TDesC8* aSrc,TRequestStatus* aRequestStatus);
sl@0: 	void ConvertChunk(const RConvert1::TConvertArgs* aSrcArgs,TRequestStatus* aRequestStatus);
sl@0: 	void ConvertInChunk(TInt aSize,TRequestStatus* aRequestStatus);
sl@0: 	void ConvertCancel();
sl@0: 	void ConvertComplete(TInt aResult);
sl@0: 	static void ConvertDfcTrampoline(TAny* aSelf);
sl@0: 	void ConvertDfc();
sl@0: 	// Methods which program the convert hardware
sl@0: 	void DoConvertStart(TInt aOffset,TInt aSize);
sl@0: 	void DoConvertCancel();
sl@0: private:
sl@0: 	DConvert1Factory* iFactory;	/**< Pointer to device driver factory object */
sl@0: 	TInt iResourceId;			/**< The id of the device hardware resource owned by this channel */
sl@0: 
sl@0: 	NFastMutex iConvertMutex;	/**< Mutex to protect access to driver state */
sl@0: 
sl@0: 	DChunkBuffer* iSource;		/**< Buffer containing the converter's input data */
sl@0: 	DChunkBuffer iInBuffer;		/**< Buffer into which client supplied data can be copied */
sl@0: 	DChunkBuffer iOutBuffer;	/**< Buffer containing the converter's output data */
sl@0: 	DChunkBuffer iClientBuffer;	/**< Buffer representing client supplied chunk data */
sl@0: 
sl@0: 	DThread* iClient;			/**< The single client thread for this channel */
sl@0: 	TRequestStatus* iConvertRequestStatus;	/**< The request status for client ConvertImage request */
sl@0: 
sl@0: 	RConvert1::TConfig iConfig;	/**< The driver configuration information */
sl@0: 
sl@0: 	NTimer iConvertTimer;		/**< Timer used to emulate image capture hardware */
sl@0: 	};
sl@0: 
sl@0: #endif
sl@0: