// 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:
// omap3530/beagleboard/inc/variant.h
// Beagle Variant Header
//



#ifndef __VA_STD_H__
#define __VA_STD_H__
#include <assp/omap3530_assp/omap3530_assp_priv.h>
#include <beagle/iolines.h>
#include <arm.h>
#include <e32const.h>
#include <assp.h>

void ExtIrqDispatch(TAny * ptr);

#define DEC_TO_BCD(dec) (((dec/10)<<4)+(dec%10))
#define BCD_TO_DEC(bcd) (((bcd>>4)*10)+bcd%16)


NONSHARABLE_CLASS(Beagle) : public Omap3530Assp
	{
public:
	Beagle();

	static inline Beagle& Variant();

public:
	/**
	 * These are the mandatory Asic class functions which need to be implemented here. The other mandatory
	 * functions are implemented in TemplateAssp
	 */

	/**
	 * initialisation
	 */
	virtual void Init1();
	virtual void Init3();

	/**
 	 * power management
 	 * Device specific Idle: prepares the CPU to go into Idle and sets out the conditions to come out of it
 	 */
 	virtual void Idle();

 	/**
	 * debug
	 * @param aChar Character to be output by debug serial port
	 */
	virtual void DebugOutput(TUint aChar);

	/**
	 * HAL
	 * @param aFunction A TVariantHalFunction enumerated value
	 * @param a1 Optional input/output parameter
	 * @param a2 Optional input/output parameter
	 * @return System wide error code. 
	 * @see TVariantHalFunction
	 */
	virtual TInt VariantHal(TInt aFunction, TAny* a1, TAny* a2);

	/**
	 * Machine configuration
	 * @return Pointer to a device configuration information
	 * @see TTemplateMachineConfig
	 */
	virtual TPtr8 MachineConfiguration();

public:
	virtual TInt IsExternalInterrupt(TInt anId);
	virtual	TInt InterruptBind(TInt anId, TIsr anIsr, TAny* aPtr);
	virtual TInt InterruptUnbind(TInt anId);
	virtual	TInt InterruptEnable(TInt anId);
	virtual	TInt InterruptDisable(TInt anId);
	virtual	TInt InterruptClear(TInt anId);
	
	/**
	 * USB client controller - Some example functions for the case that USB cable detection and
	 * UDC connect/disconnect functionality are part of the Variant.
	 * These virtual functions are called by the USB PSL (pa_usbc.cpp).
	 * If this functionality is part of the ASSP then these functions can be removed as calls to them
	 * in the PSL will have been replaced by the appropriate internal operations.
	 */
	virtual TBool UsbClientConnectorDetectable();
	virtual TBool UsbClientConnectorInserted();
	virtual TInt RegisterUsbClientConnectorCallback(TInt (*aCallback)(TAny*), TAny* aPtr);
	virtual void UnregisterUsbClientConnectorCallback();
	virtual TBool UsbSoftwareConnectable();
	virtual TInt UsbConnect();
	virtual TInt UsbDisconnect();

	virtual TInt SystemTimeInSecondsFrom2000(TInt& aTime);
	/**
	 * Obtain Adjust the RTC with new System Time (from 00:00 hours of 1/1/2000)
	 * @return System wide error code
	 */
	virtual TInt SetSystemTimeInSecondsFrom2000(TInt aTime);
	

	/**
	 * RAM zone callback functions that will be invoked by the kernel when a RAM zone
	 * operation should be performed.
	 */
	static TInt RamZoneCallback(TRamZoneOp aOp, TAny* aId, const TAny* aMasks);
	TInt DoRamZoneCallback(TRamZoneOp aOp, TUint aId, const TUint* aMasks);

	/** Input clock frequency information */
	virtual TUint SysClkFrequency() const;
	virtual TUint SysClk32kFrequency() const;
	virtual TUint AltClkFrequency() const;

private:
	void DebugInit();
	static void UsbClientConnectorIsr(TAny *);


public:
	TDfc *  iExtInterruptDfc;
	// TLinAddr iIdleFunction;		// may be used to point to a Bootstrap routine which prepares the CPU to Sleep 
	TBool iDebugInitialised;

private:
	TInt (*iUsbClientConnectorCallback)(TAny*);
	TAny* iUsbClientConnectorCallbackArg;
	
	TInt32  			iFrameBufferSize;
	TPhysAddr		iFrameBufferRamPhys;
	};

GLREF_D Beagle TheVariant;


inline Beagle& Beagle::Variant()
	{
	return *reinterpret_cast< Beagle* >( Arch::TheAsic() );
	}

#endif