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