// Copyright (c) 1995-2010 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\u32hal.h

// 

// WARNING: This file contains some APIs which are internal and are subject

//          to change without notice. Such APIs should therefore not be used

//          outside the Kernel and Hardware Services package.

//

#ifndef __U32HAL_H__

#define __U32HAL_H__

#include <e32cmn.h>

//

// Classes used for in functions

//

/**

Used for TVariantInfoV01::iLedCapabilities

@publishedPartner

@released

*/

const TUint KLedMaskRed1=0x00000001;

/**

Used for TVariantInfoV01::iLedCapabilities

@publishedPartner

@released

*/

const TUint KLedMaskGreen1=0x00000002;

/**

Used for TVariantInfoV01::iLedCapabilities

@publishedPartner

@released

*/

const TUint KLedMaskYellow1=0x00000004;

/**

Used for TSupplyInfoV1.iFlags

@publishedPartner

@deprecated Unused by Symbian code

*/

const TUint KSupplyFlagSoundWarning=0x00000001;

/**

Used for TSupplyInfoV1.iFlags

@publishedPartner

@deprecated Unused by Symbian code

*/

const TUint KSupplyFlagBacklightWarning=0x00000002;

/**

Used for TSupplyInfoV1.iFlags

@publishedPartner

@deprecated Unused by Symbian code

*/

const TUint KSupplyFlagTimeChanged=0x80000000;

/**

@internalComponent

@deprecated Unused by Symbian code

*/

class TClearSetMask

	{

public:

	TUint iClearMask;

	TUint iSetMask;

	};

/**

@internalTechnology

@deprecated Unused by Symbian code

*/

enum TSupplyStatus

	{

	EZero,EVeryLow,ELow,EGood

	};

/**

@internalTechnology

@deprecated Unused by Symbian code

*/

class TSupplyInfoV1

	{

public:

	SInt64 iMainBatteryInsertionTime;

	TSupplyStatus iMainBatteryStatus;

	SInt64 iMainBatteryInUseMicroSeconds;

	TInt iCurrentConsumptionMilliAmps;

	TInt iMainBatteryConsumedMilliAmpSeconds;

	TInt iMainBatteryMilliVolts;

	TInt iMainBatteryMaxMilliVolts;

	TSupplyStatus iBackupBatteryStatus;

	TInt iBackupBatteryMilliVolts;

	TInt iBackupBatteryMaxMilliVolts;

	TBool iExternalPowerPresent;

	SInt64 iExternalPowerInUseMicroSeconds;

	TUint iFlags;

	};

/**

@internalTechnology

@deprecated Unused by Symbian code

*/

typedef TPckgBuf<TSupplyInfoV1> TSupplyInfoV1Buf;

/**

@publishedPartner

@deprecated Unused by Symbian code

*/

class TMouseProperties

	{

public:

	TUint8 iSpeed;

	TUint8 iAcceleration;

	};

/**

@internalTechnology Used by Symbian base ports

@deprecated Unused by Symbian code

*/

class TSoundInfoV1

	{

public:

	TBool iKeyClickEnabled;

	TBool iKeyClickLoud;

	TBool iKeyClickOverridden;

	TBool iPointerClickEnabled;

	TBool iPointerClickLoud;

	TBool iBeepEnabled;

	TBool iBeepLoud;

	TBool iSoundDriverEnabled;

	TBool iSoundDriverLoud;

	TBool iSoundEnabled;

	};

/**

@internalTechnology

@deprecated Unused by Symbian code

*/

typedef TPckgBuf<TSoundInfoV1> TSoundInfoV1Buf;

/**

@internalTechnology Used by Symbian base ports

*/

class TOnOffInfoV1

	{

public:

	TBool iPointerSwitchesOn;

	TBool iCaseOpenSwitchesOn;

	TBool iCaseCloseSwitchesOff;

	};

/**

@internalTechnology

@deprecated Unused by Symbian code

*/

typedef TPckgBuf<TOnOffInfoV1> TOnOffInfoV1Buf;

/**

@internalTechnology

@removed Unused by Symbian code

*/

enum TUserMediaFunction {EUserMediaRemount,EUserMediaNotifyChange};

//

// Hal function enumerations

//

/**

@publishedPartner

@released

Defines the set of HAL groups.

Each HAL group has an associated HAL handler. Note that the

HAL handlers for EHalGroupKernel and EHalGroupEmulator are internal

to Symbian OS.

See the Base Porting Guide documentation in the developer library for

more information on HAL groups.

*/

enum THalFunctionGroup

	{

	/**

	@internalComponent

	The HAL group associated with kernel related information; for example

	the reason for the most recent system boot.

	The function-ids associated with this HAL group are defined by the set

    of TKernelHalFunction enum values.

    */

	EHalGroupKernel=0,

    /**

    The HAL group associated with Variant specific hardware.

    This HAL handler is implemented by the Variant, specifically by

    the base port's implementation of Asic::VariantHal().

    The function-ids associated with this HAL group are defined by the set

    of TVariantHalFunction enum values. See the individual function-ids for

    the associated capabilities.

    @see TVariantHalFunction

    @see Asic::VariantHal()

    */

	EHalGroupVariant=1,

    /**

    The HAL group associated with the media driver.

    It is used internally by the media driver LDD.

    The function-ids associated with this HAL group are defined by the set

    of TMediaHalFunction enum values. See the individual function-ids for

    the associated capabilities.

    @see TMediaHalFunction

    */

	EHalGroupMedia=2,

    /**

    The HAL group associated with power handling.

    This HAL handler is implemented by the power model.

    The function-ids associated with this HAL group are defined by the set

    of TPowerHalFunction enum values. See the individual function-ids for

    the associated capabilities.

	@see TPowerHalFunction

    */

	EHalGroupPower=3,

	/**

	The HAL group associated with the main screen display.

	This HAL handler is implemented by the screen (i.e. LCD or video driver).

    The function-ids associated with this HAL group are defined by the set

    of TDisplayHalFunction enum values. See the individual function-ids for

    the associated capabilities.

	@see TDisplayHalFunction

	*/

	EHalGroupDisplay=4,

    /**

    The HAL group associated with the digitiser (i.e. pen or stylus).

    This HAL handler is implemented by the digitiser.

    The function-ids associated with this HAL group are defined by the set

    of TDigitiserHalFunction enum values. See the individual function-ids for

    the associated capabilities.

    @see TDigitiserHalFunction

    */

	EHalGroupDigitiser=5,

    /**

    The HAL group associated with a sound driver.

   	This group is provided by Symbian OS for backwards compatibility with

   	the Psion Series 5MX devices.

   	The function-ids associated with this HAL group are defined by the set

    of TSoundHalFunction enum values. See the individual function-ids for

    the associated capabilities.

    @see TSoundHalFunction

    */

	EHalGroupSound=6,

    /**

	The HAL group associated with a mouse-type device.

	In Symbian OS, the the only example of a mouse device is in the emulator,

	and this is a port of Symbian OS maintained by Symbian.

    The function-ids associated with this HAL group are defined by the set

    of TMouseHalFunction enum values. See the individual function-ids for

    the associated capabilities.

	@see TMouseHalFunction

    */

	EHalGroupMouse=7,

	/**

	@internalComponent

	The HAL group associated with the emulator.

	The function-ids associated with this HAL group are defined by the set

    of TEmulatorHalFunction enum values.

	*/

	EHalGroupEmulator=8,

    /**

    The HAL group associated with the keyboard.

    This HAL handler is implemented by the keyboard driver.

    The function-ids associated with this HAL group are defined by the set

    of TKeyboardHalFunction enum values. See the individual function-ids for

    the associated capabilities.

    @see TKeyboardHalFunction

    */

	EHalGroupKeyboard=9,

	/*

    The HAL group associated with the virtual memory system.

	The function-ids associated with this HAL group are defined by the set

    of TVMHalFunction enum values.

    @see TVMHalFunction

	*/

	EHalGroupVM=10,

	/*

    The HAL group associated with the RAM Zone configuration.

	The function-ids associated with this HAL group are defined by the set

    of TRamHalFunction enum values.

    @see TRamHalFunction

	*/

	EHalGroupRam=11,

	/**

	Reserved for platform specific use.

	*/

	EHalGroupPlatformSpecific1=29,

	/**

	Reserved for platform specific use.

	*/

	EHalGroupPlatformSpecific2=30

	};

/**

@internalComponent

*/

struct SCpuStates

	{

	TUint32	iTA;

	TUint32 iIA;

	TUint32	iCU;

	TUint32	iGD;

	TInt	iDC;

	TUint32	iSC;

	TUint32	iRC;

	TUint32	iCCS;

	TUint8	iPO;

	TUint8	iSpare1;

	TUint8	iSpare2;

	TUint8	iSpare3;

	TUint32	iPODC;

	TInt	iDS[8];

	TUint32	iUDC[8];

	TUint32	iUAC[8];

	TUint32	iOP[8];

	TUint32	iF[8];

	};

/**

@internalComponent

*/

enum TKernelHalFunction

	{

	EKernelHalMemoryInfo,

	EKernelHalRomInfo,

	EKernelHalStartupReason,

	EKernelHalFaultReason,

	EKernelHalExceptionId,

	EKernelHalExceptionInfo,

	EKernelHalCpuInfo,

	EKernelHalPageSizeInBytes,

	EKernelHalTickPeriod,

	EKernelHalMemModelInfo,

	EKernelHalFastCounterFrequency,

	EKernelHalNTickPeriod,

	EKernelHalHardwareFloatingPoint,

	EKernelHalGetNonsecureClockOffset,

	EKernelHalSetNonsecureClockOffset,

	EKernelHalSmpSupported,

	EKernelHalNumLogicalCpus,

	EKernelHalSupervisorBarrier,

	EKernelHalFloatingPointSystemId,

	EKernelHalLockThreadToCpu,

	EKernelHalConfigFlags,

	EKernelHalCpuStates,

	EKernelHalSetNumberOfCpus,

	};

/**

@publishedPartner

@released

The set of function-ids that are  associated with the EHalGroupVariant

HAL group.

Each enum value represents a specific characteristic of the Variant,

and is passed as the second parameter to

the HAL handler function dealing with this group.

@see EHalGroupVariant

*/

enum TVariantHalFunction

	{

	/**

	Gets Variant specifc information.

	Requirements of the HAL function handler's 2nd, 3rd and 4th parameters:

	- TInt aFunction : This enum value.

	- TAny* a1 : This is a pointer to a package buffer (TPckgBuf) containing a

	TVariantInfoV01 structure. The HAL function needs to fill the members of

	this structure with the appropriate information.

	- TAny* a2 : NULL.

	An example of this function can be found in the Variant template;

	see the function: 

	@code

	Template::VariantHal()

	@endcode

	in  

	@code

	...\template\template_variant\specific\variant.cpp

	@endcode

	@see TVariantInfoV01

    @see TPckgBuf

	*/

	EVariantHalVariantInfo,

	/**

	Sets the debug port number.

	Requirements of the HAL function handler's 2nd, 3rd and 4th parameters:

	- TInt aFunction : This enum value.

	- TAny* a1 : A TInt value containing the debug port number.

	- TAny* a2 : NULL.

	An example of this function can be found in the Variant template;

	see the function: 

	@code

	Template::VariantHal()

	@endcode

	in  

	@code

	...\template\template_variant\specific\variant.cpp

	@endcode

	*/

	EVariantHalDebugPortSet,

	/**

	Gets the debug port number.

	Requirements of the HAL function handler's 2nd, 3rd and 4th parameters:

	- TInt aFunction : This enum value.

    - TAny* a1 : A TInt value into which the HAL handler puts the debug port value

	- TAny* a2 : NULL.

	An example of this function can be found in the Variant template;

	see the function: 

	@code

	Template::VariantHal()

	@endcode

	in  

	@code

	...\template\template_variant\specific\variant.cpp

	@endcode

	*/

	EVariantHalDebugPortGet,

	/**

	Sets the current state of each LED. 

	Requirements of the HAL function handler's 2nd, 3rd and 4th parameters: