UserHal Class Reference

class UserHal

A set of user side utility functions for acessing hardware related information.

Four of these functions are DEPRECATED and should NOT be used; some of these functions have replacements, but others do not; see the description of the individual functions.

Member Functions Documentation

CalibrationPoints(TDigitizerCalibration &)

IMPORT_C TIntCalibrationPoints(TDigitizerCalibration &aCalibration)[static]

Gets the points on the display that the user should point to in order to calibrate the digitiser (i.e. XY) input device.

Parameters

TDigitizerCalibration & aCalibrationA TDigitizerCalibration object that, on return, contains the appropriate information.

DriveInfo(TDes8 &)

IMPORT_C TIntDriveInfo(TDes8 &anInfo)[static]

Gets drive information.

TDriveInfoV1Buf TDriveInfoV1 TPckgBuf

Parameters

TDes8 & anInfoA package buffer (TPckgBuf) containing a TDriveInfoV1 structure. On return, this structure will contain the drive information.

ExceptionId(TInt &)

IMPORT_C TIntExceptionId(TInt &anId)[static]

Gets the exception Id that describes the type of fault when the kernel last faulted.

The Id is the value contained in TArmExcInfo::iExcCode.

TArmExcInfo::iExcCode TArmExcInfo

Parameters

TInt & anIdAn integer that, on return, contains the exception Id.

ExceptionInfo(TExcInfo &)

IMPORT_C TIntExceptionInfo(TExcInfo &aInfo)[static]

Gets the available exception information that describes the last kernel fault.

TExcInfo

Parameters

TExcInfo & aInfoA TExcInfo structure that, on return, contains the available exception information.

FaultReason(TInt &)

IMPORT_C TIntFaultReason(TInt &aReason)[static]

Gets the reason why the kernel last faulted.

Kern::Fault()

Parameters

TInt & aReasonAn integer that, on return, contains the reason code describing why the kernel faulted. This is the fault number passed in a call to Kern::Fault().

MachineInfo(TDes8 &)

IMPORT_C TIntMachineInfo(TDes8 &anInfo)[static]

Gets machine information.

Use HAL::Get() from the HAL library instead.

Parameters

TDes8 & anInfo

MemoryInfo(TDes8 &)

IMPORT_C TIntMemoryInfo(TDes8 &anInfo)[static]

Gets memory information.

HAL::Get()Use HAL::Get() from the HAL library instead with attributes EMemoryRAM, EMemoryRAMFree or EMemoryROM.

Parameters

TDes8 & anInfo

PageSizeInBytes(TInt &)

IMPORT_C TIntPageSizeInBytes(TInt &aSize)[static]

Gets the page size for this device.

Parameters

TInt & aSize

RestoreXYInputCalibration(TDigitizerCalibrationType)

IMPORT_C TIntRestoreXYInputCalibration(TDigitizerCalibrationTypeaType)[static]

Restores the digitiser (i.e. XY) input device calibration data.

capability
WriteDeviceData

Parameters

TDigitizerCalibrationType aTypeA TDigitizerCalibration object that, on return, contains the calibration data.

RomInfo(TDes8 &)

IMPORT_C TIntRomInfo(TDes8 &anInfo)[static]

Gets ROM configuration information.

No replacement.

Parameters

TDes8 & anInfo

SaveXYInputCalibration()

IMPORT_C TIntSaveXYInputCalibration()[static]

Saves the current digitiser (i.e. XY) input device calibration data.

SetXYInputCalibration(const TDigitizerCalibration &)

IMPORT_C TIntSetXYInputCalibration(const TDigitizerCalibration &aCalibration)[static]

Sets the calibration data for the digitiser (i.e. XY) input device.

TDigitizerCalibration
capability
WriteDeviceData

Parameters

const TDigitizerCalibration & aCalibrationThe calibration data.

StartupReason(TMachineStartupType &)

IMPORT_C TIntStartupReason(TMachineStartupType &aReason)[static]

Gets the startup reason.

HAL::Get()Use HAL::Get() from the HAL library instead with attributes ESystemStartupReason.

Parameters

TMachineStartupType & aReason

SwitchOff()

IMPORT_C TIntSwitchOff()[static]

Switches the device off.

capability
PowerMgmt

TickPeriod(TTimeIntervalMicroSeconds32 &)

IMPORT_C TIntTickPeriod(TTimeIntervalMicroSeconds32 &aPeriod)[static]

Gets the platform tick period.

Parameters

TTimeIntervalMicroSeconds32 & aPeriodThe tick period in microseconds.