epoc32/include/hal_data.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     4 // under the terms of the License "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    13 // Description:
    13 // Description:
    14 // hal\inc\hal_data.h
    14 // hal\inc\hal_data.h
    15 // 
    15 // 
    16 //
    16 //
    17 
    17 
       
    18 
    18 #ifndef __HAL_DATA_H__
    19 #ifndef __HAL_DATA_H__
    19 #define __HAL_DATA_H__
    20 #define __HAL_DATA_H__
    20 
       
    21 #define bitmask enum
    21 #define bitmask enum
    22 
       
    23 
       
    24 
       
    25 
    22 
    26 class HALData
    23 class HALData
    27 /**
    24 /**
    28 @publishedPartner
    25 @publishedPartner
    29 @released
    26 @released
    73 		*/
    70 		*/
    74 		EManufacturerSoftwareBuild,
    71 		EManufacturerSoftwareBuild,
    75 
    72 
    76 		
    73 		
    77 		/**
    74 		/**
    78 		This is device specific model number, as defined by
    75 		The device specific model number, as defined by
    79 		the device manufacturer.
    76 		the device manufacturer.
    80 		*/
    77 		*/
    81 		EModel,
    78 		EModel,
    82 		
    79 		
    83 				
    80 				
    98 		*/
    95 		*/
    99 		EDeviceFamily,
    96 		EDeviceFamily,
   100 
    97 
   101 		
    98 		
   102 		/**
    99 		/**
   103 		The Symbian OS specified device family version
   100 		The Symbian OS specified device family version.
   104 		*/
   101 		*/
   105 		EDeviceFamilyRev,
   102 		EDeviceFamilyRev,
   106 
   103 
   107 		
   104 		
   108 		/**
   105 		/**
   215 		*/
   212 		*/
   216 		EPowerBackup,
   213 		EPowerBackup,
   217 	
   214 	
   218 		
   215 		
   219 		/**
   216 		/**
   220         The power level for backup power
   217         The power level for backup power.
   221         
   218         
   222         It has the values enumerated by TPowerBackupStatus.
   219         It has the values enumerated by TPowerBackupStatus.
   223 
   220 
   224 		This is dynamic and readonly.
   221 		This is dynamic and readonly.
   225 		
   222 		
   285 	
   282 	
   286 		
   283 		
   287 		/**
   284 		/**
   288 		The keyboard click volume level.
   285 		The keyboard click volume level.
   289 
   286 
   290 		It can take a value in the range 0 to EkeyboardClickVolumeMax.
   287 		It can take a value in the range 0 to EKeyboardClickVolumeMax.
   291         
   288         
   292         This is dynamic and writeable.
   289         This is dynamic and writeable.
   293         
   290         
   294         @see HALData::EkeyboardClickVolumeMax
   291         @see HALData::EKeyboardClickVolumeMax
   295 
   292 
   296 		@capability WriteDeviceData needed to Set this attribute
   293 		@capability WriteDeviceData needed to Set this attribute
   297 		*/
   294 		*/
   298 		EKeyboardClickVolume,
   295 		EKeyboardClickVolume,
   299 	
   296 	
   300 		
   297 		
   301 		/**
   298 		/**
   302 		The maximum value for EKeyboardClickVolume.
   299 		The maximum value for EKeyboardClickVolume.
   303 		
   300 		
   304 		@see HALData::EkeyboardClickVolume
   301 		@see HALData::EKeyboardClickVolume
   305 		*/
   302 		*/
   306 		EKeyboardClickVolumeMax,
   303 		EKeyboardClickVolumeMax,
   307 	
   304 	
   308 		
   305 		
   309 		/**
   306 		/**
   411 		*/
   408 		*/
   412 		EPenX,
   409 		EPenX,
   413 			
   410 			
   414 		
   411 		
   415 		/**
   412 		/**
   416 		The is the pen/digitizer vertical resolution, in pixels.
   413 		The pen/digitizer vertical resolution, in pixels.
   417 		*/
   414 		*/
   418 		EPenY,
   415 		EPenY,
   419 			
   416 			
   420 		
   417 		
   421 		/**
   418 		/**
   423 
   420 
   424         It has the values:
   421         It has the values:
   425         0 = a pen tap has no effect;
   422         0 = a pen tap has no effect;
   426         1 = a pent tap or press enables the display.
   423         1 = a pent tap or press enables the display.
   427         
   424         
   428         The is dynamic and writeable
   425         This is dynamic and writeable.
   429 
   426 
   430 		@capability WriteDeviceData needed to Set this attribute
   427 		@capability WriteDeviceData needed to Set this attribute
   431 		*/
   428 		*/
   432 		EPenDisplayOn,
   429 		EPenDisplayOn,
   433 			
   430 			
   456 		*/
   453 		*/
   457 		EPenClickState,
   454 		EPenClickState,
   458 			
   455 			
   459 		
   456 		
   460 		/**
   457 		/**
   461 		This pen click volume level.
   458 		The pen click volume level.
   462         It can take a value in the range 0 to EPenClickVolumeMax.
   459         It can take a value in the range 0 to EPenClickVolumeMax.
   463         
   460         
   464         This value is dynamic and writable.
   461         This value is dynamic and writable.
   465         
   462         
   466         @see HALData::EPenClickVolumeMax
   463         @see HALData::EPenClickVolumeMax
   480 		
   477 		
   481 		/**
   478 		/**
   482 		Indicates whether a mouse is available for input.
   479 		Indicates whether a mouse is available for input.
   483 		
   480 		
   484 		It has the values:
   481 		It has the values:
   485 		0 = there is no mouse availablea pen/digitizeris present;
   482 		0 = there is no mouse available pen/digitizer is present;
   486 		1 = a mouse is available for input.
   483 		1 = a mouse is available for input.
   487 		*/
   484 		*/
   488 		EMouse,
   485 		EMouse,
   489 			
   486 			
   490 		
   487 		
   532 		*/
   529 		*/
   533 		EMouseButtons,
   530 		EMouseButtons,
   534 		
   531 		
   535 		
   532 		
   536 		/**
   533 		/**
   537         A bitmask defining the state of each button .
   534         A bitmask defining the state of each button.
   538 
   535 
   539         For each bit, it has values:
   536         For each bit, it has values:
   540         0 = up;
   537         0 = up;
   541         1 = down.
   538         1 = down.
   542         
   539         
   634 		*/
   631 		*/
   635 		EDisplayBrightnessMax,
   632 		EDisplayBrightnessMax,
   636 	
   633 	
   637 		
   634 		
   638 		/**
   635 		/**
   639 		Inidcates the state of the keyboard backlight.
   636 		Indicates the state of the keyboard backlight.
   640         
   637         
   641         It has the values:
   638         It has the values:
   642         0 = keyboard backlight is off;
   639         0 = keyboard backlight is off;
   643         1 = keyboard backlight is on.
   640         1 = keyboard backlight is on.
   644 
   641 
   908 		/**
   905 		/**
   909 		Indicates the whether the fast counter counts up or down.
   906 		Indicates the whether the fast counter counts up or down.
   910 		*/
   907 		*/
   911 		EFastCounterCountsUp,
   908 		EFastCounterCountsUp,
   912 
   909 
   913 		/**
   910 		/**		
   914 		@prototype
   911 		Indicates whether a 3 dimensional pointing device is available for input and Z coordinate
   915 
   912 		is provided in appropriate pointer-related TRawEvents generated by the driver.
   916 		Indicates whether a 3 dimensional pointing device is available for input.
   913 
   917 
   914 		It has the values:
   918 		It has the values:
   915 		0 = a 3D pointer is not available for input and Z coordinate is not provided in TRawEvents;
   919 		0 = a 3D pointer is not available for input;
   916 		1 = a 3D pointer is present and Z coordinate is provided in TRawEvents.
   920 		1 = a 3D pointer is present.
       
   921 		*/
   917 		*/
   922 		EPointer3D,
   918 		EPointer3D,
   923 
   919 
   924 		/**
   920 		/**		
   925 		@prototype
   921 		The furthest detectable 3D pointing device's proximity above the screen.
   926 
   922 		As proximity values above the screen are negative, this will be a negative value.
   927 		The 3D pointing device detection range, in units of distance above the screen.
       
   928 
   923 
   929 		This is dynamic and writeable.
   924 		This is dynamic and writeable.
   930 		*/
   925 		*/
   931 		EPointer3DZ,
   926 		EPointer3DMaxProximity,
   932 
   927 
   933 		/**
   928 		/**		
   934 		@prototype
       
   935 
       
   936 		Indicates whether a 3 dimensional pointing device supports Theta polar angle reading.
   929 		Indicates whether a 3 dimensional pointing device supports Theta polar angle reading.
   937 
   930 
   938 		It has the values:
   931 		It has the values:
   939 		0 = a 3D pointer does not support Theta polar angle reading;
   932 		0 = a 3D pointer does not support Theta polar angle reading;
   940 		1 = a 3D pointer supports Theta polar angle reading.
   933 		1 = a 3D pointer supports Theta polar angle reading.
   941 		*/
   934 		*/
   942 		EPointer3DThetaSupported,
   935 		EPointer3DThetaSupported,
   943 
   936 
   944 		/**
   937 		/**
   945 		@prototype
       
   946 
       
   947 		Indicates whether a 3 dimensional pointing device supports Phi polar angle reading.
   938 		Indicates whether a 3 dimensional pointing device supports Phi polar angle reading.
   948 
   939 
   949 		It has the values:
   940 		It has the values:
   950 		0 = a 3D pointer does not support Phi polar angle reading;
   941 		0 = a 3D pointer does not support Phi polar angle reading;
   951 		1 = a 3D pointer supports Phi polar angle reading.
   942 		1 = a 3D pointer supports Phi polar angle reading.
   952 		*/
   943 		*/
   953 		EPointer3DPhiSupported,
   944 		EPointer3DPhiSupported,
   954 
   945 
   955 		/**
   946 		/**
   956 		@prototype
       
   957 
       
   958 		Indicates whether a 3 dimensional pointing device supports rotation angle along its main axis reading.
   947 		Indicates whether a 3 dimensional pointing device supports rotation angle along its main axis reading.
   959 
   948 
   960 		It has the values:
   949 		It has the values:
   961 		0 = a 3D pointer does not support alpha (rotation) reading;
   950 		0 = a 3D pointer does not support alpha (rotation) reading;
   962 		1 = a 3D pointer supports alpha (rotation) reading.
   951 		1 = a 3D pointer supports alpha (rotation) reading.
   963 		*/
   952 		*/
   964 		EPointer3DRotationSupported,
   953 		EPointer3DRotationSupported,
   965 
   954 
   966 		/**
   955 		/**
   967 		@prototype
       
   968 
       
   969 		Indicates whether a 3 dimensional pointing device supports readings of pressure applied on screen.
   956 		Indicates whether a 3 dimensional pointing device supports readings of pressure applied on screen.
   970 
   957 
   971 		It has the values:
   958 		It has the values:
   972 		0 = a 3D pointer does not support pressure reading;
   959 		0 = a 3D pointer does not support pressure reading;
   973 		1 = a 3D pointer supports pressure reading.
   960 		1 = a 3D pointer supports pressure reading.
  1012 		EMaximumRestartStartupModes,
   999 		EMaximumRestartStartupModes,
  1013 		
  1000 		
  1014 		/**
  1001 		/**
  1015 		Defines the custom resource drive.
  1002 		Defines the custom resource drive.
  1016 		
  1003 		
  1017 		This drive attribute should be set if an aditional drive is required for use in the search 
  1004 		This drive attribute should be set if an additional drive is required for use in the search 
  1018 		algorithm for language files.  
  1005 		algorithm for language files.  
  1019         
  1006         
  1020         @see TDriveNumber
  1007         @see TDriveNumber
  1021 		@see BaflUtils::NearestLanguageFile for how this attribute is used
  1008 		@see BaflUtils::NearestLanguageFile for how this attribute is used
  1022 		@capability WriteDeviceData needed to Set this attribute
  1009 		@capability WriteDeviceData needed to Set this attribute
  1023 		*/
  1010 		*/
  1024 		ECustomResourceDrive,
  1011 		ECustomResourceDrive,
  1025 
  1012 
  1026 		/**
  1013 		/**
       
  1014 		Step size of Z distance data.
       
  1015 
       
  1016 		Returns the minimum size of the step between two resolvable z positions
       
  1017 		*/
       
  1018 		EPointer3DProximityStep,
       
  1019 
       
  1020 		/**
       
  1021 		Maximum Number of Pointers supported by hardware/driver
       
  1022 
       
  1023 		Returns the maximum number of pointers for a multi-touch configuration (or KErrNotSupported or 0 or 1 for single-touch legacy configuration)
       
  1024 		*/
       
  1025 		EPointerMaxPointers,
       
  1026 
       
  1027 		/**
       
  1028 		Maximum Number of Pointers
       
  1029 		
       
  1030 		Sets and reads back the number of pointers as requested by the UI (<=EPointerMaxPointers)
       
  1031 		*/
       
  1032 		EPointerNumberOfPointers,
       
  1033 
       
  1034 		/**
       
  1035 		Maximum Pressure Value
       
  1036 
       
  1037 		Returns the maximum pressure value
       
  1038 		*/
       
  1039 		EPointer3DMaxPressure,
       
  1040 
       
  1041 		/**
       
  1042 		Step size of pressure data.
       
  1043 
       
  1044 		Returns the minimum size of the step between two resolvable pressure readings			
       
  1045 		*/
       
  1046 		EPointer3DPressureStep,
       
  1047 
       
  1048 		/**
       
  1049 		The threshold on pointer's Z coordinate above which EEnterHighPressure pointer event is sent to WSERV's clients.
       
  1050 		This value is intended to be preconfigured in build time and modified by Window Server only
       
  1051 
       
  1052 		@prototype 9.5
       
  1053 		*/
       
  1054 		EPointer3DEnterHighPressureThreshold,
       
  1055 	
       
  1056 		/**
       
  1057 		The threshold on pointer's Z coordinate below which EExitHighPressure pointer event is sent to WSERV's clients.
       
  1058 		This value is intended to be preconfigured in build time and modified by Window Server only
       
  1059 
       
  1060 		@prototype 9.5
       
  1061 		*/
       
  1062 		EPointer3DExitHighPressureThreshold,
       
  1063 
       
  1064 		/**
       
  1065 		The threshold on pointer's Z coordinate above which EEnterCloseProximity pointer event is sent to WSERV's clients.
       
  1066 		This value is intended to be preconfigured in build time and modified by Window Server only
       
  1067 
       
  1068 		@prototype 9.5
       
  1069 		*/
       
  1070 		EPointer3DEnterCloseProximityThreshold,
       
  1071 
       
  1072 		
       
  1073 		/**
       
  1074 		The threshold on pointer's Z coordinate below which EExitCloseProximity pointer event is sent to WSERV's clients.
       
  1075 		This value is intended to be preconfigured in build time and modified by Window Server only
       
  1076 
       
  1077 		@prototype 9.5
       
  1078 		*/
       
  1079 		EPointer3DExitCloseProximityThreshold,
       
  1080 		
       
  1081 		/**
       
  1082 		A Handle to the display memory.
       
  1083 
       
  1084 		@prototype 9.5
       
  1085 		*/
       
  1086 		EDisplayMemoryHandle,
       
  1087 
       
  1088 		/**
       
  1089 		Serial number of this board
       
  1090 		*/
       
  1091 		ESerialNumber,
       
  1092 		
       
  1093 		
       
  1094 		/**
       
  1095 		Interrupt used by sampling profiler - applicable for SMP only. Each CPU_i is interrupted by interrupt number ECpuProfilingInterrupt + i
       
  1096 		*/
       
  1097 		ECpuProfilingDefaultInterruptBase,
       
  1098 
       
  1099 
       
  1100 		/**
       
  1101 		Number of processors present on the device. Returns 1 on unicore. This number is constant and does not take account of power management
       
  1102 		*/
       
  1103 		ENumCpus,
       
  1104 
       
  1105 
       
  1106 		/*
       
  1107 		 * NOTE:
       
  1108 		 * When updating this list, please also update hal/rom/hal.hby and hal/tsrc/t_newhal.cpp.
       
  1109 		 */
       
  1110 
       
  1111 		/**
       
  1112 		
  1027 		The number of HAL attributes per screen.
  1113 		The number of HAL attributes per screen.
  1028 		
  1114 		
  1029 		It is simply defined by its position in the enumeration.
  1115 		It is simply defined by its position in the enumeration.
  1030 		*/
  1116 		*/
  1031 		ENumHalAttributes
  1117 		ENumHalAttributes		
       
  1118 
  1032 		};
  1119 		};
  1033 
  1120 
  1034 
  1121 
  1035 
  1122 
  1036     /**
  1123     /**
  1194 		EMachineUid_Integrator=0x1000AAEA,
  1281 		EMachineUid_Integrator=0x1000AAEA,
  1195 		EMachineUid_Helen=0x101F3EE3,
  1282 		EMachineUid_Helen=0x101F3EE3,
  1196 		EMachineUid_X86PC=0x100000ad,
  1283 		EMachineUid_X86PC=0x100000ad,
  1197 		EMachineUid_OmapH2=0x1020601C,
  1284 		EMachineUid_OmapH2=0x1020601C,
  1198 		EMachineUid_OmapH4=0x102734E3,
  1285 		EMachineUid_OmapH4=0x102734E3,
       
  1286 		EMachineUid_NE1_TB=0x102864F7,
       
  1287 		EMachineUid_EmuBoard=0x1200afed,
       
  1288 		EMachineUid_OmapH6=0x10286564,
       
  1289 		EMachineUid_OmapZoom=0x10286565,
       
  1290 		EMachineUid_STE8500=0x101FF810,
  1199 		};
  1291 		};
  1200 
  1292 
  1201 
  1293 
  1202 
  1294 
  1203     /**
  1295     /**
  1225 		EPowerBackupStatus_Zero,
  1317 		EPowerBackupStatus_Zero,
  1226 		EPowerBackupStatus_Replace,
  1318 		EPowerBackupStatus_Replace,
  1227 		EPowerBackupStatus_Low,
  1319 		EPowerBackupStatus_Low,
  1228 		EPowerBackupStatus_Good,
  1320 		EPowerBackupStatus_Good,
  1229 		};
  1321 		};
       
  1322 	
  1230 	};
  1323 	};
  1231 
  1324 
  1232 #endif
  1325 #endif