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 #ifndef _RUNTIME_EVENT_HUB_H 18 #define _RUNTIME_EVENT_HUB_H 19 20 #include <vector> 21 22 #include <input/Input.h> 23 #include <input/InputDevice.h> 24 #include <input/KeyCharacterMap.h> 25 #include <input/KeyLayoutMap.h> 26 #include <input/Keyboard.h> 27 #include <input/VirtualKeyMap.h> 28 #include <utils/BitSet.h> 29 #include <utils/Errors.h> 30 #include <utils/KeyedVector.h> 31 #include <utils/List.h> 32 #include <utils/Log.h> 33 #include <utils/Mutex.h> 34 #include <utils/PropertyMap.h> 35 36 #include <linux/input.h> 37 #include <sys/epoll.h> 38 39 #include "TouchVideoDevice.h" 40 41 /* Convenience constants. */ 42 43 #define BTN_FIRST 0x100 // first button code 44 #define BTN_LAST 0x15f // last button code 45 46 namespace android { 47 48 /* 49 * A raw event as retrieved from the EventHub. 50 */ 51 struct RawEvent { 52 nsecs_t when; 53 int32_t deviceId; 54 int32_t type; 55 int32_t code; 56 int32_t value; 57 }; 58 59 /* Describes an absolute axis. */ 60 struct RawAbsoluteAxisInfo { 61 bool valid; // true if the information is valid, false otherwise 62 63 int32_t minValue; // minimum value 64 int32_t maxValue; // maximum value 65 int32_t flat; // center flat position, eg. flat == 8 means center is between -8 and 8 66 int32_t fuzz; // error tolerance, eg. fuzz == 4 means value is +/- 4 due to noise 67 int32_t resolution; // resolution in units per mm or radians per mm 68 clearRawAbsoluteAxisInfo69 inline void clear() { 70 valid = false; 71 minValue = 0; 72 maxValue = 0; 73 flat = 0; 74 fuzz = 0; 75 resolution = 0; 76 } 77 }; 78 79 /* 80 * Input device classes. 81 */ 82 enum { 83 /* The input device is a keyboard or has buttons. */ 84 INPUT_DEVICE_CLASS_KEYBOARD = 0x00000001, 85 86 /* The input device is an alpha-numeric keyboard (not just a dial pad). */ 87 INPUT_DEVICE_CLASS_ALPHAKEY = 0x00000002, 88 89 /* The input device is a touchscreen or a touchpad (either single-touch or multi-touch). */ 90 INPUT_DEVICE_CLASS_TOUCH = 0x00000004, 91 92 /* The input device is a cursor device such as a trackball or mouse. */ 93 INPUT_DEVICE_CLASS_CURSOR = 0x00000008, 94 95 /* The input device is a multi-touch touchscreen. */ 96 INPUT_DEVICE_CLASS_TOUCH_MT = 0x00000010, 97 98 /* The input device is a directional pad (implies keyboard, has DPAD keys). */ 99 INPUT_DEVICE_CLASS_DPAD = 0x00000020, 100 101 /* The input device is a gamepad (implies keyboard, has BUTTON keys). */ 102 INPUT_DEVICE_CLASS_GAMEPAD = 0x00000040, 103 104 /* The input device has switches. */ 105 INPUT_DEVICE_CLASS_SWITCH = 0x00000080, 106 107 /* The input device is a joystick (implies gamepad, has joystick absolute axes). */ 108 INPUT_DEVICE_CLASS_JOYSTICK = 0x00000100, 109 110 /* The input device has a vibrator (supports FF_RUMBLE). */ 111 INPUT_DEVICE_CLASS_VIBRATOR = 0x00000200, 112 113 /* The input device has a microphone. */ 114 INPUT_DEVICE_CLASS_MIC = 0x00000400, 115 116 /* The input device is an external stylus (has data we want to fuse with touch data). */ 117 INPUT_DEVICE_CLASS_EXTERNAL_STYLUS = 0x00000800, 118 119 /* The input device has a rotary encoder */ 120 INPUT_DEVICE_CLASS_ROTARY_ENCODER = 0x00001000, 121 122 /* The input device is virtual (not a real device, not part of UI configuration). */ 123 INPUT_DEVICE_CLASS_VIRTUAL = 0x40000000, 124 125 /* The input device is external (not built-in). */ 126 INPUT_DEVICE_CLASS_EXTERNAL = 0x80000000, 127 }; 128 129 /* 130 * Gets the class that owns an axis, in cases where multiple classes might claim 131 * the same axis for different purposes. 132 */ 133 extern uint32_t getAbsAxisUsage(int32_t axis, uint32_t deviceClasses); 134 135 /* 136 * Grand Central Station for events. 137 * 138 * The event hub aggregates input events received across all known input 139 * devices on the system, including devices that may be emulated by the simulator 140 * environment. In addition, the event hub generates fake input events to indicate 141 * when devices are added or removed. 142 * 143 * The event hub provides a stream of input events (via the getEvent function). 144 * It also supports querying the current actual state of input devices such as identifying 145 * which keys are currently down. Finally, the event hub keeps track of the capabilities of 146 * individual input devices, such as their class and the set of key codes that they support. 147 */ 148 class EventHubInterface : public virtual RefBase { 149 protected: EventHubInterface()150 EventHubInterface() {} ~EventHubInterface()151 virtual ~EventHubInterface() {} 152 153 public: 154 // Synthetic raw event type codes produced when devices are added or removed. 155 enum { 156 // Sent when a device is added. 157 DEVICE_ADDED = 0x10000000, 158 // Sent when a device is removed. 159 DEVICE_REMOVED = 0x20000000, 160 // Sent when all added/removed devices from the most recent scan have been reported. 161 // This event is always sent at least once. 162 FINISHED_DEVICE_SCAN = 0x30000000, 163 164 FIRST_SYNTHETIC_EVENT = DEVICE_ADDED, 165 }; 166 167 virtual uint32_t getDeviceClasses(int32_t deviceId) const = 0; 168 169 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const = 0; 170 171 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const = 0; 172 173 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const = 0; 174 175 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis, 176 RawAbsoluteAxisInfo* outAxisInfo) const = 0; 177 178 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const = 0; 179 180 virtual bool hasInputProperty(int32_t deviceId, int property) const = 0; 181 182 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode, 183 int32_t metaState, int32_t* outKeycode, int32_t* outMetaState, 184 uint32_t* outFlags) const = 0; 185 186 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode, AxisInfo* outAxisInfo) const = 0; 187 188 // Sets devices that are excluded from opening. 189 // This can be used to ignore input devices for sensors. 190 virtual void setExcludedDevices(const std::vector<std::string>& devices) = 0; 191 192 /* 193 * Wait for events to become available and returns them. 194 * After returning, the EventHub holds onto a wake lock until the next call to getEvent. 195 * This ensures that the device will not go to sleep while the event is being processed. 196 * If the device needs to remain awake longer than that, then the caller is responsible 197 * for taking care of it (say, by poking the power manager user activity timer). 198 * 199 * The timeout is advisory only. If the device is asleep, it will not wake just to 200 * service the timeout. 201 * 202 * Returns the number of events obtained, or 0 if the timeout expired. 203 */ 204 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize) = 0; 205 virtual std::vector<TouchVideoFrame> getVideoFrames(int32_t deviceId) = 0; 206 207 /* 208 * Query current input state. 209 */ 210 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const = 0; 211 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const = 0; 212 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const = 0; 213 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis, 214 int32_t* outValue) const = 0; 215 216 /* 217 * Examine key input devices for specific framework keycode support 218 */ 219 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes, 220 uint8_t* outFlags) const = 0; 221 222 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const = 0; 223 224 /* LED related functions expect Android LED constants, not scan codes or HID usages */ 225 virtual bool hasLed(int32_t deviceId, int32_t led) const = 0; 226 virtual void setLedState(int32_t deviceId, int32_t led, bool on) = 0; 227 228 virtual void getVirtualKeyDefinitions( 229 int32_t deviceId, std::vector<VirtualKeyDefinition>& outVirtualKeys) const = 0; 230 231 virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const = 0; 232 virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map) = 0; 233 234 /* Control the vibrator. */ 235 virtual void vibrate(int32_t deviceId, nsecs_t duration) = 0; 236 virtual void cancelVibrate(int32_t deviceId) = 0; 237 238 /* Requests the EventHub to reopen all input devices on the next call to getEvents(). */ 239 virtual void requestReopenDevices() = 0; 240 241 /* Wakes up getEvents() if it is blocked on a read. */ 242 virtual void wake() = 0; 243 244 /* Dump EventHub state to a string. */ 245 virtual void dump(std::string& dump) = 0; 246 247 /* Called by the heatbeat to ensures that the reader has not deadlocked. */ 248 virtual void monitor() = 0; 249 250 /* Return true if the device is enabled. */ 251 virtual bool isDeviceEnabled(int32_t deviceId) = 0; 252 253 /* Enable an input device */ 254 virtual status_t enableDevice(int32_t deviceId) = 0; 255 256 /* Disable an input device. Closes file descriptor to that device. */ 257 virtual status_t disableDevice(int32_t deviceId) = 0; 258 }; 259 260 class EventHub : public EventHubInterface { 261 public: 262 EventHub(); 263 264 virtual uint32_t getDeviceClasses(int32_t deviceId) const; 265 266 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const; 267 268 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const; 269 270 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const; 271 272 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis, 273 RawAbsoluteAxisInfo* outAxisInfo) const; 274 275 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const; 276 277 virtual bool hasInputProperty(int32_t deviceId, int property) const; 278 279 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode, 280 int32_t metaState, int32_t* outKeycode, int32_t* outMetaState, 281 uint32_t* outFlags) const; 282 283 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode, AxisInfo* outAxisInfo) const; 284 285 virtual void setExcludedDevices(const std::vector<std::string>& devices); 286 287 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const; 288 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const; 289 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const; 290 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis, int32_t* outValue) const; 291 292 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes, 293 uint8_t* outFlags) const; 294 295 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize); 296 virtual std::vector<TouchVideoFrame> getVideoFrames(int32_t deviceId); 297 298 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const; 299 virtual bool hasLed(int32_t deviceId, int32_t led) const; 300 virtual void setLedState(int32_t deviceId, int32_t led, bool on); 301 302 virtual void getVirtualKeyDefinitions(int32_t deviceId, 303 std::vector<VirtualKeyDefinition>& outVirtualKeys) const; 304 305 virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const; 306 virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map); 307 308 virtual void vibrate(int32_t deviceId, nsecs_t duration); 309 virtual void cancelVibrate(int32_t deviceId); 310 311 virtual void requestReopenDevices(); 312 313 virtual void wake(); 314 315 virtual void dump(std::string& dump); 316 virtual void monitor(); 317 318 protected: 319 virtual ~EventHub(); 320 321 private: 322 struct Device { 323 Device* next; 324 325 int fd; // may be -1 if device is closed 326 const int32_t id; 327 const std::string path; 328 const InputDeviceIdentifier identifier; 329 330 std::unique_ptr<TouchVideoDevice> videoDevice; 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 std::string configurationFile; 343 PropertyMap* configuration; 344 std::unique_ptr<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 Device(int fd, int32_t id, const std::string& path, 356 const InputDeviceIdentifier& identifier); 357 ~Device(); 358 359 void close(); 360 361 bool enabled; // initially true 362 status_t enable(); 363 status_t disable(); 364 bool hasValidFd(); 365 const bool isVirtual; // set if fd < 0 is passed to constructor 366 getKeyCharacterMapDevice367 const sp<KeyCharacterMap>& getKeyCharacterMap() const { 368 if (combinedKeyMap != nullptr) { 369 return combinedKeyMap; 370 } 371 return keyMap.keyCharacterMap; 372 } 373 }; 374 375 status_t openDeviceLocked(const char* devicePath); 376 void openVideoDeviceLocked(const std::string& devicePath); 377 void createVirtualKeyboardLocked(); 378 void addDeviceLocked(Device* device); 379 void assignDescriptorLocked(InputDeviceIdentifier& identifier); 380 381 void closeDeviceByPathLocked(const char* devicePath); 382 void closeVideoDeviceByPathLocked(const std::string& devicePath); 383 void closeDeviceLocked(Device* device); 384 void closeAllDevicesLocked(); 385 386 void configureFd(Device* device); 387 388 bool isDeviceEnabled(int32_t deviceId); 389 status_t enableDevice(int32_t deviceId); 390 status_t disableDevice(int32_t deviceId); 391 status_t registerFdForEpoll(int fd); 392 status_t unregisterFdFromEpoll(int fd); 393 status_t registerDeviceForEpollLocked(Device* device); 394 void registerVideoDeviceForEpollLocked(const TouchVideoDevice& videoDevice); 395 status_t unregisterDeviceFromEpollLocked(Device* device); 396 void unregisterVideoDeviceFromEpollLocked(const TouchVideoDevice& videoDevice); 397 398 status_t scanDirLocked(const char* dirname); 399 status_t scanVideoDirLocked(const std::string& dirname); 400 void scanDevicesLocked(); 401 status_t readNotifyLocked(); 402 403 Device* getDeviceByDescriptorLocked(const std::string& descriptor) const; 404 Device* getDeviceLocked(int32_t deviceId) const; 405 Device* getDeviceByPathLocked(const char* devicePath) const; 406 /** 407 * Look through all available fd's (both for input devices and for video devices), 408 * and return the device pointer. 409 */ 410 Device* getDeviceByFdLocked(int fd) const; 411 412 bool hasKeycodeLocked(Device* device, int keycode) const; 413 414 void loadConfigurationLocked(Device* device); 415 bool loadVirtualKeyMapLocked(Device* device); 416 status_t loadKeyMapLocked(Device* device); 417 418 bool isExternalDeviceLocked(Device* device); 419 bool deviceHasMicLocked(Device* device); 420 421 int32_t getNextControllerNumberLocked(Device* device); 422 void releaseControllerNumberLocked(Device* device); 423 void setLedForControllerLocked(Device* device); 424 425 status_t mapLed(Device* device, int32_t led, int32_t* outScanCode) const; 426 void setLedStateLocked(Device* device, int32_t led, bool on); 427 428 // Protect all internal state. 429 mutable Mutex mLock; 430 431 // The actual id of the built-in keyboard, or NO_BUILT_IN_KEYBOARD if none. 432 // EventHub remaps the built-in keyboard to id 0 externally as required by the API. 433 enum { 434 // Must not conflict with any other assigned device ids, including 435 // the virtual keyboard id (-1). 436 NO_BUILT_IN_KEYBOARD = -2, 437 }; 438 int32_t mBuiltInKeyboardId; 439 440 int32_t mNextDeviceId; 441 442 BitSet32 mControllerNumbers; 443 444 KeyedVector<int32_t, Device*> mDevices; 445 /** 446 * Video devices that report touchscreen heatmap, but have not (yet) been paired 447 * with a specific input device. Video device discovery is independent from input device 448 * discovery, so the two types of devices could be found in any order. 449 * Ideally, video devices in this queue do not have an open fd, or at least aren't 450 * actively streaming. 451 */ 452 std::vector<std::unique_ptr<TouchVideoDevice>> mUnattachedVideoDevices; 453 454 Device* mOpeningDevices; 455 Device* mClosingDevices; 456 457 bool mNeedToSendFinishedDeviceScan; 458 bool mNeedToReopenDevices; 459 bool mNeedToScanDevices; 460 std::vector<std::string> mExcludedDevices; 461 462 int mEpollFd; 463 int mINotifyFd; 464 int mWakeReadPipeFd; 465 int mWakeWritePipeFd; 466 467 int mInputWd; 468 int mVideoWd; 469 470 // Maximum number of signalled FDs to handle at a time. 471 static const int EPOLL_MAX_EVENTS = 16; 472 473 // The array of pending epoll events and the index of the next event to be handled. 474 struct epoll_event mPendingEventItems[EPOLL_MAX_EVENTS]; 475 size_t mPendingEventCount; 476 size_t mPendingEventIndex; 477 bool mPendingINotify; 478 479 bool mUsingEpollWakeup; 480 }; 481 482 }; // namespace android 483 484 #endif // _RUNTIME_EVENT_HUB_H 485