1 /* 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 17 // 18 #ifndef _RUNTIME_EVENT_HUB_H 19 #define _RUNTIME_EVENT_HUB_H 20 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> 37 38 #include <linux/input.h> 39 #include <sys/epoll.h> 40 41 /* Convenience constants. */ 42 43 #define BTN_FIRST 0x100 // first button code 44 #define BTN_LAST 0x15f // last button code 45 46 /* 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. 52 * 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. 56 */ 57 #define MSC_ANDROID_TIME_SEC 0x6 58 #define MSC_ANDROID_TIME_USEC 0x7 59 60 namespace android { 61 62 enum { 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, 67 }; 68 69 /* 70 * A raw event as retrieved from the EventHub. 71 */ 72 struct RawEvent { 73 nsecs_t when; 74 int32_t deviceId; 75 int32_t type; 76 int32_t code; 77 int32_t value; 78 }; 79 80 /* Describes an absolute axis. */ 81 struct RawAbsoluteAxisInfo { 82 bool valid; // true if the information is valid, false otherwise 83 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 89 clearRawAbsoluteAxisInfo90 inline void clear() { 91 valid = false; 92 minValue = 0; 93 maxValue = 0; 94 flat = 0; 95 fuzz = 0; 96 resolution = 0; 97 } 98 }; 99 100 /* 101 * Input device classes. 102 */ 103 enum { 104 /* The input device is a keyboard or has buttons. */ 105 INPUT_DEVICE_CLASS_KEYBOARD = 0x00000001, 106 107 /* The input device is an alpha-numeric keyboard (not just a dial pad). */ 108 INPUT_DEVICE_CLASS_ALPHAKEY = 0x00000002, 109 110 /* The input device is a touchscreen or a touchpad (either single-touch or multi-touch). */ 111 INPUT_DEVICE_CLASS_TOUCH = 0x00000004, 112 113 /* The input device is a cursor device such as a trackball or mouse. */ 114 INPUT_DEVICE_CLASS_CURSOR = 0x00000008, 115 116 /* The input device is a multi-touch touchscreen. */ 117 INPUT_DEVICE_CLASS_TOUCH_MT = 0x00000010, 118 119 /* The input device is a directional pad (implies keyboard, has DPAD keys). */ 120 INPUT_DEVICE_CLASS_DPAD = 0x00000020, 121 122 /* The input device is a gamepad (implies keyboard, has BUTTON keys). */ 123 INPUT_DEVICE_CLASS_GAMEPAD = 0x00000040, 124 125 /* The input device has switches. */ 126 INPUT_DEVICE_CLASS_SWITCH = 0x00000080, 127 128 /* The input device is a joystick (implies gamepad, has joystick absolute axes). */ 129 INPUT_DEVICE_CLASS_JOYSTICK = 0x00000100, 130 131 /* The input device has a vibrator (supports FF_RUMBLE). */ 132 INPUT_DEVICE_CLASS_VIBRATOR = 0x00000200, 133 134 /* The input device is virtual (not a real device, not part of UI configuration). */ 135 INPUT_DEVICE_CLASS_VIRTUAL = 0x40000000, 136 137 /* The input device is external (not built-in). */ 138 INPUT_DEVICE_CLASS_EXTERNAL = 0x80000000, 139 }; 140 141 /* 142 * Gets the class that owns an axis, in cases where multiple classes might claim 143 * the same axis for different purposes. 144 */ 145 extern uint32_t getAbsAxisUsage(int32_t axis, uint32_t deviceClasses); 146 147 /* 148 * Grand Central Station for events. 149 * 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. 154 * 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. 159 */ 160 class EventHubInterface : public virtual RefBase { 161 protected: EventHubInterface()162 EventHubInterface() { } ~EventHubInterface()163 virtual ~EventHubInterface() { } 164 165 public: 166 // Synthetic raw event type codes produced when devices are added or removed. 167 enum { 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, 175 176 FIRST_SYNTHETIC_EVENT = DEVICE_ADDED, 177 }; 178 179 virtual uint32_t getDeviceClasses(int32_t deviceId) const = 0; 180 181 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const = 0; 182 183 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const = 0; 184 185 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const = 0; 186 187 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis, 188 RawAbsoluteAxisInfo* outAxisInfo) const = 0; 189 190 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const = 0; 191 192 virtual bool hasInputProperty(int32_t deviceId, int property) const = 0; 193 194 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode, 195 int32_t* outKeycode, uint32_t* outFlags) const = 0; 196 197 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode, 198 AxisInfo* outAxisInfo) const = 0; 199 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; 203 204 /* 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). 210 * 211 * The timeout is advisory only. If the device is asleep, it will not wake just to 212 * service the timeout. 213 * 214 * Returns the number of events obtained, or 0 if the timeout expired. 215 */ 216 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize) = 0; 217 218 /* 219 * Query current input state. 220 */ 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; 226 227 /* 228 * Examine key input devices for specific framework keycode support 229 */ 230 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes, 231 uint8_t* outFlags) const = 0; 232 233 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const = 0; 234 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; 238 239 virtual void getVirtualKeyDefinitions(int32_t deviceId, 240 Vector<VirtualKeyDefinition>& outVirtualKeys) const = 0; 241 242 virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const = 0; 243 virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map) = 0; 244 245 /* Control the vibrator. */ 246 virtual void vibrate(int32_t deviceId, nsecs_t duration) = 0; 247 virtual void cancelVibrate(int32_t deviceId) = 0; 248 249 /* Requests the EventHub to reopen all input devices on the next call to getEvents(). */ 250 virtual void requestReopenDevices() = 0; 251 252 /* Wakes up getEvents() if it is blocked on a read. */ 253 virtual void wake() = 0; 254 255 /* Dump EventHub state to a string. */ 256 virtual void dump(String8& dump) = 0; 257 258 /* Called by the heatbeat to ensures that the reader has not deadlocked. */ 259 virtual void monitor() = 0; 260 }; 261 262 class EventHub : public EventHubInterface 263 { 264 public: 265 EventHub(); 266 267 virtual uint32_t getDeviceClasses(int32_t deviceId) const; 268 269 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const; 270 271 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const; 272 273 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const; 274 275 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis, 276 RawAbsoluteAxisInfo* outAxisInfo) const; 277 278 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const; 279 280 virtual bool hasInputProperty(int32_t deviceId, int property) const; 281 282 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode, 283 int32_t* outKeycode, uint32_t* outFlags) const; 284 285 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode, 286 AxisInfo* outAxisInfo) const; 287 288 virtual void setExcludedDevices(const Vector<String8>& devices); 289 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; 294 295 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, 296 const int32_t* keyCodes, uint8_t* outFlags) const; 297 298 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize); 299 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); 303 304 virtual void getVirtualKeyDefinitions(int32_t deviceId, 305 Vector<VirtualKeyDefinition>& outVirtualKeys) const; 306 307 virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const; 308 virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map); 309 310 virtual void vibrate(int32_t deviceId, nsecs_t duration); 311 virtual void cancelVibrate(int32_t deviceId); 312 313 virtual void requestReopenDevices(); 314 315 virtual void wake(); 316 317 virtual void dump(String8& dump); 318 virtual void monitor(); 319 320 protected: 321 virtual ~EventHub(); 322 323 private: 324 struct Device { 325 Device* next; 326 327 int fd; // may be -1 if device is virtual 328 const int32_t id; 329 const String8 path; 330 const InputDeviceIdentifier identifier; 331 332 uint32_t classes; 333 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]; 341 342 String8 configurationFile; 343 PropertyMap* configuration; 344 VirtualKeyMap* virtualKeyMap; 345 KeyMap keyMap; 346 347 sp<KeyCharacterMap> overlayKeyMap; 348 sp<KeyCharacterMap> combinedKeyMap; 349 350 bool ffEffectPlaying; 351 int16_t ffEffectId; // initially -1 352 353 int32_t controllerNumber; 354 355 int32_t timestampOverrideSec; 356 int32_t timestampOverrideUsec; 357 358 Device(int fd, int32_t id, const String8& path, const InputDeviceIdentifier& identifier); 359 ~Device(); 360 361 void close(); 362 isVirtualDevice363 inline bool isVirtual() const { return fd < 0; } 364 getKeyCharacterMapDevice365 const sp<KeyCharacterMap>& getKeyCharacterMap() const { 366 if (combinedKeyMap != NULL) { 367 return combinedKeyMap; 368 } 369 return keyMap.keyCharacterMap; 370 } 371 }; 372 373 status_t openDeviceLocked(const char *devicePath); 374 void createVirtualKeyboardLocked(); 375 void addDeviceLocked(Device* device); 376 void assignDescriptorLocked(InputDeviceIdentifier& identifier); 377 378 status_t closeDeviceByPathLocked(const char *devicePath); 379 void closeDeviceLocked(Device* device); 380 void closeAllDevicesLocked(); 381 382 status_t scanDirLocked(const char *dirname); 383 void scanDevicesLocked(); 384 status_t readNotifyLocked(); 385 386 Device* getDeviceByDescriptorLocked(String8& descriptor) const; 387 Device* getDeviceLocked(int32_t deviceId) const; 388 Device* getDeviceByPathLocked(const char* devicePath) const; 389 390 bool hasKeycodeLocked(Device* device, int keycode) const; 391 392 void loadConfigurationLocked(Device* device); 393 status_t loadVirtualKeyMapLocked(Device* device); 394 status_t loadKeyMapLocked(Device* device); 395 396 bool isExternalDeviceLocked(Device* device); 397 398 int32_t getNextControllerNumberLocked(Device* device); 399 void releaseControllerNumberLocked(Device* device); 400 void setLedForController(Device* device); 401 402 status_t mapLed(Device* device, int32_t led, int32_t* outScanCode) const; 403 void setLedStateLocked(Device* device, int32_t led, bool on); 404 405 // Protect all internal state. 406 mutable Mutex mLock; 407 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. 410 enum { 411 // Must not conflict with any other assigned device ids, including 412 // the virtual keyboard id (-1). 413 NO_BUILT_IN_KEYBOARD = -2, 414 }; 415 int32_t mBuiltInKeyboardId; 416 417 int32_t mNextDeviceId; 418 419 BitSet32 mControllerNumbers; 420 421 KeyedVector<int32_t, Device*> mDevices; 422 423 Device *mOpeningDevices; 424 Device *mClosingDevices; 425 426 bool mNeedToSendFinishedDeviceScan; 427 bool mNeedToReopenDevices; 428 bool mNeedToScanDevices; 429 Vector<String8> mExcludedDevices; 430 431 int mEpollFd; 432 int mINotifyFd; 433 int mWakeReadPipeFd; 434 int mWakeWritePipeFd; 435 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; 439 440 // Epoll FD list size hint. 441 static const int EPOLL_SIZE_HINT = 8; 442 443 // Maximum number of signalled FDs to handle at a time. 444 static const int EPOLL_MAX_EVENTS = 16; 445 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; 451 452 bool mUsingEpollWakeup; 453 }; 454 455 }; // namespace android 456 457 #endif // _RUNTIME_EVENT_HUB_H 458