EventHub.h revision ac72bbf4e46d6689070df09a25db2960a9036eb2
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 60namespace android { 61 62enum { 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 */ 72struct 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. */ 81struct 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 90 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 */ 103enum { 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 has a microphone. */ 135 INPUT_DEVICE_CLASS_MIC = 0x00000400, 136 137 /* The input device is an external stylus (has data we want to fuse with touch data). */ 138 INPUT_DEVICE_CLASS_EXTERNAL_STYLUS = 0x00000800, 139 140 /* The input device has a rotary encoder */ 141 INPUT_DEVICE_CLASS_ROTARY_ENCODER = 0x00001000, 142 143 /* The input device is virtual (not a real device, not part of UI configuration). */ 144 INPUT_DEVICE_CLASS_VIRTUAL = 0x40000000, 145 146 /* The input device is external (not built-in). */ 147 INPUT_DEVICE_CLASS_EXTERNAL = 0x80000000, 148}; 149 150/* 151 * Gets the class that owns an axis, in cases where multiple classes might claim 152 * the same axis for different purposes. 153 */ 154extern uint32_t getAbsAxisUsage(int32_t axis, uint32_t deviceClasses); 155 156/* 157 * Grand Central Station for events. 158 * 159 * The event hub aggregates input events received across all known input 160 * devices on the system, including devices that may be emulated by the simulator 161 * environment. In addition, the event hub generates fake input events to indicate 162 * when devices are added or removed. 163 * 164 * The event hub provides a stream of input events (via the getEvent function). 165 * It also supports querying the current actual state of input devices such as identifying 166 * which keys are currently down. Finally, the event hub keeps track of the capabilities of 167 * individual input devices, such as their class and the set of key codes that they support. 168 */ 169class EventHubInterface : public virtual RefBase { 170protected: 171 EventHubInterface() { } 172 virtual ~EventHubInterface() { } 173 174public: 175 // Synthetic raw event type codes produced when devices are added or removed. 176 enum { 177 // Sent when a device is added. 178 DEVICE_ADDED = 0x10000000, 179 // Sent when a device is removed. 180 DEVICE_REMOVED = 0x20000000, 181 // Sent when all added/removed devices from the most recent scan have been reported. 182 // This event is always sent at least once. 183 FINISHED_DEVICE_SCAN = 0x30000000, 184 185 FIRST_SYNTHETIC_EVENT = DEVICE_ADDED, 186 }; 187 188 virtual uint32_t getDeviceClasses(int32_t deviceId) const = 0; 189 190 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const = 0; 191 192 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const = 0; 193 194 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const = 0; 195 196 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis, 197 RawAbsoluteAxisInfo* outAxisInfo) const = 0; 198 199 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const = 0; 200 201 virtual bool hasInputProperty(int32_t deviceId, int property) const = 0; 202 203 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode, 204 int32_t* outKeycode, uint32_t* outFlags) const = 0; 205 206 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode, 207 AxisInfo* outAxisInfo) const = 0; 208 209 // Sets devices that are excluded from opening. 210 // This can be used to ignore input devices for sensors. 211 virtual void setExcludedDevices(const Vector<String8>& devices) = 0; 212 213 /* 214 * Wait for events to become available and returns them. 215 * After returning, the EventHub holds onto a wake lock until the next call to getEvent. 216 * This ensures that the device will not go to sleep while the event is being processed. 217 * If the device needs to remain awake longer than that, then the caller is responsible 218 * for taking care of it (say, by poking the power manager user activity timer). 219 * 220 * The timeout is advisory only. If the device is asleep, it will not wake just to 221 * service the timeout. 222 * 223 * Returns the number of events obtained, or 0 if the timeout expired. 224 */ 225 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize) = 0; 226 227 /* 228 * Query current input state. 229 */ 230 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const = 0; 231 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const = 0; 232 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const = 0; 233 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis, 234 int32_t* outValue) const = 0; 235 236 /* 237 * Examine key input devices for specific framework keycode support 238 */ 239 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes, 240 uint8_t* outFlags) const = 0; 241 242 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const = 0; 243 244 /* LED related functions expect Android LED constants, not scan codes or HID usages */ 245 virtual bool hasLed(int32_t deviceId, int32_t led) const = 0; 246 virtual void setLedState(int32_t deviceId, int32_t led, bool on) = 0; 247 248 virtual void getVirtualKeyDefinitions(int32_t deviceId, 249 Vector<VirtualKeyDefinition>& outVirtualKeys) const = 0; 250 251 virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const = 0; 252 virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map) = 0; 253 254 /* Control the vibrator. */ 255 virtual void vibrate(int32_t deviceId, nsecs_t duration) = 0; 256 virtual void cancelVibrate(int32_t deviceId) = 0; 257 258 /* Requests the EventHub to reopen all input devices on the next call to getEvents(). */ 259 virtual void requestReopenDevices() = 0; 260 261 /* Wakes up getEvents() if it is blocked on a read. */ 262 virtual void wake() = 0; 263 264 /* Dump EventHub state to a string. */ 265 virtual void dump(String8& dump) = 0; 266 267 /* Called by the heatbeat to ensures that the reader has not deadlocked. */ 268 virtual void monitor() = 0; 269}; 270 271class EventHub : public EventHubInterface 272{ 273public: 274 EventHub(); 275 276 virtual uint32_t getDeviceClasses(int32_t deviceId) const; 277 278 virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const; 279 280 virtual int32_t getDeviceControllerNumber(int32_t deviceId) const; 281 282 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const; 283 284 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis, 285 RawAbsoluteAxisInfo* outAxisInfo) const; 286 287 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const; 288 289 virtual bool hasInputProperty(int32_t deviceId, int property) const; 290 291 virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode, 292 int32_t* outKeycode, uint32_t* outFlags) const; 293 294 virtual status_t mapAxis(int32_t deviceId, int32_t scanCode, 295 AxisInfo* outAxisInfo) const; 296 297 virtual void setExcludedDevices(const Vector<String8>& devices); 298 299 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const; 300 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const; 301 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const; 302 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis, int32_t* outValue) const; 303 304 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, 305 const int32_t* keyCodes, uint8_t* outFlags) const; 306 307 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize); 308 309 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const; 310 virtual bool hasLed(int32_t deviceId, int32_t led) const; 311 virtual void setLedState(int32_t deviceId, int32_t led, bool on); 312 313 virtual void getVirtualKeyDefinitions(int32_t deviceId, 314 Vector<VirtualKeyDefinition>& outVirtualKeys) const; 315 316 virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const; 317 virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map); 318 319 virtual void vibrate(int32_t deviceId, nsecs_t duration); 320 virtual void cancelVibrate(int32_t deviceId); 321 322 virtual void requestReopenDevices(); 323 324 virtual void wake(); 325 326 virtual void dump(String8& dump); 327 virtual void monitor(); 328 329protected: 330 virtual ~EventHub(); 331 332private: 333 struct Device { 334 Device* next; 335 336 int fd; // may be -1 if device is virtual 337 const int32_t id; 338 const String8 path; 339 const InputDeviceIdentifier identifier; 340 341 uint32_t classes; 342 343 uint8_t keyBitmask[(KEY_MAX + 1) / 8]; 344 uint8_t absBitmask[(ABS_MAX + 1) / 8]; 345 uint8_t relBitmask[(REL_MAX + 1) / 8]; 346 uint8_t swBitmask[(SW_MAX + 1) / 8]; 347 uint8_t ledBitmask[(LED_MAX + 1) / 8]; 348 uint8_t ffBitmask[(FF_MAX + 1) / 8]; 349 uint8_t propBitmask[(INPUT_PROP_MAX + 1) / 8]; 350 351 String8 configurationFile; 352 PropertyMap* configuration; 353 VirtualKeyMap* virtualKeyMap; 354 KeyMap keyMap; 355 356 sp<KeyCharacterMap> overlayKeyMap; 357 sp<KeyCharacterMap> combinedKeyMap; 358 359 bool ffEffectPlaying; 360 int16_t ffEffectId; // initially -1 361 362 int32_t controllerNumber; 363 364 int32_t timestampOverrideSec; 365 int32_t timestampOverrideUsec; 366 367 Device(int fd, int32_t id, const String8& path, const InputDeviceIdentifier& identifier); 368 ~Device(); 369 370 void close(); 371 372 inline bool isVirtual() const { return fd < 0; } 373 374 const sp<KeyCharacterMap>& getKeyCharacterMap() const { 375 if (combinedKeyMap != NULL) { 376 return combinedKeyMap; 377 } 378 return keyMap.keyCharacterMap; 379 } 380 }; 381 382 status_t openDeviceLocked(const char *devicePath); 383 void createVirtualKeyboardLocked(); 384 void addDeviceLocked(Device* device); 385 void assignDescriptorLocked(InputDeviceIdentifier& identifier); 386 387 status_t closeDeviceByPathLocked(const char *devicePath); 388 void closeDeviceLocked(Device* device); 389 void closeAllDevicesLocked(); 390 391 status_t scanDirLocked(const char *dirname); 392 void scanDevicesLocked(); 393 status_t readNotifyLocked(); 394 395 Device* getDeviceByDescriptorLocked(String8& descriptor) const; 396 Device* getDeviceLocked(int32_t deviceId) const; 397 Device* getDeviceByPathLocked(const char* devicePath) const; 398 399 bool hasKeycodeLocked(Device* device, int keycode) const; 400 401 void loadConfigurationLocked(Device* device); 402 status_t loadVirtualKeyMapLocked(Device* device); 403 status_t loadKeyMapLocked(Device* device); 404 405 bool isExternalDeviceLocked(Device* device); 406 bool deviceHasMicLocked(Device* device); 407 408 int32_t getNextControllerNumberLocked(Device* device); 409 void releaseControllerNumberLocked(Device* device); 410 void setLedForController(Device* device); 411 412 status_t mapLed(Device* device, int32_t led, int32_t* outScanCode) const; 413 void setLedStateLocked(Device* device, int32_t led, bool on); 414 415 // Protect all internal state. 416 mutable Mutex mLock; 417 418 // The actual id of the built-in keyboard, or NO_BUILT_IN_KEYBOARD if none. 419 // EventHub remaps the built-in keyboard to id 0 externally as required by the API. 420 enum { 421 // Must not conflict with any other assigned device ids, including 422 // the virtual keyboard id (-1). 423 NO_BUILT_IN_KEYBOARD = -2, 424 }; 425 int32_t mBuiltInKeyboardId; 426 427 int32_t mNextDeviceId; 428 429 BitSet32 mControllerNumbers; 430 431 KeyedVector<int32_t, Device*> mDevices; 432 433 Device *mOpeningDevices; 434 Device *mClosingDevices; 435 436 bool mNeedToSendFinishedDeviceScan; 437 bool mNeedToReopenDevices; 438 bool mNeedToScanDevices; 439 Vector<String8> mExcludedDevices; 440 441 int mEpollFd; 442 int mINotifyFd; 443 int mWakeReadPipeFd; 444 int mWakeWritePipeFd; 445 446 // Ids used for epoll notifications not associated with devices. 447 static const uint32_t EPOLL_ID_INOTIFY = 0x80000001; 448 static const uint32_t EPOLL_ID_WAKE = 0x80000002; 449 450 // Epoll FD list size hint. 451 static const int EPOLL_SIZE_HINT = 8; 452 453 // Maximum number of signalled FDs to handle at a time. 454 static const int EPOLL_MAX_EVENTS = 16; 455 456 // The array of pending epoll events and the index of the next event to be handled. 457 struct epoll_event mPendingEventItems[EPOLL_MAX_EVENTS]; 458 size_t mPendingEventCount; 459 size_t mPendingEventIndex; 460 bool mPendingINotify; 461 462 bool mUsingEpollWakeup; 463}; 464 465}; // namespace android 466 467#endif // _RUNTIME_EVENT_HUB_H 468