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_INTERFACE_H
18#define ANDROID_SENSOR_INTERFACE_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <gui/Sensor.h>
24
25#include "SensorDevice.h"
26
27// ---------------------------------------------------------------------------
28
29namespace android {
30// ---------------------------------------------------------------------------
31
32class SensorInterface {
33public:
34    virtual ~SensorInterface();
35
36    virtual bool process(sensors_event_t* outEvent,
37            const sensors_event_t& event) = 0;
38
39    virtual status_t activate(void* ident, bool enabled) = 0;
40    virtual status_t setDelay(void* ident, int handle, int64_t ns) = 0;
41
42    // Not all sensors need to support batching.
43    virtual status_t batch(void* ident, int handle, int /*flags*/, int64_t samplingPeriodNs,
44                           int64_t maxBatchReportLatencyNs) {
45        if (maxBatchReportLatencyNs == 0) {
46            return setDelay(ident, handle, samplingPeriodNs);
47        }
48        return -EINVAL;
49    }
50
51    virtual status_t flush(void* /*ident*/, int /*handle*/) {
52        return -EINVAL;
53    }
54
55    virtual Sensor getSensor() const = 0;
56    virtual bool isVirtual() const = 0;
57    virtual void autoDisable(void* /*ident*/, int /*handle*/) { }
58};
59
60// ---------------------------------------------------------------------------
61
62class HardwareSensor : public SensorInterface
63{
64    SensorDevice& mSensorDevice;
65    Sensor mSensor;
66
67public:
68    HardwareSensor(const sensor_t& sensor);
69
70    virtual ~HardwareSensor();
71
72    virtual bool process(sensors_event_t* outEvent,
73            const sensors_event_t& event);
74
75    virtual status_t activate(void* ident, bool enabled);
76    virtual status_t batch(void* ident, int handle, int flags, int64_t samplingPeriodNs,
77                           int64_t maxBatchReportLatencyNs);
78    virtual status_t setDelay(void* ident, int handle, int64_t ns);
79    virtual status_t flush(void* ident, int handle);
80    virtual Sensor getSensor() const;
81    virtual bool isVirtual() const { return false; }
82    virtual void autoDisable(void *ident, int handle);
83};
84
85
86// ---------------------------------------------------------------------------
87}; // namespace android
88
89#endif // ANDROID_SENSOR_INTERFACE_H
90