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