| class HALData |
Sets of attributes and values used by HAL functions.
| Public Attributes | |
|---|---|
| bitmask TKeyboard | EKeyboard_Full |
| bitmask TKeyboard | EKeyboard_Keypad |
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.
| EManufacturer |
Identifies the manufacturer of a device. If this is not enumerated in TManufacturer, then the manufacturer must obtain a value from the Symbian registry. |
| EManufacturerHardwareRev |
The device specific hardware version number, as defined by the device manufacturer. |
| EManufacturerSoftwareRev |
The device specific version number, as defined by the device manufacturer. |
| EManufacturerSoftwareBuild |
The device specific software version number, as defined by the device manufacturer. |
| EModel |
The device specific model number, as defined by the device manufacturer. |
| EMachineUid |
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. |
| EDeviceFamily |
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. |
| EDeviceFamilyRev |
The Symbian OS specified device family version. |
| ECPU |
The CPU architecture used by this device. The values are enumerated by TCPU. |
| ECPUArch |
A revision number for the CPU architecture. |
| ECPUABI |
This is the default ABI used by CPU for user applications. The values are enumerated by HALData::TCPUABI. |
| ECPUSpeed |
The processor speed in KHz. |
| ESystemStartupReason |
The reason for most recent system boot. This is dynamic and readonly; the values are enumerated by TSystemStartupReason. |
| ESystemException |
This is the last exception code, in the case of system reboot. This is dynamic and readonly. |
| ESystemTickPeriod |
The time between system ticks, in microseconds. |
| EMemoryRAM |
The total system RAM, in bytes. |
| EMemoryRAMFree |
The currently free system RAM. This is dynamic and readonly. |
| EMemoryROM |
The total System ROM, in bytes. |
| EMemoryPageSize |
The MMU page size in bytes. |
| EPowerGood |
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. |
| EPowerBatteryStatus |
The System (or 'Main') battery power level. The allowable values are enumerated by TPowerBatteryStatus This is dynamic and readonly, |
| EPowerBackup |
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 |
| EPowerBackupStatus |
The power level for backup power. It has the values enumerated by TPowerBackupStatus. This is dynamic and readonly. |
| EPowerExternal |
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. |
| EKeyboard |
A bitmask that describes the available keyboard types (it may support more than one). |
| EKeyboardDeviceKeys | |
| EKeyboardAppKeys | |
| EKeyboardClick |
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. |
| EKeyboardClickState |
The state of keyboard clicking. It has the values: 0 = key click disabled; 1 = key click enabled. This is dynamic and writeable.
|
| EKeyboardClickVolume |
The keyboard click volume level. It can take a value in the range 0 to EKeyboardClickVolumeMax. This is dynamic and writeable.
HALData::EKeyboardClickVolumeMax
|
| EKeyboardClickVolumeMax |
The maximum value for EKeyboardClickVolume. |
| EDisplayXPixels |
The screen horizontal dimension in pixels. |
| EDisplayYPixels |
The screen vertical dimension in pixels. |
| EDisplayXTwips |
The screen horizontal dimension in twips. |
| EDisplayYTwips |
The screen vertical dimension in twips. |
| EDisplayColors |
The number of hues (colors or shades of grey) displayable on the screen. |
| EDisplayState |
The state of the display. It has the values: 0 = screen is turned off; 1 = screen is on. This is dynamic and writeable.
|
| EDisplayContrast |
The screen contrast level. It can take a value in the range 0 to EDisplayContrastMax. This is dynamic and writeable
HALData::EDisplayContrastMax
|
| EDisplayContrastMax |
The maximum value for EDisplayContrast |
| EBacklight |
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. |
| EBacklightState |
The current status of the backlight. It has the values: 0 = off; 1 = on. This is dynamic and writeable.
|
| EPen |
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. |
| EPenX |
The pen/digitizer horizontal resolution, in pixels. |
| EPenY |
The pen/digitizer vertical resolution, in pixels. |
| EPenDisplayOn |
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.
|
| EPenClick |
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. |
| EPenClickState |
The state of pen clicking. It has the values: 0 = pen clicking is disabled; 1 = pen clicking is enabled. This is dynamic and writable.
|
| EPenClickVolume |
The pen click volume level. It can take a value in the range 0 to EPenClickVolumeMax. This value is dynamic and writable.
HALData::EPenClickVolumeMax
|
| EPenClickVolumeMax |
The maximum value for EPenClickVolume. |
| EMouse |
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. |
| EMouseX |
The mouse horizontal resolution, in pixels. |
| EMouseY |
The mouse vertical resolution, in pixels. |
| EMouseState |
Describes the mouse cursor visibility. The value is enumerated by TMouseState. This is dynamic and writable. HALData::TMouseState
|
| EMouseSpeed |
Reserved for future use.
|
| EMouseAcceleration |
Reserved for future use.
|
| EMouseButtons |
The number of buttons on the mouse. |
| EMouseButtonState |
A bitmask defining the state of each button. For each bit, it has values: 0 = up; 1 = down. This is dynamic and read only. |
| ECaseState |
Defines the state of the case. It has the values: 0 = case closed; 1 = case opened. This is dynamic and read only. |
| ECaseSwitch |
Indicates whether the device has a case switch, that actions when the case opens and closes. It has values: 0 = no; 1 = yes. |
| ECaseSwitchDisplayOn |
Indicates whether the device is to switch on when case opens. It has the values: 0 = disable device switchon when the case opens; 1 = enable device switchon when the case opens. This is dynamic and writeable.
|
| ECaseSwitchDisplayOff |
Indicates whether the device is to switch off when case close. It has the values: 0 = disable device switchoff when the case closes; 1 = enable device switchoff when the case closes. This is dynamic and writeable.
|
| ELEDs |
The number of LEDs on the device. |
| ELEDmask |
A bitmask defining the state of each LED. For each bit, it has values: 0 = off; 1 = on. This is dynamic and writeable. |
| EIntegratedPhone |
Indicates how the phone hardware is connected. It has the values: 0 = phone hardware is not permanently connected; 1 = phone hardware is permanently connected. |
| EDisplayBrightness |
|
| EDisplayBrightnessMax | |
| EKeyboardBacklightState |
Indicates the state of the keyboard backlight. It has the values: 0 = keyboard backlight is off; 1 = keyboard backlight is on. This is dynamic and writeable.
|
| EAccessoryPower |
Power supply to an accessory port. It has the values: 0 = turn off power to an accessory port on the device; 1 = turn on power. This is dynamic and writeable.
|
| ELanguageIndex |
A 2 decimal digit language index. It is used as the two digit language number that is the suffix of language resource DLLs, e.g ELOCL.01. The locale with this language index is loaded the next time that the device boots. This is dynamic and writeable.
TLanguage
|
| EKeyboardIndex |
A 2 decimal digit (decimal) language keyboard index. It is used as the two digit language number that is the suffix of language resource DLLs, e.g. EKDATA.01.
TLanguage
|
| EMaxRAMDriveSize |
The maximum allowable size of RAM drive, in bytes. |
| EKeyboardState |
Indicates the state of the keyboard. It has the values: 0 = keyboard is disabled; 1 = Keyboard is enabled. This is dynamic and writeable.
|
| ESystemDrive |
Defines the system drive & custom resource drive. Legacy attribute which is no longer supported. Attribute is no longer the primary mechanism to define the System Drive or the Custom Resource Drive. RFs::GetSystemDrive. BaflUtils::NearestLanguageFile HALData::ECustomResourceDrive |
| EPenState |
Indicates the state of the pen or digitiser. It has the values: 1 = pen/digitiser is enabled; 0 = pen/digitiser is disabled. This is dynamic and writeable.
|
| EDisplayIsMono |
On input: aInOut contains the mode number. On output: aInOut contains: 0 = display is colour; 1 = display is black & white. aInOut is the 3rd parameter passed to accessor functions for derived attributes. |
| EDisplayIsPalettized |
On input: aInOut contains the mode number; On output, aInOut contains: 0 = display is not palettised; 1 = display is palettised. aInOut is the 3rd parameter passed to accessor functions for derived attributes. |
| EDisplayBitsPerPixel |
The display bits per pixel. On input, aInOut contains the mode number. On output, aInOut contains the bits per pixel for that mode. aInOut is the 3rd parameter passed to accessor functions for derived attributes. It is read only data. |
| EDisplayNumModes |
The number of display modes available. |
| EDisplayMemoryAddress |
The address of the display memory. |
| EDisplayOffsetToFirstPixel |
The offset, in bytes, to the pixel area of the screen from the start of screen memory. This is used to account for the fact that the palette is sometimes at the beginning of the display memory. On input, aInOut contains the mode number. On output, aInOut contains the offset to the first pixel for that mode. aInOut is the 3rd parameter passed to accessor functions for derived attributes. |
| EDisplayOffsetBetweenLines |
The separation, in bytes, of successive lines of display in memory. On input, aInOut contains the mode number. On output, aInOut contains the display offset between lines. aInOut is the 3rd parameter passed to accessor functions for derived attributes. |
| EDisplayPaletteEntry |
|
| EDisplayIsPixelOrderRGB |
It has the values: 1 = order of pixels in display is RGB; 0 = otherwise. |
| EDisplayIsPixelOrderLandscape |
It has the values: 1 = pixel order is landscape; 0 = pixel order is portrait. |
| EDisplayMode |
This indicates or sets the current display mode where EDisplayNumModes-1 is the maximum value for the display mode. The properties of a particular display mode are entirely defined by the base port software associated with the hardware upon which the OS is running.
|
| ESwitches |
If the target hardware upon which Symbian OS is running has switches which can be read by the base port software, this interface allows the current status of those switches to be read. |
| EDebugPort |
The port number of the debug port. |
| ELocaleLoaded |
The language code of the Locale which was loaded at device boot time. This is dynamic and writeable.
ELanguageIndex
|
| EClipboardDrive |
The drive number to use for storage of Clipboard data. 0 = Drive A, 1 = Drive B, etc... |
| ECustomRestart |
Custom restart
|
| ECustomRestartReason |
Custom restart reason |
| EDisplayNumberOfScreens |
The number of screens. |
| ENanoTickPeriod |
The time between nanokernel ticks, in microseconds. |
| EFastCounterFrequency |
The frequency of the fast counter. |
| EFastCounterCountsUp |
Indicates the whether the fast counter counts up or down. |
| EPointer3D |
Indicates whether a 3 dimensional pointing device is available for input and Z coordinate is provided in appropriate pointer-related TRawEvents generated by the driver. It has the values: 0 = a 3D pointer is not available for input and Z coordinate is not provided in TRawEvents; 1 = a 3D pointer is present and Z coordinate is provided in TRawEvents. |
| EPointer3DMaxProximity |
The furthest detectable 3D pointing device's proximity above the screen. As proximity values above the screen are negative, this will be a negative value. This is dynamic and writeable. |
| EPointer3DThetaSupported |
Indicates whether a 3 dimensional pointing device supports Theta polar angle reading. It has the values: 0 = a 3D pointer does not support Theta polar angle reading; 1 = a 3D pointer supports Theta polar angle reading. |
| EPointer3DPhiSupported |
Indicates whether a 3 dimensional pointing device supports Phi polar angle reading. It has the values: 0 = a 3D pointer does not support Phi polar angle reading; 1 = a 3D pointer supports Phi polar angle reading. |
| EPointer3DRotationSupported |
Indicates whether a 3 dimensional pointing device supports rotation angle along its main axis reading. It has the values: 0 = a 3D pointer does not support alpha (rotation) reading; 1 = a 3D pointer supports alpha (rotation) reading. |
| EPointer3DPressureSupported |
Indicates whether a 3 dimensional pointing device supports readings of pressure applied on screen. It has the values: 0 = a 3D pointer does not support pressure reading; 1 = a 3D pointer supports pressure reading. |
| EHardwareFloatingPoint |
Indicates whether hardware floating point is available, and what type. If no hardware floating point is available, reading this attribute will return KErrNotSupported. If hardware floating point is available, reading this attribute will return KErrNone and the type available. These types are specified in TFloatingPointType. |
| ETimeNonSecureOffset |
The offset between secure and nonsecure clocks. If this attribute is undefined no secure clock will be available. |
| EPersistStartupModeKernel |
Persist startup mode. If no variant specific implementation exists, the startup mode will be stored in platform specific values.hda file. |
| EMaximumCustomRestartReasons |
Maximum restart reasons. Returns the maximum number of values that can be used to store the restart reason required for a custom restart. |
| EMaximumRestartStartupModes |
Maximum startup modes. Returns the maximum number of values that can be used to store the startup mode requires for a system restart. |
| ECustomResourceDrive |
Defines the custom resource drive. This drive attribute should be set if an additional drive is required for use in the search algorithm for language files.
TDriveNumber BaflUtils::NearestLanguageFile for how this attribute is used
|
| EPointer3DProximityStep |
Step size of Z distance data. Returns the minimum size of the step between two resolvable z positions |
| EPointerMaxPointers |
Maximum Number of Pointers supported by hardware/driver Returns the maximum number of pointers for a multi-touch configuration (or KErrNotSupported or 0 or 1 for single-touch legacy configuration) |
| EPointerNumberOfPointers |
Maximum Number of Pointers Sets and reads back the number of pointers as requested by the UI (<=EPointerMaxPointers) |
| EPointer3DMaxPressure |
Maximum Pressure Value Returns the maximum pressure value |
| EPointer3DPressureStep |
Step size of pressure data. Returns the minimum size of the step between two resolvable pressure readings |
| EPointer3DEnterHighPressureThreshold |
The threshold on pointer's Z coordinate above which EEnterHighPressure pointer event is sent to WSERV's clients. This value is intended to be preconfigured in build time and modified by Window Server only 9.5 |
| EPointer3DExitHighPressureThreshold |
The threshold on pointer's Z coordinate below which EExitHighPressure pointer event is sent to WSERV's clients. This value is intended to be preconfigured in build time and modified by Window Server only 9.5 |
| EPointer3DEnterCloseProximityThreshold |
The threshold on pointer's Z coordinate above which EEnterCloseProximity pointer event is sent to WSERV's clients. This value is intended to be preconfigured in build time and modified by Window Server only 9.5 |
| EPointer3DExitCloseProximityThreshold |
The threshold on pointer's Z coordinate below which EExitCloseProximity pointer event is sent to WSERV's clients. This value is intended to be preconfigured in build time and modified by Window Server only 9.5 |
| EDisplayMemoryHandle |
A Handle to the display memory. This attribute opens a chunk, the client is responsible for closing it. Using HAL attribtues to open handles is not recommended and this attribute may be removed in the future. 9.5 |
| ESerialNumber |
Serial number of this board |
| ECpuProfilingDefaultInterruptBase |
Interrupt used by sampling profiler - applicable for SMP only. Each CPU_i is interrupted by interrupt number ECpuProfilingInterrupt + i |
| ENumCpus |
Number of processors present on the device. Returns 1 on unicore. This number is constant and does not take account of power management |
| EDigitiserOrientation |
The orientation of the Digitiser. Usually mirrors device orientation.
TDigitiserOrientation for allowed values
|
| ENumHalAttributes |
The number of HAL attributes per screen. It is simply defined by its position in the enumeration. |
Defines properties for the hardware attributes.
| EValid = 0x1 |
When set, means that an attribute is meaningful on this device. |
| ESettable = 0x2 |
When set, means that an attribute is modifiable. A call to HAL::Set() for an attribute that does not have this property, returns KErrNotSupported. |
Defines the set of ABIs used by the CPU for user applications.
| ECPUABI_ARM4 | |
| ECPUABI_ARMI | |
| ECPUABI_THUMB | |
| ECPUABI_MCORE | |
| ECPUABI_MSVC | |
| ECPUABI_ARM5T | |
| ECPUABI_X86 |
Defines the Symbian OS device families.
| EDeviceFamily_Crystal | |
| EDeviceFamily_Pearl | |
| EDeviceFamily_Quartz |
Describes the orientation of the screen digitiser, usually mirrors the device orientation not necessarily the display rotation as this might be limited to upright and left 90 only. The values in degrees measures the anti-clockwise angle from the left edge of the digitiser from the normal default position of the device.
User-side clients can use attribute to inform the digitiser driver of the digitiser orientation. The driver may then use this information to adjust X.Y sampling depending on input pointer type.
| EDigitiserOrientation_default | |
| EDigitiserOrientation_000 | |
| EDigitiserOrientation_090 | |
| EDigitiserOrientation_180 | |
| EDigitiserOrientation_270 |
Defines a set of UIDs for specific devices, reference boards etc
| EMachineUid_Series5mx = 0x1000118a | |
| EMachineUid_Brutus = 0x10005f60 | |
| EMachineUid_Cogent = 0x10005f61 | |
| EMachineUid_Win32Emulator = 0x10005f62 | |
| EMachineUid_WinC = 0x10005f63 | |
| EMachineUid_CL7211_Eval = 0x1000604f | |
| EMachineUid_LinkUp = 0x00000000 | |
| EMachineUid_Assabet = 0x100093f3 | |
| EMachineUid_Zylonite = 0x101f7f27 | |
| EMachineUid_IQ80310 = 0x1000a681 | |
| EMachineUid_Lubbock = 0x101f7f26 | |
| EMachineUid_Integrator = 0x1000AAEA | |
| EMachineUid_Helen = 0x101F3EE3 | |
| EMachineUid_X86PC = 0x100000ad | |
| EMachineUid_OmapH2 = 0x1020601C | |
| EMachineUid_OmapH4 = 0x102734E3 | |
| EMachineUid_NE1_TB = 0x102864F7 | |
| EMachineUid_EmuBoard = 0x1200afed | |
| EMachineUid_OmapH6 = 0x10286564 | |
| EMachineUid_OmapZoom = 0x10286565 | |
| EMachineUid_STE8500 = 0x101FF810 |
UIDs for a defined set of device manufacturers.
Note that any manufacturer not represented in this list must obtain a value from the Symbian registry.
| EManufacturer_Ericsson = 0x00000000 | |
| EManufacturer_Motorola = 0x00000001 | |
| EManufacturer_Nokia = 0x00000002 | |
| EManufacturer_Panasonic = 0x00000003 | |
| EManufacturer_Psion = 0x00000004 | |
| EManufacturer_Intel = 0x00000005 | |
| EManufacturer_Cogent = 0x00000006 | |
| EManufacturer_Cirrus = 0x00000007 | |
| EManufacturer_Linkup = 0x00000008 | |
| EManufacturer_TexasInstruments = 0x00000009 |
Defines the mouse cursor visibility.
| EMouseState_Invisible = 0 | |
| EMouseState_Visible = 1 |
Defines power levels for the backup power.
| EPowerBackupStatus_Zero | |
| EPowerBackupStatus_Replace | |
| EPowerBackupStatus_Low | |
| EPowerBackupStatus_Good |
Defines power levels for the system (or 'Main') battery.
| EPowerBatteryStatus_Zero | |
| EPowerBatteryStatus_Replace | |
| EPowerBatteryStatus_Low | |
| EPowerBatteryStatus_Good |
Defines the set of reasons for a system boot.
| ESystemStartupReason_Cold | |
| ESystemStartupReason_Warm | |
| ESystemStartupReason_Fault |
| bitmask TKeyboard | EKeyboard_Keypad |
Defines the set of available keyboard types.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.