blob: e6164d38d41445bebc44ec2cfd2e9bec48cf807f [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
Michael Wrightd02c5b62014-02-10 15:10:22 -080017#ifndef _RUNTIME_EVENT_HUB_H
18#define _RUNTIME_EVENT_HUB_H
19
Chris Ye66fbac32020-07-06 20:36:43 -070020#include <bitset>
21#include <climits>
Chris Ye989bb932020-07-04 16:18:59 -070022#include <unordered_map>
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +010023#include <vector>
24
Chris Ye1b0c7342020-07-28 21:57:03 -070025#include <input/Flags.h>
Kim Low03ea0352020-11-06 12:45:07 -080026#include <filesystem>
27
28#include <batteryservice/BatteryService.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080029#include <input/Input.h>
30#include <input/InputDevice.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080031#include <input/KeyCharacterMap.h>
Prabir Pradhanda7c00c2019-08-29 14:12:42 -070032#include <input/KeyLayoutMap.h>
33#include <input/Keyboard.h>
Siarhei Vishniakou32f36ae2020-09-02 20:17:10 -070034#include <input/PropertyMap.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080035#include <input/VirtualKeyMap.h>
Nathaniel R. Lewiscacd69a2019-08-12 22:07:00 +000036#include <linux/input.h>
37#include <sys/epoll.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080038#include <utils/BitSet.h>
Prabir Pradhanda7c00c2019-08-29 14:12:42 -070039#include <utils/Errors.h>
40#include <utils/KeyedVector.h>
41#include <utils/List.h>
42#include <utils/Log.h>
43#include <utils/Mutex.h>
Michael Wrightd02c5b62014-02-10 15:10:22 -080044
Siarhei Vishniakou22c88462018-12-13 19:34:53 -080045#include "TouchVideoDevice.h"
Nathaniel R. Lewiscacd69a2019-08-12 22:07:00 +000046#include "VibrationElement.h"
Siarhei Vishniakou22c88462018-12-13 19:34:53 -080047
Michael Wrightd02c5b62014-02-10 15:10:22 -080048namespace android {
49
Chris Ye3fdbfef2021-01-06 18:45:18 -080050/* Number of colors : {red, green, blue} */
51static constexpr size_t COLOR_NUM = 3;
Michael Wrightd02c5b62014-02-10 15:10:22 -080052/*
53 * A raw event as retrieved from the EventHub.
54 */
55struct RawEvent {
56 nsecs_t when;
57 int32_t deviceId;
58 int32_t type;
59 int32_t code;
60 int32_t value;
61};
62
63/* Describes an absolute axis. */
64struct RawAbsoluteAxisInfo {
65 bool valid; // true if the information is valid, false otherwise
66
Prabir Pradhanda7c00c2019-08-29 14:12:42 -070067 int32_t minValue; // minimum value
68 int32_t maxValue; // maximum value
69 int32_t flat; // center flat position, eg. flat == 8 means center is between -8 and 8
70 int32_t fuzz; // error tolerance, eg. fuzz == 4 means value is +/- 4 due to noise
Michael Wrightd02c5b62014-02-10 15:10:22 -080071 int32_t resolution; // resolution in units per mm or radians per mm
72
73 inline void clear() {
74 valid = false;
75 minValue = 0;
76 maxValue = 0;
77 flat = 0;
78 fuzz = 0;
79 resolution = 0;
80 }
81};
82
83/*
84 * Input device classes.
85 */
Chris Ye1b0c7342020-07-28 21:57:03 -070086enum class InputDeviceClass : uint32_t {
Michael Wrightd02c5b62014-02-10 15:10:22 -080087 /* The input device is a keyboard or has buttons. */
Chris Ye1b0c7342020-07-28 21:57:03 -070088 KEYBOARD = 0x00000001,
Michael Wrightd02c5b62014-02-10 15:10:22 -080089
90 /* The input device is an alpha-numeric keyboard (not just a dial pad). */
Chris Ye1b0c7342020-07-28 21:57:03 -070091 ALPHAKEY = 0x00000002,
Michael Wrightd02c5b62014-02-10 15:10:22 -080092
93 /* The input device is a touchscreen or a touchpad (either single-touch or multi-touch). */
Chris Ye1b0c7342020-07-28 21:57:03 -070094 TOUCH = 0x00000004,
Michael Wrightd02c5b62014-02-10 15:10:22 -080095
96 /* The input device is a cursor device such as a trackball or mouse. */
Chris Ye1b0c7342020-07-28 21:57:03 -070097 CURSOR = 0x00000008,
Michael Wrightd02c5b62014-02-10 15:10:22 -080098
99 /* The input device is a multi-touch touchscreen. */
Chris Ye1b0c7342020-07-28 21:57:03 -0700100 TOUCH_MT = 0x00000010,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800101
102 /* The input device is a directional pad (implies keyboard, has DPAD keys). */
Chris Ye1b0c7342020-07-28 21:57:03 -0700103 DPAD = 0x00000020,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800104
105 /* The input device is a gamepad (implies keyboard, has BUTTON keys). */
Chris Ye1b0c7342020-07-28 21:57:03 -0700106 GAMEPAD = 0x00000040,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800107
108 /* The input device has switches. */
Chris Ye1b0c7342020-07-28 21:57:03 -0700109 SWITCH = 0x00000080,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800110
111 /* The input device is a joystick (implies gamepad, has joystick absolute axes). */
Chris Ye1b0c7342020-07-28 21:57:03 -0700112 JOYSTICK = 0x00000100,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800113
114 /* The input device has a vibrator (supports FF_RUMBLE). */
Chris Ye1b0c7342020-07-28 21:57:03 -0700115 VIBRATOR = 0x00000200,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800116
Tim Kilbourn063ff532015-04-08 10:26:18 -0700117 /* The input device has a microphone. */
Chris Ye1b0c7342020-07-28 21:57:03 -0700118 MIC = 0x00000400,
Tim Kilbourn063ff532015-04-08 10:26:18 -0700119
Michael Wright842500e2015-03-13 17:32:02 -0700120 /* The input device is an external stylus (has data we want to fuse with touch data). */
Chris Ye1b0c7342020-07-28 21:57:03 -0700121 EXTERNAL_STYLUS = 0x00000800,
Michael Wright842500e2015-03-13 17:32:02 -0700122
Prashant Malani1941ff52015-08-11 18:29:28 -0700123 /* The input device has a rotary encoder */
Chris Ye1b0c7342020-07-28 21:57:03 -0700124 ROTARY_ENCODER = 0x00001000,
Prashant Malani1941ff52015-08-11 18:29:28 -0700125
Chris Yef59a2f42020-10-16 12:55:26 -0700126 /* The input device has a sensor like accelerometer, gyro, etc */
127 SENSOR = 0x00002000,
128
Kim Low03ea0352020-11-06 12:45:07 -0800129 /* The input device has a battery */
130 BATTERY = 0x00004000,
131
Chris Ye3fdbfef2021-01-06 18:45:18 -0800132 /* The input device has sysfs controllable lights */
133 LIGHT = 0x00008000,
134
Michael Wrightd02c5b62014-02-10 15:10:22 -0800135 /* The input device is virtual (not a real device, not part of UI configuration). */
Chris Ye1b0c7342020-07-28 21:57:03 -0700136 VIRTUAL = 0x40000000,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800137
138 /* The input device is external (not built-in). */
Chris Ye1b0c7342020-07-28 21:57:03 -0700139 EXTERNAL = 0x80000000,
Michael Wrightd02c5b62014-02-10 15:10:22 -0800140};
141
Chris Ye3fdbfef2021-01-06 18:45:18 -0800142enum class SysfsClass : uint32_t {
143 POWER_SUPPLY = 0,
144 LEDS = 1,
145};
146
147enum class LightColor : uint32_t {
148 RED = 0,
149 GREEN = 1,
150 BLUE = 2,
151};
152
153enum class InputLightClass : uint32_t {
154 /* The input light has brightness node. */
155 BRIGHTNESS = 0x00000001,
156 /* The input light has red name. */
157 RED = 0x00000002,
158 /* The input light has green name. */
159 GREEN = 0x00000004,
160 /* The input light has blue name. */
161 BLUE = 0x00000008,
162 /* The input light has global name. */
163 GLOBAL = 0x00000010,
164 /* The input light has multi index node. */
165 MULTI_INDEX = 0x00000020,
166 /* The input light has multi intensity node. */
167 MULTI_INTENSITY = 0x00000040,
168 /* The input light has max brightness node. */
169 MAX_BRIGHTNESS = 0x00000080,
170};
171
172/* Describes a raw light. */
173struct RawLightInfo {
174 int32_t id;
175 std::string name;
176 std::optional<int32_t> maxBrightness;
177 Flags<InputLightClass> flags;
178 std::array<int32_t, COLOR_NUM> rgbIndex;
179 std::filesystem::path path;
180};
181
Michael Wrightd02c5b62014-02-10 15:10:22 -0800182/*
183 * Gets the class that owns an axis, in cases where multiple classes might claim
184 * the same axis for different purposes.
185 */
Chris Ye1b0c7342020-07-28 21:57:03 -0700186extern Flags<InputDeviceClass> getAbsAxisUsage(int32_t axis, Flags<InputDeviceClass> deviceClasses);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800187
188/*
189 * Grand Central Station for events.
190 *
191 * The event hub aggregates input events received across all known input
192 * devices on the system, including devices that may be emulated by the simulator
193 * environment. In addition, the event hub generates fake input events to indicate
194 * when devices are added or removed.
195 *
196 * The event hub provides a stream of input events (via the getEvent function).
197 * It also supports querying the current actual state of input devices such as identifying
198 * which keys are currently down. Finally, the event hub keeps track of the capabilities of
199 * individual input devices, such as their class and the set of key codes that they support.
200 */
Siarhei Vishniakou3bc7e092019-07-24 17:43:30 -0700201class EventHubInterface {
202public:
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700203 EventHubInterface() {}
204 virtual ~EventHubInterface() {}
Michael Wrightd02c5b62014-02-10 15:10:22 -0800205
Michael Wrightd02c5b62014-02-10 15:10:22 -0800206 // Synthetic raw event type codes produced when devices are added or removed.
207 enum {
208 // Sent when a device is added.
209 DEVICE_ADDED = 0x10000000,
210 // Sent when a device is removed.
211 DEVICE_REMOVED = 0x20000000,
212 // Sent when all added/removed devices from the most recent scan have been reported.
213 // This event is always sent at least once.
214 FINISHED_DEVICE_SCAN = 0x30000000,
215
216 FIRST_SYNTHETIC_EVENT = DEVICE_ADDED,
217 };
218
Chris Ye1b0c7342020-07-28 21:57:03 -0700219 virtual Flags<InputDeviceClass> getDeviceClasses(int32_t deviceId) const = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800220
221 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const = 0;
222
223 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const = 0;
224
225 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const = 0;
226
227 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700228 RawAbsoluteAxisInfo* outAxisInfo) const = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800229
230 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const = 0;
231
232 virtual bool hasInputProperty(int32_t deviceId, int property) const = 0;
233
Chris Yef59a2f42020-10-16 12:55:26 -0700234 virtual bool hasMscEvent(int32_t deviceId, int mscEvent) const = 0;
235
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700236 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode,
237 int32_t metaState, int32_t* outKeycode, int32_t* outMetaState,
238 uint32_t* outFlags) const = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800239
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700240 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode, AxisInfo* outAxisInfo) const = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800241
242 // Sets devices that are excluded from opening.
243 // This can be used to ignore input devices for sensors.
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100244 virtual void setExcludedDevices(const std::vector<std::string>& devices) = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800245
246 /*
247 * Wait for events to become available and returns them.
248 * After returning, the EventHub holds onto a wake lock until the next call to getEvent.
249 * This ensures that the device will not go to sleep while the event is being processed.
250 * If the device needs to remain awake longer than that, then the caller is responsible
251 * for taking care of it (say, by poking the power manager user activity timer).
252 *
253 * The timeout is advisory only. If the device is asleep, it will not wake just to
254 * service the timeout.
255 *
256 * Returns the number of events obtained, or 0 if the timeout expired.
257 */
258 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize) = 0;
Siarhei Vishniakouadd89292018-12-13 19:23:36 -0800259 virtual std::vector<TouchVideoFrame> getVideoFrames(int32_t deviceId) = 0;
Chris Yef59a2f42020-10-16 12:55:26 -0700260 virtual base::Result<std::pair<InputDeviceSensorType, int32_t>> mapSensor(int32_t deviceId,
261 int32_t absCode) = 0;
Chris Ye3fdbfef2021-01-06 18:45:18 -0800262 // Raw lights are sysfs led light nodes we found from the EventHub device sysfs node,
263 // containing the raw info of the sysfs node structure.
264 virtual const std::vector<int32_t> getRawLightIds(int32_t deviceId) = 0;
265 virtual std::optional<RawLightInfo> getRawLightInfo(int32_t deviceId, int32_t lightId) = 0;
266 virtual std::optional<int32_t> getLightBrightness(int32_t deviceId, int32_t lightId) = 0;
267 virtual void setLightBrightness(int32_t deviceId, int32_t lightId, int32_t brightness) = 0;
268 virtual std::optional<std::unordered_map<LightColor, int32_t>> getLightIntensities(
269 int32_t deviceId, int32_t lightId) = 0;
270 virtual void setLightIntensities(int32_t deviceId, int32_t lightId,
271 std::unordered_map<LightColor, int32_t> intensities) = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800272 /*
273 * Query current input state.
274 */
275 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const = 0;
276 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const = 0;
277 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const = 0;
278 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis,
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700279 int32_t* outValue) const = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800280
281 /*
282 * Examine key input devices for specific framework keycode support
283 */
284 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes,
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700285 uint8_t* outFlags) const = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800286
287 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const = 0;
288
289 /* LED related functions expect Android LED constants, not scan codes or HID usages */
290 virtual bool hasLed(int32_t deviceId, int32_t led) const = 0;
291 virtual void setLedState(int32_t deviceId, int32_t led, bool on) = 0;
292
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700293 virtual void getVirtualKeyDefinitions(
294 int32_t deviceId, std::vector<VirtualKeyDefinition>& outVirtualKeys) const = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800295
Chris Ye3a1e4462020-08-12 10:13:15 -0700296 virtual const std::shared_ptr<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const = 0;
297 virtual bool setKeyboardLayoutOverlay(int32_t deviceId,
298 std::shared_ptr<KeyCharacterMap> map) = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800299
300 /* Control the vibrator. */
Nathaniel R. Lewiscacd69a2019-08-12 22:07:00 +0000301 virtual void vibrate(int32_t deviceId, const VibrationElement& effect) = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800302 virtual void cancelVibrate(int32_t deviceId) = 0;
Chris Ye87143712020-11-10 05:05:58 +0000303 virtual std::vector<int32_t> getVibratorIds(int32_t deviceId) = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800304
Kim Low03ea0352020-11-06 12:45:07 -0800305 /* Query battery level. */
306 virtual std::optional<int32_t> getBatteryCapacity(int32_t deviceId) const = 0;
307
308 /* Query battery status. */
309 virtual std::optional<int32_t> getBatteryStatus(int32_t deviceId) const = 0;
310
Michael Wrightd02c5b62014-02-10 15:10:22 -0800311 /* Requests the EventHub to reopen all input devices on the next call to getEvents(). */
312 virtual void requestReopenDevices() = 0;
313
314 /* Wakes up getEvents() if it is blocked on a read. */
315 virtual void wake() = 0;
316
317 /* Dump EventHub state to a string. */
Siarhei Vishniakouf93fcf42017-11-22 16:00:14 -0800318 virtual void dump(std::string& dump) = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800319
320 /* Called by the heatbeat to ensures that the reader has not deadlocked. */
321 virtual void monitor() = 0;
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -0700322
323 /* Return true if the device is enabled. */
324 virtual bool isDeviceEnabled(int32_t deviceId) = 0;
325
326 /* Enable an input device */
327 virtual status_t enableDevice(int32_t deviceId) = 0;
328
329 /* Disable an input device. Closes file descriptor to that device. */
330 virtual status_t disableDevice(int32_t deviceId) = 0;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800331};
332
Chris Ye66fbac32020-07-06 20:36:43 -0700333template <std::size_t BITS>
334class BitArray {
335 /* Array element type and vector of element type. */
336 using Element = std::uint32_t;
337 /* Number of bits in each BitArray element. */
338 static constexpr size_t WIDTH = sizeof(Element) * CHAR_BIT;
339 /* Number of elements to represent a bit array of the specified size of bits. */
340 static constexpr size_t COUNT = (BITS + WIDTH - 1) / WIDTH;
341
342public:
343 /* BUFFER type declaration for BitArray */
344 using Buffer = std::array<Element, COUNT>;
345 /* To tell if a bit is set in array, it selects an element from the array, and test
346 * if the relevant bit set.
347 * Note the parameter "bit" is an index to the bit, 0 <= bit < BITS.
348 */
349 inline bool test(size_t bit) const {
350 return (bit < BITS) ? mData[bit / WIDTH].test(bit % WIDTH) : false;
351 }
352 /* Returns total number of bytes needed for the array */
353 inline size_t bytes() { return (BITS + CHAR_BIT - 1) / CHAR_BIT; }
354 /* Returns true if array contains any non-zero bit from the range defined by start and end
355 * bit index [startIndex, endIndex).
356 */
357 bool any(size_t startIndex, size_t endIndex) {
358 if (startIndex >= endIndex || startIndex > BITS || endIndex > BITS + 1) {
359 ALOGE("Invalid start/end index. start = %zu, end = %zu, total bits = %zu", startIndex,
360 endIndex, BITS);
361 return false;
362 }
363 size_t se = startIndex / WIDTH; // Start of element
364 size_t ee = endIndex / WIDTH; // End of element
365 size_t si = startIndex % WIDTH; // Start index in start element
366 size_t ei = endIndex % WIDTH; // End index in end element
367 // Need to check first unaligned bitset for any non zero bit
368 if (si > 0) {
369 size_t nBits = se == ee ? ei - si : WIDTH - si;
370 // Generate the mask of interested bit range
371 Element mask = ((1 << nBits) - 1) << si;
372 if (mData[se++].to_ulong() & mask) {
373 return true;
374 }
375 }
376 // Check whole bitset for any bit set
377 for (; se < ee; se++) {
378 if (mData[se].any()) {
379 return true;
380 }
381 }
382 // Need to check last unaligned bitset for any non zero bit
383 if (ei > 0 && se <= ee) {
384 // Generate the mask of interested bit range
385 Element mask = (1 << ei) - 1;
386 if (mData[se].to_ulong() & mask) {
387 return true;
388 }
389 }
390 return false;
391 }
392 /* Load bit array values from buffer */
393 void loadFromBuffer(const Buffer& buffer) {
394 for (size_t i = 0; i < COUNT; i++) {
395 mData[i] = std::bitset<WIDTH>(buffer[i]);
396 }
397 }
398
399private:
400 std::array<std::bitset<WIDTH>, COUNT> mData;
401};
402
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700403class EventHub : public EventHubInterface {
Michael Wrightd02c5b62014-02-10 15:10:22 -0800404public:
405 EventHub();
406
Chris Ye989bb932020-07-04 16:18:59 -0700407 Flags<InputDeviceClass> getDeviceClasses(int32_t deviceId) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800408
Chris Ye989bb932020-07-04 16:18:59 -0700409 InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800410
Chris Ye989bb932020-07-04 16:18:59 -0700411 int32_t getDeviceControllerNumber(int32_t deviceId) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800412
Chris Ye989bb932020-07-04 16:18:59 -0700413 void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800414
Chris Ye989bb932020-07-04 16:18:59 -0700415 status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
416 RawAbsoluteAxisInfo* outAxisInfo) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800417
Chris Ye989bb932020-07-04 16:18:59 -0700418 bool hasRelativeAxis(int32_t deviceId, int axis) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800419
Chris Ye989bb932020-07-04 16:18:59 -0700420 bool hasInputProperty(int32_t deviceId, int property) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800421
Chris Yef59a2f42020-10-16 12:55:26 -0700422 bool hasMscEvent(int32_t deviceId, int mscEvent) const override final;
423
Chris Ye989bb932020-07-04 16:18:59 -0700424 status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode, int32_t metaState,
425 int32_t* outKeycode, int32_t* outMetaState,
426 uint32_t* outFlags) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800427
Chris Ye989bb932020-07-04 16:18:59 -0700428 status_t mapAxis(int32_t deviceId, int32_t scanCode,
429 AxisInfo* outAxisInfo) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800430
Chris Yef59a2f42020-10-16 12:55:26 -0700431 base::Result<std::pair<InputDeviceSensorType, int32_t>> mapSensor(
432 int32_t deviceId, int32_t absCode) override final;
433
Chris Ye3fdbfef2021-01-06 18:45:18 -0800434 const std::vector<int32_t> getRawLightIds(int32_t deviceId) override final;
435
436 std::optional<RawLightInfo> getRawLightInfo(int32_t deviceId, int32_t lightId) override final;
437
438 std::optional<int32_t> getLightBrightness(int32_t deviceId, int32_t lightId) override final;
439 void setLightBrightness(int32_t deviceId, int32_t lightId, int32_t brightness) override final;
440 std::optional<std::unordered_map<LightColor, int32_t>> getLightIntensities(
441 int32_t deviceId, int32_t lightId) override final;
442 void setLightIntensities(int32_t deviceId, int32_t lightId,
443 std::unordered_map<LightColor, int32_t> intensities) override final;
444
Chris Ye989bb932020-07-04 16:18:59 -0700445 void setExcludedDevices(const std::vector<std::string>& devices) override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800446
Chris Ye989bb932020-07-04 16:18:59 -0700447 int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const override final;
448 int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const override final;
449 int32_t getSwitchState(int32_t deviceId, int32_t sw) const override final;
450 status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis,
451 int32_t* outValue) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800452
Chris Ye989bb932020-07-04 16:18:59 -0700453 bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes,
454 uint8_t* outFlags) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800455
Chris Ye989bb932020-07-04 16:18:59 -0700456 size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize) override final;
457 std::vector<TouchVideoFrame> getVideoFrames(int32_t deviceId) override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800458
Chris Ye989bb932020-07-04 16:18:59 -0700459 bool hasScanCode(int32_t deviceId, int32_t scanCode) const override final;
460 bool hasLed(int32_t deviceId, int32_t led) const override final;
461 void setLedState(int32_t deviceId, int32_t led, bool on) override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800462
Chris Ye989bb932020-07-04 16:18:59 -0700463 void getVirtualKeyDefinitions(
464 int32_t deviceId,
465 std::vector<VirtualKeyDefinition>& outVirtualKeys) const override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800466
Chris Ye3a1e4462020-08-12 10:13:15 -0700467 const std::shared_ptr<KeyCharacterMap> getKeyCharacterMap(
468 int32_t deviceId) const override final;
469 bool setKeyboardLayoutOverlay(int32_t deviceId,
470 std::shared_ptr<KeyCharacterMap> map) override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800471
Chris Ye989bb932020-07-04 16:18:59 -0700472 void vibrate(int32_t deviceId, const VibrationElement& effect) override final;
473 void cancelVibrate(int32_t deviceId) override final;
Chris Ye87143712020-11-10 05:05:58 +0000474 std::vector<int32_t> getVibratorIds(int32_t deviceId) override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800475
Chris Ye989bb932020-07-04 16:18:59 -0700476 void requestReopenDevices() override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800477
Chris Ye989bb932020-07-04 16:18:59 -0700478 void wake() override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800479
Chris Ye989bb932020-07-04 16:18:59 -0700480 void dump(std::string& dump) override final;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800481
Chris Ye989bb932020-07-04 16:18:59 -0700482 void monitor() override final;
483
Kim Low03ea0352020-11-06 12:45:07 -0800484 std::optional<int32_t> getBatteryCapacity(int32_t deviceId) const override final;
485
486 std::optional<int32_t> getBatteryStatus(int32_t deviceId) const override final;
487
Chris Ye989bb932020-07-04 16:18:59 -0700488 bool isDeviceEnabled(int32_t deviceId) override final;
489
490 status_t enableDevice(int32_t deviceId) override final;
491
492 status_t disableDevice(int32_t deviceId) override final;
493
494 ~EventHub() override;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800495
496private:
497 struct Device {
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -0700498 int fd; // may be -1 if device is closed
Michael Wrightd02c5b62014-02-10 15:10:22 -0800499 const int32_t id;
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100500 const std::string path;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800501 const InputDeviceIdentifier identifier;
502
Siarhei Vishniakouec7854a2018-12-14 16:52:34 -0800503 std::unique_ptr<TouchVideoDevice> videoDevice;
504
Chris Ye1b0c7342020-07-28 21:57:03 -0700505 Flags<InputDeviceClass> classes;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800506
Chris Ye66fbac32020-07-06 20:36:43 -0700507 BitArray<KEY_MAX> keyBitmask;
508 BitArray<KEY_MAX> keyState;
509 BitArray<ABS_MAX> absBitmask;
510 BitArray<REL_MAX> relBitmask;
511 BitArray<SW_MAX> swBitmask;
512 BitArray<SW_MAX> swState;
513 BitArray<LED_MAX> ledBitmask;
514 BitArray<FF_MAX> ffBitmask;
515 BitArray<INPUT_PROP_MAX> propBitmask;
Chris Yef59a2f42020-10-16 12:55:26 -0700516 BitArray<MSC_MAX> mscBitmask;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800517
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100518 std::string configurationFile;
Siarhei Vishniakoud549b252020-08-11 11:25:26 -0500519 std::unique_ptr<PropertyMap> configuration;
Siarhei Vishniakou3e78dec2019-02-20 16:21:46 -0600520 std::unique_ptr<VirtualKeyMap> virtualKeyMap;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800521 KeyMap keyMap;
522
Michael Wrightd02c5b62014-02-10 15:10:22 -0800523 bool ffEffectPlaying;
524 int16_t ffEffectId; // initially -1
525
Chris Ye3fdbfef2021-01-06 18:45:18 -0800526 // The paths are invalid when they're std::nullopt
527 std::optional<std::filesystem::path> sysfsRootPath;
528 std::optional<std::filesystem::path> sysfsBatteryPath;
529 // maps from light id to light info
530 std::unordered_map<int32_t, RawLightInfo> lightInfos;
531 int32_t nextLightId;
Kim Low03ea0352020-11-06 12:45:07 -0800532
Michael Wrightd02c5b62014-02-10 15:10:22 -0800533 int32_t controllerNumber;
534
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100535 Device(int fd, int32_t id, const std::string& path,
Prabir Pradhanda7c00c2019-08-29 14:12:42 -0700536 const InputDeviceIdentifier& identifier);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800537 ~Device();
538
539 void close();
540
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -0700541 bool enabled; // initially true
542 status_t enable();
543 status_t disable();
Chris Ye989bb932020-07-04 16:18:59 -0700544 bool hasValidFd() const;
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -0700545 const bool isVirtual; // set if fd < 0 is passed to constructor
Michael Wrightd02c5b62014-02-10 15:10:22 -0800546
Chris Ye3a1e4462020-08-12 10:13:15 -0700547 const std::shared_ptr<KeyCharacterMap> getKeyCharacterMap() const;
Chris Ye66fbac32020-07-06 20:36:43 -0700548
549 template <std::size_t N>
Chris Ye989bb932020-07-04 16:18:59 -0700550 status_t readDeviceBitMask(unsigned long ioctlCode, BitArray<N>& bitArray);
Chris Ye66fbac32020-07-06 20:36:43 -0700551
Chris Ye989bb932020-07-04 16:18:59 -0700552 void configureFd();
553 bool hasKeycodeLocked(int keycode) const;
554 void loadConfigurationLocked();
555 bool loadVirtualKeyMapLocked();
556 status_t loadKeyMapLocked();
557 bool isExternalDeviceLocked();
558 bool deviceHasMicLocked();
559 void setLedForControllerLocked();
560 status_t mapLed(int32_t led, int32_t* outScanCode) const;
561 void setLedStateLocked(int32_t led, bool on);
Chris Ye3fdbfef2021-01-06 18:45:18 -0800562 bool configureBatteryLocked();
563 bool configureLightsLocked();
Michael Wrightd02c5b62014-02-10 15:10:22 -0800564 };
565
Chris Ye8594e192020-07-14 10:34:06 -0700566 status_t openDeviceLocked(const std::string& devicePath);
Siarhei Vishniakou22c88462018-12-13 19:34:53 -0800567 void openVideoDeviceLocked(const std::string& devicePath);
Siarhei Vishniakouf49608d2020-08-20 19:18:21 -0500568 /**
569 * Try to associate a video device with an input device. If the association succeeds,
570 * the videoDevice is moved into the input device. 'videoDevice' will become null if this
571 * happens.
572 * Return true if the association succeeds.
573 * Return false otherwise.
574 */
575 bool tryAddVideoDevice(Device& device, std::unique_ptr<TouchVideoDevice>& videoDevice);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800576 void createVirtualKeyboardLocked();
Chris Ye989bb932020-07-04 16:18:59 -0700577 void addDeviceLocked(std::unique_ptr<Device> device);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800578 void assignDescriptorLocked(InputDeviceIdentifier& identifier);
579
Chris Ye8594e192020-07-14 10:34:06 -0700580 void closeDeviceByPathLocked(const std::string& devicePath);
Siarhei Vishniakou22c88462018-12-13 19:34:53 -0800581 void closeVideoDeviceByPathLocked(const std::string& devicePath);
Chris Ye989bb932020-07-04 16:18:59 -0700582 void closeDeviceLocked(Device& device);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800583 void closeAllDevicesLocked();
584
Siarhei Vishniakou25920312018-12-12 15:24:44 -0800585 status_t registerFdForEpoll(int fd);
586 status_t unregisterFdFromEpoll(int fd);
Chris Ye989bb932020-07-04 16:18:59 -0700587 status_t registerDeviceForEpollLocked(Device& device);
Siarhei Vishniakou12598682018-11-02 17:19:19 -0700588 void registerVideoDeviceForEpollLocked(const TouchVideoDevice& videoDevice);
Chris Ye989bb932020-07-04 16:18:59 -0700589 status_t unregisterDeviceFromEpollLocked(Device& device);
Siarhei Vishniakou12598682018-11-02 17:19:19 -0700590 void unregisterVideoDeviceFromEpollLocked(const TouchVideoDevice& videoDevice);
Siarhei Vishniakoue54cb852017-03-21 17:48:16 -0700591
Chris Ye8594e192020-07-14 10:34:06 -0700592 status_t scanDirLocked(const std::string& dirname);
Siarhei Vishniakou22c88462018-12-13 19:34:53 -0800593 status_t scanVideoDirLocked(const std::string& dirname);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800594 void scanDevicesLocked();
595 status_t readNotifyLocked();
596
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100597 Device* getDeviceByDescriptorLocked(const std::string& descriptor) const;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800598 Device* getDeviceLocked(int32_t deviceId) const;
Chris Ye8594e192020-07-14 10:34:06 -0700599 Device* getDeviceByPathLocked(const std::string& devicePath) const;
Siarhei Vishniakou12598682018-11-02 17:19:19 -0700600 /**
601 * Look through all available fd's (both for input devices and for video devices),
602 * and return the device pointer.
603 */
Siarhei Vishniakou4bc561c2018-11-02 17:41:58 -0700604 Device* getDeviceByFdLocked(int fd) const;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800605
Chris Ye989bb932020-07-04 16:18:59 -0700606 int32_t getNextControllerNumberLocked(const std::string& name);
607 void releaseControllerNumberLocked(int32_t num);
Michael Wrightd02c5b62014-02-10 15:10:22 -0800608
609 // Protect all internal state.
Chris Ye1c2e0892020-11-30 21:41:44 -0800610 mutable std::mutex mLock;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800611
612 // The actual id of the built-in keyboard, or NO_BUILT_IN_KEYBOARD if none.
613 // EventHub remaps the built-in keyboard to id 0 externally as required by the API.
614 enum {
615 // Must not conflict with any other assigned device ids, including
616 // the virtual keyboard id (-1).
617 NO_BUILT_IN_KEYBOARD = -2,
618 };
619 int32_t mBuiltInKeyboardId;
620
621 int32_t mNextDeviceId;
622
623 BitSet32 mControllerNumbers;
624
Chris Ye989bb932020-07-04 16:18:59 -0700625 std::unordered_map<int32_t, std::unique_ptr<Device>> mDevices;
Siarhei Vishniakou22c88462018-12-13 19:34:53 -0800626 /**
627 * Video devices that report touchscreen heatmap, but have not (yet) been paired
628 * with a specific input device. Video device discovery is independent from input device
629 * discovery, so the two types of devices could be found in any order.
630 * Ideally, video devices in this queue do not have an open fd, or at least aren't
631 * actively streaming.
632 */
633 std::vector<std::unique_ptr<TouchVideoDevice>> mUnattachedVideoDevices;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800634
Chris Ye989bb932020-07-04 16:18:59 -0700635 std::vector<std::unique_ptr<Device>> mOpeningDevices;
636 std::vector<std::unique_ptr<Device>> mClosingDevices;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800637
638 bool mNeedToSendFinishedDeviceScan;
639 bool mNeedToReopenDevices;
640 bool mNeedToScanDevices;
Siarhei Vishniakouec8f7252018-07-06 11:19:32 +0100641 std::vector<std::string> mExcludedDevices;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800642
643 int mEpollFd;
644 int mINotifyFd;
645 int mWakeReadPipeFd;
646 int mWakeWritePipeFd;
647
Siarhei Vishniakou951f3622018-12-12 19:45:42 -0800648 int mInputWd;
649 int mVideoWd;
650
Michael Wrightd02c5b62014-02-10 15:10:22 -0800651 // Maximum number of signalled FDs to handle at a time.
652 static const int EPOLL_MAX_EVENTS = 16;
653
654 // The array of pending epoll events and the index of the next event to be handled.
655 struct epoll_event mPendingEventItems[EPOLL_MAX_EVENTS];
656 size_t mPendingEventCount;
657 size_t mPendingEventIndex;
658 bool mPendingINotify;
Michael Wrightd02c5b62014-02-10 15:10:22 -0800659};
660
661}; // namespace android
662
663#endif // _RUNTIME_EVENT_HUB_H