SensorDevice.h revision d4db70a7b8b2d136c46c50f89b276f8150be5fc2 
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#ifndef ANDROID_SENSOR_DEVICE_H
18#define ANDROID_SENSOR_DEVICE_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <utils/KeyedVector.h>
24#include <utils/Singleton.h>
25#include <utils/String8.h>
26
27#include <gui/Sensor.h>
28
29// ---------------------------------------------------------------------------
30
31namespace android {
32// ---------------------------------------------------------------------------
33
34class SensorDevice : public Singleton<SensorDevice> {
35    friend class Singleton<SensorDevice>;
36    sensors_poll_device_1_t* mSensorDevice;
37    struct sensors_module_t* mSensorModule;
38    static const nsecs_t MINIMUM_EVENTS_PERIOD =   1000000; // 1000 Hz
39    mutable Mutex mLock; // protect mActivationCount[].batchParams
40    // fixed-size array after construction
41
42    // Struct to store all the parameters(samplingPeriod, maxBatchReportLatency and flags) from
43    // batch call. For continous mode clients, maxBatchReportLatency is set to zero.
44    struct BatchParams {
45      // TODO: Get rid of flags parameter everywhere.
46      int flags;
47      nsecs_t batchDelay, batchTimeout;
48      BatchParams() : flags(0), batchDelay(0), batchTimeout(0) {}
49      BatchParams(int flag, nsecs_t delay, nsecs_t timeout): flags(flag), batchDelay(delay),
50          batchTimeout(timeout) { }
51      bool operator != (const BatchParams& other) {
52          return other.batchDelay != batchDelay || other.batchTimeout != batchTimeout ||
53                 other.flags != flags;
54      }
55    };
56
57    // Store batch parameters in the KeyedVector and the optimal batch_rate and timeout in
58    // bestBatchParams. For every batch() call corresponding params are stored in batchParams
59    // vector. A continuous mode request is batch(... timeout=0 ..) followed by activate(). A batch
60    // mode request is batch(... timeout > 0 ...) followed by activate().
61    // Info is a per-sensor data structure which contains the batch parameters for each client that
62    // has registered for this sensor.
63    struct Info {
64        BatchParams bestBatchParams;
65        // Key is the unique identifier(ident) for each client, value is the batch parameters
66        // requested by the client.
67        KeyedVector<void*, BatchParams> batchParams;
68
69        Info() : bestBatchParams(0, -1, -1) {}
70        // Sets batch parameters for this ident. Returns error if this ident is not already present
71        // in the KeyedVector above.
72        status_t setBatchParamsForIdent(void* ident, int flags, int64_t samplingPeriodNs,
73                                        int64_t maxBatchReportLatencyNs);
74        // Finds the optimal parameters for batching and stores them in bestBatchParams variable.
75        void selectBatchParams();
76        // Removes batchParams for an ident and re-computes bestBatchParams. Returns the index of
77        // the removed ident. If index >=0, ident is present and successfully removed.
78        ssize_t removeBatchParamsForIdent(void* ident);
79
80        int numActiveClients();
81    };
82    DefaultKeyedVector<int, Info> mActivationCount;
83
84    // Use this vector to determine which client is activated or deactivated.
85    SortedVector<void *> mDisabledClients;
86    SensorDevice();
87
88    bool isClientDisabled(void* ident);
89    bool isClientDisabledLocked(void* ident);
90public:
91    ssize_t getSensorList(sensor_t const** list);
92    status_t initCheck() const;
93    int getHalDeviceVersion() const;
94    ssize_t poll(sensors_event_t* buffer, size_t count);
95    status_t activate(void* ident, int handle, int enabled);
96    status_t batch(void* ident, int handle, int flags, int64_t samplingPeriodNs,
97                   int64_t maxBatchReportLatencyNs);
98    // Call batch with timeout zero instead of calling setDelay() for newer devices.
99    status_t setDelay(void* ident, int handle, int64_t ns);
100    status_t flush(void* ident, int handle);
101    status_t setMode(uint32_t mode);
102    void disableAllSensors();
103    void enableAllSensors();
104    void autoDisable(void *ident, int handle);
105    status_t injectSensorData(const sensors_event_t *event);
106    void dump(String8& result);
107    status_t setSensorPhysicalData(const char* physicaldata);
108};
109
110// ---------------------------------------------------------------------------
111}; // namespace android
112
113#endif // ANDROID_SENSOR_DEVICE_H
114