2 * Copyright (C) 2005 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef _RUNTIME_EVENT_HUB_H
19 #define _RUNTIME_EVENT_HUB_H
21 #include <input/Input.h>
22 #include <input/InputDevice.h>
23 #include <input/Keyboard.h>
24 #include <input/KeyLayoutMap.h>
25 #include <input/KeyCharacterMap.h>
26 #include <input/VirtualKeyMap.h>
27 #include <utils/String8.h>
28 #include <utils/threads.h>
29 #include <utils/Log.h>
30 #include <utils/threads.h>
31 #include <utils/List.h>
32 #include <utils/Errors.h>
33 #include <utils/PropertyMap.h>
34 #include <utils/Vector.h>
35 #include <utils/KeyedVector.h>
36 #include <utils/BitSet.h>
38 #include <linux/input.h>
39 #include <sys/epoll.h>
41 /* Convenience constants. */
43 #define BTN_FIRST 0x100 // first button code
44 #define BTN_LAST 0x15f // last button code
47 * These constants are used privately in Android to pass raw timestamps
48 * through evdev from uinput device drivers because there is currently no
49 * other way to transfer this information. The evdev driver automatically
50 * timestamps all input events with the time they were posted and clobbers
51 * whatever information was passed in.
53 * For the purposes of this hack, the timestamp is specified in the
54 * CLOCK_MONOTONIC timebase and is split into two EV_MSC events specifying
55 * seconds and microseconds.
57 #define MSC_ANDROID_TIME_SEC 0x6
58 #define MSC_ANDROID_TIME_USEC 0x7
63 // Device id of a special "virtual" keyboard that is always present.
64 VIRTUAL_KEYBOARD_ID = -1,
65 // Device id of the "built-in" keyboard if there is one.
66 BUILT_IN_KEYBOARD_ID = 0,
70 * A raw event as retrieved from the EventHub.
80 /* Describes an absolute axis. */
81 struct RawAbsoluteAxisInfo {
82 bool valid; // true if the information is valid, false otherwise
84 int32_t minValue; // minimum value
85 int32_t maxValue; // maximum value
86 int32_t flat; // center flat position, eg. flat == 8 means center is between -8 and 8
87 int32_t fuzz; // error tolerance, eg. fuzz == 4 means value is +/- 4 due to noise
88 int32_t resolution; // resolution in units per mm or radians per mm
101 * Input device classes.
104 /* The input device is a keyboard or has buttons. */
105 INPUT_DEVICE_CLASS_KEYBOARD = 0x00000001,
107 /* The input device is an alpha-numeric keyboard (not just a dial pad). */
108 INPUT_DEVICE_CLASS_ALPHAKEY = 0x00000002,
110 /* The input device is a touchscreen or a touchpad (either single-touch or multi-touch). */
111 INPUT_DEVICE_CLASS_TOUCH = 0x00000004,
113 /* The input device is a cursor device such as a trackball or mouse. */
114 INPUT_DEVICE_CLASS_CURSOR = 0x00000008,
116 /* The input device is a multi-touch touchscreen. */
117 INPUT_DEVICE_CLASS_TOUCH_MT = 0x00000010,
119 /* The input device is a directional pad (implies keyboard, has DPAD keys). */
120 INPUT_DEVICE_CLASS_DPAD = 0x00000020,
122 /* The input device is a gamepad (implies keyboard, has BUTTON keys). */
123 INPUT_DEVICE_CLASS_GAMEPAD = 0x00000040,
125 /* The input device has switches. */
126 INPUT_DEVICE_CLASS_SWITCH = 0x00000080,
128 /* The input device is a joystick (implies gamepad, has joystick absolute axes). */
129 INPUT_DEVICE_CLASS_JOYSTICK = 0x00000100,
131 /* The input device has a vibrator (supports FF_RUMBLE). */
132 INPUT_DEVICE_CLASS_VIBRATOR = 0x00000200,
134 /* The input device is virtual (not a real device, not part of UI configuration). */
135 INPUT_DEVICE_CLASS_VIRTUAL = 0x40000000,
137 /* The input device is external (not built-in). */
138 INPUT_DEVICE_CLASS_EXTERNAL = 0x80000000,
142 * Gets the class that owns an axis, in cases where multiple classes might claim
143 * the same axis for different purposes.
145 extern uint32_t getAbsAxisUsage(int32_t axis, uint32_t deviceClasses);
148 * Grand Central Station for events.
150 * The event hub aggregates input events received across all known input
151 * devices on the system, including devices that may be emulated by the simulator
152 * environment. In addition, the event hub generates fake input events to indicate
153 * when devices are added or removed.
155 * The event hub provides a stream of input events (via the getEvent function).
156 * It also supports querying the current actual state of input devices such as identifying
157 * which keys are currently down. Finally, the event hub keeps track of the capabilities of
158 * individual input devices, such as their class and the set of key codes that they support.
160 class EventHubInterface : public virtual RefBase {
162 EventHubInterface() { }
163 virtual ~EventHubInterface() { }
166 // Synthetic raw event type codes produced when devices are added or removed.
168 // Sent when a device is added.
169 DEVICE_ADDED = 0x10000000,
170 // Sent when a device is removed.
171 DEVICE_REMOVED = 0x20000000,
172 // Sent when all added/removed devices from the most recent scan have been reported.
173 // This event is always sent at least once.
174 FINISHED_DEVICE_SCAN = 0x30000000,
176 FIRST_SYNTHETIC_EVENT = DEVICE_ADDED,
179 virtual uint32_t getDeviceClasses(int32_t deviceId) const = 0;
181 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const = 0;
183 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const = 0;
185 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const = 0;
187 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
188 RawAbsoluteAxisInfo* outAxisInfo) const = 0;
190 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const = 0;
192 virtual bool hasInputProperty(int32_t deviceId, int property) const = 0;
194 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode,
195 int32_t* outKeycode, uint32_t* outFlags) const = 0;
197 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode,
198 AxisInfo* outAxisInfo) const = 0;
200 // Sets devices that are excluded from opening.
201 // This can be used to ignore input devices for sensors.
202 virtual void setExcludedDevices(const Vector<String8>& devices) = 0;
205 * Wait for events to become available and returns them.
206 * After returning, the EventHub holds onto a wake lock until the next call to getEvent.
207 * This ensures that the device will not go to sleep while the event is being processed.
208 * If the device needs to remain awake longer than that, then the caller is responsible
209 * for taking care of it (say, by poking the power manager user activity timer).
211 * The timeout is advisory only. If the device is asleep, it will not wake just to
212 * service the timeout.
214 * Returns the number of events obtained, or 0 if the timeout expired.
216 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize) = 0;
219 * Query current input state.
221 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const = 0;
222 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const = 0;
223 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const = 0;
224 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis,
225 int32_t* outValue) const = 0;
228 * Examine key input devices for specific framework keycode support
230 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes,
231 uint8_t* outFlags) const = 0;
233 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const = 0;
235 /* LED related functions expect Android LED constants, not scan codes or HID usages */
236 virtual bool hasLed(int32_t deviceId, int32_t led) const = 0;
237 virtual void setLedState(int32_t deviceId, int32_t led, bool on) = 0;
239 virtual void getVirtualKeyDefinitions(int32_t deviceId,
240 Vector<VirtualKeyDefinition>& outVirtualKeys) const = 0;
242 virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const = 0;
243 virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map) = 0;
245 /* Control the vibrator. */
246 virtual void vibrate(int32_t deviceId, nsecs_t duration) = 0;
247 virtual void cancelVibrate(int32_t deviceId) = 0;
249 /* Requests the EventHub to reopen all input devices on the next call to getEvents(). */
250 virtual void requestReopenDevices() = 0;
252 /* Wakes up getEvents() if it is blocked on a read. */
253 virtual void wake() = 0;
255 /* Dump EventHub state to a string. */
256 virtual void dump(String8& dump) = 0;
258 /* Called by the heatbeat to ensures that the reader has not deadlocked. */
259 virtual void monitor() = 0;
262 class EventHub : public EventHubInterface
267 virtual uint32_t getDeviceClasses(int32_t deviceId) const;
269 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const;
271 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const;
273 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const;
275 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
276 RawAbsoluteAxisInfo* outAxisInfo) const;
278 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const;
280 virtual bool hasInputProperty(int32_t deviceId, int property) const;
282 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode,
283 int32_t* outKeycode, uint32_t* outFlags) const;
285 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode,
286 AxisInfo* outAxisInfo) const;
288 virtual void setExcludedDevices(const Vector<String8>& devices);
290 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const;
291 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const;
292 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const;
293 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis, int32_t* outValue) const;
295 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes,
296 const int32_t* keyCodes, uint8_t* outFlags) const;
298 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize);
300 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const;
301 virtual bool hasLed(int32_t deviceId, int32_t led) const;
302 virtual void setLedState(int32_t deviceId, int32_t led, bool on);
304 virtual void getVirtualKeyDefinitions(int32_t deviceId,
305 Vector<VirtualKeyDefinition>& outVirtualKeys) const;
307 virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const;
308 virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map);
310 virtual void vibrate(int32_t deviceId, nsecs_t duration);
311 virtual void cancelVibrate(int32_t deviceId);
313 virtual void requestReopenDevices();
317 virtual void dump(String8& dump);
318 virtual void monitor();
327 int fd; // may be -1 if device is virtual
330 const InputDeviceIdentifier identifier;
334 uint8_t keyBitmask[(KEY_MAX + 1) / 8];
335 uint8_t absBitmask[(ABS_MAX + 1) / 8];
336 uint8_t relBitmask[(REL_MAX + 1) / 8];
337 uint8_t swBitmask[(SW_MAX + 1) / 8];
338 uint8_t ledBitmask[(LED_MAX + 1) / 8];
339 uint8_t ffBitmask[(FF_MAX + 1) / 8];
340 uint8_t propBitmask[(INPUT_PROP_MAX + 1) / 8];
342 String8 configurationFile;
343 PropertyMap* configuration;
344 VirtualKeyMap* virtualKeyMap;
347 sp<KeyCharacterMap> overlayKeyMap;
348 sp<KeyCharacterMap> combinedKeyMap;
350 bool ffEffectPlaying;
351 int16_t ffEffectId; // initially -1
353 int32_t controllerNumber;
355 int32_t timestampOverrideSec;
356 int32_t timestampOverrideUsec;
358 Device(int fd, int32_t id, const String8& path, const InputDeviceIdentifier& identifier);
363 inline bool isVirtual() const { return fd < 0; }
365 const sp<KeyCharacterMap>& getKeyCharacterMap() const {
366 if (combinedKeyMap != NULL) {
367 return combinedKeyMap;
369 return keyMap.keyCharacterMap;
373 status_t openDeviceLocked(const char *devicePath);
374 void createVirtualKeyboardLocked();
375 void addDeviceLocked(Device* device);
376 void assignDescriptorLocked(InputDeviceIdentifier& identifier);
378 status_t closeDeviceByPathLocked(const char *devicePath);
379 void closeDeviceLocked(Device* device);
380 void closeAllDevicesLocked();
382 status_t scanDirLocked(const char *dirname);
383 void scanDevicesLocked();
384 status_t readNotifyLocked();
386 Device* getDeviceByDescriptorLocked(String8& descriptor) const;
387 Device* getDeviceLocked(int32_t deviceId) const;
388 Device* getDeviceByPathLocked(const char* devicePath) const;
390 bool hasKeycodeLocked(Device* device, int keycode) const;
392 void loadConfigurationLocked(Device* device);
393 status_t loadVirtualKeyMapLocked(Device* device);
394 status_t loadKeyMapLocked(Device* device);
396 bool isExternalDeviceLocked(Device* device);
398 int32_t getNextControllerNumberLocked(Device* device);
399 void releaseControllerNumberLocked(Device* device);
400 void setLedForController(Device* device);
402 status_t mapLed(Device* device, int32_t led, int32_t* outScanCode) const;
403 void setLedStateLocked(Device* device, int32_t led, bool on);
405 // Protect all internal state.
408 // The actual id of the built-in keyboard, or NO_BUILT_IN_KEYBOARD if none.
409 // EventHub remaps the built-in keyboard to id 0 externally as required by the API.
411 // Must not conflict with any other assigned device ids, including
412 // the virtual keyboard id (-1).
413 NO_BUILT_IN_KEYBOARD = -2,
415 int32_t mBuiltInKeyboardId;
417 int32_t mNextDeviceId;
419 BitSet32 mControllerNumbers;
421 KeyedVector<int32_t, Device*> mDevices;
423 Device *mOpeningDevices;
424 Device *mClosingDevices;
426 bool mNeedToSendFinishedDeviceScan;
427 bool mNeedToReopenDevices;
428 bool mNeedToScanDevices;
429 Vector<String8> mExcludedDevices;
434 int mWakeWritePipeFd;
436 // Ids used for epoll notifications not associated with devices.
437 static const uint32_t EPOLL_ID_INOTIFY = 0x80000001;
438 static const uint32_t EPOLL_ID_WAKE = 0x80000002;
440 // Epoll FD list size hint.
441 static const int EPOLL_SIZE_HINT = 8;
443 // Maximum number of signalled FDs to handle at a time.
444 static const int EPOLL_MAX_EVENTS = 16;
446 // The array of pending epoll events and the index of the next event to be handled.
447 struct epoll_event mPendingEventItems[EPOLL_MAX_EVENTS];
448 size_t mPendingEventCount;
449 size_t mPendingEventIndex;
450 bool mPendingINotify;
452 bool mUsingEpollWakeup;
455 }; // namespace android
457 #endif // _RUNTIME_EVENT_HUB_H