epoc32/include/hal_data.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
     1.1 --- a/epoc32/include/hal_data.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/hal_data.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,9 +1,9 @@
     1.4  // Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5  // All rights reserved.
     1.6  // This component and the accompanying materials are made available
     1.7 -// 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
     1.8 +// under the terms of the License "Eclipse Public License v1.0"
     1.9  // which accompanies this distribution, and is available
    1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  //
    1.13  // Initial Contributors:
    1.14  // Nokia Corporation - initial contribution.
    1.15 @@ -15,14 +15,11 @@
    1.16  // 
    1.17  //
    1.18  
    1.19 +
    1.20  #ifndef __HAL_DATA_H__
    1.21  #define __HAL_DATA_H__
    1.22 -
    1.23  #define bitmask enum
    1.24  
    1.25 -
    1.26 -
    1.27 -
    1.28  class HALData
    1.29  /**
    1.30  @publishedPartner
    1.31 @@ -75,7 +72,7 @@
    1.32  
    1.33  		
    1.34  		/**
    1.35 -		This is device specific model number, as defined by
    1.36 +		The device specific model number, as defined by
    1.37  		the device manufacturer.
    1.38  		*/
    1.39  		EModel,
    1.40 @@ -100,7 +97,7 @@
    1.41  
    1.42  		
    1.43  		/**
    1.44 -		The Symbian OS specified device family version
    1.45 +		The Symbian OS specified device family version.
    1.46  		*/
    1.47  		EDeviceFamilyRev,
    1.48  
    1.49 @@ -217,7 +214,7 @@
    1.50  	
    1.51  		
    1.52  		/**
    1.53 -        The power level for backup power
    1.54 +        The power level for backup power.
    1.55          
    1.56          It has the values enumerated by TPowerBackupStatus.
    1.57  
    1.58 @@ -287,11 +284,11 @@
    1.59  		/**
    1.60  		The keyboard click volume level.
    1.61  
    1.62 -		It can take a value in the range 0 to EkeyboardClickVolumeMax.
    1.63 +		It can take a value in the range 0 to EKeyboardClickVolumeMax.
    1.64          
    1.65          This is dynamic and writeable.
    1.66          
    1.67 -        @see HALData::EkeyboardClickVolumeMax
    1.68 +        @see HALData::EKeyboardClickVolumeMax
    1.69  
    1.70  		@capability WriteDeviceData needed to Set this attribute
    1.71  		*/
    1.72 @@ -301,7 +298,7 @@
    1.73  		/**
    1.74  		The maximum value for EKeyboardClickVolume.
    1.75  		
    1.76 -		@see HALData::EkeyboardClickVolume
    1.77 +		@see HALData::EKeyboardClickVolume
    1.78  		*/
    1.79  		EKeyboardClickVolumeMax,
    1.80  	
    1.81 @@ -413,7 +410,7 @@
    1.82  			
    1.83  		
    1.84  		/**
    1.85 -		The is the pen/digitizer vertical resolution, in pixels.
    1.86 +		The pen/digitizer vertical resolution, in pixels.
    1.87  		*/
    1.88  		EPenY,
    1.89  			
    1.90 @@ -425,7 +422,7 @@
    1.91          0 = a pen tap has no effect;
    1.92          1 = a pent tap or press enables the display.
    1.93          
    1.94 -        The is dynamic and writeable
    1.95 +        This is dynamic and writeable.
    1.96  
    1.97  		@capability WriteDeviceData needed to Set this attribute
    1.98  		*/
    1.99 @@ -458,7 +455,7 @@
   1.100  			
   1.101  		
   1.102  		/**
   1.103 -		This pen click volume level.
   1.104 +		The pen click volume level.
   1.105          It can take a value in the range 0 to EPenClickVolumeMax.
   1.106          
   1.107          This value is dynamic and writable.
   1.108 @@ -482,7 +479,7 @@
   1.109  		Indicates whether a mouse is available for input.
   1.110  		
   1.111  		It has the values:
   1.112 -		0 = there is no mouse availablea pen/digitizeris present;
   1.113 +		0 = there is no mouse available pen/digitizer is present;
   1.114  		1 = a mouse is available for input.
   1.115  		*/
   1.116  		EMouse,
   1.117 @@ -534,7 +531,7 @@
   1.118  		
   1.119  		
   1.120  		/**
   1.121 -        A bitmask defining the state of each button .
   1.122 +        A bitmask defining the state of each button.
   1.123  
   1.124          For each bit, it has values:
   1.125          0 = up;
   1.126 @@ -636,7 +633,7 @@
   1.127  	
   1.128  		
   1.129  		/**
   1.130 -		Inidcates the state of the keyboard backlight.
   1.131 +		Indicates the state of the keyboard backlight.
   1.132          
   1.133          It has the values:
   1.134          0 = keyboard backlight is off;
   1.135 @@ -910,29 +907,25 @@
   1.136  		*/
   1.137  		EFastCounterCountsUp,
   1.138  
   1.139 -		/**
   1.140 -		@prototype
   1.141 -
   1.142 -		Indicates whether a 3 dimensional pointing device is available for input.
   1.143 +		/**		
   1.144 +		Indicates whether a 3 dimensional pointing device is available for input and Z coordinate
   1.145 +		is provided in appropriate pointer-related TRawEvents generated by the driver.
   1.146  
   1.147  		It has the values:
   1.148 -		0 = a 3D pointer is not available for input;
   1.149 -		1 = a 3D pointer is present.
   1.150 +		0 = a 3D pointer is not available for input and Z coordinate is not provided in TRawEvents;
   1.151 +		1 = a 3D pointer is present and Z coordinate is provided in TRawEvents.
   1.152  		*/
   1.153  		EPointer3D,
   1.154  
   1.155 -		/**
   1.156 -		@prototype
   1.157 -
   1.158 -		The 3D pointing device detection range, in units of distance above the screen.
   1.159 +		/**		
   1.160 +		The furthest detectable 3D pointing device's proximity above the screen.
   1.161 +		As proximity values above the screen are negative, this will be a negative value.
   1.162  
   1.163  		This is dynamic and writeable.
   1.164  		*/
   1.165 -		EPointer3DZ,
   1.166 +		EPointer3DMaxProximity,
   1.167  
   1.168 -		/**
   1.169 -		@prototype
   1.170 -
   1.171 +		/**		
   1.172  		Indicates whether a 3 dimensional pointing device supports Theta polar angle reading.
   1.173  
   1.174  		It has the values:
   1.175 @@ -942,8 +935,6 @@
   1.176  		EPointer3DThetaSupported,
   1.177  
   1.178  		/**
   1.179 -		@prototype
   1.180 -
   1.181  		Indicates whether a 3 dimensional pointing device supports Phi polar angle reading.
   1.182  
   1.183  		It has the values:
   1.184 @@ -953,8 +944,6 @@
   1.185  		EPointer3DPhiSupported,
   1.186  
   1.187  		/**
   1.188 -		@prototype
   1.189 -
   1.190  		Indicates whether a 3 dimensional pointing device supports rotation angle along its main axis reading.
   1.191  
   1.192  		It has the values:
   1.193 @@ -964,8 +953,6 @@
   1.194  		EPointer3DRotationSupported,
   1.195  
   1.196  		/**
   1.197 -		@prototype
   1.198 -
   1.199  		Indicates whether a 3 dimensional pointing device supports readings of pressure applied on screen.
   1.200  
   1.201  		It has the values:
   1.202 @@ -1014,7 +1001,7 @@
   1.203  		/**
   1.204  		Defines the custom resource drive.
   1.205  		
   1.206 -		This drive attribute should be set if an aditional drive is required for use in the search 
   1.207 +		This drive attribute should be set if an additional drive is required for use in the search 
   1.208  		algorithm for language files.  
   1.209          
   1.210          @see TDriveNumber
   1.211 @@ -1024,11 +1011,111 @@
   1.212  		ECustomResourceDrive,
   1.213  
   1.214  		/**
   1.215 +		Step size of Z distance data.
   1.216 +
   1.217 +		Returns the minimum size of the step between two resolvable z positions
   1.218 +		*/
   1.219 +		EPointer3DProximityStep,
   1.220 +
   1.221 +		/**
   1.222 +		Maximum Number of Pointers supported by hardware/driver
   1.223 +
   1.224 +		Returns the maximum number of pointers for a multi-touch configuration (or KErrNotSupported or 0 or 1 for single-touch legacy configuration)
   1.225 +		*/
   1.226 +		EPointerMaxPointers,
   1.227 +
   1.228 +		/**
   1.229 +		Maximum Number of Pointers
   1.230 +		
   1.231 +		Sets and reads back the number of pointers as requested by the UI (<=EPointerMaxPointers)
   1.232 +		*/
   1.233 +		EPointerNumberOfPointers,
   1.234 +
   1.235 +		/**
   1.236 +		Maximum Pressure Value
   1.237 +
   1.238 +		Returns the maximum pressure value
   1.239 +		*/
   1.240 +		EPointer3DMaxPressure,
   1.241 +
   1.242 +		/**
   1.243 +		Step size of pressure data.
   1.244 +
   1.245 +		Returns the minimum size of the step between two resolvable pressure readings			
   1.246 +		*/
   1.247 +		EPointer3DPressureStep,
   1.248 +
   1.249 +		/**
   1.250 +		The threshold on pointer's Z coordinate above which EEnterHighPressure pointer event is sent to WSERV's clients.
   1.251 +		This value is intended to be preconfigured in build time and modified by Window Server only
   1.252 +
   1.253 +		@prototype 9.5
   1.254 +		*/
   1.255 +		EPointer3DEnterHighPressureThreshold,
   1.256 +	
   1.257 +		/**
   1.258 +		The threshold on pointer's Z coordinate below which EExitHighPressure pointer event is sent to WSERV's clients.
   1.259 +		This value is intended to be preconfigured in build time and modified by Window Server only
   1.260 +
   1.261 +		@prototype 9.5
   1.262 +		*/
   1.263 +		EPointer3DExitHighPressureThreshold,
   1.264 +
   1.265 +		/**
   1.266 +		The threshold on pointer's Z coordinate above which EEnterCloseProximity pointer event is sent to WSERV's clients.
   1.267 +		This value is intended to be preconfigured in build time and modified by Window Server only
   1.268 +
   1.269 +		@prototype 9.5
   1.270 +		*/
   1.271 +		EPointer3DEnterCloseProximityThreshold,
   1.272 +
   1.273 +		
   1.274 +		/**
   1.275 +		The threshold on pointer's Z coordinate below which EExitCloseProximity pointer event is sent to WSERV's clients.
   1.276 +		This value is intended to be preconfigured in build time and modified by Window Server only
   1.277 +
   1.278 +		@prototype 9.5
   1.279 +		*/
   1.280 +		EPointer3DExitCloseProximityThreshold,
   1.281 +		
   1.282 +		/**
   1.283 +		A Handle to the display memory.
   1.284 +
   1.285 +		@prototype 9.5
   1.286 +		*/
   1.287 +		EDisplayMemoryHandle,
   1.288 +
   1.289 +		/**
   1.290 +		Serial number of this board
   1.291 +		*/
   1.292 +		ESerialNumber,
   1.293 +		
   1.294 +		
   1.295 +		/**
   1.296 +		Interrupt used by sampling profiler - applicable for SMP only. Each CPU_i is interrupted by interrupt number ECpuProfilingInterrupt + i
   1.297 +		*/
   1.298 +		ECpuProfilingDefaultInterruptBase,
   1.299 +
   1.300 +
   1.301 +		/**
   1.302 +		Number of processors present on the device. Returns 1 on unicore. This number is constant and does not take account of power management
   1.303 +		*/
   1.304 +		ENumCpus,
   1.305 +
   1.306 +
   1.307 +		/*
   1.308 +		 * NOTE:
   1.309 +		 * When updating this list, please also update hal/rom/hal.hby and hal/tsrc/t_newhal.cpp.
   1.310 +		 */
   1.311 +
   1.312 +		/**
   1.313 +		
   1.314  		The number of HAL attributes per screen.
   1.315  		
   1.316  		It is simply defined by its position in the enumeration.
   1.317  		*/
   1.318 -		ENumHalAttributes
   1.319 +		ENumHalAttributes		
   1.320 +
   1.321  		};
   1.322  
   1.323  
   1.324 @@ -1196,6 +1283,11 @@
   1.325  		EMachineUid_X86PC=0x100000ad,
   1.326  		EMachineUid_OmapH2=0x1020601C,
   1.327  		EMachineUid_OmapH4=0x102734E3,
   1.328 +		EMachineUid_NE1_TB=0x102864F7,
   1.329 +		EMachineUid_EmuBoard=0x1200afed,
   1.330 +		EMachineUid_OmapH6=0x10286564,
   1.331 +		EMachineUid_OmapZoom=0x10286565,
   1.332 +		EMachineUid_STE8500=0x101FF810,
   1.333  		};
   1.334  
   1.335  
   1.336 @@ -1227,6 +1319,7 @@
   1.337  		EPowerBackupStatus_Low,
   1.338  		EPowerBackupStatus_Good,
   1.339  		};
   1.340 +	
   1.341  	};
   1.342  
   1.343  #endif