sl@0: // Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // e32\include\e32hal.h
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __E32HAL_H__
sl@0: #define __E32HAL_H__
sl@0: #include <e32cmn.h>
sl@0: #include <e32cmn_private.h>
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated No replacement.
sl@0: */ 
sl@0: const TInt KMaxRomDevices=8;
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Defines the calibration settings that can be restored by 
sl@0: the digitiser's implementation of DDigitiser::RestoreXYInputCalibration.
sl@0: 
sl@0: See the digitiser template port in:
sl@0: @code
sl@0: ...\template\template_variant\specific\xyin.cpp
sl@0: @endcode
sl@0: 
sl@0: @see DDigitiser::RestoreXYInputCalibration()
sl@0: */ 
sl@0: enum TDigitizerCalibrationType
sl@0:     {
sl@0:     EFactory, /**< Restore to factory settings. */
sl@0:     ESaved    /**< Restore to saved settings.   */
sl@0:     };
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Defines the screen coordinates of the point touched during calibration.
sl@0: 
sl@0: An object of this type is passed, via a TPckgBuf, to the HAL handler
sl@0: that deals with the HAL group function-id pair:
sl@0: - EHalGroupDigitiser, EDigitiserHalSetXYInputCalibration
sl@0: - EHalGroupDigitiser, EDigitiserHalCalibrationPoints
sl@0: - EHalGroupDigitiser, EDigitiserHalRestoreXYInputCalibration
sl@0: 
sl@0: @see EDigitiserHalSetXYInputCalibration
sl@0: @see EDigitiserHalCalibrationPoints
sl@0: @see EDigitiserHalRestoreXYInputCalibration
sl@0: @see TDigitiserHalFunction
sl@0: @see EHalGroupDigitiser
sl@0: @see TPckgBuf
sl@0: */ 
sl@0: class TDigitizerCalibration
sl@0:     {
sl@0: public:
sl@0:     TPoint iTl;  /**< Top left point.*/
sl@0:     TPoint iBl;  /**< Bottom left point. */
sl@0:     TPoint iTr;  /**< Top right point.*/
sl@0:     TPoint iBr;  /**< Bottom right point.*/
sl@0:     };
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: An enum that identifies the full set of keyboard types.
sl@0: 
sl@0: A variable of this type is defined and used in the TKeyboardInfoV01 struct. 
sl@0: 
sl@0: @see TKeyboardInfoV01::iKeyboardType.
sl@0: */ 
sl@0: enum TKeyboard
sl@0: 	{
sl@0: 	EKeyboard_Keypad=1, /**< Keypad type*/
sl@0: 	EKeyboard_Full=2,   /**< Full keyboard type*/
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Encapsulates information about the keyboard.
sl@0: 
sl@0: NOTE that the information represented here is not used by Symbian OS, 
sl@0: and exists to maintain binary compatibilty with older versions.
sl@0: 
sl@0: However, keyboard drivers that implement the HAL handler for
sl@0: the EHalGroupKeyboard group still need to return a default object
sl@0: of this type.
sl@0: See the template port.
sl@0: 
sl@0: An object of this type is passed, via a TPckgBuf, to the HAL handler
sl@0: that deals with the HAL group function-id pair:
sl@0: - EHalGroupKeyboard, EKeyboardHalKeyboardInfo;
sl@0: 
sl@0: @see EKeyboardHalKeyboardInfo
sl@0: @see TKeyboardHalFunction
sl@0: @see EHalGroupKeyboard
sl@0: @see TPckgBuf
sl@0: */ 
sl@0: class TKeyboardInfoV01
sl@0: 	{
sl@0: public:
sl@0:     /**
sl@0:     The number of device keys.
sl@0:     
sl@0:     NOTE that the information represented by this variable is not
sl@0:     used by Symbian OS, and exists to maintain binary compatibility
sl@0:     with older versions. 
sl@0:     */
sl@0: 	TInt iDeviceKeys;
sl@0: 	
sl@0: 	
sl@0: 	/**
sl@0: 	The number of application keys.
sl@0: 	
sl@0: 	NOTE that the information represented by this variable is not
sl@0:     used by Symbian OS, and exists to maintain binary compatibility
sl@0:     with older versions. 
sl@0: 	*/
sl@0:     TInt iAppsKeys;
sl@0:     
sl@0:     
sl@0:     /**
sl@0:     Defines the type of keyboard available as enumerated by
sl@0:     the TKeyboard enum.
sl@0:         
sl@0:     NOTE that the information represented by this variable is not
sl@0:     used by Symbian OS, and exists to maintain binary compatibility
sl@0:     with older versions. 
sl@0:             
sl@0:     @see TKeyboard
sl@0:     */
sl@0: 	TKeyboard iKeyboardType;
sl@0:     };
sl@0:     
sl@0:     
sl@0:     
sl@0:     
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Package buffer for a TKeyboardInfoV01 object.
sl@0: 
sl@0: @see TKeyboardInfoV01
sl@0: */ 
sl@0: typedef TPckgBuf<TKeyboardInfoV01> TKeyboardInfoV01Buf;
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Encapsulates information about the digitiser.
sl@0: 
sl@0: An object of this type is passed, via a TPckgBuf, to the HAL handler
sl@0: that deals with the HAL group function-id pair:
sl@0: - EHalGroupDigitiser, EDigitiserHalXYInfo;
sl@0: 
sl@0: @see EDigitiserHalXYInfo
sl@0: @see TDigitiserHalFunction
sl@0: @see EHalGroupDigitiser
sl@0: @see TPckgBuf
sl@0: */ 
sl@0: class TDigitiserInfoV01
sl@0: 	{
sl@0: public:
sl@0: 	TPoint iOffsetToDisplay;/**< The offset in pixels from the digitiser usable area to the display area. */
sl@0: 	TSize iDigitiserSize;   /**< The width/height of the display in pixels as used by digitiser.*/
sl@0: 	};
sl@0: 	
sl@0: 	
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: Encapsulates extra information required by 3 dimensional pointing devices.
sl@0: */ 
sl@0: class TDigitiserInfoV02 : public TDigitiserInfoV01
sl@0: 	{	
sl@0: public :
sl@0: 	TInt iZRange;			/**< The maximum distance to screen a pointing device will be detected (settable).*/
sl@0: 	TUint8 iThetaSupported;	/**< A Boolean value that indicates if Theta polar angle detection (tilt) is supported.*/
sl@0: 	TUint8 iPhiSupported;	/**< A Boolean value that indicates if Phi polar angle detection (tilt) is supported.*/
sl@0: 	TUint8 iAlphaSupported;	/**< A Boolean value that indicates if rotation of the pointing device along its main axis is supported.*/
sl@0: 	TUint8 iPressureSupported; /**< A Boolean value that indicates if pressure applied on screen is supported.*/
sl@0: 	TInt iProximityStep;    /**<proximity resolution, e.g. proximity readings change in steps of 1, 5, 10, ... */
sl@0: 	TInt iMaxPressure;      /**< maximum pressure reading*/
sl@0: 	TInt iPressureStep;     /**< pressure resolution, */	
sl@0: 	TUint8 iMaxPointers;    /**< max number of multi-touch pointers supported by hardware/driver.*/ 
sl@0: 	TUint8 iNumberOfPointers;/**< Number of pointers it supports (settable).*/
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Package buffer for a TDigitiserInfoV01 object.
sl@0: 
sl@0: @see TDigitiserInfoV01
sl@0: */ 
sl@0: typedef TPckgBuf<TDigitiserInfoV01> TDigitiserInfoV01Buf;
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @prototype
sl@0: 
sl@0: Package buffer for a TDigitiserInfoV02 object.
sl@0: 
sl@0: @see TDigitiserInfoV02
sl@0: */ 
sl@0: typedef TPckgBuf<TDigitiserInfoV02> TDigitiserInfoV02Buf;
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Encapsulates information about the mouse display characteristics.
sl@0: 
sl@0: An object of this type is passed, via a TPckgBuf, to the HAL handler
sl@0: that deals with the HAL group function-id pair:
sl@0: - EHalGroupMouse, EMouseHalMouseInfo;
sl@0: 
sl@0: @see EMouseHalMouseInfo
sl@0: @see TMouseHalFunction
sl@0: @see EHalGroupMouse
sl@0: @see TPckgBuf
sl@0: */ 
sl@0: class TMouseInfoV01
sl@0: 	{
sl@0: public:
sl@0: 	TInt iMouseButtons;      /**< The number of mouse buttons.*/
sl@0: 	TPoint iOffsetToDisplay; /**< The offset in pixels from the mouse usable area to the display area.*/
sl@0: 	TSize iMouseAreaSize;    /**< The width/height of the display in pixels as used by the mouse.     */
sl@0: 	};
sl@0: 	
sl@0: 	
sl@0: 	
sl@0: 	
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Package buffer for a TMouseInfoV01 object.
sl@0: 
sl@0: @see TMouseInfoV01
sl@0: */ 
sl@0: typedef TPckgBuf<TMouseInfoV01> TMouseInfoV01Buf;
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Encapsulates Variant specific information.
sl@0: 
sl@0: An object of this type is passed, via a TPckgBuf, to the HAL handler
sl@0: that deals with the HAL group function-id pair:
sl@0: - EHalGroupVariant, EVariantHalVariantInfo;
sl@0: 
sl@0: @see EVariantHalVariantInfo
sl@0: @see TVariantHalFunction
sl@0: @see EHalGroupVariant
sl@0: @see TPckgBuf
sl@0: */ 
sl@0: class TVariantInfoV01
sl@0: 	{
sl@0: public:
sl@0:     /**
sl@0:     The ROM version.
sl@0:     */
sl@0: 	TVersion iRomVersion;
sl@0: 	
sl@0: 	/**
sl@0: 	The Id that uniquely identifies the device.
sl@0: 	*/
sl@0: 	SInt64 iMachineUniqueId;
sl@0: 	
sl@0: 	/**
sl@0: 	The bits that represent the LED capabilities.
sl@0: 	
sl@0: 	NB capabilities in this context does not mean security capabilities.
sl@0: 	*/
sl@0:     TUint iLedCapabilities;
sl@0:     
sl@0:     /**
sl@0:     The processor clock speed.
sl@0:     */
sl@0:     TInt iProcessorClockInKHz;
sl@0:     
sl@0:     /**
sl@0:     The speed factor. 
sl@0:     */
sl@0:     TInt iSpeedFactor;
sl@0:     };
sl@0:     
sl@0:     
sl@0:     
sl@0:     
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Package buffer for a TVariantInfoV01 object.
sl@0: 
sl@0: @see TVariantInfoV01
sl@0: */ 
sl@0: typedef TPckgBuf<TVariantInfoV01> TVariantInfoV01Buf;
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated Use HAL::Get() from the HAL library instead with attributes ESystemStartupReason.
sl@0: 
sl@0: The reason that the device last reset
sl@0: 
sl@0: Note that not all reasons can occur on all devices.
sl@0: */
sl@0: enum TMachineStartupType
sl@0: 	{
sl@0: 	EStartupCold,EStartupColdReset,EStartupNewOs,
sl@0: 	EStartupPowerFail,EStartupWarmReset,EStartupKernelFault,
sl@0: 	EStartupSafeReset
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated Use HAL::Get() from the HAL library instead with attributes  EPen or EMouse.
sl@0: 
sl@0: The XY input method supported
sl@0: */
sl@0: enum TXYInputType
sl@0: 	{
sl@0: 	EXYInputNone,
sl@0: 	EXYInputPointer,
sl@0: 	EXYInputMouse,
sl@0: 	EXYInputDeltaMouse
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated Use HAL::Get() from the HAL library instead.
sl@0: 
sl@0: Miscellaneous machine info.
sl@0: */
sl@0: class TMachineInfoV1
sl@0: 	{
sl@0: public:
sl@0: 	TVersion iRomVersion;
sl@0: 	TXYInputType iXYInputType;
sl@0: 	TBool iKeyboardPresent;
sl@0: 	TBool iBacklightPresent;
sl@0:     TSize iDisplaySizeInPixels;
sl@0:     TSize iXYInputSizeInPixels;
sl@0:     TSize iPhysicalScreenSize;
sl@0: 	TPoint iOffsetToDisplayInPixels;
sl@0: 	TInt iKeyboardId;
sl@0: 	TInt iDisplayId;
sl@0: 	SInt64 iMachineUniqueId;
sl@0:     TUint iLedCapabilities;
sl@0:     TInt iProcessorClockInKHz;
sl@0:     TInt iSpeedFactor;
sl@0:     TInt iMaximumDisplayColors;
sl@0: 	};
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated
sl@0: */
sl@0: typedef TPckgBuf<TMachineInfoV1> TMachineInfoV1Buf;
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated Use HAL::Get() from the HAL library instead with attributes ELanguageIndex or EKeyboardIndex.
sl@0: 
sl@0: Miscellaneous locale info.
sl@0: */
sl@0: class TMachineInfoV2 : public TMachineInfoV1
sl@0: 	{
sl@0: public:
sl@0: 	TInt iLanguageIndex;
sl@0:     TInt iKeyboardIndex;
sl@0:     };
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated
sl@0: */
sl@0: typedef TPckgBuf<TMachineInfoV2> TMachineInfoV2Buf;
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated Use HAL::Get() from the HAL library instead with attributes EMemoryRAM, EMemoryRAMFree or EMemoryROM.
sl@0: 
sl@0: Miscellaneous memory info.
sl@0: */ 
sl@0: class TMemoryInfoV1
sl@0:     {
sl@0: public:
sl@0:     TInt iTotalRamInBytes;
sl@0:     TInt iTotalRomInBytes;
sl@0:     TInt iMaxFreeRamInBytes;
sl@0:     TInt iFreeRamInBytes;
sl@0:     TInt iInternalDiskRamInBytes;
sl@0:     TBool iRomIsReprogrammable;
sl@0:     };
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated
sl@0: */
sl@0: typedef TPckgBuf<TMemoryInfoV1> TMemoryInfoV1Buf;
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated No replacement.
sl@0: 
sl@0: Miscellaneous ROM info.
sl@0: */ 
sl@0: class TRomInfoEntryV1
sl@0: 	{
sl@0: public:
sl@0:     enum TRomTypeV1
sl@0:     	{
sl@0:     	ERomTypeRom=0,
sl@0:     	ERomTypeFlash=1
sl@0:     	};
sl@0: 	TInt iSize;		    // size of ROM in bytes, 0=no ROM present
sl@0: 	TInt iWidth;		// bus width in bits
sl@0: 	TInt iSpeed;		// number of wait states
sl@0: 	TRomTypeV1 iType;	// 0=ROM, 1=FLASH
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated No replacement.
sl@0: 
sl@0: Miscellaneous ROM info.
sl@0: */ 
sl@0: class TRomInfoV1
sl@0: 	{
sl@0: public:
sl@0: 	TRomInfoEntryV1	iEntry[KMaxRomDevices];
sl@0: 	};
sl@0: /**
sl@0: @publishedPartner
sl@0: @deprecated
sl@0: */
sl@0: typedef TPckgBuf<TRomInfoV1> TRomInfoV1Buf;
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: const TUint KRuggedFileSystem=0x01;
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: class TDriveInfoV1
sl@0:     {
sl@0: public:
sl@0: 	TInt iTotalSupportedDrives;
sl@0: 	TInfoName iDriveName[KMaxLocalDrives];
sl@0: 	TInt iTotalSockets;
sl@0: 	TInfoName iSocketName[KMaxPBusSockets];
sl@0: 	TInt iRuggedFileSystem;
sl@0: 	TUint iRegisteredDriveBitmask;
sl@0: 	};
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: typedef TPckgBuf<TDriveInfoV1> TDriveInfoV1Buf;
sl@0: 
sl@0: #if defined(_UNICODE) && !defined(__KERNEL_MODE__)
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: class TDriveInfoV18
sl@0:     {
sl@0: public:
sl@0: 	TInt iTotalSupportedDrives;
sl@0: 	TBuf8<KMaxInfoName> iDriveName[KMaxLocalDrives]; //TInfoName
sl@0: 	TInt iTotalSockets;
sl@0: 	TBuf8<KMaxInfoName> iSocketName[KMaxPBusSockets]; //TInfoName
sl@0: 	TInt iRuggedFileSystem;
sl@0: 	TUint iRegisteredDriveBitmask;
sl@0: 	};
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: typedef TPckgBuf<TDriveInfoV18> TDriveInfoV1Buf8;
sl@0: #else
sl@0: typedef TDriveInfoV1 TDriveInfoV18;
sl@0: typedef TDriveInfoV1Buf TDriveInfoV1Buf8;
sl@0: #endif
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: class TExcInfo
sl@0: 	{
sl@0: public:
sl@0: 	TAny *iCodeAddress;
sl@0: 	TAny *iDataAddress;
sl@0: 	TInt iExtraData;
sl@0: 	};
sl@0: 
sl@0: #ifndef __KERNEL_MODE__
sl@0: #include <e32std.h>
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: A set of user side utility functions for acessing hardware related
sl@0: information.
sl@0: 
sl@0: Four of these functions are DEPRECATED and should NOT be used; some of
sl@0: these functions have replacements, but others do not; see the description of
sl@0: the individual functions.
sl@0: 
sl@0: The following functions are not deprecated, but are only used by Symbian
sl@0: OS as part of its internal implementation:
sl@0: -  UserHal::FaultReason()
sl@0: -  UserHal::ExceptionId()
sl@0: -  UserHal::ExceptionInfo()
sl@0: -  UserHal::PageSizeInBytes()
sl@0: -  UserHal::TickPeriod()
sl@0: -  UserHal::DriveInfo()
sl@0: -  UserHal::SwitchOff()
sl@0: -  UserHal::SetXYInputCalibration()
sl@0: -  UserHal::CalibrationPoints()
sl@0: -  UserHal::SaveXYInputCalibration()
sl@0: -  UserHal::RestoreXYInputCalibration()
sl@0: */
sl@0: class UserHal
sl@0: 	{
sl@0: public:
sl@0: 	// kernel group
sl@0: 	IMPORT_C static TInt MemoryInfo(TDes8& anInfo);
sl@0: 	IMPORT_C static TInt RomInfo(TDes8& anInfo);
sl@0: 	IMPORT_C static TInt StartupReason(TMachineStartupType& aReason);
sl@0: 	IMPORT_C static TInt FaultReason(TInt &aReason);
sl@0: 	IMPORT_C static TInt ExceptionId(TInt &anId);
sl@0: 	IMPORT_C static TInt ExceptionInfo(TExcInfo &aInfo);
sl@0: 	IMPORT_C static TInt PageSizeInBytes(TInt& aSize);
sl@0: 
sl@0: 	// variant group
sl@0: 	IMPORT_C static TInt MachineInfo(TDes8& anInfo);
sl@0: 	IMPORT_C static TInt TickPeriod(TTimeIntervalMicroSeconds32& aPeriod);
sl@0: 
sl@0: 	// media group
sl@0: 	IMPORT_C static TInt DriveInfo(TDes8& anInfo);
sl@0: 
sl@0: 	// power group
sl@0:    	IMPORT_C static TInt SwitchOff();
sl@0: 
sl@0: 	// digitiser group
sl@0: 	IMPORT_C static TInt SetXYInputCalibration(const TDigitizerCalibration& aCalibration);
sl@0: 	IMPORT_C static TInt CalibrationPoints(TDigitizerCalibration& aCalibration);
sl@0: 	IMPORT_C static TInt SaveXYInputCalibration();
sl@0: 	IMPORT_C static TInt RestoreXYInputCalibration(TDigitizerCalibrationType aType);
sl@0: 	};
sl@0: #endif
sl@0: #endif
sl@0: