2 * Copyright (C) 2010 The Android Open Source Project
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <sys/types.h>
20 #include <sys/limits.h>
22 #include <utils/Errors.h>
23 #include <utils/String8.h>
24 #include <utils/Flattenable.h>
26 #include <hardware/sensors.h>
28 #include <binder/AppOpsManager.h>
29 #include <binder/IServiceManager.h>
31 #include <gui/Sensor.h>
34 // ----------------------------------------------------------------------------
36 // ----------------------------------------------------------------------------
38 Sensor::Sensor(const char * name)
39 : mName(name), mHandle(0), mType(0),
40 mMinValue(0), mMaxValue(0), mResolution(0),
41 mPower(0), mMinDelay(0), mVersion(0), mFifoReservedEventCount(0),
42 mFifoMaxEventCount(0), mRequiredAppOp(0),
43 mMaxDelay(0), mFlags(0)
47 Sensor::Sensor(struct sensor_t const* hwSensor, int halVersion)
49 mName = hwSensor->name;
50 mVendor = hwSensor->vendor;
51 mVersion = hwSensor->version;
52 mHandle = hwSensor->handle;
53 mType = hwSensor->type;
54 mMinValue = 0; // FIXME: minValue
55 mMaxValue = hwSensor->maxRange; // FIXME: maxValue
56 mResolution = hwSensor->resolution;
57 mPower = hwSensor->power;
58 mMinDelay = hwSensor->minDelay;
61 // Set fifo event count zero for older devices which do not support batching. Fused
62 // sensors also have their fifo counts set to zero.
63 if (halVersion > SENSORS_DEVICE_API_VERSION_1_0) {
64 mFifoReservedEventCount = hwSensor->fifoReservedEventCount;
65 mFifoMaxEventCount = hwSensor->fifoMaxEventCount;
67 mFifoReservedEventCount = 0;
68 mFifoMaxEventCount = 0;
71 if (halVersion >= SENSORS_DEVICE_API_VERSION_1_3) {
72 if (hwSensor->maxDelay > INT_MAX) {
73 // Max delay is declared as a 64 bit integer for 64 bit architectures. But it should
74 // always fit in a 32 bit integer, log error and cap it to INT_MAX.
75 ALOGE("Sensor maxDelay overflow error %s %" PRId64, mName.string(),
76 static_cast<int64_t>(hwSensor->maxDelay));
79 mMaxDelay = static_cast<int32_t>(hwSensor->maxDelay);
82 // For older hals set maxDelay to 0.
86 // Ensure existing sensors have correct string type, required permissions and reporting mode.
87 // Set reportingMode for all android defined sensor types, set wake-up flag only for proximity
88 // sensor, significant motion, tilt, pick_up gesture, wake gesture and glance gesture on older
89 // HALs. Newer HALs can define both wake-up and non wake-up proximity sensors.
90 // All the OEM defined defined sensors have flags set to whatever is provided by the HAL.
92 case SENSOR_TYPE_ACCELEROMETER:
93 mStringType = SENSOR_STRING_TYPE_ACCELEROMETER;
94 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
96 case SENSOR_TYPE_AMBIENT_TEMPERATURE:
97 mStringType = SENSOR_STRING_TYPE_AMBIENT_TEMPERATURE;
98 mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
100 case SENSOR_TYPE_GAME_ROTATION_VECTOR:
101 mStringType = SENSOR_STRING_TYPE_GAME_ROTATION_VECTOR;
102 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
104 case SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR:
105 mStringType = SENSOR_STRING_TYPE_GEOMAGNETIC_ROTATION_VECTOR;
106 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
108 case SENSOR_TYPE_GRAVITY:
109 mStringType = SENSOR_STRING_TYPE_GRAVITY;
110 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
112 case SENSOR_TYPE_GYROSCOPE:
113 mStringType = SENSOR_STRING_TYPE_GYROSCOPE;
114 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
116 case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
117 mStringType = SENSOR_STRING_TYPE_GYROSCOPE_UNCALIBRATED;
118 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
120 case SENSOR_TYPE_HEART_RATE: {
121 mStringType = SENSOR_STRING_TYPE_HEART_RATE;
122 mRequiredPermission = SENSOR_PERMISSION_BODY_SENSORS;
123 AppOpsManager appOps;
124 mRequiredAppOp = appOps.permissionToOpCode(String16(SENSOR_PERMISSION_BODY_SENSORS));
125 mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
127 case SENSOR_TYPE_LIGHT:
128 mStringType = SENSOR_STRING_TYPE_LIGHT;
129 mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
131 case SENSOR_TYPE_LINEAR_ACCELERATION:
132 mStringType = SENSOR_STRING_TYPE_LINEAR_ACCELERATION;
133 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
135 case SENSOR_TYPE_MAGNETIC_FIELD:
136 mStringType = SENSOR_STRING_TYPE_MAGNETIC_FIELD;
137 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
139 case SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED:
140 mStringType = SENSOR_STRING_TYPE_MAGNETIC_FIELD_UNCALIBRATED;
141 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
143 case SENSOR_TYPE_ORIENTATION:
144 mStringType = SENSOR_STRING_TYPE_ORIENTATION;
145 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
147 case SENSOR_TYPE_PRESSURE:
148 mStringType = SENSOR_STRING_TYPE_PRESSURE;
149 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
151 case SENSOR_TYPE_PROXIMITY:
152 mStringType = SENSOR_STRING_TYPE_PROXIMITY;
153 mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
154 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
155 mFlags |= SENSOR_FLAG_WAKE_UP;
158 case SENSOR_TYPE_RELATIVE_HUMIDITY:
159 mStringType = SENSOR_STRING_TYPE_RELATIVE_HUMIDITY;
160 mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
162 case SENSOR_TYPE_ROTATION_VECTOR:
163 mStringType = SENSOR_STRING_TYPE_ROTATION_VECTOR;
164 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
166 case SENSOR_TYPE_SIGNIFICANT_MOTION:
167 mStringType = SENSOR_STRING_TYPE_SIGNIFICANT_MOTION;
168 mFlags |= SENSOR_FLAG_ONE_SHOT_MODE;
169 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
170 mFlags |= SENSOR_FLAG_WAKE_UP;
173 case SENSOR_TYPE_STEP_COUNTER:
174 mStringType = SENSOR_STRING_TYPE_STEP_COUNTER;
175 mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
177 case SENSOR_TYPE_STEP_DETECTOR:
178 mStringType = SENSOR_STRING_TYPE_STEP_DETECTOR;
179 mFlags |= SENSOR_FLAG_SPECIAL_REPORTING_MODE;
181 case SENSOR_TYPE_TEMPERATURE:
182 mStringType = SENSOR_STRING_TYPE_TEMPERATURE;
183 mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
185 case SENSOR_TYPE_TILT_DETECTOR:
186 mStringType = SENSOR_STRING_TYPE_TILT_DETECTOR;
187 mFlags |= SENSOR_FLAG_SPECIAL_REPORTING_MODE;
188 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
189 mFlags |= SENSOR_FLAG_WAKE_UP;
192 case SENSOR_TYPE_WAKE_GESTURE:
193 mStringType = SENSOR_STRING_TYPE_WAKE_GESTURE;
194 mFlags |= SENSOR_FLAG_ONE_SHOT_MODE;
195 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
196 mFlags |= SENSOR_FLAG_WAKE_UP;
199 case SENSOR_TYPE_GLANCE_GESTURE:
200 mStringType = SENSOR_STRING_TYPE_GLANCE_GESTURE;
201 mFlags |= SENSOR_FLAG_ONE_SHOT_MODE;
202 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
203 mFlags |= SENSOR_FLAG_WAKE_UP;
206 case SENSOR_TYPE_PICK_UP_GESTURE:
207 mStringType = SENSOR_STRING_TYPE_PICK_UP_GESTURE;
208 mFlags |= SENSOR_FLAG_ONE_SHOT_MODE;
209 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
210 mFlags |= SENSOR_FLAG_WAKE_UP;
213 case SENSOR_TYPE_WRIST_TILT_GESTURE:
214 mStringType = SENSOR_STRING_TYPE_WRIST_TILT_GESTURE;
215 mFlags |= SENSOR_FLAG_SPECIAL_REPORTING_MODE;
216 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
217 mFlags |= SENSOR_FLAG_WAKE_UP;
220 case SENSOR_TYPE_DYNAMIC_SENSOR_META:
221 mStringType = SENSOR_STRING_TYPE_DYNAMIC_SENSOR_META;
222 mFlags = SENSOR_FLAG_SPECIAL_REPORTING_MODE; // special trigger and non-wake up
224 case SENSOR_TYPE_POSE_6DOF:
225 mStringType = SENSOR_STRING_TYPE_POSE_6DOF;
226 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
228 case SENSOR_TYPE_STATIONARY_DETECT:
229 mStringType = SENSOR_STRING_TYPE_STATIONARY_DETECT;
230 mFlags |= SENSOR_FLAG_ONE_SHOT_MODE;
231 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
232 mFlags |= SENSOR_FLAG_WAKE_UP;
235 case SENSOR_TYPE_MOTION_DETECT:
236 mStringType = SENSOR_STRING_TYPE_MOTION_DETECT;
237 mFlags |= SENSOR_FLAG_ONE_SHOT_MODE;
238 if (halVersion < SENSORS_DEVICE_API_VERSION_1_3) {
239 mFlags |= SENSOR_FLAG_WAKE_UP;
242 case SENSOR_TYPE_HEART_BEAT:
243 mStringType = SENSOR_STRING_TYPE_HEART_BEAT;
244 mFlags |= SENSOR_FLAG_SPECIAL_REPORTING_MODE;
247 // Only pipe the stringType, requiredPermission and flags for custom sensors.
248 if (halVersion > SENSORS_DEVICE_API_VERSION_1_0 && hwSensor->stringType) {
249 mStringType = hwSensor->stringType;
251 if (halVersion > SENSORS_DEVICE_API_VERSION_1_0 && hwSensor->requiredPermission) {
252 mRequiredPermission = hwSensor->requiredPermission;
253 if (!strcmp(mRequiredPermission, SENSOR_PERMISSION_BODY_SENSORS)) {
254 AppOpsManager appOps;
255 mRequiredAppOp = appOps.permissionToOpCode(String16(SENSOR_PERMISSION_BODY_SENSORS));
259 if (halVersion >= SENSORS_DEVICE_API_VERSION_1_3) {
260 mFlags = static_cast<uint32_t>(hwSensor->flags);
262 // This is an OEM defined sensor on an older HAL. Use minDelay to determine the
263 // reporting mode of the sensor.
265 mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
266 } else if (mMinDelay == 0) {
267 mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
268 } else if (mMinDelay < 0) {
269 mFlags |= SENSOR_FLAG_ONE_SHOT_MODE;
275 // Set DYNAMIC_SENSOR_MASK and ADDITIONAL_INFO_MASK flag here. Compatible with HAL 1_3.
276 if (halVersion >= SENSORS_DEVICE_API_VERSION_1_3) {
277 mFlags |= (hwSensor->flags & (DYNAMIC_SENSOR_MASK | ADDITIONAL_INFO_MASK));
280 // Set DATA_INJECTION flag here. Defined in HAL 1_4.
281 if (halVersion >= SENSORS_DEVICE_API_VERSION_1_4) {
282 mFlags |= (hwSensor->flags & DATA_INJECTION_MASK);
285 // For the newer HALs log errors if reporting mask flags are set incorrectly.
286 if (halVersion >= SENSORS_DEVICE_API_VERSION_1_3) {
287 // Wake-up flag is set here.
288 mFlags |= (hwSensor->flags & SENSOR_FLAG_WAKE_UP);
289 if (mFlags != hwSensor->flags) {
290 int actualReportingMode =
291 (hwSensor->flags & REPORTING_MODE_MASK) >> REPORTING_MODE_SHIFT;
292 int expectedReportingMode = (mFlags & REPORTING_MODE_MASK) >> REPORTING_MODE_SHIFT;
293 if (actualReportingMode != expectedReportingMode) {
294 ALOGE("Reporting Mode incorrect: sensor %s handle=%d type=%d "
295 "actual=%d expected=%d",
296 mName.string(), mHandle, mType, actualReportingMode, expectedReportingMode);
302 if (mRequiredPermission.length() > 0) {
303 // If the sensor is protected by a permission we need to know if it is
304 // a runtime one to determine whether we can use the permission cache.
305 sp<IBinder> binder = defaultServiceManager()->getService(String16("permission"));
307 sp<IPermissionController> permCtrl = interface_cast<IPermissionController>(binder);
308 mRequiredPermissionRuntime = permCtrl->isRuntimePermission(
309 String16(mRequiredPermission));
318 const String8& Sensor::getName() const {
322 const String8& Sensor::getVendor() const {
326 int32_t Sensor::getHandle() const {
330 int32_t Sensor::getType() const {
334 float Sensor::getMinValue() const {
338 float Sensor::getMaxValue() const {
342 float Sensor::getResolution() const {
346 float Sensor::getPowerUsage() const {
350 int32_t Sensor::getMinDelay() const {
354 nsecs_t Sensor::getMinDelayNs() const {
355 return getMinDelay() * 1000;
358 int32_t Sensor::getVersion() const {
362 uint32_t Sensor::getFifoReservedEventCount() const {
363 return mFifoReservedEventCount;
366 uint32_t Sensor::getFifoMaxEventCount() const {
367 return mFifoMaxEventCount;
370 const String8& Sensor::getStringType() const {
374 const String8& Sensor::getRequiredPermission() const {
375 return mRequiredPermission;
378 bool Sensor::isRequiredPermissionRuntime() const {
379 return mRequiredPermissionRuntime;
382 int32_t Sensor::getRequiredAppOp() const {
383 return mRequiredAppOp;
386 int32_t Sensor::getMaxDelay() const {
390 uint32_t Sensor::getFlags() const {
394 bool Sensor::isWakeUpSensor() const {
395 return mFlags & SENSOR_FLAG_WAKE_UP;
398 bool Sensor::isDynamicSensor() const {
399 return mFlags & SENSOR_FLAG_DYNAMIC_SENSOR;
402 int32_t Sensor::getReportingMode() const {
403 return ((mFlags & REPORTING_MODE_MASK) >> REPORTING_MODE_SHIFT);
406 const Sensor::uuid_t& Sensor::getUuid() const {
410 size_t Sensor::getFlattenedSize() const
413 sizeof(mVersion) + sizeof(mHandle) + sizeof(mType) +
414 sizeof(mMinValue) + sizeof(mMaxValue) + sizeof(mResolution) +
415 sizeof(mPower) + sizeof(mMinDelay) + sizeof(mFifoMaxEventCount) +
416 sizeof(mFifoMaxEventCount) + sizeof(mRequiredPermissionRuntime) +
417 sizeof(mRequiredAppOp) + sizeof(mMaxDelay) + sizeof(mFlags) + sizeof(mUuid);
419 size_t variableSize =
420 sizeof(uint32_t) + FlattenableUtils::align<4>(mName.length()) +
421 sizeof(uint32_t) + FlattenableUtils::align<4>(mVendor.length()) +
422 sizeof(uint32_t) + FlattenableUtils::align<4>(mStringType.length()) +
423 sizeof(uint32_t) + FlattenableUtils::align<4>(mRequiredPermission.length());
425 return fixedSize + variableSize;
428 status_t Sensor::flatten(void* buffer, size_t size) const {
429 if (size < getFlattenedSize()) {
433 flattenString8(buffer, size, mName);
434 flattenString8(buffer, size, mVendor);
435 FlattenableUtils::write(buffer, size, mVersion);
436 FlattenableUtils::write(buffer, size, mHandle);
437 FlattenableUtils::write(buffer, size, mType);
438 FlattenableUtils::write(buffer, size, mMinValue);
439 FlattenableUtils::write(buffer, size, mMaxValue);
440 FlattenableUtils::write(buffer, size, mResolution);
441 FlattenableUtils::write(buffer, size, mPower);
442 FlattenableUtils::write(buffer, size, mMinDelay);
443 FlattenableUtils::write(buffer, size, mFifoReservedEventCount);
444 FlattenableUtils::write(buffer, size, mFifoMaxEventCount);
445 flattenString8(buffer, size, mStringType);
446 flattenString8(buffer, size, mRequiredPermission);
447 FlattenableUtils::write(buffer, size, mRequiredPermissionRuntime);
448 FlattenableUtils::write(buffer, size, mRequiredAppOp);
449 FlattenableUtils::write(buffer, size, mMaxDelay);
450 FlattenableUtils::write(buffer, size, mFlags);
451 FlattenableUtils::write(buffer, size, mUuid);
455 status_t Sensor::unflatten(void const* buffer, size_t size) {
456 if (!unflattenString8(buffer, size, mName)) {
459 if (!unflattenString8(buffer, size, mVendor)) {
464 sizeof(mVersion) + sizeof(mHandle) + sizeof(mType) + sizeof(mMinValue) +
465 sizeof(mMaxValue) + sizeof(mResolution) + sizeof(mPower) + sizeof(mMinDelay) +
466 sizeof(mFifoMaxEventCount) + sizeof(mFifoMaxEventCount);
467 if (size < fixedSize1) {
471 FlattenableUtils::read(buffer, size, mVersion);
472 FlattenableUtils::read(buffer, size, mHandle);
473 FlattenableUtils::read(buffer, size, mType);
474 FlattenableUtils::read(buffer, size, mMinValue);
475 FlattenableUtils::read(buffer, size, mMaxValue);
476 FlattenableUtils::read(buffer, size, mResolution);
477 FlattenableUtils::read(buffer, size, mPower);
478 FlattenableUtils::read(buffer, size, mMinDelay);
479 FlattenableUtils::read(buffer, size, mFifoReservedEventCount);
480 FlattenableUtils::read(buffer, size, mFifoMaxEventCount);
482 if (!unflattenString8(buffer, size, mStringType)) {
485 if (!unflattenString8(buffer, size, mRequiredPermission)) {
490 sizeof(mRequiredPermissionRuntime) + sizeof(mRequiredAppOp) + sizeof(mMaxDelay) +
491 sizeof(mFlags) + sizeof(mUuid);
492 if (size < fixedSize2) {
496 FlattenableUtils::read(buffer, size, mRequiredPermissionRuntime);
497 FlattenableUtils::read(buffer, size, mRequiredAppOp);
498 FlattenableUtils::read(buffer, size, mMaxDelay);
499 FlattenableUtils::read(buffer, size, mFlags);
500 FlattenableUtils::read(buffer, size, mUuid);
504 void Sensor::flattenString8(void*& buffer, size_t& size,
505 const String8& string8) {
506 uint32_t len = static_cast<uint32_t>(string8.length());
507 FlattenableUtils::write(buffer, size, len);
508 memcpy(static_cast<char*>(buffer), string8.string(), len);
509 FlattenableUtils::advance(buffer, size, FlattenableUtils::align<4>(len));
512 bool Sensor::unflattenString8(void const*& buffer, size_t& size, String8& outputString8) {
514 if (size < sizeof(len)) {
517 FlattenableUtils::read(buffer, size, len);
521 outputString8.setTo(static_cast<char const*>(buffer), len);
522 FlattenableUtils::advance(buffer, size, FlattenableUtils::align<4>(len));
526 // ----------------------------------------------------------------------------
527 }; // namespace android