services/sensorservice/SensorInterface.h

   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 <sensor/Sensor.h>
  21 #include <utils/RefBase.h>
  22
  23 // ---------------------------------------------------------------------------
  24
  25 namespace android {
  26 // ---------------------------------------------------------------------------
  27 class SensorDevice;
  28 class SensorFusion;
  29
  30 class SensorInterface : public VirtualLightRefBase {
  31 public:
  32     virtual ~SensorInterface() {}
  33
  34     virtual bool process(sensors_event_t* outEvent, const sensors_event_t& event) = 0;
  35
  36     virtual status_t activate(void* ident, bool enabled) = 0;
  37     virtual status_t setDelay(void* ident, int handle, int64_t ns) = 0;
  38     virtual status_t batch(void* ident, int handle, int /*flags*/, int64_t samplingPeriodNs,
  39                            int64_t maxBatchReportLatencyNs) = 0;
  40
  41     virtual status_t flush(void* /*ident*/, int /*handle*/) = 0;
  42
  43     virtual const Sensor& getSensor() const = 0;
  44     virtual bool isVirtual() const = 0;
  45     virtual void autoDisable(void* /*ident*/, int /*handle*/) = 0;
  46 };
  47
  48 class BaseSensor : public SensorInterface {
  49 public:
  50     explicit BaseSensor(const sensor_t& sensor);
  51     BaseSensor(const sensor_t& sensor, const uint8_t (&uuid)[16]);
  52
  53     // Not all sensors need to support batching.
  54     virtual status_t batch(void* ident, int handle, int, int64_t samplingPeriodNs,
  55                            int64_t maxBatchReportLatencyNs) override {
  56         if (maxBatchReportLatencyNs == 0) {
  57             return setDelay(ident, handle, samplingPeriodNs);
  58         }
  59         return -EINVAL;
  60     }
  61
  62     virtual status_t flush(void* /*ident*/, int /*handle*/) override {
  63         return -EINVAL;
  64     }
  65
  66     virtual const Sensor& getSensor() const override { return mSensor; }
  67     virtual void autoDisable(void* /*ident*/, int /*handle*/) override { }
  68 protected:
  69     SensorDevice& mSensorDevice;
  70     Sensor mSensor;
  71 };
  72
  73 // ---------------------------------------------------------------------------
  74
  75 class HardwareSensor : public BaseSensor {
  76 public:
  77     explicit HardwareSensor(const sensor_t& sensor);
  78     HardwareSensor(const sensor_t& sensor, const uint8_t (&uuid)[16]);
  79
  80     virtual ~HardwareSensor();
  81
  82     virtual bool process(sensors_event_t* outEvent,
  83             const sensors_event_t& event);
  84
  85     virtual status_t activate(void* ident, bool enabled) override;
  86     virtual status_t batch(void* ident, int handle, int flags, int64_t samplingPeriodNs,
  87                            int64_t maxBatchReportLatencyNs) override;
  88     virtual status_t setDelay(void* ident, int handle, int64_t ns) override;
  89     virtual status_t flush(void* ident, int handle) override;
  90     virtual bool isVirtual() const override { return false; }
  91     virtual void autoDisable(void *ident, int handle) override;
  92 };
  93
  94 class VirtualSensor : public BaseSensor
  95 {
  96 public:
  97     VirtualSensor();
  98     virtual bool isVirtual() const override { return true; }
  99 protected:
 100     SensorFusion& mSensorFusion;
 101 };
 102
 103
 104 // ---------------------------------------------------------------------------
 105 }; // namespace android
 106
 107 #endif // ANDROID_SENSOR_INTERFACE_H