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 <PointerControllerInterface.h> 20 #include <android-base/thread_annotations.h> 21 #include <utils/Condition.h> 22 #include <utils/Mutex.h> 23 24 #include <memory> 25 #include <unordered_map> 26 #include <vector> 27 28 #include "EventHub.h" 29 #include "InputListener.h" 30 #include "InputReaderBase.h" 31 #include "InputReaderContext.h" 32 #include "InputThread.h" 33 34 namespace android { 35 36 class InputDevice; 37 class InputMapper; 38 struct StylusState; 39 40 /* The input reader reads raw event data from the event hub and processes it into input events 41 * that it sends to the input listener. Some functions of the input reader, such as early 42 * event filtering in low power states, are controlled by a separate policy object. 43 * 44 * The InputReader owns a collection of InputMappers. InputReader starts its own thread, where 45 * most of the work happens, but the InputReader can receive queries from other system 46 * components running on arbitrary threads. To keep things manageable, the InputReader 47 * uses a single Mutex to guard its state. The Mutex may be held while calling into the 48 * EventHub or the InputReaderPolicy but it is never held while calling into the 49 * InputListener. All calls to InputListener must happen from InputReader's thread. 50 */ 51 class InputReader : public InputReaderInterface { 52 public: 53 InputReader(std::shared_ptr<EventHubInterface> eventHub, 54 const sp<InputReaderPolicyInterface>& policy, InputListenerInterface& listener); 55 virtual ~InputReader(); 56 57 void dump(std::string& dump) override; 58 void monitor() override; 59 60 status_t start() override; 61 status_t stop() override; 62 63 std::vector<InputDeviceInfo> getInputDevices() const override; 64 65 bool isInputDeviceEnabled(int32_t deviceId) override; 66 67 int32_t getScanCodeState(int32_t deviceId, uint32_t sourceMask, int32_t scanCode) override; 68 int32_t getKeyCodeState(int32_t deviceId, uint32_t sourceMask, int32_t keyCode) override; 69 int32_t getSwitchState(int32_t deviceId, uint32_t sourceMask, int32_t sw) override; 70 71 void addKeyRemapping(int32_t deviceId, int32_t fromKeyCode, int32_t toKeyCode) const override; 72 73 int32_t getKeyCodeForKeyLocation(int32_t deviceId, int32_t locationKeyCode) const override; 74 75 void toggleCapsLockState(int32_t deviceId) override; 76 77 bool hasKeys(int32_t deviceId, uint32_t sourceMask, const std::vector<int32_t>& keyCodes, 78 uint8_t* outFlags) override; 79 80 void requestRefreshConfiguration(ConfigurationChanges changes) override; 81 82 void vibrate(int32_t deviceId, const VibrationSequence& sequence, ssize_t repeat, 83 int32_t token) override; 84 void cancelVibrate(int32_t deviceId, int32_t token) override; 85 86 bool isVibrating(int32_t deviceId) override; 87 88 std::vector<int32_t> getVibratorIds(int32_t deviceId) override; 89 90 bool canDispatchToDisplay(int32_t deviceId, int32_t displayId) override; 91 92 bool enableSensor(int32_t deviceId, InputDeviceSensorType sensorType, 93 std::chrono::microseconds samplingPeriod, 94 std::chrono::microseconds maxBatchReportLatency) override; 95 96 void disableSensor(int32_t deviceId, InputDeviceSensorType sensorType) override; 97 98 void flushSensor(int32_t deviceId, InputDeviceSensorType sensorType) override; 99 100 std::optional<int32_t> getBatteryCapacity(int32_t deviceId) override; 101 102 std::optional<int32_t> getBatteryStatus(int32_t deviceId) override; 103 104 std::optional<std::string> getBatteryDevicePath(int32_t deviceId) override; 105 106 std::vector<InputDeviceLightInfo> getLights(int32_t deviceId) override; 107 108 std::vector<InputDeviceSensorInfo> getSensors(int32_t deviceId) override; 109 110 bool setLightColor(int32_t deviceId, int32_t lightId, int32_t color) override; 111 112 bool setLightPlayerId(int32_t deviceId, int32_t lightId, int32_t playerId) override; 113 114 std::optional<int32_t> getLightColor(int32_t deviceId, int32_t lightId) override; 115 116 std::optional<int32_t> getLightPlayerId(int32_t deviceId, int32_t lightId) override; 117 118 std::optional<std::string> getBluetoothAddress(int32_t deviceId) const override; 119 120 void sysfsNodeChanged(const std::string& sysfsNodePath) override; 121 122 protected: 123 // These members are protected so they can be instrumented by test cases. 124 virtual std::shared_ptr<InputDevice> createDeviceLocked(int32_t deviceId, 125 const InputDeviceIdentifier& identifier) 126 REQUIRES(mLock); 127 128 // With each iteration of the loop, InputReader reads and processes one incoming message from 129 // the EventHub. 130 void loopOnce(); 131 132 class ContextImpl : public InputReaderContext { 133 InputReader* mReader; 134 IdGenerator mIdGenerator; 135 136 public: 137 explicit ContextImpl(InputReader* reader); 138 // lock is already held by the input loop 139 void updateGlobalMetaState() NO_THREAD_SAFETY_ANALYSIS override; 140 int32_t getGlobalMetaState() NO_THREAD_SAFETY_ANALYSIS override; 141 void disableVirtualKeysUntil(nsecs_t time) REQUIRES(mReader->mLock) override; 142 bool shouldDropVirtualKey(nsecs_t now, int32_t keyCode, int32_t scanCode) 143 REQUIRES(mReader->mLock) override; 144 void fadePointer() REQUIRES(mReader->mLock) override; 145 std::shared_ptr<PointerControllerInterface> getPointerController(int32_t deviceId) 146 REQUIRES(mReader->mLock) override; 147 void requestTimeoutAtTime(nsecs_t when) REQUIRES(mReader->mLock) override; 148 int32_t bumpGeneration() NO_THREAD_SAFETY_ANALYSIS override; 149 void getExternalStylusDevices(std::vector<InputDeviceInfo>& outDevices) 150 REQUIRES(mReader->mLock) override; 151 [[nodiscard]] std::list<NotifyArgs> dispatchExternalStylusState(const StylusState& outState) 152 REQUIRES(mReader->mLock) override; 153 InputReaderPolicyInterface* getPolicy() REQUIRES(mReader->mLock) override; 154 EventHubInterface* getEventHub() REQUIRES(mReader->mLock) override; 155 int32_t getNextId() NO_THREAD_SAFETY_ANALYSIS override; 156 void updateLedMetaState(int32_t metaState) REQUIRES(mReader->mLock) override; 157 int32_t getLedMetaState() REQUIRES(mReader->mLock) REQUIRES(mLock) override; 158 void setPreventingTouchpadTaps(bool prevent) REQUIRES(mReader->mLock) 159 REQUIRES(mLock) override; 160 bool isPreventingTouchpadTaps() REQUIRES(mReader->mLock) REQUIRES(mLock) override; 161 } mContext; 162 163 friend class ContextImpl; 164 // Test cases need to override the locked functions 165 mutable std::mutex mLock; 166 167 private: 168 std::unique_ptr<InputThread> mThread; 169 170 std::condition_variable mReaderIsAliveCondition; 171 172 // This could be unique_ptr, but due to the way InputReader tests are written, 173 // it is made shared_ptr here. In the tests, an EventHub reference is retained by the test 174 // in parallel to passing it to the InputReader. 175 std::shared_ptr<EventHubInterface> mEventHub; 176 sp<InputReaderPolicyInterface> mPolicy; 177 178 // The next stage that should receive the events generated inside InputReader. 179 InputListenerInterface& mNextListener; 180 // As various events are generated inside InputReader, they are stored inside this list. The 181 // list can only be accessed with the lock, so the events inside it are well-ordered. 182 // Once the reader is done working, these events will be swapped into a temporary storage and 183 // sent to the 'mNextListener' without holding the lock. 184 std::list<NotifyArgs> mPendingArgs GUARDED_BY(mLock); 185 186 InputReaderConfiguration mConfig GUARDED_BY(mLock); 187 188 // An input device can represent a collection of EventHub devices. This map provides a way 189 // to lookup the input device instance from the EventHub device id. 190 std::unordered_map<int32_t /*eventHubId*/, std::shared_ptr<InputDevice>> mDevices 191 GUARDED_BY(mLock); 192 193 // An input device contains one or more eventHubId, this map provides a way to lookup the 194 // EventHubIds contained in the input device from the input device instance. 195 std::unordered_map<std::shared_ptr<InputDevice>, std::vector<int32_t> /*eventHubId*/> 196 mDeviceToEventHubIdsMap GUARDED_BY(mLock); 197 198 // true if tap-to-click on touchpad currently disabled GUARDED_BY(mLock)199 bool mPreventingTouchpadTaps GUARDED_BY(mLock){false}; 200 201 // low-level input event decoding and device management 202 [[nodiscard]] std::list<NotifyArgs> processEventsLocked(const RawEvent* rawEvents, size_t count) 203 REQUIRES(mLock); 204 205 void addDeviceLocked(nsecs_t when, int32_t eventHubId) REQUIRES(mLock); 206 void removeDeviceLocked(nsecs_t when, int32_t eventHubId) REQUIRES(mLock); 207 [[nodiscard]] std::list<NotifyArgs> processEventsForDeviceLocked(int32_t eventHubId, 208 const RawEvent* rawEvents, 209 size_t count) REQUIRES(mLock); 210 [[nodiscard]] std::list<NotifyArgs> timeoutExpiredLocked(nsecs_t when) REQUIRES(mLock); 211 212 void handleConfigurationChangedLocked(nsecs_t when) REQUIRES(mLock); 213 214 int32_t mGlobalMetaState GUARDED_BY(mLock); 215 void updateGlobalMetaStateLocked() REQUIRES(mLock); 216 int32_t getGlobalMetaStateLocked() REQUIRES(mLock); 217 218 int32_t mLedMetaState GUARDED_BY(mLock); 219 void updateLedMetaStateLocked(int32_t metaState) REQUIRES(mLock); 220 int32_t getLedMetaStateLocked() REQUIRES(mLock); 221 222 void notifyExternalStylusPresenceChangedLocked() REQUIRES(mLock); 223 void getExternalStylusDevicesLocked(std::vector<InputDeviceInfo>& outDevices) REQUIRES(mLock); 224 [[nodiscard]] std::list<NotifyArgs> dispatchExternalStylusStateLocked(const StylusState& state) 225 REQUIRES(mLock); 226 227 // The PointerController that is shared among all the input devices that need it. 228 std::weak_ptr<PointerControllerInterface> mPointerController; 229 std::shared_ptr<PointerControllerInterface> getPointerControllerLocked(int32_t deviceId) 230 REQUIRES(mLock); 231 void updatePointerDisplayLocked() REQUIRES(mLock); 232 void fadePointerLocked() REQUIRES(mLock); 233 234 int32_t mGeneration GUARDED_BY(mLock); 235 int32_t bumpGenerationLocked() REQUIRES(mLock); 236 237 int32_t mNextInputDeviceId GUARDED_BY(mLock); 238 int32_t nextInputDeviceIdLocked() REQUIRES(mLock); 239 240 std::vector<InputDeviceInfo> getInputDevicesLocked() const REQUIRES(mLock); 241 242 nsecs_t mDisableVirtualKeysTimeout GUARDED_BY(mLock); 243 void disableVirtualKeysUntilLocked(nsecs_t time) REQUIRES(mLock); 244 bool shouldDropVirtualKeyLocked(nsecs_t now, int32_t keyCode, int32_t scanCode) REQUIRES(mLock); 245 246 nsecs_t mNextTimeout GUARDED_BY(mLock); 247 void requestTimeoutAtTimeLocked(nsecs_t when) REQUIRES(mLock); 248 249 ConfigurationChanges mConfigurationChangesToRefresh GUARDED_BY(mLock); 250 void refreshConfigurationLocked(ConfigurationChanges changes) REQUIRES(mLock); 251 252 PointerCaptureRequest mCurrentPointerCaptureRequest GUARDED_BY(mLock); 253 254 // state queries 255 typedef int32_t (InputDevice::*GetStateFunc)(uint32_t sourceMask, int32_t code); 256 int32_t getStateLocked(int32_t deviceId, uint32_t sourceMask, int32_t code, 257 GetStateFunc getStateFunc) REQUIRES(mLock); 258 bool markSupportedKeyCodesLocked(int32_t deviceId, uint32_t sourceMask, 259 const std::vector<int32_t>& keyCodes, uint8_t* outFlags) 260 REQUIRES(mLock); 261 262 // find an InputDevice from an InputDevice id 263 InputDevice* findInputDeviceLocked(int32_t deviceId) const REQUIRES(mLock); 264 }; 265 266 } // namespace android 267