Sensor.cpp revision 0e025c5af365e45e02cb75c1d46b46c7f4cd44cb 
1/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
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
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
15 */
16
17#include <stdint.h>
18#include <sys/types.h>
19#include <sys/limits.h>
20
21#include <utils/Errors.h>
22#include <utils/String8.h>
23#include <utils/Flattenable.h>
24
25#include <hardware/sensors.h>
26
27#include <gui/Sensor.h>
28#include <log/log.h>
29
30// ----------------------------------------------------------------------------
31namespace android {
32// ----------------------------------------------------------------------------
33
34Sensor::Sensor()
35    : mHandle(0), mType(0),
36      mMinValue(0), mMaxValue(0), mResolution(0),
37      mPower(0), mMinDelay(0), mFifoReservedEventCount(0), mFifoMaxEventCount(0),
38      mMaxDelay(0), mFlags(0)
39{
40}
41
42Sensor::Sensor(struct sensor_t const* hwSensor, int halVersion)
43{
44    mName = hwSensor->name;
45    mVendor = hwSensor->vendor;
46    mVersion = hwSensor->version;
47    mHandle = hwSensor->handle;
48    mType = hwSensor->type;
49    mMinValue = 0;                      // FIXME: minValue
50    mMaxValue = hwSensor->maxRange;     // FIXME: maxValue
51    mResolution = hwSensor->resolution;
52    mPower = hwSensor->power;
53    mMinDelay = hwSensor->minDelay;
54    mFlags = 0;
55
56    // Set fifo event count zero for older devices which do not support batching. Fused
57    // sensors also have their fifo counts set to zero.
58    if (halVersion >= SENSORS_DEVICE_API_VERSION_1_1) {
59        mFifoReservedEventCount = hwSensor->fifoReservedEventCount;
60        mFifoMaxEventCount = hwSensor->fifoMaxEventCount;
61    } else {
62        mFifoReservedEventCount = 0;
63        mFifoMaxEventCount = 0;
64    }
65
66    if (halVersion >= SENSORS_DEVICE_API_VERSION_1_3) {
67        if (hwSensor->maxDelay > INT_MAX) {
68            // Max delay is declared as a 64 bit integer for 64 bit architectures. But it should
69            // always fit in a 32 bit integer, log error and cap it to INT_MAX.
70            ALOGE("Sensor maxDelay overflow error %s %lld", mName.string(), hwSensor->maxDelay);
71            mMaxDelay = INT_MAX;
72        } else {
73            mMaxDelay = (int32_t) hwSensor->maxDelay;
74        }
75    } else {
76        // For older hals set maxDelay to 0.
77        mMaxDelay = 0;
78    }
79
80    // Ensure existing sensors have correct string type, required permissions and reporting mode.
81    switch (mType) {
82    case SENSOR_TYPE_ACCELEROMETER:
83        mStringType = SENSOR_STRING_TYPE_ACCELEROMETER;
84        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
85        break;
86    case SENSOR_TYPE_AMBIENT_TEMPERATURE:
87        mStringType = SENSOR_STRING_TYPE_AMBIENT_TEMPERATURE;
88        mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
89        break;
90    case SENSOR_TYPE_GAME_ROTATION_VECTOR:
91        mStringType = SENSOR_STRING_TYPE_GAME_ROTATION_VECTOR;
92        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
93        break;
94    case SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR:
95        mStringType = SENSOR_STRING_TYPE_GEOMAGNETIC_ROTATION_VECTOR;
96        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
97        break;
98    case SENSOR_TYPE_GRAVITY:
99        mStringType = SENSOR_STRING_TYPE_GRAVITY;
100        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
101        break;
102    case SENSOR_TYPE_GYROSCOPE:
103        mStringType = SENSOR_STRING_TYPE_GYROSCOPE;
104        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
105        break;
106    case SENSOR_TYPE_GYROSCOPE_UNCALIBRATED:
107        mStringType = SENSOR_STRING_TYPE_GYROSCOPE_UNCALIBRATED;
108        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
109        break;
110    case SENSOR_TYPE_HEART_RATE:
111        mStringType = SENSOR_STRING_TYPE_HEART_RATE;
112        mRequiredPermission = SENSOR_PERMISSION_BODY_SENSORS;
113        mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
114        break;
115    case SENSOR_TYPE_LIGHT:
116        mStringType = SENSOR_STRING_TYPE_LIGHT;
117        mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
118        break;
119    case SENSOR_TYPE_LINEAR_ACCELERATION:
120        mStringType = SENSOR_STRING_TYPE_LINEAR_ACCELERATION;
121        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
122        break;
123    case SENSOR_TYPE_MAGNETIC_FIELD:
124        mStringType = SENSOR_STRING_TYPE_MAGNETIC_FIELD;
125        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
126        break;
127    case SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED:
128        mStringType = SENSOR_STRING_TYPE_MAGNETIC_FIELD_UNCALIBRATED;
129        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
130        break;
131    case SENSOR_TYPE_ORIENTATION:
132        mStringType = SENSOR_STRING_TYPE_ORIENTATION;
133        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
134        break;
135    case SENSOR_TYPE_PRESSURE:
136        mStringType = SENSOR_STRING_TYPE_PRESSURE;
137        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
138        break;
139    case SENSOR_TYPE_PROXIMITY:
140        mStringType = SENSOR_STRING_TYPE_PROXIMITY;
141        mFlags |= (SENSOR_FLAG_ON_CHANGE_MODE | SENSOR_FLAG_WAKE_UP);
142        break;
143    case SENSOR_TYPE_RELATIVE_HUMIDITY:
144        mStringType = SENSOR_STRING_TYPE_RELATIVE_HUMIDITY;
145        mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
146        break;
147    case SENSOR_TYPE_ROTATION_VECTOR:
148        mStringType = SENSOR_STRING_TYPE_ROTATION_VECTOR;
149        mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
150        break;
151    case SENSOR_TYPE_SIGNIFICANT_MOTION:
152        mStringType = SENSOR_STRING_TYPE_SIGNIFICANT_MOTION;
153        mFlags |= (SENSOR_FLAG_ONE_SHOT_MODE | SENSOR_FLAG_WAKE_UP);
154        break;
155    case SENSOR_TYPE_STEP_COUNTER:
156        mStringType = SENSOR_STRING_TYPE_STEP_COUNTER;
157        mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
158        break;
159    case SENSOR_TYPE_STEP_DETECTOR:
160        mStringType = SENSOR_STRING_TYPE_STEP_DETECTOR;
161        mFlags |= SENSOR_FLAG_SPECIAL_REPORTING_MODE;
162        break;
163    case SENSOR_TYPE_TEMPERATURE:
164        mStringType = SENSOR_STRING_TYPE_TEMPERATURE;
165        mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
166        break;
167    case SENSOR_TYPE_NON_WAKE_UP_PROXIMITY_SENSOR:
168        mStringType = SENSOR_STRING_TYPE_NON_WAKE_UP_PROXIMITY_SENSOR;
169        mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
170        break;
171    case SENSOR_TYPE_WAKE_UP_ACCELEROMETER:
172        mStringType = SENSOR_STRING_TYPE_WAKE_UP_ACCELEROMETER;
173        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
174        break;
175    case SENSOR_TYPE_WAKE_UP_MAGNETIC_FIELD:
176        mStringType = SENSOR_STRING_TYPE_WAKE_UP_MAGNETIC_FIELD;
177        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
178        break;
179    case SENSOR_TYPE_WAKE_UP_ORIENTATION:
180        mStringType = SENSOR_STRING_TYPE_WAKE_UP_ORIENTATION;
181        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
182        break;
183    case SENSOR_TYPE_WAKE_UP_GYROSCOPE:
184        mStringType = SENSOR_STRING_TYPE_WAKE_UP_GYROSCOPE;
185        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
186        break;
187    case SENSOR_TYPE_WAKE_UP_LIGHT:
188        mStringType = SENSOR_STRING_TYPE_WAKE_UP_LIGHT;
189        mFlags |= (SENSOR_FLAG_ON_CHANGE_MODE | SENSOR_FLAG_WAKE_UP);
190        break;
191    case SENSOR_TYPE_WAKE_UP_PRESSURE:
192        mStringType = SENSOR_STRING_TYPE_WAKE_UP_PRESSURE;
193        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
194        break;
195    case SENSOR_TYPE_WAKE_UP_GRAVITY:
196        mStringType = SENSOR_STRING_TYPE_WAKE_UP_GRAVITY;
197        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
198        break;
199    case SENSOR_TYPE_WAKE_UP_LINEAR_ACCELERATION:
200        mStringType = SENSOR_STRING_TYPE_WAKE_UP_LINEAR_ACCELERATION;
201        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
202        break;
203    case SENSOR_TYPE_WAKE_UP_ROTATION_VECTOR:
204        mStringType = SENSOR_STRING_TYPE_WAKE_UP_ROTATION_VECTOR;
205        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
206        break;
207    case SENSOR_TYPE_WAKE_UP_RELATIVE_HUMIDITY:
208        mStringType = SENSOR_STRING_TYPE_WAKE_UP_RELATIVE_HUMIDITY;
209        mFlags |= (SENSOR_FLAG_SPECIAL_REPORTING_MODE | SENSOR_FLAG_WAKE_UP);
210        break;
211    case SENSOR_TYPE_WAKE_UP_AMBIENT_TEMPERATURE:
212        mStringType = SENSOR_STRING_TYPE_WAKE_UP_AMBIENT_TEMPERATURE;
213        mFlags |= (SENSOR_FLAG_ON_CHANGE_MODE | SENSOR_FLAG_WAKE_UP);
214        break;
215    case SENSOR_TYPE_WAKE_UP_MAGNETIC_FIELD_UNCALIBRATED:
216        mStringType = SENSOR_STRING_TYPE_WAKE_UP_MAGNETIC_FIELD_UNCALIBRATED;
217        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
218        break;
219    case SENSOR_TYPE_WAKE_UP_GAME_ROTATION_VECTOR:
220        mStringType = SENSOR_STRING_TYPE_WAKE_UP_GAME_ROTATION_VECTOR;
221        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
222        break;
223    case SENSOR_TYPE_WAKE_UP_GYROSCOPE_UNCALIBRATED:
224        mStringType = SENSOR_STRING_TYPE_WAKE_UP_GYROSCOPE_UNCALIBRATED;
225        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
226        break;
227    case SENSOR_TYPE_WAKE_UP_STEP_DETECTOR:
228        mStringType = SENSOR_STRING_TYPE_WAKE_UP_STEP_DETECTOR;
229        mFlags |= (SENSOR_FLAG_SPECIAL_REPORTING_MODE | SENSOR_FLAG_WAKE_UP);
230        break;
231    case SENSOR_TYPE_WAKE_UP_STEP_COUNTER:
232        mStringType = SENSOR_STRING_TYPE_WAKE_UP_STEP_COUNTER;
233        mFlags |= (SENSOR_FLAG_ON_CHANGE_MODE | SENSOR_FLAG_WAKE_UP);
234        break;
235    case SENSOR_TYPE_WAKE_UP_GEOMAGNETIC_ROTATION_VECTOR:
236        mStringType = SENSOR_STRING_TYPE_WAKE_UP_GEOMAGNETIC_ROTATION_VECTOR;
237        mFlags |= (SENSOR_FLAG_CONTINUOUS_MODE | SENSOR_FLAG_WAKE_UP);
238        break;
239    case SENSOR_TYPE_WAKE_UP_HEART_RATE:
240        mStringType = SENSOR_STRING_TYPE_WAKE_UP_HEART_RATE;
241        mRequiredPermission = SENSOR_PERMISSION_BODY_SENSORS;
242        mFlags |= (SENSOR_FLAG_ON_CHANGE_MODE | SENSOR_FLAG_WAKE_UP);
243        break;
244    case SENSOR_TYPE_WAKE_UP_TILT_DETECTOR:
245        mStringType = SENSOR_STRING_TYPE_WAKE_UP_TILT_DETECTOR;
246        mFlags |= (SENSOR_FLAG_SPECIAL_REPORTING_MODE | SENSOR_FLAG_WAKE_UP);
247        break;
248    case SENSOR_TYPE_WAKE_GESTURE:
249        mStringType = SENSOR_STRING_TYPE_WAKE_GESTURE;
250        mFlags |= (SENSOR_FLAG_ONE_SHOT_MODE | SENSOR_FLAG_WAKE_UP);
251        break;
252    default:
253        // Only pipe the stringType, requiredPermission and flags for custom sensors.
254        if (halVersion >= SENSORS_DEVICE_API_VERSION_1_2 && hwSensor->stringType) {
255            mStringType = hwSensor->stringType;
256        }
257        if (halVersion >= SENSORS_DEVICE_API_VERSION_1_2 && hwSensor->requiredPermission) {
258            mRequiredPermission = hwSensor->requiredPermission;
259        }
260
261        if (halVersion >= SENSORS_DEVICE_API_VERSION_1_3) {
262            mFlags = (int32_t) hwSensor->flags;
263        } else {
264            // This is an OEM defined sensor on an older HAL. Use minDelay to determine the
265            // reporting mode of the sensor.
266            if (mMinDelay > 0) {
267                mFlags |= SENSOR_FLAG_CONTINUOUS_MODE;
268            } else if (mMinDelay == 0) {
269                mFlags |= SENSOR_FLAG_ON_CHANGE_MODE;
270            } else if (mMinDelay < 0) {
271                mFlags |= SENSOR_FLAG_ONE_SHOT_MODE;
272            }
273        }
274        break;
275    }
276}
277
278Sensor::~Sensor()
279{
280}
281
282const String8& Sensor::getName() const {
283    return mName;
284}
285
286const String8& Sensor::getVendor() const {
287    return mVendor;
288}
289
290int32_t Sensor::getHandle() const {
291    return mHandle;
292}
293
294int32_t Sensor::getType() const {
295    return mType;
296}
297
298float Sensor::getMinValue() const {
299    return mMinValue;
300}
301
302float Sensor::getMaxValue() const {
303    return mMaxValue;
304}
305
306float Sensor::getResolution() const {
307    return mResolution;
308}
309
310float Sensor::getPowerUsage() const {
311    return mPower;
312}
313
314int32_t Sensor::getMinDelay() const {
315    return mMinDelay;
316}
317
318nsecs_t Sensor::getMinDelayNs() const {
319    return getMinDelay() * 1000;
320}
321
322int32_t Sensor::getVersion() const {
323    return mVersion;
324}
325
326int32_t Sensor::getFifoReservedEventCount() const {
327    return mFifoReservedEventCount;
328}
329
330int32_t Sensor::getFifoMaxEventCount() const {
331    return mFifoMaxEventCount;
332}
333
334const String8& Sensor::getStringType() const {
335    return mStringType;
336}
337
338const String8& Sensor::getRequiredPermission() const {
339    return mRequiredPermission;
340}
341
342int32_t Sensor::getMaxDelay() const {
343    return mMaxDelay;
344}
345
346int32_t Sensor::getFlags() const {
347    return mFlags;
348}
349
350bool Sensor::isWakeUpSensor() const {
351    return mFlags & SENSOR_FLAG_WAKE_UP;
352}
353
354int32_t Sensor::getReportingMode() const {
355    return ((mFlags & REPORTING_MODE_MASK) >> REPORTING_MODE_SHIFT);
356}
357
358size_t Sensor::getFlattenedSize() const
359{
360    size_t fixedSize =
361            sizeof(int32_t) * 3 +
362            sizeof(float) * 4 +
363            sizeof(int32_t) * 5;
364
365    size_t variableSize =
366            sizeof(uint32_t) + FlattenableUtils::align<4>(mName.length()) +
367            sizeof(uint32_t) + FlattenableUtils::align<4>(mVendor.length()) +
368            sizeof(uint32_t) + FlattenableUtils::align<4>(mStringType.length()) +
369            sizeof(uint32_t) + FlattenableUtils::align<4>(mRequiredPermission.length());
370
371    return fixedSize + variableSize;
372}
373
374status_t Sensor::flatten(void* buffer, size_t size) const {
375    if (size < getFlattenedSize()) {
376        return NO_MEMORY;
377    }
378
379    flattenString8(buffer, size, mName);
380    flattenString8(buffer, size, mVendor);
381    FlattenableUtils::write(buffer, size, mVersion);
382    FlattenableUtils::write(buffer, size, mHandle);
383    FlattenableUtils::write(buffer, size, mType);
384    FlattenableUtils::write(buffer, size, mMinValue);
385    FlattenableUtils::write(buffer, size, mMaxValue);
386    FlattenableUtils::write(buffer, size, mResolution);
387    FlattenableUtils::write(buffer, size, mPower);
388    FlattenableUtils::write(buffer, size, mMinDelay);
389    FlattenableUtils::write(buffer, size, mFifoReservedEventCount);
390    FlattenableUtils::write(buffer, size, mFifoMaxEventCount);
391    flattenString8(buffer, size, mStringType);
392    flattenString8(buffer, size, mRequiredPermission);
393    FlattenableUtils::write(buffer, size, mMaxDelay);
394    FlattenableUtils::write(buffer, size, mFlags);
395    return NO_ERROR;
396}
397
398status_t Sensor::unflatten(void const* buffer, size_t size) {
399    if (!unflattenString8(buffer, size, mName)) {
400        return NO_MEMORY;
401    }
402    if (!unflattenString8(buffer, size, mVendor)) {
403        return NO_MEMORY;
404    }
405
406    size_t fixedSize =
407            sizeof(int32_t) * 3 +
408            sizeof(float) * 4 +
409            sizeof(int32_t) * 5;
410    if (size < fixedSize) {
411        return NO_MEMORY;
412    }
413
414    FlattenableUtils::read(buffer, size, mVersion);
415    FlattenableUtils::read(buffer, size, mHandle);
416    FlattenableUtils::read(buffer, size, mType);
417    FlattenableUtils::read(buffer, size, mMinValue);
418    FlattenableUtils::read(buffer, size, mMaxValue);
419    FlattenableUtils::read(buffer, size, mResolution);
420    FlattenableUtils::read(buffer, size, mPower);
421    FlattenableUtils::read(buffer, size, mMinDelay);
422    FlattenableUtils::read(buffer, size, mFifoReservedEventCount);
423    FlattenableUtils::read(buffer, size, mFifoMaxEventCount);
424
425    if (!unflattenString8(buffer, size, mStringType)) {
426        return NO_MEMORY;
427    }
428    if (!unflattenString8(buffer, size, mRequiredPermission)) {
429        return NO_MEMORY;
430    }
431    FlattenableUtils::read(buffer, size, mMaxDelay);
432    FlattenableUtils::read(buffer, size, mFlags);
433    return NO_ERROR;
434}
435
436void Sensor::flattenString8(void*& buffer, size_t& size,
437        const String8& string8) {
438    uint32_t len = string8.length();
439    FlattenableUtils::write(buffer, size, len);
440    memcpy(static_cast<char*>(buffer), string8.string(), len);
441    FlattenableUtils::advance(buffer, size, FlattenableUtils::align<4>(len));
442}
443
444bool Sensor::unflattenString8(void const*& buffer, size_t& size, String8& outputString8) {
445    uint32_t len;
446    if (size < sizeof(len)) {
447        return false;
448    }
449    FlattenableUtils::read(buffer, size, len);
450    if (size < len) {
451        return false;
452    }
453    outputString8.setTo(static_cast<char const*>(buffer), len);
454    FlattenableUtils::advance(buffer, size, FlattenableUtils::align<4>(len));
455    return true;
456}
457
458// ----------------------------------------------------------------------------
459}; // namespace android
460