blob: e11adb8c76cd6827aeed618c4774d0d126b5a4f2 [file] [log] [blame]
Michael Wrightd02c5b62014-02-10 15:10:22 -08001/*
2 * Copyright (C) 2005 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
Mark Salyzyn5aa26b22014-06-10 13:07:44 -070017#include <assert.h>
18#include <dirent.h>
19#include <errno.h>
20#include <fcntl.h>
21#include <inttypes.h>
Colin Cross5b799302022-10-18 21:52:41 -070022#include <linux/ioctl.h>
Mark Salyzyn5aa26b22014-06-10 13:07:44 -070023#include <memory.h>
24#include <stdint.h>
25#include <stdio.h>
26#include <stdlib.h>
27#include <string.h>
Siarhei Vishniakou7a522bf2019-09-24 12:46:29 +010028#include <sys/capability.h>
Mark Salyzyn5aa26b22014-06-10 13:07:44 -070029#include <sys/epoll.h>
Mark Salyzyn5aa26b22014-06-10 13:07:44 -070030#include <sys/inotify.h>
31#include <sys/ioctl.h>
Kim Low03ea0352020-11-06 12:45:07 -080032#include <sys/stat.h>
33#include <sys/sysmacros.h>
Mark Salyzyn5aa26b22014-06-10 13:07:44 -070034#include <unistd.h>
35
Vladimir Komsiyskidd438e22024-02-13 11:47:54 +010036#include <android_companion_virtualdevice_flags.h>
37
Michael Wrightd02c5b62014-02-10 15:10:22 -080038#define LOG_TAG "EventHub"
39
40// #define LOG_NDEBUG 0
Kim Low03ea0352020-11-06 12:45:07 -080041#include <android-base/file.h>
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -080042#include <android-base/stringprintf.h>
Chris Yed3fef462021-03-07 17:10:08 -080043#include <android-base/strings.h>
Philip Quinn39b81682019-01-09 22:20:39 -080044#include <cutils/properties.h>
Dominik Laskowski75788452021-02-09 18:51:25 -080045#include <ftl/enum.h>
Chris Ye8594e192020-07-14 10:34:06 -070046#include <input/KeyCharacterMap.h>
47#include <input/KeyLayoutMap.h>
Prabir Pradhan07525ef2022-10-03 21:51:26 +000048#include <input/PrintTools.h>
Chris Ye8594e192020-07-14 10:34:06 -070049#include <input/VirtualKeyMap.h>
Dan Albert677d87e2014-06-16 17:31:28 -070050#include <openssl/sha.h>
Chris Yed3fef462021-03-07 17:10:08 -080051#include <statslog.h>
Prabir Pradhanda7c00c2019-08-29 14:12:42 -070052#include <utils/Errors.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080053#include <utils/Log.h>
54#include <utils/Timers.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080055
Chris Ye8594e192020-07-14 10:34:06 -070056#include <filesystem>
Harry Cuttsf13161a2023-03-08 14:15:49 +000057#include <optional>
Chris Ye3fdbfef2021-01-06 18:45:18 -080058#include <regex>
Prabir Pradhancb42b472022-08-23 16:01:19 +000059#include <utility>
Chris Ye8594e192020-07-14 10:34:06 -070060
61#include "EventHub.h"
Michael Wrightd02c5b62014-02-10 15:10:22 -080062
Prabir Pradhanae10ee62023-05-12 19:44:18 +000063#include "KeyCodeClassifications.h"
64
Michael Wrightd02c5b62014-02-10 15:10:22 -080065#define INDENT " "
66#define INDENT2 " "
67#define INDENT3 " "
68
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -080069using android::base::StringPrintf;
70
Michael Wrightd02c5b62014-02-10 15:10:22 -080071namespace android {
72
Vladimir Komsiyskidd438e22024-02-13 11:47:54 +010073namespace vd_flags = android::companion::virtualdevice::flags;
74
Dominik Laskowski2f01d772022-03-23 16:01:29 -070075using namespace ftl::flag_operators;
76
Usama Arifb27c8e62021-06-03 16:44:09 +010077static const char* DEVICE_INPUT_PATH = "/dev/input";
Siarhei Vishniakou951f3622018-12-12 19:45:42 -080078// v4l2 devices go directly into /dev
Usama Arifb27c8e62021-06-03 16:44:09 +010079static const char* DEVICE_PATH = "/dev";
Michael Wrightd02c5b62014-02-10 15:10:22 -080080
Chris Ye657c2f02021-05-25 16:24:37 -070081static constexpr size_t OBFUSCATED_LENGTH = 8;
82
Chris Ye87143712020-11-10 05:05:58 +000083static constexpr int32_t FF_STRONG_MAGNITUDE_CHANNEL_IDX = 0;
84static constexpr int32_t FF_WEAK_MAGNITUDE_CHANNEL_IDX = 1;
Chris Ye6393a262020-08-04 19:41:36 -070085
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -070086static constexpr size_t EVENT_BUFFER_SIZE = 256;
87
Chris Yee2b1e5c2021-03-10 22:45:12 -080088// Mapping for input battery class node IDs lookup.
89// https://www.kernel.org/doc/Documentation/power/power_supply_class.txt
90static const std::unordered_map<std::string, InputBatteryClass> BATTERY_CLASSES =
91 {{"capacity", InputBatteryClass::CAPACITY},
92 {"capacity_level", InputBatteryClass::CAPACITY_LEVEL},
93 {"status", InputBatteryClass::STATUS}};
94
95// Mapping for input battery class node names lookup.
96// https://www.kernel.org/doc/Documentation/power/power_supply_class.txt
97static const std::unordered_map<InputBatteryClass, std::string> BATTERY_NODES =
98 {{InputBatteryClass::CAPACITY, "capacity"},
99 {InputBatteryClass::CAPACITY_LEVEL, "capacity_level"},
100 {InputBatteryClass::STATUS, "status"}};
101
Kim Low03ea0352020-11-06 12:45:07 -0800102// must be kept in sync with definitions in kernel /drivers/power/supply/power_supply_sysfs.c
103static const std::unordered_map<std::string, int32_t> BATTERY_STATUS =
104 {{"Unknown", BATTERY_STATUS_UNKNOWN},
105 {"Charging", BATTERY_STATUS_CHARGING},
106 {"Discharging", BATTERY_STATUS_DISCHARGING},
107 {"Not charging", BATTERY_STATUS_NOT_CHARGING},
108 {"Full", BATTERY_STATUS_FULL}};
109
110// Mapping taken from
111// https://gitlab.freedesktop.org/upower/upower/-/blob/master/src/linux/up-device-supply.c#L484
112static const std::unordered_map<std::string, int32_t> BATTERY_LEVEL = {{"Critical", 5},
113 {"Low", 10},
114 {"Normal", 55},
115 {"High", 70},
116 {"Full", 100},
117 {"Unknown", 50}};
118
Chris Ye3fdbfef2021-01-06 18:45:18 -0800119// Mapping for input led class node names lookup.
120// https://www.kernel.org/doc/html/latest/leds/leds-class.html
121static const std::unordered_map<std::string, InputLightClass> LIGHT_CLASSES =
122 {{"red", InputLightClass::RED},
123 {"green", InputLightClass::GREEN},
124 {"blue", InputLightClass::BLUE},
125 {"global", InputLightClass::GLOBAL},
126 {"brightness", InputLightClass::BRIGHTNESS},
127 {"multi_index", InputLightClass::MULTI_INDEX},
128 {"multi_intensity", InputLightClass::MULTI_INTENSITY},
Vaibhav Devmurari82b37d62022-09-12 13:36:48 +0000129 {"max_brightness", InputLightClass::MAX_BRIGHTNESS},
DingYong99f2c3c2023-12-20 15:46:06 +0800130 {"kbd_backlight", InputLightClass::KEYBOARD_BACKLIGHT},
131 {"mic_mute", InputLightClass::KEYBOARD_MIC_MUTE}};
Chris Ye3fdbfef2021-01-06 18:45:18 -0800132
133// Mapping for input multicolor led class node names.
134// https://www.kernel.org/doc/html/latest/leds/leds-class-multicolor.html
135static const std::unordered_map<InputLightClass, std::string> LIGHT_NODES =
136 {{InputLightClass::BRIGHTNESS, "brightness"},
137 {InputLightClass::MULTI_INDEX, "multi_index"},
138 {InputLightClass::MULTI_INTENSITY, "multi_intensity"}};
139
140// Mapping for light color name and the light color
141const std::unordered_map<std::string, LightColor> LIGHT_COLORS = {{"red", LightColor::RED},
142 {"green", LightColor::GREEN},
143 {"blue", LightColor::BLUE}};
144
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +0000145// Mapping for country code to Layout info.
146// See bCountryCode in 6.2.1 of https://usb.org/sites/default/files/hid1_11.pdf.
147const std::unordered_map<std::int32_t, RawLayoutInfo> LAYOUT_INFOS =
148 {{0, RawLayoutInfo{.languageTag = "", .layoutType = ""}}, // NOT_SUPPORTED
149 {1, RawLayoutInfo{.languageTag = "ar-Arab", .layoutType = ""}}, // ARABIC
150 {2, RawLayoutInfo{.languageTag = "fr-BE", .layoutType = ""}}, // BELGIAN
151 {3, RawLayoutInfo{.languageTag = "fr-CA", .layoutType = ""}}, // CANADIAN_BILINGUAL
152 {4, RawLayoutInfo{.languageTag = "fr-CA", .layoutType = ""}}, // CANADIAN_FRENCH
153 {5, RawLayoutInfo{.languageTag = "cs", .layoutType = ""}}, // CZECH_REPUBLIC
154 {6, RawLayoutInfo{.languageTag = "da", .layoutType = ""}}, // DANISH
155 {7, RawLayoutInfo{.languageTag = "fi", .layoutType = ""}}, // FINNISH
156 {8, RawLayoutInfo{.languageTag = "fr-FR", .layoutType = ""}}, // FRENCH
157 {9, RawLayoutInfo{.languageTag = "de", .layoutType = ""}}, // GERMAN
158 {10, RawLayoutInfo{.languageTag = "el", .layoutType = ""}}, // GREEK
159 {11, RawLayoutInfo{.languageTag = "iw", .layoutType = ""}}, // HEBREW
160 {12, RawLayoutInfo{.languageTag = "hu", .layoutType = ""}}, // HUNGARY
161 {13, RawLayoutInfo{.languageTag = "en", .layoutType = "extended"}}, // INTERNATIONAL (ISO)
162 {14, RawLayoutInfo{.languageTag = "it", .layoutType = ""}}, // ITALIAN
163 {15, RawLayoutInfo{.languageTag = "ja", .layoutType = ""}}, // JAPAN
164 {16, RawLayoutInfo{.languageTag = "ko", .layoutType = ""}}, // KOREAN
165 {17, RawLayoutInfo{.languageTag = "es-419", .layoutType = ""}}, // LATIN_AMERICA
166 {18, RawLayoutInfo{.languageTag = "nl", .layoutType = ""}}, // DUTCH
167 {19, RawLayoutInfo{.languageTag = "nb", .layoutType = ""}}, // NORWEGIAN
168 {20, RawLayoutInfo{.languageTag = "fa", .layoutType = ""}}, // PERSIAN
169 {21, RawLayoutInfo{.languageTag = "pl", .layoutType = ""}}, // POLAND
170 {22, RawLayoutInfo{.languageTag = "pt", .layoutType = ""}}, // PORTUGUESE
171 {23, RawLayoutInfo{.languageTag = "ru", .layoutType = ""}}, // RUSSIA
172 {24, RawLayoutInfo{.languageTag = "sk", .layoutType = ""}}, // SLOVAKIA
173 {25, RawLayoutInfo{.languageTag = "es-ES", .layoutType = ""}}, // SPANISH
174 {26, RawLayoutInfo{.languageTag = "sv", .layoutType = ""}}, // SWEDISH
175 {27, RawLayoutInfo{.languageTag = "fr-CH", .layoutType = ""}}, // SWISS_FRENCH
176 {28, RawLayoutInfo{.languageTag = "de-CH", .layoutType = ""}}, // SWISS_GERMAN
177 {29, RawLayoutInfo{.languageTag = "de-CH", .layoutType = ""}}, // SWITZERLAND
178 {30, RawLayoutInfo{.languageTag = "zh-TW", .layoutType = ""}}, // TAIWAN
179 {31, RawLayoutInfo{.languageTag = "tr", .layoutType = "turkish_q"}}, // TURKISH_Q
180 {32, RawLayoutInfo{.languageTag = "en-GB", .layoutType = ""}}, // UK
181 {33, RawLayoutInfo{.languageTag = "en-US", .layoutType = ""}}, // US
182 {34, RawLayoutInfo{.languageTag = "", .layoutType = ""}}, // YUGOSLAVIA
183 {35, RawLayoutInfo{.languageTag = "tr", .layoutType = "turkish_f"}}}; // TURKISH_F
184
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100185static std::string sha1(const std::string& in) {
Dan Albert677d87e2014-06-16 17:31:28 -0700186 SHA_CTX ctx;
187 SHA1_Init(&ctx);
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100188 SHA1_Update(&ctx, reinterpret_cast<const u_char*>(in.c_str()), in.size());
Dan Albert677d87e2014-06-16 17:31:28 -0700189 u_char digest[SHA_DIGEST_LENGTH];
190 SHA1_Final(digest, &ctx);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800191
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100192 std::string out;
Dan Albert677d87e2014-06-16 17:31:28 -0700193 for (size_t i = 0; i < SHA_DIGEST_LENGTH; i++) {
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100194 out += StringPrintf("%02x", digest[i]);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800195 }
196 return out;
197}
198
Siarhei Vishniakou951f3622018-12-12 19:45:42 -0800199/**
200 * Return true if name matches "v4l-touch*"
201 */
Chris Ye8594e192020-07-14 10:34:06 -0700202static bool isV4lTouchNode(std::string name) {
203 return name.find("v4l-touch") != std::string::npos;
Siarhei Vishniakou951f3622018-12-12 19:45:42 -0800204}
205
Philip Quinn39b81682019-01-09 22:20:39 -0800206/**
207 * Returns true if V4L devices should be scanned.
208 *
209 * The system property ro.input.video_enabled can be used to control whether
210 * EventHub scans and opens V4L devices. As V4L does not support multiple
211 * clients, EventHub effectively blocks access to these devices when it opens
Siarhei Vishniakou29f88492019-04-05 14:11:43 -0700212 * them.
213 *
214 * Setting this to "false" would prevent any video devices from being discovered and
215 * associated with input devices.
216 *
217 * This property can be used as follows:
218 * 1. To turn off features that are dependent on video device presence.
219 * 2. During testing and development, to allow other clients to read video devices
220 * directly from /dev.
Philip Quinn39b81682019-01-09 22:20:39 -0800221 */
222static bool isV4lScanningEnabled() {
Harry Cutts33476232023-01-30 19:57:29 +0000223 return property_get_bool("ro.input.video_enabled", /*default_value=*/true);
Philip Quinn39b81682019-01-09 22:20:39 -0800224}
225
Siarhei Vishniakou592bac22018-11-08 19:42:38 -0800226static nsecs_t processEventTimestamp(const struct input_event& event) {
227 // Use the time specified in the event instead of the current time
228 // so that downstream code can get more accurate estimates of
229 // event dispatch latency from the time the event is enqueued onto
230 // the evdev client buffer.
231 //
232 // The event's timestamp fortuitously uses the same monotonic clock
233 // time base as the rest of Android. The kernel event device driver
234 // (drivers/input/evdev.c) obtains timestamps using ktime_get_ts().
235 // The systemTime(SYSTEM_TIME_MONOTONIC) function we use everywhere
236 // calls clock_gettime(CLOCK_MONOTONIC) which is implemented as a
237 // system call that also queries ktime_get_ts().
238
Colin Cross5b799302022-10-18 21:52:41 -0700239 const nsecs_t inputEventTime = seconds_to_nanoseconds(event.input_event_sec) +
240 microseconds_to_nanoseconds(event.input_event_usec);
Siarhei Vishniakou592bac22018-11-08 19:42:38 -0800241 return inputEventTime;
242}
243
Kim Low03ea0352020-11-06 12:45:07 -0800244/**
Prabir Pradhancb42b472022-08-23 16:01:19 +0000245 * Returns the sysfs root path of the input device.
Kim Low03ea0352020-11-06 12:45:07 -0800246 */
Chris Ye3fdbfef2021-01-06 18:45:18 -0800247static std::optional<std::filesystem::path> getSysfsRootPath(const char* devicePath) {
Kim Low03ea0352020-11-06 12:45:07 -0800248 std::error_code errorCode;
249
250 // Stat the device path to get the major and minor number of the character file
251 struct stat statbuf;
252 if (stat(devicePath, &statbuf) == -1) {
253 ALOGE("Could not stat device %s due to error: %s.", devicePath, std::strerror(errno));
Chris Ye3fdbfef2021-01-06 18:45:18 -0800254 return std::nullopt;
Kim Low03ea0352020-11-06 12:45:07 -0800255 }
256
257 unsigned int major_num = major(statbuf.st_rdev);
258 unsigned int minor_num = minor(statbuf.st_rdev);
259
260 // Realpath "/sys/dev/char/{major}:{minor}" to get the sysfs path to the input event
261 auto sysfsPath = std::filesystem::path("/sys/dev/char/");
262 sysfsPath /= std::to_string(major_num) + ":" + std::to_string(minor_num);
263 sysfsPath = std::filesystem::canonical(sysfsPath, errorCode);
264
265 // Make sure nothing went wrong in call to canonical()
266 if (errorCode) {
267 ALOGW("Could not run filesystem::canonical() due to error %d : %s.", errorCode.value(),
268 errorCode.message().c_str());
Chris Ye3fdbfef2021-01-06 18:45:18 -0800269 return std::nullopt;
Kim Low03ea0352020-11-06 12:45:07 -0800270 }
271
272 // Continue to go up a directory until we reach a directory named "input"
273 while (sysfsPath != "/" && sysfsPath.filename() != "input") {
274 sysfsPath = sysfsPath.parent_path();
275 }
276
277 // Then go up one more and you will be at the sysfs root of the device
278 sysfsPath = sysfsPath.parent_path();
279
280 // Make sure we didn't reach root path and that directory actually exists
281 if (sysfsPath == "/" || !std::filesystem::exists(sysfsPath, errorCode)) {
282 if (errorCode) {
283 ALOGW("Could not run filesystem::exists() due to error %d : %s.", errorCode.value(),
284 errorCode.message().c_str());
285 }
286
287 // Not found
Chris Ye3fdbfef2021-01-06 18:45:18 -0800288 return std::nullopt;
Kim Low03ea0352020-11-06 12:45:07 -0800289 }
290
291 return sysfsPath;
292}
293
294/**
Chris Ye3fdbfef2021-01-06 18:45:18 -0800295 * Returns the list of files under a specified path.
Kim Low03ea0352020-11-06 12:45:07 -0800296 */
Chris Ye3fdbfef2021-01-06 18:45:18 -0800297static std::vector<std::filesystem::path> allFilesInPath(const std::filesystem::path& path) {
298 std::vector<std::filesystem::path> nodes;
299 std::error_code errorCode;
300 auto iter = std::filesystem::directory_iterator(path, errorCode);
301 while (!errorCode && iter != std::filesystem::directory_iterator()) {
302 nodes.push_back(iter->path());
303 iter++;
304 }
305 return nodes;
306}
307
308/**
309 * Returns the list of files under a specified directory in a sysfs path.
310 * Example:
311 * findSysfsNodes(sysfsRootPath, SysfsClass::LEDS) will return all led nodes under "leds" directory
312 * in the sysfs path.
313 */
314static std::vector<std::filesystem::path> findSysfsNodes(const std::filesystem::path& sysfsRoot,
315 SysfsClass clazz) {
Dominik Laskowski75788452021-02-09 18:51:25 -0800316 std::string nodeStr = ftl::enum_string(clazz);
Chris Ye3fdbfef2021-01-06 18:45:18 -0800317 std::for_each(nodeStr.begin(), nodeStr.end(),
318 [](char& c) { c = std::tolower(static_cast<unsigned char>(c)); });
319 std::vector<std::filesystem::path> nodes;
320 for (auto path = sysfsRoot; path != "/" && nodes.empty(); path = path.parent_path()) {
321 nodes = allFilesInPath(path / nodeStr);
322 }
323 return nodes;
324}
325
326static std::optional<std::array<LightColor, COLOR_NUM>> getColorIndexArray(
327 std::filesystem::path path) {
328 std::string indexStr;
329 if (!base::ReadFileToString(path, &indexStr)) {
330 return std::nullopt;
331 }
332
333 // Parse the multi color LED index file, refer to kernel docs
334 // leds/leds-class-multicolor.html
335 std::regex indexPattern("(red|green|blue)\\s(red|green|blue)\\s(red|green|blue)[\\n]");
336 std::smatch results;
337 std::array<LightColor, COLOR_NUM> colors;
338 if (!std::regex_match(indexStr, results, indexPattern)) {
339 return std::nullopt;
340 }
341
342 for (size_t i = 1; i < results.size(); i++) {
343 const auto it = LIGHT_COLORS.find(results[i].str());
344 if (it != LIGHT_COLORS.end()) {
345 // intensities.emplace(it->second, 0);
346 colors[i - 1] = it->second;
Kim Low03ea0352020-11-06 12:45:07 -0800347 }
348 }
Chris Ye3fdbfef2021-01-06 18:45:18 -0800349 return colors;
Kim Low03ea0352020-11-06 12:45:07 -0800350}
351
Prabir Pradhancb42b472022-08-23 16:01:19 +0000352/**
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +0000353 * Read country code information exposed through the sysfs path and convert it to Layout info.
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +0000354 */
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +0000355static std::optional<RawLayoutInfo> readLayoutConfiguration(
356 const std::filesystem::path& sysfsRootPath) {
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +0000357 // Check the sysfs root path
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +0000358 int32_t hidCountryCode = -1;
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +0000359 std::string str;
360 if (base::ReadFileToString(sysfsRootPath / "country", &str)) {
361 hidCountryCode = std::stoi(str, nullptr, 16);
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +0000362 // Update this condition if new supported country codes are added to HID spec.
Vaibhav Devmurari990ff7b2022-12-22 18:23:21 +0000363 if (hidCountryCode > 35 || hidCountryCode < 0) {
364 ALOGE("HID country code should be in range [0, 35], but for sysfs path %s it was %d",
365 sysfsRootPath.c_str(), hidCountryCode);
Vaibhav Devmurari990ff7b2022-12-22 18:23:21 +0000366 }
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +0000367 }
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +0000368 const auto it = LAYOUT_INFOS.find(hidCountryCode);
369 if (it != LAYOUT_INFOS.end()) {
370 return it->second;
371 }
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +0000372
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +0000373 return std::nullopt;
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +0000374}
375
376/**
Prabir Pradhancb42b472022-08-23 16:01:19 +0000377 * Read information about batteries exposed through the sysfs path.
378 */
379static std::unordered_map<int32_t /*batteryId*/, RawBatteryInfo> readBatteryConfiguration(
380 const std::filesystem::path& sysfsRootPath) {
381 std::unordered_map<int32_t, RawBatteryInfo> batteryInfos;
382 int32_t nextBatteryId = 0;
383 // Check if device has any battery.
384 const auto& paths = findSysfsNodes(sysfsRootPath, SysfsClass::POWER_SUPPLY);
385 for (const auto& nodePath : paths) {
386 RawBatteryInfo info;
387 info.id = ++nextBatteryId;
388 info.path = nodePath;
389 info.name = nodePath.filename();
390
391 // Scan the path for all the files
392 // Refer to https://www.kernel.org/doc/Documentation/leds/leds-class.txt
393 const auto& files = allFilesInPath(nodePath);
394 for (const auto& file : files) {
395 const auto it = BATTERY_CLASSES.find(file.filename().string());
396 if (it != BATTERY_CLASSES.end()) {
397 info.flags |= it->second;
398 }
399 }
400 batteryInfos.insert_or_assign(info.id, info);
401 ALOGD("configureBatteryLocked rawBatteryId %d name %s", info.id, info.name.c_str());
402 }
403 return batteryInfos;
404}
405
406/**
407 * Read information about lights exposed through the sysfs path.
408 */
409static std::unordered_map<int32_t /*lightId*/, RawLightInfo> readLightsConfiguration(
410 const std::filesystem::path& sysfsRootPath) {
411 std::unordered_map<int32_t, RawLightInfo> lightInfos;
412 int32_t nextLightId = 0;
413 // Check if device has any lights.
414 const auto& paths = findSysfsNodes(sysfsRootPath, SysfsClass::LEDS);
415 for (const auto& nodePath : paths) {
416 RawLightInfo info;
417 info.id = ++nextLightId;
418 info.path = nodePath;
419 info.name = nodePath.filename();
420 info.maxBrightness = std::nullopt;
Vaibhav Devmurari82b37d62022-09-12 13:36:48 +0000421
422 // Light name should follow the naming pattern <name>:<color>:<function>
423 // Refer kernel docs /leds/leds-class.html for valid supported LED names.
424 std::regex indexPattern("([a-zA-Z0-9_.:]*:)?([a-zA-Z0-9_.]*):([a-zA-Z0-9_.]*)");
425 std::smatch results;
426
427 if (std::regex_match(info.name, results, indexPattern)) {
428 // regex_match will return full match at index 0 and <name> at index 1. For RawLightInfo
429 // we only care about sections <color> and <function> which will be at index 2 and 3.
430 for (int i = 2; i <= 3; i++) {
431 const auto it = LIGHT_CLASSES.find(results.str(i));
432 if (it != LIGHT_CLASSES.end()) {
433 info.flags |= it->second;
434 }
Prabir Pradhancb42b472022-08-23 16:01:19 +0000435 }
Vaibhav Devmurari82b37d62022-09-12 13:36:48 +0000436
437 // Set name of the raw light to <function> which represents playerIDs for LEDs that
438 // turn on/off based on the current player ID (Refer to PeripheralController.cpp for
439 // player ID logic)
440 info.name = results.str(3);
Prabir Pradhancb42b472022-08-23 16:01:19 +0000441 }
442 // Scan the path for all the files
443 // Refer to https://www.kernel.org/doc/Documentation/leds/leds-class.txt
444 const auto& files = allFilesInPath(nodePath);
445 for (const auto& file : files) {
446 const auto it = LIGHT_CLASSES.find(file.filename().string());
447 if (it != LIGHT_CLASSES.end()) {
448 info.flags |= it->second;
449 // If the node has maximum brightness, read it
450 if (it->second == InputLightClass::MAX_BRIGHTNESS) {
451 std::string str;
452 if (base::ReadFileToString(file, &str)) {
453 info.maxBrightness = std::stoi(str);
454 }
455 }
456 }
457 }
458 lightInfos.insert_or_assign(info.id, info);
459 ALOGD("configureLightsLocked rawLightId %d name %s", info.id, info.name.c_str());
460 }
461 return lightInfos;
462}
463
Michael Wrightd02c5b62014-02-10 15:10:22 -0800464// --- Global Functions ---
465
Dominik Laskowski2f01d772022-03-23 16:01:29 -0700466ftl::Flags<InputDeviceClass> getAbsAxisUsage(int32_t axis,
467 ftl::Flags<InputDeviceClass> deviceClasses) {
Michael Wrightd02c5b62014-02-10 15:10:22 -0800468 // Touch devices get dibs on touch-related axes.
Chris Ye1b0c7342020-07-28 21:57:03 -0700469 if (deviceClasses.test(InputDeviceClass::TOUCH)) {
Michael Wrightd02c5b62014-02-10 15:10:22 -0800470 switch (axis) {
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700471 case ABS_X:
472 case ABS_Y:
473 case ABS_PRESSURE:
474 case ABS_TOOL_WIDTH:
475 case ABS_DISTANCE:
476 case ABS_TILT_X:
477 case ABS_TILT_Y:
478 case ABS_MT_SLOT:
479 case ABS_MT_TOUCH_MAJOR:
480 case ABS_MT_TOUCH_MINOR:
481 case ABS_MT_WIDTH_MAJOR:
482 case ABS_MT_WIDTH_MINOR:
483 case ABS_MT_ORIENTATION:
484 case ABS_MT_POSITION_X:
485 case ABS_MT_POSITION_Y:
486 case ABS_MT_TOOL_TYPE:
487 case ABS_MT_BLOB_ID:
488 case ABS_MT_TRACKING_ID:
489 case ABS_MT_PRESSURE:
490 case ABS_MT_DISTANCE:
Chris Ye1b0c7342020-07-28 21:57:03 -0700491 return InputDeviceClass::TOUCH;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800492 }
493 }
494
Chris Yef59a2f42020-10-16 12:55:26 -0700495 if (deviceClasses.test(InputDeviceClass::SENSOR)) {
496 switch (axis) {
497 case ABS_X:
498 case ABS_Y:
499 case ABS_Z:
500 case ABS_RX:
501 case ABS_RY:
502 case ABS_RZ:
503 return InputDeviceClass::SENSOR;
504 }
505 }
506
Michael Wright842500e2015-03-13 17:32:02 -0700507 // External stylus gets the pressure axis
Chris Ye1b0c7342020-07-28 21:57:03 -0700508 if (deviceClasses.test(InputDeviceClass::EXTERNAL_STYLUS)) {
Michael Wright842500e2015-03-13 17:32:02 -0700509 if (axis == ABS_PRESSURE) {
Chris Ye1b0c7342020-07-28 21:57:03 -0700510 return InputDeviceClass::EXTERNAL_STYLUS;
Michael Wright842500e2015-03-13 17:32:02 -0700511 }
512 }
513
Michael Wrightd02c5b62014-02-10 15:10:22 -0800514 // Joystick devices get the rest.
Chris Ye1b0c7342020-07-28 21:57:03 -0700515 return deviceClasses & InputDeviceClass::JOYSTICK;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800516}
517
Harry Cuttsea73eaa2023-01-16 17:55:46 +0000518// --- RawAbsoluteAxisInfo ---
519
Prabir Pradhan132f21c2024-07-25 16:48:30 +0000520std::ostream& operator<<(std::ostream& out, const std::optional<RawAbsoluteAxisInfo>& info) {
521 if (info) {
522 out << "min=" << info->minValue << ", max=" << info->maxValue << ", flat=" << info->flat
523 << ", fuzz=" << info->fuzz << ", resolution=" << info->resolution;
Harry Cuttsea73eaa2023-01-16 17:55:46 +0000524 } else {
525 out << "unknown range";
526 }
527 return out;
528}
529
Michael Wrightd02c5b62014-02-10 15:10:22 -0800530// --- EventHub::Device ---
531
Prabir Pradhancb42b472022-08-23 16:01:19 +0000532EventHub::Device::Device(int fd, int32_t id, std::string path, InputDeviceIdentifier identifier,
533 std::shared_ptr<const AssociatedDevice> assocDev)
Chris Ye989bb932020-07-04 16:18:59 -0700534 : fd(fd),
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700535 id(id),
Prabir Pradhancb42b472022-08-23 16:01:19 +0000536 path(std::move(path)),
537 identifier(std::move(identifier)),
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700538 classes(0),
539 configuration(nullptr),
540 virtualKeyMap(nullptr),
541 ffEffectPlaying(false),
542 ffEffectId(-1),
Prabir Pradhancb42b472022-08-23 16:01:19 +0000543 associatedDevice(std::move(assocDev)),
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700544 controllerNumber(0),
545 enabled(true),
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000546 isVirtual(fd < 0),
547 currentFrameDropped(false) {}
Michael Wrightd02c5b62014-02-10 15:10:22 -0800548
549EventHub::Device::~Device() {
550 close();
Michael Wrightd02c5b62014-02-10 15:10:22 -0800551}
552
553void EventHub::Device::close() {
554 if (fd >= 0) {
555 ::close(fd);
556 fd = -1;
557 }
558}
559
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -0700560status_t EventHub::Device::enable() {
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100561 fd = open(path.c_str(), O_RDWR | O_CLOEXEC | O_NONBLOCK);
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700562 if (fd < 0) {
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100563 ALOGE("could not open %s, %s\n", path.c_str(), strerror(errno));
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -0700564 return -errno;
565 }
566 enabled = true;
567 return OK;
568}
569
570status_t EventHub::Device::disable() {
571 close();
572 enabled = false;
573 return OK;
574}
575
Chris Ye989bb932020-07-04 16:18:59 -0700576bool EventHub::Device::hasValidFd() const {
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -0700577 return !isVirtual && enabled;
578}
Michael Wrightd02c5b62014-02-10 15:10:22 -0800579
Chris Ye3a1e4462020-08-12 10:13:15 -0700580const std::shared_ptr<KeyCharacterMap> EventHub::Device::getKeyCharacterMap() const {
Chris Ye989bb932020-07-04 16:18:59 -0700581 return keyMap.keyCharacterMap;
582}
583
584template <std::size_t N>
585status_t EventHub::Device::readDeviceBitMask(unsigned long ioctlCode, BitArray<N>& bitArray) {
586 if (!hasValidFd()) {
587 return BAD_VALUE;
588 }
589 if ((_IOC_SIZE(ioctlCode) == 0)) {
590 ioctlCode |= _IOC(0, 0, 0, bitArray.bytes());
591 }
592
593 typename BitArray<N>::Buffer buffer;
594 status_t ret = ioctl(fd, ioctlCode, buffer.data());
595 bitArray.loadFromBuffer(buffer);
596 return ret;
597}
598
599void EventHub::Device::configureFd() {
600 // Set fd parameters with ioctl, such as key repeat, suspend block, and clock type
601 if (classes.test(InputDeviceClass::KEYBOARD)) {
602 // Disable kernel key repeat since we handle it ourselves
603 unsigned int repeatRate[] = {0, 0};
604 if (ioctl(fd, EVIOCSREP, repeatRate)) {
605 ALOGW("Unable to disable kernel key repeat for %s: %s", path.c_str(), strerror(errno));
606 }
607 }
608
609 // Tell the kernel that we want to use the monotonic clock for reporting timestamps
610 // associated with input events. This is important because the input system
611 // uses the timestamps extensively and assumes they were recorded using the monotonic
612 // clock.
613 int clockId = CLOCK_MONOTONIC;
Chris Yef59a2f42020-10-16 12:55:26 -0700614 if (classes.test(InputDeviceClass::SENSOR)) {
615 // Each new sensor event should use the same time base as
616 // SystemClock.elapsedRealtimeNanos().
617 clockId = CLOCK_BOOTTIME;
618 }
Chris Ye989bb932020-07-04 16:18:59 -0700619 bool usingClockIoctl = !ioctl(fd, EVIOCSCLOCKID, &clockId);
620 ALOGI("usingClockIoctl=%s", toString(usingClockIoctl));
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000621
622 // Query the initial state of keys and switches, which is tracked by EventHub.
623 readDeviceState();
624}
625
626void EventHub::Device::readDeviceState() {
627 if (readDeviceBitMask(EVIOCGKEY(0), keyState) < 0) {
628 ALOGD("Unable to query the global key state for %s: %s", path.c_str(), strerror(errno));
629 }
630 if (readDeviceBitMask(EVIOCGSW(0), swState) < 0) {
631 ALOGD("Unable to query the global switch state for %s: %s", path.c_str(), strerror(errno));
632 }
Prabir Pradhan341d0782023-07-14 19:04:10 +0000633
634 // Read absolute axis info and values for all available axes for the device.
635 populateAbsoluteAxisStates();
636}
637
638void EventHub::Device::populateAbsoluteAxisStates() {
639 absState.clear();
640
641 for (int axis = 0; axis <= ABS_MAX; axis++) {
642 if (!absBitmask.test(axis)) {
643 continue;
644 }
645 struct input_absinfo info {};
646 if (ioctl(fd, EVIOCGABS(axis), &info)) {
647 ALOGE("Error reading absolute controller %d for device %s fd %d: %s", axis,
648 identifier.name.c_str(), fd, strerror(errno));
649 continue;
650 }
Prabir Pradhan341d0782023-07-14 19:04:10 +0000651 auto& [axisInfo, value] = absState[axis];
Prabir Pradhan341d0782023-07-14 19:04:10 +0000652 axisInfo.minValue = info.minimum;
653 axisInfo.maxValue = info.maximum;
654 axisInfo.flat = info.flat;
655 axisInfo.fuzz = info.fuzz;
656 axisInfo.resolution = info.resolution;
657 value = info.value;
658 }
Chris Ye989bb932020-07-04 16:18:59 -0700659}
660
661bool EventHub::Device::hasKeycodeLocked(int keycode) const {
662 if (!keyMap.haveKeyLayout()) {
663 return false;
664 }
665
Siarhei Vishniakouef1564c2022-05-18 09:45:54 -0700666 std::vector<int32_t> scanCodes = keyMap.keyLayoutMap->findScanCodesForKey(keycode);
Chris Ye989bb932020-07-04 16:18:59 -0700667 const size_t N = scanCodes.size();
668 for (size_t i = 0; i < N && i <= KEY_MAX; i++) {
669 int32_t sc = scanCodes[i];
670 if (sc >= 0 && sc <= KEY_MAX && keyBitmask.test(sc)) {
671 return true;
672 }
673 }
674
Charles Linaadf8d52023-03-30 13:34:54 +0800675 std::vector<int32_t> usageCodes = keyMap.keyLayoutMap->findUsageCodesForKey(keycode);
676 if (usageCodes.size() > 0 && mscBitmask.test(MSC_SCAN)) {
677 return true;
678 }
679
Chris Ye989bb932020-07-04 16:18:59 -0700680 return false;
681}
682
683void EventHub::Device::loadConfigurationLocked() {
684 configurationFile =
685 getInputDeviceConfigurationFilePathByDeviceIdentifier(identifier,
686 InputDeviceConfigurationFileType::
687 CONFIGURATION);
688 if (configurationFile.empty()) {
689 ALOGD("No input device configuration file found for device '%s'.", identifier.name.c_str());
690 } else {
Siarhei Vishniakou4d9f9772020-09-02 22:28:29 -0500691 android::base::Result<std::unique_ptr<PropertyMap>> propertyMap =
692 PropertyMap::load(configurationFile.c_str());
693 if (!propertyMap.ok()) {
Chris Ye989bb932020-07-04 16:18:59 -0700694 ALOGE("Error loading input device configuration file for device '%s'. "
695 "Using default configuration.",
696 identifier.name.c_str());
Siarhei Vishniakoud549b252020-08-11 11:25:26 -0500697 } else {
Siarhei Vishniakou4d9f9772020-09-02 22:28:29 -0500698 configuration = std::move(*propertyMap);
Chris Ye989bb932020-07-04 16:18:59 -0700699 }
700 }
701}
702
703bool EventHub::Device::loadVirtualKeyMapLocked() {
704 // The virtual key map is supplied by the kernel as a system board property file.
705 std::string propPath = "/sys/board_properties/virtualkeys.";
706 propPath += identifier.getCanonicalName();
707 if (access(propPath.c_str(), R_OK)) {
708 return false;
709 }
710 virtualKeyMap = VirtualKeyMap::load(propPath);
711 return virtualKeyMap != nullptr;
712}
713
714status_t EventHub::Device::loadKeyMapLocked() {
Siarhei Vishniakoud549b252020-08-11 11:25:26 -0500715 return keyMap.load(identifier, configuration.get());
Chris Ye989bb932020-07-04 16:18:59 -0700716}
717
718bool EventHub::Device::isExternalDeviceLocked() {
719 if (configuration) {
Harry Cuttsf13161a2023-03-08 14:15:49 +0000720 std::optional<bool> isInternal = configuration->getBool("device.internal");
721 if (isInternal.has_value()) {
722 return !isInternal.value();
Chris Ye989bb932020-07-04 16:18:59 -0700723 }
724 }
725 return identifier.bus == BUS_USB || identifier.bus == BUS_BLUETOOTH;
726}
727
728bool EventHub::Device::deviceHasMicLocked() {
729 if (configuration) {
Harry Cuttsf13161a2023-03-08 14:15:49 +0000730 std::optional<bool> hasMic = configuration->getBool("audio.mic");
731 if (hasMic.has_value()) {
732 return hasMic.value();
Chris Ye989bb932020-07-04 16:18:59 -0700733 }
734 }
735 return false;
736}
737
738void EventHub::Device::setLedStateLocked(int32_t led, bool on) {
739 int32_t sc;
740 if (hasValidFd() && mapLed(led, &sc) != NAME_NOT_FOUND) {
741 struct input_event ev;
Colin Cross5b799302022-10-18 21:52:41 -0700742 ev.input_event_sec = 0;
743 ev.input_event_usec = 0;
Chris Ye989bb932020-07-04 16:18:59 -0700744 ev.type = EV_LED;
745 ev.code = sc;
746 ev.value = on ? 1 : 0;
747
748 ssize_t nWrite;
749 do {
750 nWrite = write(fd, &ev, sizeof(struct input_event));
751 } while (nWrite == -1 && errno == EINTR);
752 }
753}
754
755void EventHub::Device::setLedForControllerLocked() {
756 for (int i = 0; i < MAX_CONTROLLER_LEDS; i++) {
757 setLedStateLocked(ALED_CONTROLLER_1 + i, controllerNumber == i + 1);
758 }
759}
760
761status_t EventHub::Device::mapLed(int32_t led, int32_t* outScanCode) const {
762 if (!keyMap.haveKeyLayout()) {
763 return NAME_NOT_FOUND;
764 }
765
Siarhei Vishniakouef1564c2022-05-18 09:45:54 -0700766 std::optional<int32_t> scanCode = keyMap.keyLayoutMap->findScanCodeForLed(led);
767 if (scanCode.has_value()) {
768 if (*scanCode >= 0 && *scanCode <= LED_MAX && ledBitmask.test(*scanCode)) {
769 *outScanCode = *scanCode;
Chris Ye989bb932020-07-04 16:18:59 -0700770 return NO_ERROR;
771 }
772 }
773 return NAME_NOT_FOUND;
774}
775
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000776void EventHub::Device::trackInputEvent(const struct input_event& event) {
777 switch (event.type) {
778 case EV_KEY: {
779 LOG_ALWAYS_FATAL_IF(!currentFrameDropped &&
780 !keyState.set(static_cast<size_t>(event.code),
781 event.value != 0),
Prabir Pradhan10301422023-07-26 21:48:30 +0000782 "%s: device '%s' received invalid EV_KEY event code: %s value: %d",
783 __func__, identifier.name.c_str(),
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000784 InputEventLookup::getLinuxEvdevLabel(EV_KEY, event.code, 1)
Prabir Pradhan10301422023-07-26 21:48:30 +0000785 .code.c_str(),
786 event.value);
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000787 break;
788 }
789 case EV_SW: {
790 LOG_ALWAYS_FATAL_IF(!currentFrameDropped &&
791 !swState.set(static_cast<size_t>(event.code),
792 event.value != 0),
Prabir Pradhan10301422023-07-26 21:48:30 +0000793 "%s: device '%s' received invalid EV_SW event code: %s value: %d",
794 __func__, identifier.name.c_str(),
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000795 InputEventLookup::getLinuxEvdevLabel(EV_SW, event.code, 1)
Prabir Pradhan10301422023-07-26 21:48:30 +0000796 .code.c_str(),
797 event.value);
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000798 break;
799 }
Prabir Pradhan341d0782023-07-14 19:04:10 +0000800 case EV_ABS: {
Prabir Pradhan10301422023-07-26 21:48:30 +0000801 if (currentFrameDropped) {
802 break;
803 }
Prabir Pradhan341d0782023-07-14 19:04:10 +0000804 auto it = absState.find(event.code);
Prabir Pradhan10301422023-07-26 21:48:30 +0000805 LOG_ALWAYS_FATAL_IF(it == absState.end(),
806 "%s: device '%s' received invalid EV_ABS event code: %s value: %d",
807 __func__, identifier.name.c_str(),
Prabir Pradhan341d0782023-07-14 19:04:10 +0000808 InputEventLookup::getLinuxEvdevLabel(EV_ABS, event.code, 0)
Prabir Pradhan10301422023-07-26 21:48:30 +0000809 .code.c_str(),
810 event.value);
Prabir Pradhan341d0782023-07-14 19:04:10 +0000811 it->second.value = event.value;
812 break;
813 }
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000814 case EV_SYN: {
815 switch (event.code) {
816 case SYN_REPORT:
Arpit Singh1c3d8552024-01-08 14:16:28 +0000817 if (currentFrameDropped) {
818 // To recover after a SYN_DROPPED, we need to query the state of the device
819 // to synchronize our device state with the kernel's to account for the
820 // dropped events on receiving the next SYN_REPORT.
821 // Note we don't drop the SYN_REPORT at this point but it is used by the
822 // InputDevice to reset and repopulate mapper state
823 readDeviceState();
824 currentFrameDropped = false;
825 }
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000826 break;
827 case SYN_DROPPED:
828 // When we receive SYN_DROPPED, all events in the current frame should be
Arpit Singh1c3d8552024-01-08 14:16:28 +0000829 // dropped up to and including next SYN_REPORT
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000830 currentFrameDropped = true;
Prabir Pradhan9762ac92023-07-13 21:45:12 +0000831 break;
832 default:
833 break;
834 }
835 break;
836 }
837 default:
838 break;
839 }
840}
841
Siarhei Vishniakou7a522bf2019-09-24 12:46:29 +0100842/**
843 * Get the capabilities for the current process.
844 * Crashes the system if unable to create / check / destroy the capabilities object.
845 */
846class Capabilities final {
847public:
848 explicit Capabilities() {
849 mCaps = cap_get_proc();
850 LOG_ALWAYS_FATAL_IF(mCaps == nullptr, "Could not get capabilities of the current process");
851 }
852
853 /**
854 * Check whether the current process has a specific capability
855 * in the set of effective capabilities.
856 * Return CAP_SET if the process has the requested capability
857 * Return CAP_CLEAR otherwise.
858 */
859 cap_flag_value_t checkEffectiveCapability(cap_value_t capability) {
860 cap_flag_value_t value;
861 const int result = cap_get_flag(mCaps, capability, CAP_EFFECTIVE, &value);
862 LOG_ALWAYS_FATAL_IF(result == -1, "Could not obtain the requested capability");
863 return value;
864 }
865
866 ~Capabilities() {
867 const int result = cap_free(mCaps);
868 LOG_ALWAYS_FATAL_IF(result == -1, "Could not release the capabilities structure");
869 }
870
871private:
872 cap_t mCaps;
873};
874
875static void ensureProcessCanBlockSuspend() {
876 Capabilities capabilities;
877 const bool canBlockSuspend =
878 capabilities.checkEffectiveCapability(CAP_BLOCK_SUSPEND) == CAP_SET;
879 LOG_ALWAYS_FATAL_IF(!canBlockSuspend,
880 "Input must be able to block suspend to properly process events");
881}
882
Michael Wrightd02c5b62014-02-10 15:10:22 -0800883// --- EventHub ---
884
Michael Wrightd02c5b62014-02-10 15:10:22 -0800885const int EventHub::EPOLL_MAX_EVENTS;
886
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700887EventHub::EventHub(void)
888 : mBuiltInKeyboardId(NO_BUILT_IN_KEYBOARD),
889 mNextDeviceId(1),
890 mControllerNumbers(),
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700891 mNeedToReopenDevices(false),
892 mNeedToScanDevices(true),
893 mPendingEventCount(0),
894 mPendingEventIndex(0),
895 mPendingINotify(false) {
Siarhei Vishniakou7a522bf2019-09-24 12:46:29 +0100896 ensureProcessCanBlockSuspend();
Michael Wrightd02c5b62014-02-10 15:10:22 -0800897
Nick Kralevichfcf1b2b2018-12-15 11:59:30 -0800898 mEpollFd = epoll_create1(EPOLL_CLOEXEC);
Siarhei Vishniakou951f3622018-12-12 19:45:42 -0800899 LOG_ALWAYS_FATAL_IF(mEpollFd < 0, "Could not create epoll instance: %s", strerror(errno));
Michael Wrightd02c5b62014-02-10 15:10:22 -0800900
Michael Wright8e9a8562022-02-09 13:44:29 +0000901 mINotifyFd = inotify_init1(IN_CLOEXEC);
Prabir Pradhan952e65b2022-06-23 17:49:55 +0000902 LOG_ALWAYS_FATAL_IF(mINotifyFd < 0, "Could not create inotify instance: %s", strerror(errno));
Usama Arifb27c8e62021-06-03 16:44:09 +0100903
904 std::error_code errorCode;
905 bool isDeviceInotifyAdded = false;
906 if (std::filesystem::exists(DEVICE_INPUT_PATH, errorCode)) {
907 addDeviceInputInotify();
Philip Quinn39b81682019-01-09 22:20:39 -0800908 } else {
Usama Arifb27c8e62021-06-03 16:44:09 +0100909 addDeviceInotify();
910 isDeviceInotifyAdded = true;
911 if (errorCode) {
912 ALOGW("Could not run filesystem::exists() due to error %d : %s.", errorCode.value(),
913 errorCode.message().c_str());
914 }
915 }
916
917 if (isV4lScanningEnabled() && !isDeviceInotifyAdded) {
918 addDeviceInotify();
919 } else {
Philip Quinn39b81682019-01-09 22:20:39 -0800920 ALOGI("Video device scanning disabled");
921 }
Michael Wrightd02c5b62014-02-10 15:10:22 -0800922
Siarhei Vishniakou2d0e9482019-09-24 12:52:47 +0100923 struct epoll_event eventItem = {};
924 eventItem.events = EPOLLIN | EPOLLWAKEUP;
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -0700925 eventItem.data.fd = mINotifyFd;
Siarhei Vishniakou951f3622018-12-12 19:45:42 -0800926 int result = epoll_ctl(mEpollFd, EPOLL_CTL_ADD, mINotifyFd, &eventItem);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800927 LOG_ALWAYS_FATAL_IF(result != 0, "Could not add INotify to epoll instance. errno=%d", errno);
928
929 int wakeFds[2];
Michael Wright8e9a8562022-02-09 13:44:29 +0000930 result = pipe2(wakeFds, O_CLOEXEC);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800931 LOG_ALWAYS_FATAL_IF(result != 0, "Could not create wake pipe. errno=%d", errno);
932
933 mWakeReadPipeFd = wakeFds[0];
934 mWakeWritePipeFd = wakeFds[1];
935
936 result = fcntl(mWakeReadPipeFd, F_SETFL, O_NONBLOCK);
937 LOG_ALWAYS_FATAL_IF(result != 0, "Could not make wake read pipe non-blocking. errno=%d",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700938 errno);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800939
940 result = fcntl(mWakeWritePipeFd, F_SETFL, O_NONBLOCK);
941 LOG_ALWAYS_FATAL_IF(result != 0, "Could not make wake write pipe non-blocking. errno=%d",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700942 errno);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800943
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -0700944 eventItem.data.fd = mWakeReadPipeFd;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800945 result = epoll_ctl(mEpollFd, EPOLL_CTL_ADD, mWakeReadPipeFd, &eventItem);
946 LOG_ALWAYS_FATAL_IF(result != 0, "Could not add wake read pipe to epoll instance. errno=%d",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700947 errno);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800948}
949
950EventHub::~EventHub(void) {
951 closeAllDevicesLocked();
952
Michael Wrightd02c5b62014-02-10 15:10:22 -0800953 ::close(mEpollFd);
954 ::close(mINotifyFd);
955 ::close(mWakeReadPipeFd);
956 ::close(mWakeWritePipeFd);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800957}
958
Usama Arifb27c8e62021-06-03 16:44:09 +0100959/**
960 * On devices that don't have any input devices (like some development boards), the /dev/input
961 * directory will be absent. However, the user may still plug in an input device at a later time.
962 * Add watch for contents of /dev/input only when /dev/input appears.
963 */
964void EventHub::addDeviceInputInotify() {
965 mDeviceInputWd = inotify_add_watch(mINotifyFd, DEVICE_INPUT_PATH, IN_DELETE | IN_CREATE);
966 LOG_ALWAYS_FATAL_IF(mDeviceInputWd < 0, "Could not register INotify for %s: %s",
967 DEVICE_INPUT_PATH, strerror(errno));
968}
969
970void EventHub::addDeviceInotify() {
971 mDeviceWd = inotify_add_watch(mINotifyFd, DEVICE_PATH, IN_DELETE | IN_CREATE);
972 LOG_ALWAYS_FATAL_IF(mDeviceWd < 0, "Could not register INotify for %s: %s", DEVICE_PATH,
973 strerror(errno));
974}
975
Michael Wrightd02c5b62014-02-10 15:10:22 -0800976InputDeviceIdentifier EventHub::getDeviceIdentifier(int32_t deviceId) const {
Chris Ye87143712020-11-10 05:05:58 +0000977 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800978 Device* device = getDeviceLocked(deviceId);
Chris Ye989bb932020-07-04 16:18:59 -0700979 return device != nullptr ? device->identifier : InputDeviceIdentifier();
Michael Wrightd02c5b62014-02-10 15:10:22 -0800980}
981
Dominik Laskowski2f01d772022-03-23 16:01:29 -0700982ftl::Flags<InputDeviceClass> EventHub::getDeviceClasses(int32_t deviceId) const {
Chris Ye87143712020-11-10 05:05:58 +0000983 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800984 Device* device = getDeviceLocked(deviceId);
Dominik Laskowski2f01d772022-03-23 16:01:29 -0700985 return device != nullptr ? device->classes : ftl::Flags<InputDeviceClass>(0);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800986}
987
988int32_t EventHub::getDeviceControllerNumber(int32_t deviceId) const {
Chris Ye87143712020-11-10 05:05:58 +0000989 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800990 Device* device = getDeviceLocked(deviceId);
Chris Ye989bb932020-07-04 16:18:59 -0700991 return device != nullptr ? device->controllerNumber : 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800992}
993
Harry Cuttsc34f7582023-03-07 16:23:30 +0000994std::optional<PropertyMap> EventHub::getConfiguration(int32_t deviceId) const {
Chris Ye87143712020-11-10 05:05:58 +0000995 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800996 Device* device = getDeviceLocked(deviceId);
Harry Cuttsc34f7582023-03-07 16:23:30 +0000997 if (device == nullptr || device->configuration == nullptr) {
998 return {};
Michael Wrightd02c5b62014-02-10 15:10:22 -0800999 }
Harry Cuttsc34f7582023-03-07 16:23:30 +00001000 return *device->configuration;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001001}
1002
Harry Cutts207674d2024-06-06 18:53:41 +00001003std::optional<RawAbsoluteAxisInfo> EventHub::getAbsoluteAxisInfo(int32_t deviceId, int axis) const {
Arpit Singh77140f42023-06-13 11:35:27 +00001004 if (axis < 0 || axis > ABS_MAX) {
Harry Cutts207674d2024-06-06 18:53:41 +00001005 return std::nullopt;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001006 }
Arpit Singh77140f42023-06-13 11:35:27 +00001007 std::scoped_lock _l(mLock);
Prabir Pradhan341d0782023-07-14 19:04:10 +00001008 const Device* device = getDeviceLocked(deviceId);
Arpit Singh77140f42023-06-13 11:35:27 +00001009 if (device == nullptr) {
Harry Cutts207674d2024-06-06 18:53:41 +00001010 return std::nullopt;
Arpit Singh77140f42023-06-13 11:35:27 +00001011 }
Prabir Pradhan341d0782023-07-14 19:04:10 +00001012 // We can read the RawAbsoluteAxisInfo even if the device is disabled and doesn't have a valid
1013 // fd, because the info is populated once when the device is first opened, and it doesn't change
1014 // throughout the device lifecycle.
1015 auto it = device->absState.find(axis);
1016 if (it == device->absState.end()) {
Harry Cutts207674d2024-06-06 18:53:41 +00001017 return std::nullopt;
Arpit Singh77140f42023-06-13 11:35:27 +00001018 }
Harry Cutts207674d2024-06-06 18:53:41 +00001019 return it->second.info;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001020}
1021
1022bool EventHub::hasRelativeAxis(int32_t deviceId, int axis) const {
1023 if (axis >= 0 && axis <= REL_MAX) {
Chris Ye87143712020-11-10 05:05:58 +00001024 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001025 Device* device = getDeviceLocked(deviceId);
Chris Ye66fbac32020-07-06 20:36:43 -07001026 return device != nullptr ? device->relBitmask.test(axis) : false;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001027 }
1028 return false;
1029}
1030
1031bool EventHub::hasInputProperty(int32_t deviceId, int property) const {
Chris Ye87143712020-11-10 05:05:58 +00001032 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001033
Chris Ye989bb932020-07-04 16:18:59 -07001034 Device* device = getDeviceLocked(deviceId);
1035 return property >= 0 && property <= INPUT_PROP_MAX && device != nullptr
1036 ? device->propBitmask.test(property)
1037 : false;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001038}
1039
Chris Yef59a2f42020-10-16 12:55:26 -07001040bool EventHub::hasMscEvent(int32_t deviceId, int mscEvent) const {
1041 std::scoped_lock _l(mLock);
1042
1043 Device* device = getDeviceLocked(deviceId);
1044 return mscEvent >= 0 && mscEvent <= MSC_MAX && device != nullptr
1045 ? device->mscBitmask.test(mscEvent)
1046 : false;
1047}
1048
Michael Wrightd02c5b62014-02-10 15:10:22 -08001049int32_t EventHub::getScanCodeState(int32_t deviceId, int32_t scanCode) const {
Prabir Pradhan9762ac92023-07-13 21:45:12 +00001050 if (scanCode < 0 || scanCode > KEY_MAX) {
1051 return AKEY_STATE_UNKNOWN;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001052 }
Prabir Pradhan9762ac92023-07-13 21:45:12 +00001053 std::scoped_lock _l(mLock);
1054 const Device* device = getDeviceLocked(deviceId);
1055 if (device == nullptr || !device->hasValidFd() || !device->keyBitmask.test(scanCode)) {
1056 return AKEY_STATE_UNKNOWN;
1057 }
1058 return device->keyState.test(scanCode) ? AKEY_STATE_DOWN : AKEY_STATE_UP;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001059}
1060
1061int32_t EventHub::getKeyCodeState(int32_t deviceId, int32_t keyCode) const {
Chris Ye87143712020-11-10 05:05:58 +00001062 std::scoped_lock _l(mLock);
Prabir Pradhan9762ac92023-07-13 21:45:12 +00001063 const Device* device = getDeviceLocked(deviceId);
1064 if (device == nullptr || !device->hasValidFd() || !device->keyMap.haveKeyLayout()) {
1065 return AKEY_STATE_UNKNOWN;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001066 }
Prabir Pradhan9762ac92023-07-13 21:45:12 +00001067 const std::vector<int32_t> scanCodes =
1068 device->keyMap.keyLayoutMap->findScanCodesForKey(keyCode);
1069 if (scanCodes.empty()) {
1070 return AKEY_STATE_UNKNOWN;
1071 }
1072 return std::any_of(scanCodes.begin(), scanCodes.end(),
1073 [&device](const int32_t sc) {
1074 return sc >= 0 && sc <= KEY_MAX && device->keyState.test(sc);
1075 })
1076 ? AKEY_STATE_DOWN
1077 : AKEY_STATE_UP;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001078}
1079
Philip Junker4af3b3d2021-12-14 10:36:55 +01001080int32_t EventHub::getKeyCodeForKeyLocation(int32_t deviceId, int32_t locationKeyCode) const {
1081 std::scoped_lock _l(mLock);
1082
1083 Device* device = getDeviceLocked(deviceId);
1084 if (device == nullptr || !device->hasValidFd() || device->keyMap.keyCharacterMap == nullptr ||
1085 device->keyMap.keyLayoutMap == nullptr) {
1086 return AKEYCODE_UNKNOWN;
1087 }
Siarhei Vishniakouef1564c2022-05-18 09:45:54 -07001088 std::vector<int32_t> scanCodes =
1089 device->keyMap.keyLayoutMap->findScanCodesForKey(locationKeyCode);
Philip Junker4af3b3d2021-12-14 10:36:55 +01001090 if (scanCodes.empty()) {
1091 ALOGW("Failed to get key code for key location: no scan code maps to key code %d for input"
1092 "device %d",
1093 locationKeyCode, deviceId);
1094 return AKEYCODE_UNKNOWN;
1095 }
1096 if (scanCodes.size() > 1) {
1097 ALOGW("Multiple scan codes map to the same key code %d, returning only the first match",
1098 locationKeyCode);
1099 }
1100 int32_t outKeyCode;
1101 status_t mapKeyRes =
Harry Cutts33476232023-01-30 19:57:29 +00001102 device->getKeyCharacterMap()->mapKey(scanCodes[0], /*usageCode=*/0, &outKeyCode);
Philip Junker4af3b3d2021-12-14 10:36:55 +01001103 switch (mapKeyRes) {
1104 case OK:
Vaibhav Devmuraricbba14c2022-10-10 16:54:49 +00001105 break;
Philip Junker4af3b3d2021-12-14 10:36:55 +01001106 case NAME_NOT_FOUND:
1107 // key character map doesn't re-map this scanCode, hence the keyCode remains the same
Vaibhav Devmuraricbba14c2022-10-10 16:54:49 +00001108 outKeyCode = locationKeyCode;
1109 break;
Philip Junker4af3b3d2021-12-14 10:36:55 +01001110 default:
1111 ALOGW("Failed to get key code for key location: Key character map returned error %s",
1112 statusToString(mapKeyRes).c_str());
Vaibhav Devmuraricbba14c2022-10-10 16:54:49 +00001113 outKeyCode = AKEYCODE_UNKNOWN;
1114 break;
Philip Junker4af3b3d2021-12-14 10:36:55 +01001115 }
Vaibhav Devmuraricbba14c2022-10-10 16:54:49 +00001116 // Remap if there is a Key remapping added to the KCM and return the remapped key
1117 return device->getKeyCharacterMap()->applyKeyRemapping(outKeyCode);
Philip Junker4af3b3d2021-12-14 10:36:55 +01001118}
1119
Michael Wrightd02c5b62014-02-10 15:10:22 -08001120int32_t EventHub::getSwitchState(int32_t deviceId, int32_t sw) const {
Prabir Pradhan9762ac92023-07-13 21:45:12 +00001121 if (sw < 0 || sw > SW_MAX) {
1122 return AKEY_STATE_UNKNOWN;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001123 }
Prabir Pradhan9762ac92023-07-13 21:45:12 +00001124 std::scoped_lock _l(mLock);
1125 const Device* device = getDeviceLocked(deviceId);
1126 if (device == nullptr || !device->hasValidFd() || !device->swBitmask.test(sw)) {
1127 return AKEY_STATE_UNKNOWN;
1128 }
1129 return device->swState.test(sw) ? AKEY_STATE_DOWN : AKEY_STATE_UP;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001130}
1131
Harry Cuttse2c5e202024-06-21 17:08:48 +00001132std::optional<int32_t> EventHub::getAbsoluteAxisValue(int32_t deviceId, int32_t axis) const {
Prabir Pradhan341d0782023-07-14 19:04:10 +00001133 if (axis < 0 || axis > ABS_MAX) {
Harry Cuttse2c5e202024-06-21 17:08:48 +00001134 return std::nullopt;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001135 }
Prabir Pradhan341d0782023-07-14 19:04:10 +00001136 std::scoped_lock _l(mLock);
1137 const Device* device = getDeviceLocked(deviceId);
1138 if (device == nullptr || !device->hasValidFd()) {
Harry Cuttse2c5e202024-06-21 17:08:48 +00001139 return std::nullopt;
Prabir Pradhan341d0782023-07-14 19:04:10 +00001140 }
1141 const auto it = device->absState.find(axis);
1142 if (it == device->absState.end()) {
Harry Cuttse2c5e202024-06-21 17:08:48 +00001143 return std::nullopt;
Prabir Pradhan341d0782023-07-14 19:04:10 +00001144 }
Harry Cuttse2c5e202024-06-21 17:08:48 +00001145 return it->second.value;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001146}
1147
Arpit Singh4b4a4572023-11-24 18:19:56 +00001148base::Result<std::vector<int32_t>> EventHub::getMtSlotValues(int32_t deviceId, int32_t axis,
1149 size_t slotCount) const {
1150 std::scoped_lock _l(mLock);
1151 const Device* device = getDeviceLocked(deviceId);
1152 if (device == nullptr || !device->hasValidFd() || !device->absBitmask.test(axis)) {
1153 return base::ResultError("device problem or axis not supported", NAME_NOT_FOUND);
1154 }
1155 std::vector<int32_t> outValues(slotCount + 1);
1156 outValues[0] = axis;
1157 const size_t bufferSize = outValues.size() * sizeof(int32_t);
1158 if (ioctl(device->fd, EVIOCGMTSLOTS(bufferSize), outValues.data()) != OK) {
1159 return base::ErrnoError();
1160 }
1161 return std::move(outValues);
1162}
1163
Siarhei Vishniakou74007942022-06-13 13:57:47 -07001164bool EventHub::markSupportedKeyCodes(int32_t deviceId, const std::vector<int32_t>& keyCodes,
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001165 uint8_t* outFlags) const {
Chris Ye87143712020-11-10 05:05:58 +00001166 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001167
1168 Device* device = getDeviceLocked(deviceId);
Chris Ye66fbac32020-07-06 20:36:43 -07001169 if (device != nullptr && device->keyMap.haveKeyLayout()) {
Siarhei Vishniakou74007942022-06-13 13:57:47 -07001170 for (size_t codeIndex = 0; codeIndex < keyCodes.size(); codeIndex++) {
Sergej Salnikove5420e72023-05-11 11:52:54 +00001171 if (device->hasKeycodeLocked(keyCodes[codeIndex])) {
1172 outFlags[codeIndex] = 1;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001173 }
1174 }
1175 return true;
1176 }
1177 return false;
1178}
1179
Vaibhav Devmuraricbba14c2022-10-10 16:54:49 +00001180void EventHub::addKeyRemapping(int32_t deviceId, int32_t fromKeyCode, int32_t toKeyCode) const {
1181 std::scoped_lock _l(mLock);
1182 Device* device = getDeviceLocked(deviceId);
1183 if (device == nullptr) {
1184 return;
1185 }
1186 const std::shared_ptr<KeyCharacterMap> kcm = device->getKeyCharacterMap();
1187 if (kcm) {
1188 kcm->addKeyRemapping(fromKeyCode, toKeyCode);
1189 }
1190}
1191
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001192status_t EventHub::mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode, int32_t metaState,
1193 int32_t* outKeycode, int32_t* outMetaState, uint32_t* outFlags) const {
Chris Ye87143712020-11-10 05:05:58 +00001194 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001195 Device* device = getDeviceLocked(deviceId);
Dmitry Torokhov0faaa0b2015-09-24 13:13:55 -07001196 status_t status = NAME_NOT_FOUND;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001197
Chris Ye66fbac32020-07-06 20:36:43 -07001198 if (device != nullptr) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001199 // Check the key character map first.
Chris Ye3a1e4462020-08-12 10:13:15 -07001200 const std::shared_ptr<KeyCharacterMap> kcm = device->getKeyCharacterMap();
1201 if (kcm) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001202 if (!kcm->mapKey(scanCode, usageCode, outKeycode)) {
1203 *outFlags = 0;
Dmitry Torokhov0faaa0b2015-09-24 13:13:55 -07001204 status = NO_ERROR;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001205 }
1206 }
1207
1208 // Check the key layout next.
Dmitry Torokhov0faaa0b2015-09-24 13:13:55 -07001209 if (status != NO_ERROR && device->keyMap.haveKeyLayout()) {
Siarhei Vishniakou592bac22018-11-08 19:42:38 -08001210 if (!device->keyMap.keyLayoutMap->mapKey(scanCode, usageCode, outKeycode, outFlags)) {
Dmitry Torokhov0faaa0b2015-09-24 13:13:55 -07001211 status = NO_ERROR;
1212 }
1213 }
1214
1215 if (status == NO_ERROR) {
Chris Ye3a1e4462020-08-12 10:13:15 -07001216 if (kcm) {
Vaibhav Devmuraricbba14c2022-10-10 16:54:49 +00001217 // Remap keys based on user-defined key remappings and key behavior defined in the
1218 // corresponding kcm file
1219 *outKeycode = kcm->applyKeyRemapping(*outKeycode);
1220
1221 // Remap keys based on Key behavior defined in KCM file
1222 std::tie(*outKeycode, *outMetaState) =
1223 kcm->applyKeyBehavior(*outKeycode, metaState);
Dmitry Torokhov0faaa0b2015-09-24 13:13:55 -07001224 } else {
1225 *outMetaState = metaState;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001226 }
1227 }
1228 }
1229
Dmitry Torokhov0faaa0b2015-09-24 13:13:55 -07001230 if (status != NO_ERROR) {
1231 *outKeycode = 0;
1232 *outFlags = 0;
1233 *outMetaState = metaState;
1234 }
1235
1236 return status;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001237}
1238
1239status_t EventHub::mapAxis(int32_t deviceId, int32_t scanCode, AxisInfo* outAxisInfo) const {
Chris Ye87143712020-11-10 05:05:58 +00001240 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001241 Device* device = getDeviceLocked(deviceId);
1242
Siarhei Vishniakouef1564c2022-05-18 09:45:54 -07001243 if (device == nullptr || !device->keyMap.haveKeyLayout()) {
1244 return NAME_NOT_FOUND;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001245 }
Siarhei Vishniakouef1564c2022-05-18 09:45:54 -07001246 std::optional<AxisInfo> info = device->keyMap.keyLayoutMap->mapAxis(scanCode);
1247 if (!info.has_value()) {
1248 return NAME_NOT_FOUND;
1249 }
1250 *outAxisInfo = *info;
1251 return NO_ERROR;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001252}
1253
Chris Yef59a2f42020-10-16 12:55:26 -07001254base::Result<std::pair<InputDeviceSensorType, int32_t>> EventHub::mapSensor(int32_t deviceId,
Prabir Pradhanae4ff282022-08-23 16:21:39 +00001255 int32_t absCode) const {
Chris Yef59a2f42020-10-16 12:55:26 -07001256 std::scoped_lock _l(mLock);
1257 Device* device = getDeviceLocked(deviceId);
1258
1259 if (device != nullptr && device->keyMap.haveKeyLayout()) {
1260 return device->keyMap.keyLayoutMap->mapSensor(absCode);
1261 }
1262 return Errorf("Device not found or device has no key layout.");
1263}
1264
Chris Yee2b1e5c2021-03-10 22:45:12 -08001265// Gets the battery info map from battery ID to RawBatteryInfo of the miscellaneous device
1266// associated with the device ID. Returns an empty map if no miscellaneous device found.
1267const std::unordered_map<int32_t, RawBatteryInfo>& EventHub::getBatteryInfoLocked(
1268 int32_t deviceId) const {
1269 static const std::unordered_map<int32_t, RawBatteryInfo> EMPTY_BATTERY_INFO = {};
1270 Device* device = getDeviceLocked(deviceId);
Chris Ye1dd2e5c2021-04-04 23:12:41 -07001271 if (device == nullptr || !device->associatedDevice) {
Chris Yee2b1e5c2021-03-10 22:45:12 -08001272 return EMPTY_BATTERY_INFO;
1273 }
Chris Ye1dd2e5c2021-04-04 23:12:41 -07001274 return device->associatedDevice->batteryInfos;
Chris Yee2b1e5c2021-03-10 22:45:12 -08001275}
1276
Prabir Pradhanae4ff282022-08-23 16:21:39 +00001277std::vector<int32_t> EventHub::getRawBatteryIds(int32_t deviceId) const {
Chris Yee2b1e5c2021-03-10 22:45:12 -08001278 std::scoped_lock _l(mLock);
1279 std::vector<int32_t> batteryIds;
1280
Prabir Pradhan51894782022-08-23 16:29:10 +00001281 for (const auto& [id, info] : getBatteryInfoLocked(deviceId)) {
Chris Yee2b1e5c2021-03-10 22:45:12 -08001282 batteryIds.push_back(id);
1283 }
1284
1285 return batteryIds;
1286}
1287
Prabir Pradhanae4ff282022-08-23 16:21:39 +00001288std::optional<RawBatteryInfo> EventHub::getRawBatteryInfo(int32_t deviceId,
1289 int32_t batteryId) const {
Chris Yee2b1e5c2021-03-10 22:45:12 -08001290 std::scoped_lock _l(mLock);
1291
1292 const auto infos = getBatteryInfoLocked(deviceId);
1293
1294 auto it = infos.find(batteryId);
1295 if (it != infos.end()) {
1296 return it->second;
1297 }
1298
1299 return std::nullopt;
1300}
1301
1302// Gets the light info map from light ID to RawLightInfo of the miscellaneous device associated
Prabir Pradhan51894782022-08-23 16:29:10 +00001303// with the device ID. Returns an empty map if no miscellaneous device found.
Chris Yee2b1e5c2021-03-10 22:45:12 -08001304const std::unordered_map<int32_t, RawLightInfo>& EventHub::getLightInfoLocked(
1305 int32_t deviceId) const {
1306 static const std::unordered_map<int32_t, RawLightInfo> EMPTY_LIGHT_INFO = {};
1307 Device* device = getDeviceLocked(deviceId);
Chris Ye1dd2e5c2021-04-04 23:12:41 -07001308 if (device == nullptr || !device->associatedDevice) {
Chris Yee2b1e5c2021-03-10 22:45:12 -08001309 return EMPTY_LIGHT_INFO;
1310 }
Chris Ye1dd2e5c2021-04-04 23:12:41 -07001311 return device->associatedDevice->lightInfos;
Chris Yee2b1e5c2021-03-10 22:45:12 -08001312}
1313
Prabir Pradhanae4ff282022-08-23 16:21:39 +00001314std::vector<int32_t> EventHub::getRawLightIds(int32_t deviceId) const {
Chris Ye3fdbfef2021-01-06 18:45:18 -08001315 std::scoped_lock _l(mLock);
Chris Ye3fdbfef2021-01-06 18:45:18 -08001316 std::vector<int32_t> lightIds;
1317
Prabir Pradhan51894782022-08-23 16:29:10 +00001318 for (const auto& [id, info] : getLightInfoLocked(deviceId)) {
Chris Yee2b1e5c2021-03-10 22:45:12 -08001319 lightIds.push_back(id);
Chris Ye3fdbfef2021-01-06 18:45:18 -08001320 }
Chris Yee2b1e5c2021-03-10 22:45:12 -08001321
Chris Ye3fdbfef2021-01-06 18:45:18 -08001322 return lightIds;
1323}
1324
Prabir Pradhanae4ff282022-08-23 16:21:39 +00001325std::optional<RawLightInfo> EventHub::getRawLightInfo(int32_t deviceId, int32_t lightId) const {
Chris Ye3fdbfef2021-01-06 18:45:18 -08001326 std::scoped_lock _l(mLock);
Chris Ye3fdbfef2021-01-06 18:45:18 -08001327
Chris Yee2b1e5c2021-03-10 22:45:12 -08001328 const auto infos = getLightInfoLocked(deviceId);
1329
1330 auto it = infos.find(lightId);
1331 if (it != infos.end()) {
1332 return it->second;
Chris Ye3fdbfef2021-01-06 18:45:18 -08001333 }
Chris Yee2b1e5c2021-03-10 22:45:12 -08001334
Chris Ye3fdbfef2021-01-06 18:45:18 -08001335 return std::nullopt;
1336}
1337
Prabir Pradhanae4ff282022-08-23 16:21:39 +00001338std::optional<int32_t> EventHub::getLightBrightness(int32_t deviceId, int32_t lightId) const {
Chris Ye3fdbfef2021-01-06 18:45:18 -08001339 std::scoped_lock _l(mLock);
1340
Chris Yee2b1e5c2021-03-10 22:45:12 -08001341 const auto infos = getLightInfoLocked(deviceId);
1342 auto it = infos.find(lightId);
1343 if (it == infos.end()) {
Chris Ye3fdbfef2021-01-06 18:45:18 -08001344 return std::nullopt;
1345 }
1346 std::string buffer;
1347 if (!base::ReadFileToString(it->second.path / LIGHT_NODES.at(InputLightClass::BRIGHTNESS),
1348 &buffer)) {
1349 return std::nullopt;
1350 }
1351 return std::stoi(buffer);
1352}
1353
1354std::optional<std::unordered_map<LightColor, int32_t>> EventHub::getLightIntensities(
Prabir Pradhanae4ff282022-08-23 16:21:39 +00001355 int32_t deviceId, int32_t lightId) const {
Chris Ye3fdbfef2021-01-06 18:45:18 -08001356 std::scoped_lock _l(mLock);
1357
Chris Yee2b1e5c2021-03-10 22:45:12 -08001358 const auto infos = getLightInfoLocked(deviceId);
1359 auto lightIt = infos.find(lightId);
1360 if (lightIt == infos.end()) {
Chris Ye3fdbfef2021-01-06 18:45:18 -08001361 return std::nullopt;
1362 }
1363
1364 auto ret =
1365 getColorIndexArray(lightIt->second.path / LIGHT_NODES.at(InputLightClass::MULTI_INDEX));
1366
1367 if (!ret.has_value()) {
1368 return std::nullopt;
1369 }
1370 std::array<LightColor, COLOR_NUM> colors = ret.value();
1371
1372 std::string intensityStr;
1373 if (!base::ReadFileToString(lightIt->second.path /
1374 LIGHT_NODES.at(InputLightClass::MULTI_INTENSITY),
1375 &intensityStr)) {
1376 return std::nullopt;
1377 }
1378
1379 // Intensity node outputs 3 color values
1380 std::regex intensityPattern("([0-9]+)\\s([0-9]+)\\s([0-9]+)[\\n]");
1381 std::smatch results;
1382
1383 if (!std::regex_match(intensityStr, results, intensityPattern)) {
1384 return std::nullopt;
1385 }
1386 std::unordered_map<LightColor, int32_t> intensities;
1387 for (size_t i = 1; i < results.size(); i++) {
1388 int value = std::stoi(results[i].str());
1389 intensities.emplace(colors[i - 1], value);
1390 }
1391 return intensities;
1392}
1393
1394void EventHub::setLightBrightness(int32_t deviceId, int32_t lightId, int32_t brightness) {
1395 std::scoped_lock _l(mLock);
1396
Chris Yee2b1e5c2021-03-10 22:45:12 -08001397 const auto infos = getLightInfoLocked(deviceId);
1398 auto lightIt = infos.find(lightId);
1399 if (lightIt == infos.end()) {
1400 ALOGE("%s lightId %d not found ", __func__, lightId);
Chris Ye3fdbfef2021-01-06 18:45:18 -08001401 return;
1402 }
1403
1404 if (!base::WriteStringToFile(std::to_string(brightness),
1405 lightIt->second.path /
1406 LIGHT_NODES.at(InputLightClass::BRIGHTNESS))) {
1407 ALOGE("Can not write to file, error: %s", strerror(errno));
1408 }
1409}
1410
1411void EventHub::setLightIntensities(int32_t deviceId, int32_t lightId,
1412 std::unordered_map<LightColor, int32_t> intensities) {
1413 std::scoped_lock _l(mLock);
1414
Chris Yee2b1e5c2021-03-10 22:45:12 -08001415 const auto infos = getLightInfoLocked(deviceId);
1416 auto lightIt = infos.find(lightId);
1417 if (lightIt == infos.end()) {
Chris Ye3fdbfef2021-01-06 18:45:18 -08001418 ALOGE("Light Id %d does not exist.", lightId);
1419 return;
1420 }
1421
1422 auto ret =
1423 getColorIndexArray(lightIt->second.path / LIGHT_NODES.at(InputLightClass::MULTI_INDEX));
1424
1425 if (!ret.has_value()) {
1426 return;
1427 }
1428 std::array<LightColor, COLOR_NUM> colors = ret.value();
1429
1430 std::string rgbStr;
1431 for (size_t i = 0; i < COLOR_NUM; i++) {
1432 auto it = intensities.find(colors[i]);
1433 if (it != intensities.end()) {
1434 rgbStr += std::to_string(it->second);
1435 // Insert space between colors
1436 if (i < COLOR_NUM - 1) {
1437 rgbStr += " ";
1438 }
1439 }
1440 }
1441 // Append new line
1442 rgbStr += "\n";
1443
1444 if (!base::WriteStringToFile(rgbStr,
1445 lightIt->second.path /
1446 LIGHT_NODES.at(InputLightClass::MULTI_INTENSITY))) {
1447 ALOGE("Can not write to file, error: %s", strerror(errno));
1448 }
1449}
1450
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +00001451std::optional<RawLayoutInfo> EventHub::getRawLayoutInfo(int32_t deviceId) const {
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +00001452 std::scoped_lock _l(mLock);
1453 Device* device = getDeviceLocked(deviceId);
1454 if (device == nullptr || !device->associatedDevice) {
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +00001455 return std::nullopt;
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +00001456 }
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +00001457 return device->associatedDevice->layoutInfo;
Vaibhav Devmuraridd82b8e2022-08-16 15:34:01 +00001458}
1459
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01001460void EventHub::setExcludedDevices(const std::vector<std::string>& devices) {
Chris Ye87143712020-11-10 05:05:58 +00001461 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001462
1463 mExcludedDevices = devices;
1464}
1465
1466bool EventHub::hasScanCode(int32_t deviceId, int32_t scanCode) const {
Chris Ye87143712020-11-10 05:05:58 +00001467 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001468 Device* device = getDeviceLocked(deviceId);
Chris Ye66fbac32020-07-06 20:36:43 -07001469 if (device != nullptr && scanCode >= 0 && scanCode <= KEY_MAX) {
1470 return device->keyBitmask.test(scanCode);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001471 }
1472 return false;
1473}
1474
Arthur Hungcb40a002021-08-03 14:31:01 +00001475bool EventHub::hasKeyCode(int32_t deviceId, int32_t keyCode) const {
1476 std::scoped_lock _l(mLock);
1477 Device* device = getDeviceLocked(deviceId);
1478 if (device != nullptr) {
1479 return device->hasKeycodeLocked(keyCode);
1480 }
1481 return false;
1482}
1483
Michael Wrightd02c5b62014-02-10 15:10:22 -08001484bool EventHub::hasLed(int32_t deviceId, int32_t led) const {
Chris Ye87143712020-11-10 05:05:58 +00001485 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001486 Device* device = getDeviceLocked(deviceId);
1487 int32_t sc;
Chris Ye989bb932020-07-04 16:18:59 -07001488 if (device != nullptr && device->mapLed(led, &sc) == NO_ERROR) {
Chris Ye66fbac32020-07-06 20:36:43 -07001489 return device->ledBitmask.test(sc);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001490 }
1491 return false;
1492}
1493
1494void EventHub::setLedState(int32_t deviceId, int32_t led, bool on) {
Chris Ye87143712020-11-10 05:05:58 +00001495 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001496 Device* device = getDeviceLocked(deviceId);
Chris Ye989bb932020-07-04 16:18:59 -07001497 if (device != nullptr && device->hasValidFd()) {
1498 device->setLedStateLocked(led, on);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001499 }
1500}
1501
1502void EventHub::getVirtualKeyDefinitions(int32_t deviceId,
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001503 std::vector<VirtualKeyDefinition>& outVirtualKeys) const {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001504 outVirtualKeys.clear();
1505
Chris Ye87143712020-11-10 05:05:58 +00001506 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001507 Device* device = getDeviceLocked(deviceId);
Chris Ye66fbac32020-07-06 20:36:43 -07001508 if (device != nullptr && device->virtualKeyMap) {
Arthur Hung7c3ae9c2019-03-11 11:23:03 +08001509 const std::vector<VirtualKeyDefinition> virtualKeys =
1510 device->virtualKeyMap->getVirtualKeys();
1511 outVirtualKeys.insert(outVirtualKeys.end(), virtualKeys.begin(), virtualKeys.end());
Michael Wrightd02c5b62014-02-10 15:10:22 -08001512 }
1513}
1514
Chris Ye3a1e4462020-08-12 10:13:15 -07001515const std::shared_ptr<KeyCharacterMap> EventHub::getKeyCharacterMap(int32_t deviceId) const {
Chris Ye87143712020-11-10 05:05:58 +00001516 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001517 Device* device = getDeviceLocked(deviceId);
Chris Ye66fbac32020-07-06 20:36:43 -07001518 if (device != nullptr) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001519 return device->getKeyCharacterMap();
1520 }
Yi Kong9b14ac62018-07-17 13:48:38 -07001521 return nullptr;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001522}
1523
Vaibhav Devmurari23e8ae92022-12-29 12:07:56 +00001524// If provided map is null, it will reset key character map to default KCM.
Chris Ye3a1e4462020-08-12 10:13:15 -07001525bool EventHub::setKeyboardLayoutOverlay(int32_t deviceId, std::shared_ptr<KeyCharacterMap> map) {
Chris Ye87143712020-11-10 05:05:58 +00001526 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001527 Device* device = getDeviceLocked(deviceId);
Vaibhav Devmurari23e8ae92022-12-29 12:07:56 +00001528 if (device == nullptr || device->keyMap.keyCharacterMap == nullptr) {
Philip Junker90bc9492021-12-10 18:39:42 +01001529 return false;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001530 }
Vaibhav Devmurari23e8ae92022-12-29 12:07:56 +00001531 if (map == nullptr) {
1532 device->keyMap.keyCharacterMap->clearLayoutOverlay();
1533 return true;
1534 }
Philip Junker90bc9492021-12-10 18:39:42 +01001535 device->keyMap.keyCharacterMap->combine(*map);
1536 return true;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001537}
1538
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01001539static std::string generateDescriptor(InputDeviceIdentifier& identifier) {
1540 std::string rawDescriptor;
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001541 rawDescriptor += StringPrintf(":%04x:%04x:", identifier.vendor, identifier.product);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001542 // TODO add handling for USB devices to not uniqueify kbs that show up twice
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01001543 if (!identifier.uniqueId.empty()) {
1544 rawDescriptor += "uniqueId:";
1545 rawDescriptor += identifier.uniqueId;
Josh Bartel938632f2022-07-19 15:34:22 -05001546 }
1547 if (identifier.nonce != 0) {
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01001548 rawDescriptor += StringPrintf("nonce:%04x", identifier.nonce);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001549 }
1550
1551 if (identifier.vendor == 0 && identifier.product == 0) {
1552 // If we don't know the vendor and product id, then the device is probably
1553 // built-in so we need to rely on other information to uniquely identify
1554 // the input device. Usually we try to avoid relying on the device name or
1555 // location but for built-in input device, they are unlikely to ever change.
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01001556 if (!identifier.name.empty()) {
1557 rawDescriptor += "name:";
1558 rawDescriptor += identifier.name;
1559 } else if (!identifier.location.empty()) {
1560 rawDescriptor += "location:";
1561 rawDescriptor += identifier.location;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001562 }
1563 }
1564 identifier.descriptor = sha1(rawDescriptor);
1565 return rawDescriptor;
1566}
1567
1568void EventHub::assignDescriptorLocked(InputDeviceIdentifier& identifier) {
1569 // Compute a device descriptor that uniquely identifies the device.
1570 // The descriptor is assumed to be a stable identifier. Its value should not
1571 // change between reboots, reconnections, firmware updates or new releases
1572 // of Android. In practice we sometimes get devices that cannot be uniquely
1573 // identified. In this case we enforce uniqueness between connected devices.
1574 // Ideally, we also want the descriptor to be short and relatively opaque.
Josh Bartel938632f2022-07-19 15:34:22 -05001575 // Note that we explicitly do not use the path or location for external devices
1576 // as their path or location will change as they are plugged/unplugged or moved
1577 // to different ports. We do fallback to using name and location in the case of
1578 // internal devices which are detected by the vendor and product being 0 in
1579 // generateDescriptor. If two identical descriptors are detected we will fallback
1580 // to using a 'nonce' and incrementing it until the new descriptor no longer has
1581 // a match with any existing descriptors.
Michael Wrightd02c5b62014-02-10 15:10:22 -08001582
1583 identifier.nonce = 0;
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01001584 std::string rawDescriptor = generateDescriptor(identifier);
Josh Bartel938632f2022-07-19 15:34:22 -05001585 // Enforce that the generated descriptor is unique.
1586 while (hasDeviceWithDescriptorLocked(identifier.descriptor)) {
1587 identifier.nonce++;
1588 rawDescriptor = generateDescriptor(identifier);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001589 }
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01001590 ALOGV("Created descriptor: raw=%s, cooked=%s", rawDescriptor.c_str(),
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001591 identifier.descriptor.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08001592}
1593
Prabir Pradhancb42b472022-08-23 16:01:19 +00001594std::shared_ptr<const EventHub::AssociatedDevice> EventHub::obtainAssociatedDeviceLocked(
1595 const std::filesystem::path& devicePath) const {
1596 const std::optional<std::filesystem::path> sysfsRootPathOpt =
1597 getSysfsRootPath(devicePath.c_str());
1598 if (!sysfsRootPathOpt) {
1599 return nullptr;
1600 }
1601
1602 const auto& path = *sysfsRootPathOpt;
Prabir Pradhancb42b472022-08-23 16:01:19 +00001603
Prabir Pradhanedeec3b2022-08-26 22:33:55 +00001604 std::shared_ptr<const AssociatedDevice> associatedDevice = std::make_shared<AssociatedDevice>(
Prabir Pradhancb42b472022-08-23 16:01:19 +00001605 AssociatedDevice{.sysfsRootPath = path,
1606 .batteryInfos = readBatteryConfiguration(path),
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +00001607 .lightInfos = readLightsConfiguration(path),
1608 .layoutInfo = readLayoutConfiguration(path)});
Prabir Pradhanedeec3b2022-08-26 22:33:55 +00001609
1610 bool associatedDeviceChanged = false;
1611 for (const auto& [id, dev] : mDevices) {
1612 if (dev->associatedDevice && dev->associatedDevice->sysfsRootPath == path) {
1613 if (*associatedDevice != *dev->associatedDevice) {
1614 associatedDeviceChanged = true;
1615 dev->associatedDevice = associatedDevice;
1616 }
1617 associatedDevice = dev->associatedDevice;
1618 }
1619 }
1620 ALOGI_IF(associatedDeviceChanged,
1621 "The AssociatedDevice changed for path '%s'. Using new AssociatedDevice: %s",
1622 path.c_str(), associatedDevice->dump().c_str());
1623
1624 return associatedDevice;
Prabir Pradhancb42b472022-08-23 16:01:19 +00001625}
1626
Vaibhav Devmurari5fc7d852023-03-17 18:43:33 +00001627bool EventHub::AssociatedDevice::isChanged() const {
1628 std::unordered_map<int32_t, RawBatteryInfo> newBatteryInfos =
1629 readBatteryConfiguration(sysfsRootPath);
1630 std::unordered_map<int32_t, RawLightInfo> newLightInfos =
1631 readLightsConfiguration(sysfsRootPath);
1632 std::optional<RawLayoutInfo> newLayoutInfo = readLayoutConfiguration(sysfsRootPath);
1633
1634 if (newBatteryInfos == batteryInfos && newLightInfos == lightInfos &&
1635 newLayoutInfo == layoutInfo) {
1636 return false;
1637 }
1638 return true;
1639}
1640
Nathaniel R. Lewiscacd69a2019-08-12 22:07:00 +00001641void EventHub::vibrate(int32_t deviceId, const VibrationElement& element) {
Chris Ye87143712020-11-10 05:05:58 +00001642 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001643 Device* device = getDeviceLocked(deviceId);
Chris Ye66fbac32020-07-06 20:36:43 -07001644 if (device != nullptr && device->hasValidFd()) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001645 ff_effect effect;
1646 memset(&effect, 0, sizeof(effect));
1647 effect.type = FF_RUMBLE;
1648 effect.id = device->ffEffectId;
Nathaniel R. Lewiscacd69a2019-08-12 22:07:00 +00001649 // evdev FF_RUMBLE effect only supports two channels of vibration.
Chris Ye6393a262020-08-04 19:41:36 -07001650 effect.u.rumble.strong_magnitude = element.getMagnitude(FF_STRONG_MAGNITUDE_CHANNEL_IDX);
1651 effect.u.rumble.weak_magnitude = element.getMagnitude(FF_WEAK_MAGNITUDE_CHANNEL_IDX);
Nathaniel R. Lewiscacd69a2019-08-12 22:07:00 +00001652 effect.replay.length = element.duration.count();
Michael Wrightd02c5b62014-02-10 15:10:22 -08001653 effect.replay.delay = 0;
1654 if (ioctl(device->fd, EVIOCSFF, &effect)) {
1655 ALOGW("Could not upload force feedback effect to device %s due to error %d.",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001656 device->identifier.name.c_str(), errno);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001657 return;
1658 }
1659 device->ffEffectId = effect.id;
1660
1661 struct input_event ev;
Colin Cross5b799302022-10-18 21:52:41 -07001662 ev.input_event_sec = 0;
1663 ev.input_event_usec = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001664 ev.type = EV_FF;
1665 ev.code = device->ffEffectId;
1666 ev.value = 1;
1667 if (write(device->fd, &ev, sizeof(ev)) != sizeof(ev)) {
1668 ALOGW("Could not start force feedback effect on device %s due to error %d.",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001669 device->identifier.name.c_str(), errno);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001670 return;
1671 }
1672 device->ffEffectPlaying = true;
1673 }
1674}
1675
1676void EventHub::cancelVibrate(int32_t deviceId) {
Chris Ye87143712020-11-10 05:05:58 +00001677 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001678 Device* device = getDeviceLocked(deviceId);
Chris Ye66fbac32020-07-06 20:36:43 -07001679 if (device != nullptr && device->hasValidFd()) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001680 if (device->ffEffectPlaying) {
1681 device->ffEffectPlaying = false;
1682
1683 struct input_event ev;
Colin Cross5b799302022-10-18 21:52:41 -07001684 ev.input_event_sec = 0;
1685 ev.input_event_usec = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001686 ev.type = EV_FF;
1687 ev.code = device->ffEffectId;
1688 ev.value = 0;
1689 if (write(device->fd, &ev, sizeof(ev)) != sizeof(ev)) {
1690 ALOGW("Could not stop force feedback effect on device %s due to error %d.",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001691 device->identifier.name.c_str(), errno);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001692 return;
1693 }
1694 }
1695 }
1696}
1697
Prabir Pradhanae4ff282022-08-23 16:21:39 +00001698std::vector<int32_t> EventHub::getVibratorIds(int32_t deviceId) const {
Chris Ye87143712020-11-10 05:05:58 +00001699 std::scoped_lock _l(mLock);
1700 std::vector<int32_t> vibrators;
1701 Device* device = getDeviceLocked(deviceId);
1702 if (device != nullptr && device->hasValidFd() &&
1703 device->classes.test(InputDeviceClass::VIBRATOR)) {
1704 vibrators.push_back(FF_STRONG_MAGNITUDE_CHANNEL_IDX);
1705 vibrators.push_back(FF_WEAK_MAGNITUDE_CHANNEL_IDX);
1706 }
1707 return vibrators;
1708}
1709
Josh Bartel938632f2022-07-19 15:34:22 -05001710/**
1711 * Checks both mDevices and mOpeningDevices for a device with the descriptor passed.
1712 */
1713bool EventHub::hasDeviceWithDescriptorLocked(const std::string& descriptor) const {
1714 for (const auto& device : mOpeningDevices) {
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01001715 if (descriptor == device->identifier.descriptor) {
Josh Bartel938632f2022-07-19 15:34:22 -05001716 return true;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001717 }
1718 }
Josh Bartel938632f2022-07-19 15:34:22 -05001719
1720 for (const auto& [id, device] : mDevices) {
1721 if (descriptor == device->identifier.descriptor) {
1722 return true;
1723 }
1724 }
1725 return false;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001726}
1727
1728EventHub::Device* EventHub::getDeviceLocked(int32_t deviceId) const {
Prabir Pradhancae4b3a2019-02-05 18:51:32 -08001729 if (deviceId == ReservedInputDeviceId::BUILT_IN_KEYBOARD_ID) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001730 deviceId = mBuiltInKeyboardId;
1731 }
Chris Ye989bb932020-07-04 16:18:59 -07001732 const auto& it = mDevices.find(deviceId);
1733 return it != mDevices.end() ? it->second.get() : nullptr;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001734}
1735
Chris Ye8594e192020-07-14 10:34:06 -07001736EventHub::Device* EventHub::getDeviceByPathLocked(const std::string& devicePath) const {
Chris Ye989bb932020-07-04 16:18:59 -07001737 for (const auto& [id, device] : mDevices) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001738 if (device->path == devicePath) {
Chris Ye989bb932020-07-04 16:18:59 -07001739 return device.get();
Michael Wrightd02c5b62014-02-10 15:10:22 -08001740 }
1741 }
Yi Kong9b14ac62018-07-17 13:48:38 -07001742 return nullptr;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001743}
1744
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001745/**
1746 * The file descriptor could be either input device, or a video device (associated with a
1747 * specific input device). Check both cases here, and return the device that this event
1748 * belongs to. Caller can compare the fd's once more to determine event type.
1749 * Looks through all input devices, and only attached video devices. Unattached video
1750 * devices are ignored.
1751 */
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -07001752EventHub::Device* EventHub::getDeviceByFdLocked(int fd) const {
Chris Ye989bb932020-07-04 16:18:59 -07001753 for (const auto& [id, device] : mDevices) {
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -07001754 if (device->fd == fd) {
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001755 // This is an input device event
Chris Ye989bb932020-07-04 16:18:59 -07001756 return device.get();
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001757 }
1758 if (device->videoDevice && device->videoDevice->getFd() == fd) {
1759 // This is a video device event
Chris Ye989bb932020-07-04 16:18:59 -07001760 return device.get();
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -07001761 }
1762 }
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001763 // We do not check mUnattachedVideoDevices here because they should not participate in epoll,
1764 // and therefore should never be looked up by fd.
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -07001765 return nullptr;
1766}
1767
Chris Yee2b1e5c2021-03-10 22:45:12 -08001768std::optional<int32_t> EventHub::getBatteryCapacity(int32_t deviceId, int32_t batteryId) const {
Andy Chenf9f1a022022-08-29 20:07:10 -04001769 std::filesystem::path batteryPath;
1770 {
1771 // Do not read the sysfs node to get the battery state while holding
1772 // the EventHub lock. For some peripheral devices, reading battery state
1773 // can be broken and take 5+ seconds. Holding the lock in this case would
1774 // block all other event processing during this time. For now, we assume this
1775 // call never happens on the InputReader thread and read the sysfs node outside
1776 // the lock to prevent event processing from being blocked by this call.
1777 std::scoped_lock _l(mLock);
Kim Low03ea0352020-11-06 12:45:07 -08001778
Prabir Pradhane287ecd2022-09-07 21:18:05 +00001779 const auto& infos = getBatteryInfoLocked(deviceId);
Andy Chenf9f1a022022-08-29 20:07:10 -04001780 auto it = infos.find(batteryId);
1781 if (it == infos.end()) {
1782 return std::nullopt;
1783 }
1784 batteryPath = it->second.path;
1785 } // release lock
1786
Chris Yee2b1e5c2021-03-10 22:45:12 -08001787 std::string buffer;
Kim Low03ea0352020-11-06 12:45:07 -08001788
1789 // Some devices report battery capacity as an integer through the "capacity" file
Andy Chenf9f1a022022-08-29 20:07:10 -04001790 if (base::ReadFileToString(batteryPath / BATTERY_NODES.at(InputBatteryClass::CAPACITY),
Chris Yee2b1e5c2021-03-10 22:45:12 -08001791 &buffer)) {
Chris Yed1936772021-02-22 10:30:40 -08001792 return std::stoi(base::Trim(buffer));
Kim Low03ea0352020-11-06 12:45:07 -08001793 }
1794
1795 // Other devices report capacity as an enum value POWER_SUPPLY_CAPACITY_LEVEL_XXX
1796 // These values are taken from kernel source code include/linux/power_supply.h
Andy Chenf9f1a022022-08-29 20:07:10 -04001797 if (base::ReadFileToString(batteryPath / BATTERY_NODES.at(InputBatteryClass::CAPACITY_LEVEL),
Chris Yee2b1e5c2021-03-10 22:45:12 -08001798 &buffer)) {
Chris Yed1936772021-02-22 10:30:40 -08001799 // Remove any white space such as trailing new line
Chris Yee2b1e5c2021-03-10 22:45:12 -08001800 const auto levelIt = BATTERY_LEVEL.find(base::Trim(buffer));
1801 if (levelIt != BATTERY_LEVEL.end()) {
1802 return levelIt->second;
Kim Low03ea0352020-11-06 12:45:07 -08001803 }
1804 }
Chris Yee2b1e5c2021-03-10 22:45:12 -08001805
Kim Low03ea0352020-11-06 12:45:07 -08001806 return std::nullopt;
1807}
1808
Chris Yee2b1e5c2021-03-10 22:45:12 -08001809std::optional<int32_t> EventHub::getBatteryStatus(int32_t deviceId, int32_t batteryId) const {
Andy Chenf9f1a022022-08-29 20:07:10 -04001810 std::filesystem::path batteryPath;
1811 {
1812 // Do not read the sysfs node to get the battery state while holding
1813 // the EventHub lock. For some peripheral devices, reading battery state
1814 // can be broken and take 5+ seconds. Holding the lock in this case would
1815 // block all other event processing during this time. For now, we assume this
1816 // call never happens on the InputReader thread and read the sysfs node outside
1817 // the lock to prevent event processing from being blocked by this call.
1818 std::scoped_lock _l(mLock);
1819
Prabir Pradhane287ecd2022-09-07 21:18:05 +00001820 const auto& infos = getBatteryInfoLocked(deviceId);
Andy Chenf9f1a022022-08-29 20:07:10 -04001821 auto it = infos.find(batteryId);
1822 if (it == infos.end()) {
1823 return std::nullopt;
1824 }
1825 batteryPath = it->second.path;
1826 } // release lock
1827
Chris Yee2b1e5c2021-03-10 22:45:12 -08001828 std::string buffer;
Kim Low03ea0352020-11-06 12:45:07 -08001829
Andy Chenf9f1a022022-08-29 20:07:10 -04001830 if (!base::ReadFileToString(batteryPath / BATTERY_NODES.at(InputBatteryClass::STATUS),
Chris Yee2b1e5c2021-03-10 22:45:12 -08001831 &buffer)) {
Kim Low03ea0352020-11-06 12:45:07 -08001832 ALOGE("Failed to read sysfs battery info: %s", strerror(errno));
1833 return std::nullopt;
1834 }
1835
Chris Yed1936772021-02-22 10:30:40 -08001836 // Remove white space like trailing new line
Chris Yee2b1e5c2021-03-10 22:45:12 -08001837 const auto statusIt = BATTERY_STATUS.find(base::Trim(buffer));
1838 if (statusIt != BATTERY_STATUS.end()) {
1839 return statusIt->second;
Kim Low03ea0352020-11-06 12:45:07 -08001840 }
1841
1842 return std::nullopt;
1843}
1844
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07001845std::vector<RawEvent> EventHub::getEvents(int timeoutMillis) {
Chris Ye87143712020-11-10 05:05:58 +00001846 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001847
Siarhei Vishniakou45fd9042022-09-27 13:26:20 -07001848 std::array<input_event, EVENT_BUFFER_SIZE> readBuffer;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001849
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07001850 std::vector<RawEvent> events;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001851 bool awoken = false;
1852 for (;;) {
1853 nsecs_t now = systemTime(SYSTEM_TIME_MONOTONIC);
1854
1855 // Reopen input devices if needed.
1856 if (mNeedToReopenDevices) {
1857 mNeedToReopenDevices = false;
1858
1859 ALOGI("Reopening all input devices due to a configuration change.");
1860
1861 closeAllDevicesLocked();
1862 mNeedToScanDevices = true;
1863 break; // return to the caller before we actually rescan
1864 }
1865
1866 // Report any devices that had last been added/removed.
Chris Ye989bb932020-07-04 16:18:59 -07001867 for (auto it = mClosingDevices.begin(); it != mClosingDevices.end();) {
1868 std::unique_ptr<Device> device = std::move(*it);
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001869 ALOGV("Reporting device closed: id=%d, name=%s\n", device->id, device->path.c_str());
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07001870 const int32_t deviceId = (device->id == mBuiltInKeyboardId)
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001871 ? ReservedInputDeviceId::BUILT_IN_KEYBOARD_ID
1872 : device->id;
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07001873 events.push_back({
1874 .when = now,
1875 .deviceId = deviceId,
1876 .type = DEVICE_REMOVED,
1877 });
Chris Ye989bb932020-07-04 16:18:59 -07001878 it = mClosingDevices.erase(it);
Siarhei Vishniakou45fd9042022-09-27 13:26:20 -07001879 if (events.size() == EVENT_BUFFER_SIZE) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001880 break;
1881 }
1882 }
1883
1884 if (mNeedToScanDevices) {
1885 mNeedToScanDevices = false;
1886 scanDevicesLocked();
Michael Wrightd02c5b62014-02-10 15:10:22 -08001887 }
1888
Siarhei Vishniakouf49608d2020-08-20 19:18:21 -05001889 while (!mOpeningDevices.empty()) {
1890 std::unique_ptr<Device> device = std::move(*mOpeningDevices.rbegin());
1891 mOpeningDevices.pop_back();
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001892 ALOGV("Reporting device opened: id=%d, name=%s\n", device->id, device->path.c_str());
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07001893 const int32_t deviceId = device->id == mBuiltInKeyboardId ? 0 : device->id;
1894 events.push_back({
1895 .when = now,
1896 .deviceId = deviceId,
1897 .type = DEVICE_ADDED,
1898 });
Siarhei Vishniakouf49608d2020-08-20 19:18:21 -05001899
1900 // Try to find a matching video device by comparing device names
1901 for (auto it = mUnattachedVideoDevices.begin(); it != mUnattachedVideoDevices.end();
1902 it++) {
1903 std::unique_ptr<TouchVideoDevice>& videoDevice = *it;
Chris Yed3fef462021-03-07 17:10:08 -08001904 if (tryAddVideoDeviceLocked(*device, videoDevice)) {
Siarhei Vishniakouf49608d2020-08-20 19:18:21 -05001905 // videoDevice was transferred to 'device'
1906 it = mUnattachedVideoDevices.erase(it);
1907 break;
1908 }
1909 }
1910
1911 auto [dev_it, inserted] = mDevices.insert_or_assign(device->id, std::move(device));
1912 if (!inserted) {
Chris Ye989bb932020-07-04 16:18:59 -07001913 ALOGW("Device id %d exists, replaced.", device->id);
1914 }
Siarhei Vishniakou45fd9042022-09-27 13:26:20 -07001915 if (events.size() == EVENT_BUFFER_SIZE) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001916 break;
1917 }
1918 }
1919
1920 // Grab the next input event.
1921 bool deviceChanged = false;
1922 while (mPendingEventIndex < mPendingEventCount) {
1923 const struct epoll_event& eventItem = mPendingEventItems[mPendingEventIndex++];
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -07001924 if (eventItem.data.fd == mINotifyFd) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001925 if (eventItem.events & EPOLLIN) {
1926 mPendingINotify = true;
1927 } else {
1928 ALOGW("Received unexpected epoll event 0x%08x for INotify.", eventItem.events);
1929 }
1930 continue;
1931 }
1932
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -07001933 if (eventItem.data.fd == mWakeReadPipeFd) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08001934 if (eventItem.events & EPOLLIN) {
1935 ALOGV("awoken after wake()");
1936 awoken = true;
Siarhei Vishniakoub4d960d2019-10-03 15:38:44 -05001937 char wakeReadBuffer[16];
Michael Wrightd02c5b62014-02-10 15:10:22 -08001938 ssize_t nRead;
1939 do {
Siarhei Vishniakoub4d960d2019-10-03 15:38:44 -05001940 nRead = read(mWakeReadPipeFd, wakeReadBuffer, sizeof(wakeReadBuffer));
1941 } while ((nRead == -1 && errno == EINTR) || nRead == sizeof(wakeReadBuffer));
Michael Wrightd02c5b62014-02-10 15:10:22 -08001942 } else {
1943 ALOGW("Received unexpected epoll event 0x%08x for wake read pipe.",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001944 eventItem.events);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001945 }
1946 continue;
1947 }
1948
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -07001949 Device* device = getDeviceByFdLocked(eventItem.data.fd);
Chris Ye989bb932020-07-04 16:18:59 -07001950 if (device == nullptr) {
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001951 ALOGE("Received unexpected epoll event 0x%08x for unknown fd %d.", eventItem.events,
1952 eventItem.data.fd);
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001953 ALOG_ASSERT(!DEBUG);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001954 continue;
1955 }
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001956 if (device->videoDevice && eventItem.data.fd == device->videoDevice->getFd()) {
1957 if (eventItem.events & EPOLLIN) {
1958 size_t numFrames = device->videoDevice->readAndQueueFrames();
1959 if (numFrames == 0) {
1960 ALOGE("Received epoll event for video device %s, but could not read frame",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001961 device->videoDevice->getName().c_str());
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001962 }
1963 } else if (eventItem.events & EPOLLHUP) {
1964 // TODO(b/121395353) - consider adding EPOLLRDHUP
1965 ALOGI("Removing video device %s due to epoll hang-up event.",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001966 device->videoDevice->getName().c_str());
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001967 unregisterVideoDeviceFromEpollLocked(*device->videoDevice);
1968 device->videoDevice = nullptr;
1969 } else {
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001970 ALOGW("Received unexpected epoll event 0x%08x for device %s.", eventItem.events,
1971 device->videoDevice->getName().c_str());
Siarhei Vishniakou12598682018-11-02 17:19:19 -07001972 ALOG_ASSERT(!DEBUG);
1973 }
1974 continue;
1975 }
1976 // This must be an input event
Michael Wrightd02c5b62014-02-10 15:10:22 -08001977 if (eventItem.events & EPOLLIN) {
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07001978 int32_t readSize =
Siarhei Vishniakou45fd9042022-09-27 13:26:20 -07001979 read(device->fd, readBuffer.data(),
1980 sizeof(decltype(readBuffer)::value_type) * readBuffer.size());
Michael Wrightd02c5b62014-02-10 15:10:22 -08001981 if (readSize == 0 || (readSize < 0 && errno == ENODEV)) {
1982 // Device was removed before INotify noticed.
Mark Salyzyn5aa26b22014-06-10 13:07:44 -07001983 ALOGW("could not get event, removed? (fd: %d size: %" PRId32
Siarhei Vishniakou45fd9042022-09-27 13:26:20 -07001984 " capacity: %zu errno: %d)\n",
1985 device->fd, readSize, readBuffer.size(), errno);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001986 deviceChanged = true;
Chris Ye989bb932020-07-04 16:18:59 -07001987 closeDeviceLocked(*device);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001988 } else if (readSize < 0) {
1989 if (errno != EAGAIN && errno != EINTR) {
1990 ALOGW("could not get event (errno=%d)", errno);
1991 }
1992 } else if ((readSize % sizeof(struct input_event)) != 0) {
1993 ALOGE("could not get event (wrong size: %d)", readSize);
1994 } else {
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07001995 const int32_t deviceId = device->id == mBuiltInKeyboardId ? 0 : device->id;
Michael Wrightd02c5b62014-02-10 15:10:22 -08001996
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07001997 const size_t count = size_t(readSize) / sizeof(struct input_event);
Michael Wrightd02c5b62014-02-10 15:10:22 -08001998 for (size_t i = 0; i < count; i++) {
1999 struct input_event& iev = readBuffer[i];
Prabir Pradhan9762ac92023-07-13 21:45:12 +00002000 device->trackInputEvent(iev);
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07002001 events.push_back({
2002 .when = processEventTimestamp(iev),
2003 .readTime = systemTime(SYSTEM_TIME_MONOTONIC),
2004 .deviceId = deviceId,
2005 .type = iev.type,
2006 .code = iev.code,
2007 .value = iev.value,
2008 });
Michael Wrightd02c5b62014-02-10 15:10:22 -08002009 }
Siarhei Vishniakou45fd9042022-09-27 13:26:20 -07002010 if (events.size() >= EVENT_BUFFER_SIZE) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002011 // The result buffer is full. Reset the pending event index
2012 // so we will try to read the device again on the next iteration.
2013 mPendingEventIndex -= 1;
2014 break;
2015 }
2016 }
2017 } else if (eventItem.events & EPOLLHUP) {
2018 ALOGI("Removing device %s due to epoll hang-up event.",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002019 device->identifier.name.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002020 deviceChanged = true;
Chris Ye989bb932020-07-04 16:18:59 -07002021 closeDeviceLocked(*device);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002022 } else {
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002023 ALOGW("Received unexpected epoll event 0x%08x for device %s.", eventItem.events,
2024 device->identifier.name.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002025 }
2026 }
2027
2028 // readNotify() will modify the list of devices so this must be done after
2029 // processing all other events to ensure that we read all remaining events
2030 // before closing the devices.
2031 if (mPendingINotify && mPendingEventIndex >= mPendingEventCount) {
2032 mPendingINotify = false;
Prabir Pradhan952e65b2022-06-23 17:49:55 +00002033 const auto res = readNotifyLocked();
2034 if (!res.ok()) {
2035 ALOGW("Failed to read from inotify: %s", res.error().message().c_str());
2036 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002037 deviceChanged = true;
2038 }
2039
2040 // Report added or removed devices immediately.
2041 if (deviceChanged) {
2042 continue;
2043 }
2044
2045 // Return now if we have collected any events or if we were explicitly awoken.
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07002046 if (!events.empty() || awoken) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002047 break;
2048 }
2049
Siarhei Vishniakou4b5a87f2019-09-24 13:03:58 +01002050 // Poll for events.
2051 // When a device driver has pending (unread) events, it acquires
2052 // a kernel wake lock. Once the last pending event has been read, the device
2053 // driver will release the kernel wake lock, but the epoll will hold the wakelock,
2054 // since we are using EPOLLWAKEUP. The wakelock is released by the epoll when epoll_wait
2055 // is called again for the same fd that produced the event.
2056 // Thus the system can only sleep if there are no events pending or
2057 // currently being processed.
Michael Wrightd02c5b62014-02-10 15:10:22 -08002058 //
2059 // The timeout is advisory only. If the device is asleep, it will not wake just to
2060 // service the timeout.
2061 mPendingEventIndex = 0;
2062
Siarhei Vishniakou4b5a87f2019-09-24 13:03:58 +01002063 mLock.unlock(); // release lock before poll
Michael Wrightd02c5b62014-02-10 15:10:22 -08002064
2065 int pollResult = epoll_wait(mEpollFd, mPendingEventItems, EPOLL_MAX_EVENTS, timeoutMillis);
2066
Siarhei Vishniakou4b5a87f2019-09-24 13:03:58 +01002067 mLock.lock(); // reacquire lock after poll
Michael Wrightd02c5b62014-02-10 15:10:22 -08002068
2069 if (pollResult == 0) {
2070 // Timed out.
2071 mPendingEventCount = 0;
2072 break;
2073 }
2074
2075 if (pollResult < 0) {
2076 // An error occurred.
2077 mPendingEventCount = 0;
2078
2079 // Sleep after errors to avoid locking up the system.
2080 // Hopefully the error is transient.
2081 if (errno != EINTR) {
2082 ALOGW("poll failed (errno=%d)\n", errno);
2083 usleep(100000);
2084 }
2085 } else {
2086 // Some events occurred.
2087 mPendingEventCount = size_t(pollResult);
2088 }
2089 }
2090
2091 // All done, return the number of events we read.
Siarhei Vishniakou7b3ea0b2022-09-16 14:23:20 -07002092 return events;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002093}
2094
Siarhei Vishniakouadd89292018-12-13 19:23:36 -08002095std::vector<TouchVideoFrame> EventHub::getVideoFrames(int32_t deviceId) {
Chris Ye87143712020-11-10 05:05:58 +00002096 std::scoped_lock _l(mLock);
Siarhei Vishniakouadd89292018-12-13 19:23:36 -08002097
2098 Device* device = getDeviceLocked(deviceId);
Chris Ye66fbac32020-07-06 20:36:43 -07002099 if (device == nullptr || !device->videoDevice) {
Siarhei Vishniakouadd89292018-12-13 19:23:36 -08002100 return {};
2101 }
2102 return device->videoDevice->consumeFrames();
2103}
2104
Michael Wrightd02c5b62014-02-10 15:10:22 -08002105void EventHub::wake() {
2106 ALOGV("wake() called");
2107
2108 ssize_t nWrite;
2109 do {
2110 nWrite = write(mWakeWritePipeFd, "W", 1);
2111 } while (nWrite == -1 && errno == EINTR);
2112
2113 if (nWrite != 1 && errno != EAGAIN) {
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002114 ALOGW("Could not write wake signal: %s", strerror(errno));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002115 }
2116}
2117
2118void EventHub::scanDevicesLocked() {
Usama Arifb27c8e62021-06-03 16:44:09 +01002119 status_t result;
2120 std::error_code errorCode;
2121
2122 if (std::filesystem::exists(DEVICE_INPUT_PATH, errorCode)) {
2123 result = scanDirLocked(DEVICE_INPUT_PATH);
2124 if (result < 0) {
2125 ALOGE("scan dir failed for %s", DEVICE_INPUT_PATH);
2126 }
2127 } else {
2128 if (errorCode) {
2129 ALOGW("Could not run filesystem::exists() due to error %d : %s.", errorCode.value(),
2130 errorCode.message().c_str());
2131 }
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002132 }
Philip Quinn39b81682019-01-09 22:20:39 -08002133 if (isV4lScanningEnabled()) {
Usama Arifb27c8e62021-06-03 16:44:09 +01002134 result = scanVideoDirLocked(DEVICE_PATH);
Philip Quinn39b81682019-01-09 22:20:39 -08002135 if (result != OK) {
Usama Arifb27c8e62021-06-03 16:44:09 +01002136 ALOGE("scan video dir failed for %s", DEVICE_PATH);
Philip Quinn39b81682019-01-09 22:20:39 -08002137 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002138 }
Chris Ye989bb932020-07-04 16:18:59 -07002139 if (mDevices.find(ReservedInputDeviceId::VIRTUAL_KEYBOARD_ID) == mDevices.end()) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002140 createVirtualKeyboardLocked();
2141 }
2142}
2143
2144// ----------------------------------------------------------------------------
2145
Siarhei Vishniakou25920312018-12-12 15:24:44 -08002146status_t EventHub::registerFdForEpoll(int fd) {
Siarhei Vishniakou12598682018-11-02 17:19:19 -07002147 // TODO(b/121395353) - consider adding EPOLLRDHUP
Siarhei Vishniakou25920312018-12-12 15:24:44 -08002148 struct epoll_event eventItem = {};
2149 eventItem.events = EPOLLIN | EPOLLWAKEUP;
2150 eventItem.data.fd = fd;
2151 if (epoll_ctl(mEpollFd, EPOLL_CTL_ADD, fd, &eventItem)) {
2152 ALOGE("Could not add fd to epoll instance: %s", strerror(errno));
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002153 return -errno;
2154 }
2155 return OK;
2156}
2157
Siarhei Vishniakou25920312018-12-12 15:24:44 -08002158status_t EventHub::unregisterFdFromEpoll(int fd) {
2159 if (epoll_ctl(mEpollFd, EPOLL_CTL_DEL, fd, nullptr)) {
2160 ALOGW("Could not remove fd from epoll instance: %s", strerror(errno));
2161 return -errno;
2162 }
2163 return OK;
2164}
2165
Chris Ye989bb932020-07-04 16:18:59 -07002166status_t EventHub::registerDeviceForEpollLocked(Device& device) {
2167 status_t result = registerFdForEpoll(device.fd);
Siarhei Vishniakou25920312018-12-12 15:24:44 -08002168 if (result != OK) {
Chris Ye989bb932020-07-04 16:18:59 -07002169 ALOGE("Could not add input device fd to epoll for device %" PRId32, device.id);
Siarhei Vishniakou12598682018-11-02 17:19:19 -07002170 return result;
2171 }
Chris Ye989bb932020-07-04 16:18:59 -07002172 if (device.videoDevice) {
2173 registerVideoDeviceForEpollLocked(*device.videoDevice);
Siarhei Vishniakou25920312018-12-12 15:24:44 -08002174 }
2175 return result;
2176}
2177
Siarhei Vishniakou12598682018-11-02 17:19:19 -07002178void EventHub::registerVideoDeviceForEpollLocked(const TouchVideoDevice& videoDevice) {
2179 status_t result = registerFdForEpoll(videoDevice.getFd());
2180 if (result != OK) {
2181 ALOGE("Could not add video device %s to epoll", videoDevice.getName().c_str());
2182 }
2183}
2184
Chris Ye989bb932020-07-04 16:18:59 -07002185status_t EventHub::unregisterDeviceFromEpollLocked(Device& device) {
2186 if (device.hasValidFd()) {
2187 status_t result = unregisterFdFromEpoll(device.fd);
Siarhei Vishniakou25920312018-12-12 15:24:44 -08002188 if (result != OK) {
Chris Ye989bb932020-07-04 16:18:59 -07002189 ALOGW("Could not remove input device fd from epoll for device %" PRId32, device.id);
Siarhei Vishniakou25920312018-12-12 15:24:44 -08002190 return result;
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002191 }
2192 }
Chris Ye989bb932020-07-04 16:18:59 -07002193 if (device.videoDevice) {
2194 unregisterVideoDeviceFromEpollLocked(*device.videoDevice);
Siarhei Vishniakou12598682018-11-02 17:19:19 -07002195 }
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002196 return OK;
2197}
2198
Siarhei Vishniakou12598682018-11-02 17:19:19 -07002199void EventHub::unregisterVideoDeviceFromEpollLocked(const TouchVideoDevice& videoDevice) {
2200 if (videoDevice.hasValidFd()) {
2201 status_t result = unregisterFdFromEpoll(videoDevice.getFd());
2202 if (result != OK) {
2203 ALOGW("Could not remove video device fd from epoll for device: %s",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002204 videoDevice.getName().c_str());
Siarhei Vishniakou12598682018-11-02 17:19:19 -07002205 }
2206 }
2207}
2208
Chris Yed3fef462021-03-07 17:10:08 -08002209void EventHub::reportDeviceAddedForStatisticsLocked(const InputDeviceIdentifier& identifier,
Dominik Laskowski2f01d772022-03-23 16:01:29 -07002210 ftl::Flags<InputDeviceClass> classes) {
Chris Ye657c2f02021-05-25 16:24:37 -07002211 SHA256_CTX ctx;
2212 SHA256_Init(&ctx);
2213 SHA256_Update(&ctx, reinterpret_cast<const uint8_t*>(identifier.uniqueId.c_str()),
2214 identifier.uniqueId.size());
2215 std::array<uint8_t, SHA256_DIGEST_LENGTH> digest;
2216 SHA256_Final(digest.data(), &ctx);
2217
2218 std::string obfuscatedId;
2219 for (size_t i = 0; i < OBFUSCATED_LENGTH; i++) {
2220 obfuscatedId += StringPrintf("%02x", digest[i]);
2221 }
2222
Chris Yed3fef462021-03-07 17:10:08 -08002223 android::util::stats_write(android::util::INPUTDEVICE_REGISTERED, identifier.name.c_str(),
2224 identifier.vendor, identifier.product, identifier.version,
Chris Ye657c2f02021-05-25 16:24:37 -07002225 identifier.bus, obfuscatedId.c_str(), classes.get());
Chris Yed3fef462021-03-07 17:10:08 -08002226}
2227
Siarhei Vishniakoua4c502a2021-02-05 00:45:20 +00002228void EventHub::openDeviceLocked(const std::string& devicePath) {
2229 // If an input device happens to register around the time when EventHub's constructor runs, it
2230 // is possible that the same input event node (for example, /dev/input/event3) will be noticed
2231 // in both 'inotify' callback and also in the 'scanDirLocked' pass. To prevent duplicate devices
2232 // from getting registered, ensure that this path is not already covered by an existing device.
2233 for (const auto& [deviceId, device] : mDevices) {
2234 if (device->path == devicePath) {
2235 return; // device was already registered
2236 }
2237 }
2238
Michael Wrightd02c5b62014-02-10 15:10:22 -08002239 char buffer[80];
2240
Chris Ye8594e192020-07-14 10:34:06 -07002241 ALOGV("Opening device: %s", devicePath.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002242
Chris Ye8594e192020-07-14 10:34:06 -07002243 int fd = open(devicePath.c_str(), O_RDWR | O_CLOEXEC | O_NONBLOCK);
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002244 if (fd < 0) {
Chris Ye8594e192020-07-14 10:34:06 -07002245 ALOGE("could not open %s, %s\n", devicePath.c_str(), strerror(errno));
Siarhei Vishniakoua4c502a2021-02-05 00:45:20 +00002246 return;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002247 }
2248
2249 InputDeviceIdentifier identifier;
2250
2251 // Get device name.
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002252 if (ioctl(fd, EVIOCGNAME(sizeof(buffer) - 1), &buffer) < 1) {
Chris Ye8594e192020-07-14 10:34:06 -07002253 ALOGE("Could not get device name for %s: %s", devicePath.c_str(), strerror(errno));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002254 } else {
2255 buffer[sizeof(buffer) - 1] = '\0';
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01002256 identifier.name = buffer;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002257 }
2258
2259 // Check to see if the device is on our excluded list
2260 for (size_t i = 0; i < mExcludedDevices.size(); i++) {
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01002261 const std::string& item = mExcludedDevices[i];
Michael Wrightd02c5b62014-02-10 15:10:22 -08002262 if (identifier.name == item) {
Chris Ye8594e192020-07-14 10:34:06 -07002263 ALOGI("ignoring event id %s driver %s\n", devicePath.c_str(), item.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002264 close(fd);
Siarhei Vishniakoua4c502a2021-02-05 00:45:20 +00002265 return;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002266 }
2267 }
2268
2269 // Get device driver version.
2270 int driverVersion;
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002271 if (ioctl(fd, EVIOCGVERSION, &driverVersion)) {
Chris Ye8594e192020-07-14 10:34:06 -07002272 ALOGE("could not get driver version for %s, %s\n", devicePath.c_str(), strerror(errno));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002273 close(fd);
Siarhei Vishniakoua4c502a2021-02-05 00:45:20 +00002274 return;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002275 }
2276
2277 // Get device identifier.
2278 struct input_id inputId;
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002279 if (ioctl(fd, EVIOCGID, &inputId)) {
Chris Ye8594e192020-07-14 10:34:06 -07002280 ALOGE("could not get device input id for %s, %s\n", devicePath.c_str(), strerror(errno));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002281 close(fd);
Siarhei Vishniakoua4c502a2021-02-05 00:45:20 +00002282 return;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002283 }
2284 identifier.bus = inputId.bustype;
2285 identifier.product = inputId.product;
2286 identifier.vendor = inputId.vendor;
2287 identifier.version = inputId.version;
2288
2289 // Get device physical location.
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002290 if (ioctl(fd, EVIOCGPHYS(sizeof(buffer) - 1), &buffer) < 1) {
2291 // fprintf(stderr, "could not get location for %s, %s\n", devicePath, strerror(errno));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002292 } else {
2293 buffer[sizeof(buffer) - 1] = '\0';
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01002294 identifier.location = buffer;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002295 }
2296
2297 // Get device unique id.
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002298 if (ioctl(fd, EVIOCGUNIQ(sizeof(buffer) - 1), &buffer) < 1) {
2299 // fprintf(stderr, "could not get idstring for %s, %s\n", devicePath, strerror(errno));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002300 } else {
2301 buffer[sizeof(buffer) - 1] = '\0';
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01002302 identifier.uniqueId = buffer;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002303 }
2304
Prabir Pradhan07525ef2022-10-03 21:51:26 +00002305 // Attempt to get the bluetooth address of an input device from the uniqueId.
2306 if (identifier.bus == BUS_BLUETOOTH &&
2307 std::regex_match(identifier.uniqueId,
2308 std::regex("^[A-Fa-f0-9]{2}(?::[A-Fa-f0-9]{2}){5}$"))) {
2309 identifier.bluetoothAddress = identifier.uniqueId;
2310 // The Bluetooth stack requires alphabetic characters to be uppercase in a valid address.
2311 for (auto& c : *identifier.bluetoothAddress) {
2312 c = ::toupper(c);
2313 }
2314 }
2315
Michael Wrightd02c5b62014-02-10 15:10:22 -08002316 // Fill in the descriptor.
2317 assignDescriptorLocked(identifier);
2318
Michael Wrightd02c5b62014-02-10 15:10:22 -08002319 // Allocate device. (The device object takes ownership of the fd at this point.)
2320 int32_t deviceId = mNextDeviceId++;
Prabir Pradhancb42b472022-08-23 16:01:19 +00002321 std::unique_ptr<Device> device =
2322 std::make_unique<Device>(fd, deviceId, devicePath, identifier,
2323 obtainAssociatedDeviceLocked(devicePath));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002324
Chris Ye8594e192020-07-14 10:34:06 -07002325 ALOGV("add device %d: %s\n", deviceId, devicePath.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002326 ALOGV(" bus: %04x\n"
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002327 " vendor %04x\n"
2328 " product %04x\n"
2329 " version %04x\n",
2330 identifier.bus, identifier.vendor, identifier.product, identifier.version);
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01002331 ALOGV(" name: \"%s\"\n", identifier.name.c_str());
2332 ALOGV(" location: \"%s\"\n", identifier.location.c_str());
2333 ALOGV(" unique id: \"%s\"\n", identifier.uniqueId.c_str());
2334 ALOGV(" descriptor: \"%s\"\n", identifier.descriptor.c_str());
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002335 ALOGV(" driver: v%d.%d.%d\n", driverVersion >> 16, (driverVersion >> 8) & 0xff,
2336 driverVersion & 0xff);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002337
2338 // Load the configuration file for the device.
Chris Ye989bb932020-07-04 16:18:59 -07002339 device->loadConfigurationLocked();
Michael Wrightd02c5b62014-02-10 15:10:22 -08002340
2341 // Figure out the kinds of events the device reports.
Chris Ye66fbac32020-07-06 20:36:43 -07002342 device->readDeviceBitMask(EVIOCGBIT(EV_KEY, 0), device->keyBitmask);
2343 device->readDeviceBitMask(EVIOCGBIT(EV_ABS, 0), device->absBitmask);
2344 device->readDeviceBitMask(EVIOCGBIT(EV_REL, 0), device->relBitmask);
2345 device->readDeviceBitMask(EVIOCGBIT(EV_SW, 0), device->swBitmask);
2346 device->readDeviceBitMask(EVIOCGBIT(EV_LED, 0), device->ledBitmask);
2347 device->readDeviceBitMask(EVIOCGBIT(EV_FF, 0), device->ffBitmask);
Chris Yef59a2f42020-10-16 12:55:26 -07002348 device->readDeviceBitMask(EVIOCGBIT(EV_MSC, 0), device->mscBitmask);
Chris Ye66fbac32020-07-06 20:36:43 -07002349 device->readDeviceBitMask(EVIOCGPROP(0), device->propBitmask);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002350
Prabir Pradhane1a41a82022-10-14 18:06:50 +00002351 // See if this is a device with keys. This could be full keyboard, or other devices like
2352 // gamepads, joysticks, and styluses with buttons that should generate key presses.
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002353 bool haveKeyboardKeys =
Chris Ye66fbac32020-07-06 20:36:43 -07002354 device->keyBitmask.any(0, BTN_MISC) || device->keyBitmask.any(BTN_WHEEL, KEY_MAX + 1);
2355 bool haveGamepadButtons = device->keyBitmask.any(BTN_MISC, BTN_MOUSE) ||
2356 device->keyBitmask.any(BTN_JOYSTICK, BTN_DIGI);
Prabir Pradhane1a41a82022-10-14 18:06:50 +00002357 bool haveStylusButtons = device->keyBitmask.test(BTN_STYLUS) ||
2358 device->keyBitmask.test(BTN_STYLUS2) || device->keyBitmask.test(BTN_STYLUS3);
2359 if (haveKeyboardKeys || haveGamepadButtons || haveStylusButtons) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002360 device->classes |= InputDeviceClass::KEYBOARD;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002361 }
2362
2363 // See if this is a cursor device such as a trackball or mouse.
Chris Ye66fbac32020-07-06 20:36:43 -07002364 if (device->keyBitmask.test(BTN_MOUSE) && device->relBitmask.test(REL_X) &&
2365 device->relBitmask.test(REL_Y)) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002366 device->classes |= InputDeviceClass::CURSOR;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002367 }
2368
Prabir Pradhana3621852022-10-14 18:57:23 +00002369 // See if the device is specially configured to be of a certain type.
Harry Cuttsf13161a2023-03-08 14:15:49 +00002370 if (device->configuration) {
2371 std::string deviceType = device->configuration->getString("device.type").value_or("");
Siarhei Vishniakou4f94c1a2022-07-13 07:29:51 -07002372 if (deviceType == "rotaryEncoder") {
Chris Ye1b0c7342020-07-28 21:57:03 -07002373 device->classes |= InputDeviceClass::ROTARY_ENCODER;
Prabir Pradhana3621852022-10-14 18:57:23 +00002374 } else if (deviceType == "externalStylus") {
2375 device->classes |= InputDeviceClass::EXTERNAL_STYLUS;
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002376 }
Prashant Malani1941ff52015-08-11 18:29:28 -07002377 }
2378
Michael Wrightd02c5b62014-02-10 15:10:22 -08002379 // See if this is a touch pad.
2380 // Is this a new modern multi-touch driver?
Chris Ye66fbac32020-07-06 20:36:43 -07002381 if (device->absBitmask.test(ABS_MT_POSITION_X) && device->absBitmask.test(ABS_MT_POSITION_Y)) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002382 // Some joysticks such as the PS3 controller report axes that conflict
2383 // with the ABS_MT range. Try to confirm that the device really is
2384 // a touch screen.
Chris Ye66fbac32020-07-06 20:36:43 -07002385 if (device->keyBitmask.test(BTN_TOUCH) || !haveGamepadButtons) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002386 device->classes |= (InputDeviceClass::TOUCH | InputDeviceClass::TOUCH_MT);
Harry Cutts79cc9fa2022-10-28 15:32:39 +00002387 if (device->propBitmask.test(INPUT_PROP_POINTER) &&
2388 !device->keyBitmask.any(BTN_TOOL_PEN, BTN_TOOL_FINGER) && !haveStylusButtons) {
2389 device->classes |= InputDeviceClass::TOUCHPAD;
2390 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002391 }
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002392 // Is this an old style single-touch driver?
Chris Ye66fbac32020-07-06 20:36:43 -07002393 } else if (device->keyBitmask.test(BTN_TOUCH) && device->absBitmask.test(ABS_X) &&
2394 device->absBitmask.test(ABS_Y)) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002395 device->classes |= InputDeviceClass::TOUCH;
Prabir Pradhane1a41a82022-10-14 18:06:50 +00002396 // Is this a stylus that reports contact/pressure independently of touch coordinates?
Chris Ye66fbac32020-07-06 20:36:43 -07002397 } else if ((device->absBitmask.test(ABS_PRESSURE) || device->keyBitmask.test(BTN_TOUCH)) &&
2398 !device->absBitmask.test(ABS_X) && !device->absBitmask.test(ABS_Y)) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002399 device->classes |= InputDeviceClass::EXTERNAL_STYLUS;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002400 }
2401
2402 // See if this device is a joystick.
2403 // Assumes that joysticks always have gamepad buttons in order to distinguish them
2404 // from other devices such as accelerometers that also have absolute axes.
2405 if (haveGamepadButtons) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002406 auto assumedClasses = device->classes | InputDeviceClass::JOYSTICK;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002407 for (int i = 0; i <= ABS_MAX; i++) {
Chris Ye66fbac32020-07-06 20:36:43 -07002408 if (device->absBitmask.test(i) &&
Chris Ye1b0c7342020-07-28 21:57:03 -07002409 (getAbsAxisUsage(i, assumedClasses).test(InputDeviceClass::JOYSTICK))) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002410 device->classes = assumedClasses;
2411 break;
2412 }
2413 }
2414 }
2415
Chris Yef59a2f42020-10-16 12:55:26 -07002416 // Check whether this device is an accelerometer.
2417 if (device->propBitmask.test(INPUT_PROP_ACCELEROMETER)) {
2418 device->classes |= InputDeviceClass::SENSOR;
2419 }
2420
Michael Wrightd02c5b62014-02-10 15:10:22 -08002421 // Check whether this device has switches.
2422 for (int i = 0; i <= SW_MAX; i++) {
Chris Ye66fbac32020-07-06 20:36:43 -07002423 if (device->swBitmask.test(i)) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002424 device->classes |= InputDeviceClass::SWITCH;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002425 break;
2426 }
2427 }
2428
2429 // Check whether this device supports the vibrator.
Chris Ye66fbac32020-07-06 20:36:43 -07002430 if (device->ffBitmask.test(FF_RUMBLE)) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002431 device->classes |= InputDeviceClass::VIBRATOR;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002432 }
2433
2434 // Configure virtual keys.
Chris Ye1b0c7342020-07-28 21:57:03 -07002435 if ((device->classes.test(InputDeviceClass::TOUCH))) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002436 // Load the virtual keys for the touch screen, if any.
2437 // We do this now so that we can make sure to load the keymap if necessary.
Chris Ye989bb932020-07-04 16:18:59 -07002438 bool success = device->loadVirtualKeyMapLocked();
Siarhei Vishniakou3e78dec2019-02-20 16:21:46 -06002439 if (success) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002440 device->classes |= InputDeviceClass::KEYBOARD;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002441 }
2442 }
2443
2444 // Load the key map.
Chris Yef59a2f42020-10-16 12:55:26 -07002445 // We need to do this for joysticks too because the key layout may specify axes, and for
2446 // sensor as well because the key layout may specify the axes to sensor data mapping.
Michael Wrightd02c5b62014-02-10 15:10:22 -08002447 status_t keyMapStatus = NAME_NOT_FOUND;
Chris Yef59a2f42020-10-16 12:55:26 -07002448 if (device->classes.any(InputDeviceClass::KEYBOARD | InputDeviceClass::JOYSTICK |
2449 InputDeviceClass::SENSOR)) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002450 // Load the keymap for the device.
Chris Ye989bb932020-07-04 16:18:59 -07002451 keyMapStatus = device->loadKeyMapLocked();
Michael Wrightd02c5b62014-02-10 15:10:22 -08002452 }
2453
2454 // Configure the keyboard, gamepad or virtual keyboard.
Chris Ye1b0c7342020-07-28 21:57:03 -07002455 if (device->classes.test(InputDeviceClass::KEYBOARD)) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002456 // Register the keyboard as a built-in keyboard if it is eligible.
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002457 if (!keyMapStatus && mBuiltInKeyboardId == NO_BUILT_IN_KEYBOARD &&
Siarhei Vishniakoud549b252020-08-11 11:25:26 -05002458 isEligibleBuiltInKeyboard(device->identifier, device->configuration.get(),
2459 &device->keyMap)) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002460 mBuiltInKeyboardId = device->id;
2461 }
2462
2463 // 'Q' key support = cheap test of whether this is an alpha-capable kbd
Chris Ye989bb932020-07-04 16:18:59 -07002464 if (device->hasKeycodeLocked(AKEYCODE_Q)) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002465 device->classes |= InputDeviceClass::ALPHAKEY;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002466 }
2467
Prabir Pradhanae10ee62023-05-12 19:44:18 +00002468 // See if this device has a D-pad.
2469 if (std::all_of(DPAD_REQUIRED_KEYCODES.begin(), DPAD_REQUIRED_KEYCODES.end(),
2470 [&](int32_t keycode) { return device->hasKeycodeLocked(keycode); })) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002471 device->classes |= InputDeviceClass::DPAD;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002472 }
2473
2474 // See if this device has a gamepad.
Prabir Pradhanae10ee62023-05-12 19:44:18 +00002475 if (std::any_of(GAMEPAD_KEYCODES.begin(), GAMEPAD_KEYCODES.end(),
2476 [&](int32_t keycode) { return device->hasKeycodeLocked(keycode); })) {
2477 device->classes |= InputDeviceClass::GAMEPAD;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002478 }
Prabir Pradhana3621852022-10-14 18:57:23 +00002479
2480 // See if this device has any stylus buttons that we would want to fuse with touch data.
Prabir Pradhanae10ee62023-05-12 19:44:18 +00002481 if (!device->classes.any(InputDeviceClass::TOUCH | InputDeviceClass::TOUCH_MT) &&
Prabir Pradhan3c28b942023-08-18 20:02:01 +00002482 !device->classes.any(InputDeviceClass::ALPHAKEY) &&
Prabir Pradhanae10ee62023-05-12 19:44:18 +00002483 std::any_of(STYLUS_BUTTON_KEYCODES.begin(), STYLUS_BUTTON_KEYCODES.end(),
2484 [&](int32_t keycode) { return device->hasKeycodeLocked(keycode); })) {
2485 device->classes |= InputDeviceClass::EXTERNAL_STYLUS;
Prabir Pradhana3621852022-10-14 18:57:23 +00002486 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002487 }
2488
Vladimir Komsiyskidd438e22024-02-13 11:47:54 +01002489 // See if the device is a rotary encoder with a single scroll axis and nothing else.
2490 if (vd_flags::virtual_rotary() && device->classes == ftl::Flags<InputDeviceClass>(0) &&
2491 device->relBitmask.test(REL_WHEEL) && !device->relBitmask.test(REL_HWHEEL)) {
2492 device->classes |= InputDeviceClass::ROTARY_ENCODER;
2493 }
2494
Michael Wrightd02c5b62014-02-10 15:10:22 -08002495 // If the device isn't recognized as something we handle, don't monitor it.
Dominik Laskowski2f01d772022-03-23 16:01:29 -07002496 if (device->classes == ftl::Flags<InputDeviceClass>(0)) {
Chris Ye8594e192020-07-14 10:34:06 -07002497 ALOGV("Dropping device: id=%d, path='%s', name='%s'", deviceId, devicePath.c_str(),
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002498 device->identifier.name.c_str());
Siarhei Vishniakoua4c502a2021-02-05 00:45:20 +00002499 return;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002500 }
2501
Chris Ye3fdbfef2021-01-06 18:45:18 -08002502 // Classify InputDeviceClass::BATTERY.
Prabir Pradhan51894782022-08-23 16:29:10 +00002503 if (device->associatedDevice && !device->associatedDevice->batteryInfos.empty()) {
Chris Ye3fdbfef2021-01-06 18:45:18 -08002504 device->classes |= InputDeviceClass::BATTERY;
2505 }
Kim Low03ea0352020-11-06 12:45:07 -08002506
Chris Ye3fdbfef2021-01-06 18:45:18 -08002507 // Classify InputDeviceClass::LIGHT.
Prabir Pradhan51894782022-08-23 16:29:10 +00002508 if (device->associatedDevice && !device->associatedDevice->lightInfos.empty()) {
Chris Ye3fdbfef2021-01-06 18:45:18 -08002509 device->classes |= InputDeviceClass::LIGHT;
Kim Low03ea0352020-11-06 12:45:07 -08002510 }
2511
Tim Kilbourn063ff532015-04-08 10:26:18 -07002512 // Determine whether the device has a mic.
Chris Ye989bb932020-07-04 16:18:59 -07002513 if (device->deviceHasMicLocked()) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002514 device->classes |= InputDeviceClass::MIC;
Tim Kilbourn063ff532015-04-08 10:26:18 -07002515 }
2516
Michael Wrightd02c5b62014-02-10 15:10:22 -08002517 // Determine whether the device is external or internal.
Chris Ye989bb932020-07-04 16:18:59 -07002518 if (device->isExternalDeviceLocked()) {
Chris Ye1b0c7342020-07-28 21:57:03 -07002519 device->classes |= InputDeviceClass::EXTERNAL;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002520 }
2521
Chris Ye1b0c7342020-07-28 21:57:03 -07002522 if (device->classes.any(InputDeviceClass::JOYSTICK | InputDeviceClass::DPAD) &&
2523 device->classes.test(InputDeviceClass::GAMEPAD)) {
Chris Ye989bb932020-07-04 16:18:59 -07002524 device->controllerNumber = getNextControllerNumberLocked(device->identifier.name);
2525 device->setLedForControllerLocked();
Michael Wrightd02c5b62014-02-10 15:10:22 -08002526 }
2527
Chris Ye989bb932020-07-04 16:18:59 -07002528 if (registerDeviceForEpollLocked(*device) != OK) {
Siarhei Vishniakoua4c502a2021-02-05 00:45:20 +00002529 return;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002530 }
2531
Chris Ye989bb932020-07-04 16:18:59 -07002532 device->configureFd();
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002533
Chris Ye1b0c7342020-07-28 21:57:03 -07002534 ALOGI("New device: id=%d, fd=%d, path='%s', name='%s', classes=%s, "
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002535 "configuration='%s', keyLayout='%s', keyCharacterMap='%s', builtinKeyboard=%s, ",
Chris Ye1b0c7342020-07-28 21:57:03 -07002536 deviceId, fd, devicePath.c_str(), device->identifier.name.c_str(),
2537 device->classes.string().c_str(), device->configurationFile.c_str(),
2538 device->keyMap.keyLayoutFile.c_str(), device->keyMap.keyCharacterMapFile.c_str(),
2539 toString(mBuiltInKeyboardId == deviceId));
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002540
Chris Ye989bb932020-07-04 16:18:59 -07002541 addDeviceLocked(std::move(device));
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002542}
2543
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002544void EventHub::openVideoDeviceLocked(const std::string& devicePath) {
2545 std::unique_ptr<TouchVideoDevice> videoDevice = TouchVideoDevice::create(devicePath);
2546 if (!videoDevice) {
2547 ALOGE("Could not create touch video device for %s. Ignoring", devicePath.c_str());
2548 return;
2549 }
Siarhei Vishniakouec7854a2018-12-14 16:52:34 -08002550 // Transfer ownership of this video device to a matching input device
Chris Ye989bb932020-07-04 16:18:59 -07002551 for (const auto& [id, device] : mDevices) {
Chris Yed3fef462021-03-07 17:10:08 -08002552 if (tryAddVideoDeviceLocked(*device, videoDevice)) {
Siarhei Vishniakouf49608d2020-08-20 19:18:21 -05002553 return; // 'device' now owns 'videoDevice'
Siarhei Vishniakouec7854a2018-12-14 16:52:34 -08002554 }
2555 }
2556
2557 // Couldn't find a matching input device, so just add it to a temporary holding queue.
2558 // A matching input device may appear later.
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002559 ALOGI("Adding video device %s to list of unattached video devices",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002560 videoDevice->getName().c_str());
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002561 mUnattachedVideoDevices.push_back(std::move(videoDevice));
2562}
2563
Chris Yed3fef462021-03-07 17:10:08 -08002564bool EventHub::tryAddVideoDeviceLocked(EventHub::Device& device,
2565 std::unique_ptr<TouchVideoDevice>& videoDevice) {
Siarhei Vishniakouf49608d2020-08-20 19:18:21 -05002566 if (videoDevice->getName() != device.identifier.name) {
2567 return false;
2568 }
2569 device.videoDevice = std::move(videoDevice);
2570 if (device.enabled) {
2571 registerVideoDeviceForEpollLocked(*device.videoDevice);
2572 }
2573 return true;
2574}
2575
Prabir Pradhanae4ff282022-08-23 16:21:39 +00002576bool EventHub::isDeviceEnabled(int32_t deviceId) const {
Chris Ye87143712020-11-10 05:05:58 +00002577 std::scoped_lock _l(mLock);
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002578 Device* device = getDeviceLocked(deviceId);
Yi Kong9b14ac62018-07-17 13:48:38 -07002579 if (device == nullptr) {
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002580 ALOGE("Invalid device id=%" PRId32 " provided to %s", deviceId, __func__);
2581 return false;
2582 }
2583 return device->enabled;
2584}
Michael Wrightd02c5b62014-02-10 15:10:22 -08002585
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002586status_t EventHub::enableDevice(int32_t deviceId) {
Chris Ye87143712020-11-10 05:05:58 +00002587 std::scoped_lock _l(mLock);
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002588 Device* device = getDeviceLocked(deviceId);
Yi Kong9b14ac62018-07-17 13:48:38 -07002589 if (device == nullptr) {
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002590 ALOGE("Invalid device id=%" PRId32 " provided to %s", deviceId, __func__);
2591 return BAD_VALUE;
2592 }
2593 if (device->enabled) {
2594 ALOGW("Duplicate call to %s, input device %" PRId32 " already enabled", __func__, deviceId);
2595 return OK;
2596 }
2597 status_t result = device->enable();
2598 if (result != OK) {
2599 ALOGE("Failed to enable device %" PRId32, deviceId);
2600 return result;
2601 }
2602
Chris Ye989bb932020-07-04 16:18:59 -07002603 device->configureFd();
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002604
Chris Ye989bb932020-07-04 16:18:59 -07002605 return registerDeviceForEpollLocked(*device);
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002606}
2607
2608status_t EventHub::disableDevice(int32_t deviceId) {
Chris Ye87143712020-11-10 05:05:58 +00002609 std::scoped_lock _l(mLock);
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002610 Device* device = getDeviceLocked(deviceId);
Yi Kong9b14ac62018-07-17 13:48:38 -07002611 if (device == nullptr) {
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002612 ALOGE("Invalid device id=%" PRId32 " provided to %s", deviceId, __func__);
2613 return BAD_VALUE;
2614 }
2615 if (!device->enabled) {
2616 ALOGW("Duplicate call to %s, input device already disabled", __func__);
2617 return OK;
2618 }
Chris Ye989bb932020-07-04 16:18:59 -07002619 unregisterDeviceFromEpollLocked(*device);
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002620 return device->disable();
Michael Wrightd02c5b62014-02-10 15:10:22 -08002621}
2622
Vaibhav Devmurari5fc7d852023-03-17 18:43:33 +00002623// TODO(b/274755573): Shift to uevent handling on native side and remove this method
2624// Currently using Java UEventObserver to trigger this which uses UEvent infrastructure that uses a
2625// NETLINK socket to observe UEvents. We can create similar infrastructure on Eventhub side to
2626// directly observe UEvents instead of triggering from Java side.
2627void EventHub::sysfsNodeChanged(const std::string& sysfsNodePath) {
2628 std::scoped_lock _l(mLock);
2629
2630 // Check in opening devices
2631 for (auto it = mOpeningDevices.begin(); it != mOpeningDevices.end(); it++) {
2632 std::unique_ptr<Device>& device = *it;
2633 if (device->associatedDevice &&
2634 sysfsNodePath.find(device->associatedDevice->sysfsRootPath.string()) !=
2635 std::string::npos &&
2636 device->associatedDevice->isChanged()) {
2637 it = mOpeningDevices.erase(it);
2638 openDeviceLocked(device->path);
2639 }
2640 }
2641
2642 // Check in already added device
2643 std::vector<Device*> devicesToReopen;
2644 for (const auto& [id, device] : mDevices) {
2645 if (device->associatedDevice &&
2646 sysfsNodePath.find(device->associatedDevice->sysfsRootPath.string()) !=
2647 std::string::npos &&
2648 device->associatedDevice->isChanged()) {
2649 devicesToReopen.push_back(device.get());
2650 }
2651 }
2652 for (const auto& device : devicesToReopen) {
2653 closeDeviceLocked(*device);
2654 openDeviceLocked(device->path);
2655 }
2656 devicesToReopen.clear();
2657}
2658
Michael Wrightd02c5b62014-02-10 15:10:22 -08002659void EventHub::createVirtualKeyboardLocked() {
2660 InputDeviceIdentifier identifier;
2661 identifier.name = "Virtual";
2662 identifier.uniqueId = "<virtual>";
2663 assignDescriptorLocked(identifier);
2664
Chris Ye989bb932020-07-04 16:18:59 -07002665 std::unique_ptr<Device> device =
2666 std::make_unique<Device>(-1, ReservedInputDeviceId::VIRTUAL_KEYBOARD_ID, "<virtual>",
Harry Cutts33476232023-01-30 19:57:29 +00002667 identifier, /*associatedDevice=*/nullptr);
Chris Ye1b0c7342020-07-28 21:57:03 -07002668 device->classes = InputDeviceClass::KEYBOARD | InputDeviceClass::ALPHAKEY |
2669 InputDeviceClass::DPAD | InputDeviceClass::VIRTUAL;
Chris Ye989bb932020-07-04 16:18:59 -07002670 device->loadKeyMapLocked();
2671 addDeviceLocked(std::move(device));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002672}
2673
Chris Ye989bb932020-07-04 16:18:59 -07002674void EventHub::addDeviceLocked(std::unique_ptr<Device> device) {
Chris Yed3fef462021-03-07 17:10:08 -08002675 reportDeviceAddedForStatisticsLocked(device->identifier, device->classes);
Chris Ye989bb932020-07-04 16:18:59 -07002676 mOpeningDevices.push_back(std::move(device));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002677}
2678
Chris Ye989bb932020-07-04 16:18:59 -07002679int32_t EventHub::getNextControllerNumberLocked(const std::string& name) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002680 if (mControllerNumbers.isFull()) {
2681 ALOGI("Maximum number of controllers reached, assigning controller number 0 to device %s",
Chris Ye989bb932020-07-04 16:18:59 -07002682 name.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002683 return 0;
2684 }
2685 // Since the controller number 0 is reserved for non-controllers, translate all numbers up by
2686 // one
2687 return static_cast<int32_t>(mControllerNumbers.markFirstUnmarkedBit() + 1);
2688}
2689
Chris Ye989bb932020-07-04 16:18:59 -07002690void EventHub::releaseControllerNumberLocked(int32_t num) {
2691 if (num > 0) {
2692 mControllerNumbers.clearBit(static_cast<uint32_t>(num - 1));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002693 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002694}
2695
Chris Ye8594e192020-07-14 10:34:06 -07002696void EventHub::closeDeviceByPathLocked(const std::string& devicePath) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002697 Device* device = getDeviceByPathLocked(devicePath);
Chris Ye989bb932020-07-04 16:18:59 -07002698 if (device != nullptr) {
2699 closeDeviceLocked(*device);
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002700 return;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002701 }
Chris Ye8594e192020-07-14 10:34:06 -07002702 ALOGV("Remove device: %s not found, device may already have been removed.", devicePath.c_str());
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002703}
2704
Siarhei Vishniakouec7854a2018-12-14 16:52:34 -08002705/**
2706 * Find the video device by filename, and close it.
2707 * The video device is closed by path during an inotify event, where we don't have the
2708 * additional context about the video device fd, or the associated input device.
2709 */
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002710void EventHub::closeVideoDeviceByPathLocked(const std::string& devicePath) {
Siarhei Vishniakouec7854a2018-12-14 16:52:34 -08002711 // A video device may be owned by an existing input device, or it may be stored in
2712 // the mUnattachedVideoDevices queue. Check both locations.
Chris Ye989bb932020-07-04 16:18:59 -07002713 for (const auto& [id, device] : mDevices) {
Siarhei Vishniakouec7854a2018-12-14 16:52:34 -08002714 if (device->videoDevice && device->videoDevice->getPath() == devicePath) {
Siarhei Vishniakou12598682018-11-02 17:19:19 -07002715 unregisterVideoDeviceFromEpollLocked(*device->videoDevice);
Siarhei Vishniakouec7854a2018-12-14 16:52:34 -08002716 device->videoDevice = nullptr;
2717 return;
2718 }
2719 }
Siarhei Vishniakouf47c339e2021-12-30 11:22:26 -08002720 std::erase_if(mUnattachedVideoDevices,
2721 [&devicePath](const std::unique_ptr<TouchVideoDevice>& videoDevice) {
2722 return videoDevice->getPath() == devicePath;
2723 });
Michael Wrightd02c5b62014-02-10 15:10:22 -08002724}
2725
2726void EventHub::closeAllDevicesLocked() {
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002727 mUnattachedVideoDevices.clear();
Siarhei Vishniakoud549b252020-08-11 11:25:26 -05002728 while (!mDevices.empty()) {
2729 closeDeviceLocked(*(mDevices.begin()->second));
Michael Wrightd02c5b62014-02-10 15:10:22 -08002730 }
2731}
2732
Chris Ye989bb932020-07-04 16:18:59 -07002733void EventHub::closeDeviceLocked(Device& device) {
2734 ALOGI("Removed device: path=%s name=%s id=%d fd=%d classes=%s", device.path.c_str(),
2735 device.identifier.name.c_str(), device.id, device.fd, device.classes.string().c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002736
Chris Ye989bb932020-07-04 16:18:59 -07002737 if (device.id == mBuiltInKeyboardId) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002738 ALOGW("built-in keyboard device %s (id=%d) is closing! the apps will not like this",
Chris Ye989bb932020-07-04 16:18:59 -07002739 device.path.c_str(), mBuiltInKeyboardId);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002740 mBuiltInKeyboardId = NO_BUILT_IN_KEYBOARD;
2741 }
2742
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -07002743 unregisterDeviceFromEpollLocked(device);
Chris Ye989bb932020-07-04 16:18:59 -07002744 if (device.videoDevice) {
Siarhei Vishniakou12598682018-11-02 17:19:19 -07002745 // This must be done after the video device is removed from epoll
Chris Ye989bb932020-07-04 16:18:59 -07002746 mUnattachedVideoDevices.push_back(std::move(device.videoDevice));
Siarhei Vishniakouec7854a2018-12-14 16:52:34 -08002747 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002748
Chris Ye989bb932020-07-04 16:18:59 -07002749 releaseControllerNumberLocked(device.controllerNumber);
Siarhei Vishniakoud549b252020-08-11 11:25:26 -05002750 device.controllerNumber = 0;
Chris Ye989bb932020-07-04 16:18:59 -07002751 device.close();
Chris Ye989bb932020-07-04 16:18:59 -07002752 mClosingDevices.push_back(std::move(mDevices[device.id]));
Siarhei Vishniakoud549b252020-08-11 11:25:26 -05002753
Chris Ye989bb932020-07-04 16:18:59 -07002754 mDevices.erase(device.id);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002755}
2756
Prabir Pradhan952e65b2022-06-23 17:49:55 +00002757base::Result<void> EventHub::readNotifyLocked() {
2758 static constexpr auto EVENT_SIZE = static_cast<ssize_t>(sizeof(inotify_event));
2759 uint8_t eventBuffer[512];
2760 ssize_t sizeRead;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002761
2762 ALOGV("EventHub::readNotify nfd: %d\n", mINotifyFd);
Prabir Pradhan952e65b2022-06-23 17:49:55 +00002763 do {
2764 sizeRead = read(mINotifyFd, eventBuffer, sizeof(eventBuffer));
2765 } while (sizeRead < 0 && errno == EINTR);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002766
Prabir Pradhan952e65b2022-06-23 17:49:55 +00002767 if (sizeRead < EVENT_SIZE) return Errorf("could not get event, %s", strerror(errno));
2768
2769 for (ssize_t eventPos = 0; sizeRead >= EVENT_SIZE;) {
2770 const inotify_event* event;
2771 event = (const inotify_event*)(eventBuffer + eventPos);
2772 if (event->len == 0) continue;
2773
2774 handleNotifyEventLocked(*event);
2775
2776 const ssize_t eventSize = EVENT_SIZE + event->len;
2777 sizeRead -= eventSize;
2778 eventPos += eventSize;
Michael Wrightd02c5b62014-02-10 15:10:22 -08002779 }
Prabir Pradhan952e65b2022-06-23 17:49:55 +00002780 return {};
2781}
2782
2783void EventHub::handleNotifyEventLocked(const inotify_event& event) {
2784 if (event.wd == mDeviceInputWd) {
2785 std::string filename = std::string(DEVICE_INPUT_PATH) + "/" + event.name;
2786 if (event.mask & IN_CREATE) {
2787 openDeviceLocked(filename);
2788 } else {
2789 ALOGI("Removing device '%s' due to inotify event\n", filename.c_str());
2790 closeDeviceByPathLocked(filename);
2791 }
2792 } else if (event.wd == mDeviceWd) {
2793 if (isV4lTouchNode(event.name)) {
2794 std::string filename = std::string(DEVICE_PATH) + "/" + event.name;
2795 if (event.mask & IN_CREATE) {
2796 openVideoDeviceLocked(filename);
2797 } else {
2798 ALOGI("Removing video device '%s' due to inotify event", filename.c_str());
2799 closeVideoDeviceByPathLocked(filename);
2800 }
2801 } else if (strcmp(event.name, "input") == 0 && event.mask & IN_CREATE) {
2802 addDeviceInputInotify();
2803 }
2804 } else {
2805 LOG_ALWAYS_FATAL("Unexpected inotify event, wd = %i", event.wd);
2806 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002807}
2808
Chris Ye8594e192020-07-14 10:34:06 -07002809status_t EventHub::scanDirLocked(const std::string& dirname) {
2810 for (const auto& entry : std::filesystem::directory_iterator(dirname)) {
2811 openDeviceLocked(entry.path());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002812 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002813 return 0;
2814}
2815
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002816/**
2817 * Look for all dirname/v4l-touch* devices, and open them.
2818 */
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002819status_t EventHub::scanVideoDirLocked(const std::string& dirname) {
Chris Ye8594e192020-07-14 10:34:06 -07002820 for (const auto& entry : std::filesystem::directory_iterator(dirname)) {
2821 if (isV4lTouchNode(entry.path())) {
2822 ALOGI("Found touch video device %s", entry.path().c_str());
2823 openVideoDeviceLocked(entry.path());
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002824 }
2825 }
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002826 return OK;
2827}
2828
Michael Wrightd02c5b62014-02-10 15:10:22 -08002829void EventHub::requestReopenDevices() {
2830 ALOGV("requestReopenDevices() called");
2831
Chris Ye87143712020-11-10 05:05:58 +00002832 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002833 mNeedToReopenDevices = true;
2834}
2835
Prabir Pradhanae4ff282022-08-23 16:21:39 +00002836void EventHub::dump(std::string& dump) const {
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002837 dump += "Event Hub State:\n";
Michael Wrightd02c5b62014-02-10 15:10:22 -08002838
2839 { // acquire lock
Chris Ye87143712020-11-10 05:05:58 +00002840 std::scoped_lock _l(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002841
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002842 dump += StringPrintf(INDENT "BuiltInKeyboardId: %d\n", mBuiltInKeyboardId);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002843
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002844 dump += INDENT "Devices:\n";
Michael Wrightd02c5b62014-02-10 15:10:22 -08002845
Chris Ye989bb932020-07-04 16:18:59 -07002846 for (const auto& [id, device] : mDevices) {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002847 if (mBuiltInKeyboardId == device->id) {
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002848 dump += StringPrintf(INDENT2 "%d: %s (aka device 0 - built-in keyboard)\n",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002849 device->id, device->identifier.name.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002850 } else {
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002851 dump += StringPrintf(INDENT2 "%d: %s\n", device->id,
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002852 device->identifier.name.c_str());
Michael Wrightd02c5b62014-02-10 15:10:22 -08002853 }
Chris Ye1b0c7342020-07-28 21:57:03 -07002854 dump += StringPrintf(INDENT3 "Classes: %s\n", device->classes.string().c_str());
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01002855 dump += StringPrintf(INDENT3 "Path: %s\n", device->path.c_str());
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002856 dump += StringPrintf(INDENT3 "Enabled: %s\n", toString(device->enabled));
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01002857 dump += StringPrintf(INDENT3 "Descriptor: %s\n", device->identifier.descriptor.c_str());
2858 dump += StringPrintf(INDENT3 "Location: %s\n", device->identifier.location.c_str());
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002859 dump += StringPrintf(INDENT3 "ControllerNumber: %d\n", device->controllerNumber);
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +01002860 dump += StringPrintf(INDENT3 "UniqueId: %s\n", device->identifier.uniqueId.c_str());
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002861 dump += StringPrintf(INDENT3 "Identifier: bus=0x%04x, vendor=0x%04x, "
Prabir Pradhan07525ef2022-10-03 21:51:26 +00002862 "product=0x%04x, version=0x%04x, bluetoothAddress=%s\n",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002863 device->identifier.bus, device->identifier.vendor,
Prabir Pradhan07525ef2022-10-03 21:51:26 +00002864 device->identifier.product, device->identifier.version,
2865 toString(device->identifier.bluetoothAddress).c_str());
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002866 dump += StringPrintf(INDENT3 "KeyLayoutFile: %s\n",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002867 device->keyMap.keyLayoutFile.c_str());
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002868 dump += StringPrintf(INDENT3 "KeyCharacterMapFile: %s\n",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002869 device->keyMap.keyCharacterMapFile.c_str());
Vaibhav Devmurari7fb41132023-01-02 13:30:26 +00002870 if (device->associatedDevice && device->associatedDevice->layoutInfo) {
2871 dump += StringPrintf(INDENT3 "LanguageTag: %s\n",
2872 device->associatedDevice->layoutInfo->languageTag.c_str());
2873 dump += StringPrintf(INDENT3 "LayoutType: %s\n",
2874 device->associatedDevice->layoutInfo->layoutType.c_str());
2875 }
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -08002876 dump += StringPrintf(INDENT3 "ConfigurationFile: %s\n",
Prabir Pradhanda7c00c2019-08-29 14:12:42 -07002877 device->configurationFile.c_str());
Prabir Pradhan51894782022-08-23 16:29:10 +00002878 dump += StringPrintf(INDENT3 "VideoDevice: %s\n",
2879 device->videoDevice ? device->videoDevice->dump().c_str()
2880 : "<none>");
2881 dump += StringPrintf(INDENT3 "SysfsDevicePath: %s\n",
2882 device->associatedDevice
2883 ? device->associatedDevice->sysfsRootPath.c_str()
2884 : "<none>");
Prabir Pradhan955b6132023-07-14 19:44:34 +00002885 if (device->keyBitmask.any(0, KEY_MAX + 1)) {
2886 const auto pressedKeys = device->keyState.dumpSetIndices(", ", [](int i) {
2887 return InputEventLookup::getLinuxEvdevLabel(EV_KEY, i, 1).code;
2888 });
2889 dump += StringPrintf(INDENT3 "KeyState (pressed): %s\n", pressedKeys.c_str());
2890 }
2891 if (device->swBitmask.any(0, SW_MAX + 1)) {
2892 const auto pressedSwitches = device->swState.dumpSetIndices(", ", [](int i) {
2893 return InputEventLookup::getLinuxEvdevLabel(EV_SW, i, 1).code;
2894 });
2895 dump += StringPrintf(INDENT3 "SwState (pressed): %s\n", pressedSwitches.c_str());
2896 }
2897 if (!device->absState.empty()) {
2898 std::string axisValues;
2899 for (const auto& [axis, state] : device->absState) {
2900 if (!axisValues.empty()) {
2901 axisValues += ", ";
2902 }
2903 axisValues += StringPrintf("%s=%d",
2904 InputEventLookup::getLinuxEvdevLabel(EV_ABS, axis, 0)
2905 .code.c_str(),
2906 state.value);
2907 }
2908 dump += INDENT3 "AbsState: " + axisValues + "\n";
2909 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002910 }
Siarhei Vishniakou22c88462018-12-13 19:34:53 -08002911
2912 dump += INDENT "Unattached video devices:\n";
2913 for (const std::unique_ptr<TouchVideoDevice>& videoDevice : mUnattachedVideoDevices) {
2914 dump += INDENT2 + videoDevice->dump() + "\n";
2915 }
2916 if (mUnattachedVideoDevices.empty()) {
2917 dump += INDENT2 "<none>\n";
2918 }
Michael Wrightd02c5b62014-02-10 15:10:22 -08002919 } // release lock
2920}
2921
Prabir Pradhanae4ff282022-08-23 16:21:39 +00002922void EventHub::monitor() const {
Michael Wrightd02c5b62014-02-10 15:10:22 -08002923 // Acquire and release the lock to ensure that the event hub has not deadlocked.
Chris Ye1c2e0892020-11-30 21:41:44 -08002924 std::unique_lock<std::mutex> lock(mLock);
Michael Wrightd02c5b62014-02-10 15:10:22 -08002925}
2926
Prabir Pradhanedeec3b2022-08-26 22:33:55 +00002927std::string EventHub::AssociatedDevice::dump() const {
2928 return StringPrintf("path=%s, numBatteries=%zu, numLight=%zu", sysfsRootPath.c_str(),
2929 batteryInfos.size(), lightInfos.size());
2930}
2931
Prabir Pradhanae4ff282022-08-23 16:21:39 +00002932} // namespace android