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

// hal\inc\hal_data.h

// 

//

#ifndef __HAL_DATA_H__

#define __HAL_DATA_H__

#define bitmask enum

class HALData

/**

@publishedPartner

@released

Sets of attributes and values used by HAL functions.

*/

	{

public:

    /**

    A set of enumerators that identifies hardware attributes.

    The enumerators are passed to HAL::Get() and HAL::Set().

    They are also used by the HAL accessor functions.

    Note: It is not recommended to use HAL attributes to pass handles from the  

	kernel to user-side clients due to resource overhead's that will affect 

	existing clients of HAL. HAL is designed to allow simply hardware parameters

	to be shared with user-side clients without resource allocation overheads.

    @see HAL::Get()

    @see HAL::Set()

    */

	enum TAttribute

		{

		/**

		Identifies the manufacturer of a device.

        If this is not enumerated in TManufacturer, then the manufacturer must

        obtain a value from the Symbian registry.

        @see HALData::TManufacturer

		*/

		EManufacturer,

		/**

		The device specific hardware version number, as defined by

		the device manufacturer.

		*/

		EManufacturerHardwareRev,

		/**

		The device specific version number, as defined by

		the device manufacturer.

		*/

		EManufacturerSoftwareRev,

		/**

		The device specific software version number, as defined by

		the device manufacturer.

		*/

		EManufacturerSoftwareBuild,

		/**

		The device specific model number, as defined by

		the device manufacturer.

		*/

		EModel,

		/**

		This is the device specific UID, It is unique to the class /model

		of device. A value must be obtained from Symbian's UID registry for

		this attribute.

		*/

		EMachineUid,

		/**

		The Symbian OS specified device family identifier.

		If the device family is not one of those enumerated by TDeviceFamily,

		then the licensee must obtain a UID from Symbian for this attribute.

		@see HALData::TDeviceFamily

		*/

		EDeviceFamily,

		/**

		The Symbian OS specified device family version.

		*/

		EDeviceFamilyRev,

		/**

		The CPU architecture used by this device. The values are enumerated

		by TCPU.

		@see HALData::TCPU

		*/

		ECPU,

		/**

		A revision number for the CPU architecture.

		*/

		ECPUArch,

		/**

		This is the default ABI used by CPU for user applications.

		The values are enumerated by HALData::TCPUABI.

		*/

		ECPUABI,

		/**

		The processor speed in KHz.

		*/

		ECPUSpeed,

		/**

		The reason for most recent system boot.

        This is dynamic and readonly; the values are enumerated by

        TSystemStartupReason.

		@see HALData::TSystemStartupReason

		*/

		ESystemStartupReason,

		/**

		This is the last exception code, in the case of system reboot.

		This is dynamic and readonly.

		*/

		ESystemException,

		/**

		The time between system ticks, in microseconds.

		*/

		ESystemTickPeriod,

		/** 

		The total system RAM, in bytes.

		*/

		EMemoryRAM,

		/**

		The currently free system RAM.

		This is dynamic and readonly.

		*/

		EMemoryRAMFree,

		/**

		The total System ROM, in bytes.

		*/

		EMemoryROM,

		/**

		The MMU page size in bytes.

		*/

		EMemoryPageSize,

		/**

		Indicates the state of the power supply.

        It has the values:

        1 = Power is good (i.e. external power is available,

        or the 'power' battery is >= low);

        0 = otherwise.

        This is dynamic and readonly.

		*/

		EPowerGood,

		/**

        The System (or 'Main') battery power level.

        The allowable values are enumerated by TPowerBatteryStatus

		This is dynamic and readonly,

		@see HALData::TPowerBatteryStatus

		*/

		EPowerBatteryStatus,

		/**

		Indicates whether a backup power supply is available.

        It has the values:

        0 = the device does not support (or need) a backup battery source;

        1 = a backup batter source is present.

		This is dynamic and readonly

		*/

		EPowerBackup,

		/**

        The power level for backup power.

        It has the values enumerated by TPowerBackupStatus.

		This is dynamic and readonly.

		@see HALData::TPowerBackupStatus

		*/

		EPowerBackupStatus,

		/**

		Indicates the state of the external power.

		It has the values:

		0 = external power is not in use;

		1 = external power is in use.

        This is dynamic and readonly.

		*/

		EPowerExternal,

		/**

		A bitmask that describes the available keyboard types (it may support

		more than one).

        @see HALData::TKeyboard

		*/

		EKeyboard,

		/**

		*/

		EKeyboardDeviceKeys,

		/**

		*/

		EKeyboardAppKeys,

		/**

		Indicates whether the device can produce a click sound for

		each keypress.

		It has the values:

		0 = the device cannot produce a click sound for each keypress;

		1 = the device can produce a click sound.

		*/

		EKeyboardClick,

		/**

		The state of keyboard clicking.

        It has the values:

        0 = key click disabled;

        1 = key click enabled.

		This is dynamic and writeable.

		@capability WriteDeviceData needed to Set this attribute

		*/

		EKeyboardClickState,

		/**

		The keyboard click volume level.

		It can take a value in the range 0 to EKeyboardClickVolumeMax.

        This is dynamic and writeable.

        @see HALData::EKeyboardClickVolumeMax

		@capability WriteDeviceData needed to Set this attribute

		*/

		EKeyboardClickVolume,

		/**

		The maximum value for EKeyboardClickVolume.

		@see HALData::EKeyboardClickVolume

		*/

		EKeyboardClickVolumeMax,

		/**

		The screen horizontal dimension in pixels.

		*/

		EDisplayXPixels,

		/**

		The screen vertical dimension in pixels.

		*/

		EDisplayYPixels,

		/**

		The screen horizontal dimension in twips.

		*/

		EDisplayXTwips,

		/**

		The screen vertical dimension in twips.

		*/

		EDisplayYTwips,

		/**

		The number of hues (colors or shades of grey) displayable on

		the screen.

		*/

		EDisplayColors,

		/**

		The state of the display.

		It has the values:

		0 = screen is turned off;

		1 = screen is on.

		This is dynamic and writeable.

		@capability PowerMgmt needed to Set this attribute

		*/

		EDisplayState,

		/**

		The screen contrast level.

   		It can take a value in the range 0 to EDisplayContrastMax.

        This is dynamic and writeable

		@see HALData::EDisplayContrastMax

		@capability WriteDeviceData needed to Set this attribute

		*/

		EDisplayContrast,

		/**

		The maximum value for EDisplayContrast

		@see HALData::EDisplayContrast

		*/

		EDisplayContrastMax,

		/**

		Indicates whether there is a backlight on the device.

		It has the values:

		0 = there is no screen backlight;

		1 = a screen backlight is present.

		*/

		EBacklight,

		/**

		The current status of the backlight.

		It has the values:

		0 = off;

		1 = on.

        This is dynamic and writeable.

		@capability WriteDeviceData needed to Set this attribute

		*/

		EBacklightState,

		/**

		Indicates whether a pen or digitizer is available for input.

		It has the values:

		0 = a pen/digitizer is not available for input;

		1 = a pen/digitizeris present.

		*/

		EPen,

		/**

		The pen/digitizer horizontal resolution, in pixels.

		*/

		EPenX,

		/**

		The pen/digitizer vertical resolution, in pixels.

		*/

		EPenY,

		/**

		Indicates whether a pen tap will turn the display on.

        It has the values:

        0 = a pen tap has no effect;

        1 = a pent tap or press enables the display.

        This is dynamic and writeable.

		@capability WriteDeviceData needed to Set this attribute

		*/

		EPenDisplayOn,

		/**

		Indicates whether the device can produce a click sound for

		each pen tap.

		It has the values:

        0 = the device cannot produce a click sound

        1 = production of a click sound is supported by the device.

		*/

		EPenClick,

		/**

		The state of pen clicking.

		It has the values:

		0 = pen clicking is disabled;

		1 = pen clicking is enabled.

        This is dynamic and writable.

		@capability WriteDeviceData needed to Set this attribute

		*/

		EPenClickState,

		/**

		The pen click volume level.

        It can take a value in the range 0 to EPenClickVolumeMax.

        This value is dynamic and writable.

        @see HALData::EPenClickVolumeMax

		@capability WriteDeviceData needed to Set this attribute

		*/

		EPenClickVolume,

		/**

		The maximum value for EPenClickVolume.

		@see HALData::EPenClickVolume

		*/

		EPenClickVolumeMax,

		/**

		Indicates whether a mouse is available for input.

		It has the values:

		0 = there is no mouse available pen/digitizer is present;

		1 = a mouse is available for input.

		*/

		EMouse,

		/**

		The mouse horizontal resolution, in pixels.

		*/

		EMouseX,

		/**

		The mouse vertical resolution, in pixels.

		*/

		EMouseY,

		/**

		Describes the mouse cursor visibility.

        The value is enumerated by TMouseState.

		This is dynamic and writable.

		@see HALData::TMouseState

		@capability MultimediaDD needed to Set this attribute

		*/

		EMouseState,

		/**

        Reserved for future use.

		@capability MultimediaDD needed to Set this attribute

		*/

		EMouseSpeed,

		/**

		Reserved for future use.

		@capability MultimediaDD needed to Set this attribute

		*/