SensorDevice.h revision 3889e6ea1c321cbaf8a959775da58509672143af 
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 "SensorServiceUtils.h"
21
22#include <gui/Sensor.h>
23#include <stdint.h>
24#include <sys/types.h>
25#include <utils/KeyedVector.h>
26#include <utils/Singleton.h>
27#include <utils/String8.h>
28
29#include <string>
30#include <map>
31
32#include "android/hardware/sensors/1.0/ISensors.h"
33
34// ---------------------------------------------------------------------------
35
36namespace android {
37
38// ---------------------------------------------------------------------------
39using SensorServiceUtil::Dumpable;
40using hardware::Return;
41
42class SensorDevice : public Singleton<SensorDevice>, public Dumpable {
43public:
44    ssize_t getSensorList(sensor_t const** list);
45
46    void handleDynamicSensorConnection(int handle, bool connected);
47    status_t initCheck() const;
48    int getHalDeviceVersion() const;
49
50    ssize_t poll(sensors_event_t* buffer, size_t count);
51
52    status_t activate(void* ident, int handle, int enabled);
53    status_t batch(void* ident, int handle, int flags, int64_t samplingPeriodNs,
54                   int64_t maxBatchReportLatencyNs);
55    // Call batch with timeout zero instead of calling setDelay() for newer devices.
56    status_t setDelay(void* ident, int handle, int64_t ns);
57    status_t flush(void* ident, int handle);
58    status_t setMode(uint32_t mode);
59
60    bool isDirectReportSupported() const;
61    int32_t registerDirectChannel(const sensors_direct_mem_t *memory);
62    void unregisterDirectChannel(int32_t channelHandle);
63    int32_t configureDirectChannel(int32_t sensorHandle,
64            int32_t channelHandle, const struct sensors_direct_cfg_t *config);
65
66    void disableAllSensors();
67    void enableAllSensors();
68    void autoDisable(void *ident, int handle);
69
70    status_t injectSensorData(const sensors_event_t *event);
71    void notifyConnectionDestroyed(void *ident);
72
73    // Dumpable
74    virtual std::string dump() const;
75private:
76    friend class Singleton<SensorDevice>;
77
78    sp<android::hardware::sensors::V1_0::ISensors> mSensors;
79    Vector<sensor_t> mSensorList;
80    std::map<int32_t, sensor_t*> mConnectedDynamicSensors;
81
82    static const nsecs_t MINIMUM_EVENTS_PERIOD =   1000000; // 1000 Hz
83    mutable Mutex mLock; // protect mActivationCount[].batchParams
84    // fixed-size array after construction
85
86    // Struct to store all the parameters(samplingPeriod, maxBatchReportLatency and flags) from
87    // batch call. For continous mode clients, maxBatchReportLatency is set to zero.
88    struct BatchParams {
89      // TODO: Get rid of flags parameter everywhere.
90      int flags;
91      nsecs_t batchDelay, batchTimeout;
92      BatchParams() : flags(0), batchDelay(0), batchTimeout(0) {}
93      BatchParams(int flag, nsecs_t delay, nsecs_t timeout): flags(flag), batchDelay(delay),
94          batchTimeout(timeout) { }
95      bool operator != (const BatchParams& other) {
96          return other.batchDelay != batchDelay || other.batchTimeout != batchTimeout ||
97                 other.flags != flags;
98      }
99    };
100
101    // Store batch parameters in the KeyedVector and the optimal batch_rate and timeout in
102    // bestBatchParams. For every batch() call corresponding params are stored in batchParams
103    // vector. A continuous mode request is batch(... timeout=0 ..) followed by activate(). A batch
104    // mode request is batch(... timeout > 0 ...) followed by activate().
105    // Info is a per-sensor data structure which contains the batch parameters for each client that
106    // has registered for this sensor.
107    struct Info {
108        BatchParams bestBatchParams;
109        // Key is the unique identifier(ident) for each client, value is the batch parameters
110        // requested by the client.
111        KeyedVector<void*, BatchParams> batchParams;
112
113        Info() : bestBatchParams(0, -1, -1) {}
114        // Sets batch parameters for this ident. Returns error if this ident is not already present
115        // in the KeyedVector above.
116        status_t setBatchParamsForIdent(void* ident, int flags, int64_t samplingPeriodNs,
117                                        int64_t maxBatchReportLatencyNs);
118        // Finds the optimal parameters for batching and stores them in bestBatchParams variable.
119        void selectBatchParams();
120        // Removes batchParams for an ident and re-computes bestBatchParams. Returns the index of
121        // the removed ident. If index >=0, ident is present and successfully removed.
122        ssize_t removeBatchParamsForIdent(void* ident);
123
124        int numActiveClients();
125    };
126    DefaultKeyedVector<int, Info> mActivationCount;
127
128    // Use this vector to determine which client is activated or deactivated.
129    SortedVector<void *> mDisabledClients;
130    SensorDevice();
131
132    static void handleHidlDeath(const std::string &detail);
133    template<typename T>
134    static Return<T> checkReturn(Return<T> &&ret) {
135        if (!ret.isOk()) {
136            handleHidlDeath(ret.description());
137        }
138        return std::move(ret);
139    }
140
141    bool isClientDisabled(void* ident);
142    bool isClientDisabledLocked(void* ident);
143
144    using Event = hardware::sensors::V1_0::Event;
145    using SensorInfo = hardware::sensors::V1_0::SensorInfo;
146
147    void convertToSensorEvent(const Event &src, sensors_event_t *dst);
148
149    void convertToSensorEvents(
150            const hardware::hidl_vec<Event> &src,
151            const hardware::hidl_vec<SensorInfo> &dynamicSensorsAdded,
152            sensors_event_t *dst);
153
154    bool mIsDirectReportSupported;
155};
156
157// ---------------------------------------------------------------------------
158}; // namespace android
159
160#endif // ANDROID_SENSOR_DEVICE_H
161