• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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  #pragma once
18  
19  #include <stdint.h>
20  #include <sys/types.h>
21  
22  #include <utils/Errors.h>
23  #include <utils/RefBase.h>
24  #include <utils/Timers.h>
25  #include <utils/Mutex.h>
26  
27  #include <sensor/BitTube.h>
28  
29  // ----------------------------------------------------------------------------
30  #define WAKE_UP_SENSOR_EVENT_NEEDS_ACK (1U << 31)
31  struct ALooper;
32  struct ASensorEvent;
33  
34  // Concrete types for the NDK
35  struct ASensorEventQueue {
36      ALooper* looper;
37      bool requestAdditionalInfo;
38  };
39  
40  // ----------------------------------------------------------------------------
41  namespace android {
42  // ----------------------------------------------------------------------------
43  
44  class ISensorEventConnection;
45  class Sensor;
46  class Looper;
47  
48  // ----------------------------------------------------------------------------
49  
50  class SensorEventQueue : public ASensorEventQueue, public RefBase
51  {
52  public:
53  
54      enum { MAX_RECEIVE_BUFFER_EVENT_COUNT = 256 };
55  
56      /**
57       * Typical sensor delay (sample period) in microseconds.
58       */
59      // Fastest sampling, system will bound it to minDelay
60      static constexpr int32_t SENSOR_DELAY_FASTEST = 0;
61      // Typical sample period for game, 50Hz;
62      static constexpr int32_t SENSOR_DELAY_GAME = 20000;
63      // Typical sample period for UI, 15Hz
64      static constexpr int32_t SENSOR_DELAY_UI = 66667;
65      // Default sensor sample period
66      static constexpr int32_t SENSOR_DELAY_NORMAL = 200000;
67  
68      explicit SensorEventQueue(const sp<ISensorEventConnection>& connection);
69      virtual ~SensorEventQueue();
70      virtual void onFirstRef();
71  
72      int getFd() const;
73  
74      static ssize_t write(const sp<BitTube>& tube,
75              ASensorEvent const* events, size_t numEvents);
76  
77      ssize_t read(ASensorEvent* events, size_t numEvents);
78  
79      status_t waitForEvent() const;
80      status_t wake() const;
81  
82      status_t enableSensor(Sensor const* sensor) const;
83      status_t enableSensor(Sensor const* sensor, int32_t samplingPeriodUs) const;
84      status_t disableSensor(Sensor const* sensor) const;
85      status_t setEventRate(Sensor const* sensor, nsecs_t ns) const;
86  
87      // these are here only to support SensorManager.java and HIDL Frameworks SensorManager.
88      status_t enableSensor(int32_t handle, int32_t samplingPeriodUs, int64_t maxBatchReportLatencyUs,
89                            int reservedFlags) const;
90      status_t disableSensor(int32_t handle) const;
91      status_t flush() const;
92      // Send an ack for every wake_up sensor event that is set to WAKE_UP_SENSOR_EVENT_NEEDS_ACK.
93      void sendAck(const ASensorEvent* events, int count);
94  
95      status_t injectSensorEvent(const ASensorEvent& event);
96  
97      // Filters the given sensor events in place and returns the new number of events.
98      //
99      // The filtering is controlled by ASensorEventQueue.requestAdditionalInfo, and if this value is
100      // false, then all SENSOR_TYPE_ADDITIONAL_INFO sensor events will be removed.
101      ssize_t filterEvents(ASensorEvent* events, size_t count) const;
102  
103  private:
104      sp<Looper> getLooper() const;
105      sp<ISensorEventConnection> mSensorEventConnection;
106      sp<BitTube> mSensorChannel;
107      mutable Mutex mLock;
108      mutable sp<Looper> mLooper;
109      ASensorEvent* mRecBuffer;
110      size_t mAvailable;
111      size_t mConsumed;
112      uint32_t mNumAcksToSend;
113  };
114  
115  // ----------------------------------------------------------------------------
116  }; // namespace android
117