HAL Attributes +and Function IDs

This topic The list is ordered by group.

Symbian defines capabilities for each function ID. To find out a function +ID's capabilities, follow the link to its reference information. If no capabilities +are listed in the reference documentation for a function ID, it means that +no capabilities are required.

Note:

An attribute can map +to more than one function ID. This reflects the fact that any given attribute +can be passed to both HAL::Get() and HAL::Set(), +but the set behavior and get behavior map to two different function IDs.
There are group/function +ID pairs for which there is no attribute. This reflects the fact that the +hardware specific information represented by that group/function ID cannot +be accessed from the user side using the generic interface.

Attributes are defined as values of the TAttribute enum +within the scope of the HALData class in ...\os\kernelhwsrv\halservices\hal\inc\hal_data.h, +which is exported to ...\epoc32\include.

HAL groups are defined as values of the THalFunctionGroup enum +in ...\os\kernelhwsrv\kernel\eka\include\u32hal.h, which +is exported to ...\epoc32\include.

Function IDs are defined as values of various enums in ...\os\kernelhwsrv\kernel\eka\include\u32hal.h.

Group EHalGroupVariant
Group EHalGroupPower
Group EHalGroupDisplay
Group EHalGroupDigitiser
Group EHalGroupKeyboard
Group EHalGroupKernel
Group EHalGroupMedia
Group EHalGroupEmulator
Group EHalGroupSound
Group EHalGroupMouse

Group EHalGroupVariant + + + +

Attribute

Function ID

+ + +

ECPUSpeed

EVariantHalVariantInfo

+ + +

ELEDs

EVariantHalVariantInfo

+ + +

ELEDmask

EVariantHalLedMaskSet

EVariantHalLedMaskGet

+ + +

ESwitches

EVariantHalSwitches

+ + +

EDebugPort

EVariantHalDebugPortSet

EVariantHalDebugPortGet

+ + +

ECustomRestart

EVariantHalCustomRestart

+ + +

ECustomRestartReason

EVariantHalCustomRestartReason

+ + +

ECpuProfilingDefaultInterruptBase

EVariantHalProfilingDefaultInterruptBase

+ + + +

Group EHalGroupPower + + + +

Attribute

Function ID

+ + +

EPowerGood

EPowerHalSupplyInfo

+ + +

EPowerBatteryStatus

EPowerHalSupplyInfo

+ + +

EAccessoryPower

EPowerHalAcessoryPowerPresent

+ + +

EPowerBackup

EPowerHalBackupPresent

+ + +

EPowerBackupStatus

EPowerHalSupplyInfo

+ + +

EPowerExternal

EPowerHalSupplyInfo

+ + +

EPenDisplayOn

EPowerHalSetPointerSwitchesOn

EPowerHalPointerSwitchesOn

+ + +

ECaseSwitchDisplayOn

EPowerHalSetCaseOpenSwitchesOn

EPowerHalCaseOpenSwitchesOn

+ + +

ECaseSwitchDisplayOff

EPowerHalSetCaseCloseSwitchesOff

EPowerHalCaseCloseSwitchesOff

+ + +

No attributes

EPowerHalOnOffInfo

+ + +

No attributes

EPowerHalSetAutoSwitchOffBehavior

+ + +

No attributes

EPowerHalAutoSwitchOffBehavior

+ + +

No attributes

EPowerHalSetAutoSwitchOffTime

+ + +

No attributes

EPowerHalAutoSwitchOffTime

+ + +

No attributes

EPowerHalResetAutoSwitchOffTimer

+ + +

No attributes

EPowerHalSwitchOff

+ + +

No attributes

EPowerHalSetBatteryType

+ + +

No attributes

EPowerHalBatteryType

+ + +

No attributes

EPowerHalSetBatteryCapacity

+ + +

No attributes

EPowerHalBatteryCapacity

+ + +

No attributes

EPowerHalAutoSwitchOffType

+ + +

No attributes

EPowerHalTestBootSequence

+ + + +

Group EHalGroupDisplay + + + +

Attribute

Function ID

+ + +

EDisplayContrast

EDisplayHalSetDisplayContrast

EDisplayHalDisplayContrast

+ + +

EDisplayBrightness

EDisplayHalSetDisplayBrightness

EDisplayHalDisplayBrightness

+ + +

EDisplayPaletteEntry

EDisplayHalSetPaletteEntry

EDisplayHalPaletteEntry

+ + +

EDisplayNumModes

EDisplayHalModeCount

+ + +

EDisplayState

EDisplayHalSetState

EDisplayHalState

+ + +

EDisplayColors

EDisplayHalColors

+ + +

EDisplayBrightnessMax

EDisplayHalMaxDisplayBrightness

+ + +

EDisplayContrastMax

EDisplayHalMaxDisplayContrast

+ + +

EDisplayXPixels

EDisplayHalCurrentModeInfo

+ + +

EDisplayYPixels

EDisplayHalCurrentModeInfo

+ + +

EDisplayXTwips

EDisplayHalCurrentModeInfo

+ + +

EDisplayYTwips

EDisplayHalCurrentModeInfo

+ + +

EDisplayMemoryAddress

EDisplayHalCurrentModeInfo

EDisplayHalGetDisplayMemoryAddress

+ + +

EDisplayIsPixelOrderRGB

EDisplayHalCurrentModeInfo

+ + +

EDisplayIsPixelOrderLandscape

EDisplayHalCurrentModeInfo

+ + +

EDisplayMemoryHandle

EDisplayHalGetDisplayMemoryHandle

+ + +

EBacklight

EDisplayHalBacklightOn

+ + +

EBacklightState

EDisplayHalSetBacklightOn

EDisplayHalBacklightOn

+ + +

No attributes

EDisplayHalScreenInfo

+ + +

No attributes

EDisplayHalWsRegisterSwitchOnScreenHandling

+ + +

No attributes

EDisplayHalWsSwitchOnScreen

+ + +

No attributes

EDisplayHalSetBacklightBehavior

+ + +

No attributes

EDisplayHalBacklightBehavior

+ + +

No attributes

EDisplayHalSetBacklightOnTime

+ + +

No attributes

EDisplayHalBacklightOnTime

+ + +

No attributes

EDisplayHalBlockFill

+ + +

No attributes

EDisplayHalBlockCopy

+ + +

No attributes

EDisplayHalSecure

+ + +

No attributes

EDisplayHalSetSecure

+ + + +

Group EHalGroupDigitiser + + + +

Attribute

Function ID)

+ + +

EPen

EDigitiserHalXYInfo

+ + +

EPenX

EDigitiserHalXYInfo

+ + +

EPenY

EDigitiserHalXYInfo

+ + +

EPenState

EDigitiserHalSetXYState

EDigitiserHalXYState

+ + +

No attributes

EDigitiserHalSetXYInputCalibration

+ + +

No attributes

EDigitiserHalCalibrationPoints

+ + +

No attributes

EDigitiserHalSaveXYInputCalibration

+ + +

No attributes

EDigitiserHalRestoreXYInputCalibration

+ + + +

Group EHalGroupKeyboard + + + +

Attribute

Function ID

+ + +

EKeyboardState

EKeyboardHalSetKeyboardState

EKeyboardHalKeyboardState

+ + +

EKeyboard

EKeyboardHalKeyboardInfo

+ + +

EKeyboardDeviceKeys

EKeyboardHalKeyboardInfo

+ + +

EKeyboardAppKeys

EKeyboardHalKeyboardInfo

+ + + +

Group EHalGroupKernel

This +group is defined as internal and is listed here for information purposes only. +However, the attributes are public.

+ + + +

Attribute

Function ID

+ + +

ESystemStartupReason

EKernelHalStartupReason

+ + +

ESystemException

EKernelHalExceptionId

+ + +

EMemoryRAM

EKernelHalMemoryInfo

+ + +

EMemoryRAMFree

EKernelHalMemoryInfo

+ + +

EMemoryROM

EKernelHalMemoryInfo

+ + +

EFastCounterFrequency

EKernelHalFastCounterFrequency

+ + +

ENanoTickPeriod

EKernelHalNTickPeriod

+ + + +

Group EHalGroupMedia + + + +

Attribute

Function ID

+ + +

No attribute - the group and function ID pair is used internally.

EMediaHalDriveInfo

+ + + +

Group EHalGroupEmulator

This +group is defined as internal and is listed here for information purposes only. +However, the attributes are public.

+ + + +

Attribute

Function ID

+ + +

No attribute - the group and function ID pair is used internally.

EEmulatorHalStringProperty

EEmulatorHalIntProperty

EEmulatorHalBoolProperty

EEmulatorHalMapFilename

EEmulatorHalColorDepth

EEmulatorHalSetFlip

EEmulatorHalCPUSpeed

EEmulatorHalNumberOfScreens

+ + + +

Group EHalGroupSound + + + +

Attribute

Function ID

+ + +

EKeyboardClick

ESoundHalKeyClickEnabled

+ + +

EKeyboardClickVolumeMax

ESoundHalKeyClickVolumeMax

+ + +

EKeyboardClickState

ESoundHalSetKeyClickEnabled

ESoundHalKeyClickEnabled

+ + +

EKeyboardClickVolume

ESoundHalKeyClickVolumeMax

ESoundHalSetKeyClickLoud

ESoundHalKeyClickLoud

+ + +

EPenClick

ESoundHalPointerClickEnabled

+ + +

EPenClickVolumeMax

ESoundHalPointerClickVolumeMax

+ + +

EPenClickState

ESoundHalSetPointerClickEnabled

ESoundHalPointerClickEnabled

+ + +

EPenClickVolume

ESoundHalPointerClickVolumeMax

ESoundHalSetPointerClickLoud

ESoundHalPointerClickLoud

+ + + +

Group EHalGroupMouse + + + +

Attribute

Function ID

+ + +

EMouse

EMouseHalMouseInfo

+ + +

EMouseX

EMouseHalMouseInfo

+ + +

EMouseY

EMouseHalMouseInfo

+ + +

EMouseButtons

EMouseHalMouseInfo

+ + +

EMouseState

EMouseHalSetMouseState

EMouseHalMouseState

+ + +

EMouseSpeed

EMouseHalSetMouseSpeed

EMouseHalMouseSpeed

+ + +

EMouseAcceleration

EMouseHalSetMouseAcceleration

EMouseHalMouseAcceleration

+ + +

EMouseButtonState

Not supported

+ + + +