EventHub.h revision ba421dddfd558b34726df5dfbf8a3bf748e285b1
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 <ui/Input.h> 22#include <ui/Keyboard.h> 23#include <ui/KeyLayoutMap.h> 24#include <ui/KeyCharacterMap.h> 25#include <ui/VirtualKeyMap.h> 26#include <utils/String8.h> 27#include <utils/threads.h> 28#include <utils/Log.h> 29#include <utils/threads.h> 30#include <utils/List.h> 31#include <utils/Errors.h> 32#include <utils/PropertyMap.h> 33#include <utils/Vector.h> 34#include <utils/KeyedVector.h> 35 36#include <linux/input.h> 37#include <sys/epoll.h> 38 39/* Convenience constants. */ 40 41#define BTN_FIRST 0x100 // first button scancode 42#define BTN_LAST 0x15f // last button scancode 43 44namespace android { 45 46/* 47 * A raw event as retrieved from the EventHub. 48 */ 49struct RawEvent { 50 nsecs_t when; 51 int32_t deviceId; 52 int32_t type; 53 int32_t scanCode; 54 int32_t keyCode; 55 int32_t value; 56 uint32_t flags; 57}; 58 59/* Describes an absolute axis. */ 60struct 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 69 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 */ 82enum { 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 is external (not built-in). */ 111 INPUT_DEVICE_CLASS_EXTERNAL = 0x80000000, 112}; 113 114/* 115 * Grand Central Station for events. 116 * 117 * The event hub aggregates input events received across all known input 118 * devices on the system, including devices that may be emulated by the simulator 119 * environment. In addition, the event hub generates fake input events to indicate 120 * when devices are added or removed. 121 * 122 * The event hub provides a stream of input events (via the getEvent function). 123 * It also supports querying the current actual state of input devices such as identifying 124 * which keys are currently down. Finally, the event hub keeps track of the capabilities of 125 * individual input devices, such as their class and the set of key codes that they support. 126 */ 127class EventHubInterface : public virtual RefBase { 128protected: 129 EventHubInterface() { } 130 virtual ~EventHubInterface() { } 131 132public: 133 // Synthetic raw event type codes produced when devices are added or removed. 134 enum { 135 // Sent when a device is added. 136 DEVICE_ADDED = 0x10000000, 137 // Sent when a device is removed. 138 DEVICE_REMOVED = 0x20000000, 139 // Sent when all added/removed devices from the most recent scan have been reported. 140 // This event is always sent at least once. 141 FINISHED_DEVICE_SCAN = 0x30000000, 142 143 FIRST_SYNTHETIC_EVENT = DEVICE_ADDED, 144 }; 145 146 virtual uint32_t getDeviceClasses(int32_t deviceId) const = 0; 147 148 virtual String8 getDeviceName(int32_t deviceId) const = 0; 149 150 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const = 0; 151 152 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis, 153 RawAbsoluteAxisInfo* outAxisInfo) const = 0; 154 155 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const = 0; 156 157 virtual bool hasInputProperty(int32_t deviceId, int property) const = 0; 158 159 virtual status_t mapKey(int32_t deviceId, int scancode, 160 int32_t* outKeycode, uint32_t* outFlags) const = 0; 161 162 virtual status_t mapAxis(int32_t deviceId, int scancode, 163 AxisInfo* outAxisInfo) const = 0; 164 165 // Sets devices that are excluded from opening. 166 // This can be used to ignore input devices for sensors. 167 virtual void setExcludedDevices(const Vector<String8>& devices) = 0; 168 169 /* 170 * Wait for events to become available and returns them. 171 * After returning, the EventHub holds onto a wake lock until the next call to getEvent. 172 * This ensures that the device will not go to sleep while the event is being processed. 173 * If the device needs to remain awake longer than that, then the caller is responsible 174 * for taking care of it (say, by poking the power manager user activity timer). 175 * 176 * The timeout is advisory only. If the device is asleep, it will not wake just to 177 * service the timeout. 178 * 179 * Returns the number of events obtained, or 0 if the timeout expired. 180 */ 181 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize) = 0; 182 183 /* 184 * Query current input state. 185 */ 186 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const = 0; 187 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const = 0; 188 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const = 0; 189 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis, 190 int32_t* outValue) const = 0; 191 192 /* 193 * Examine key input devices for specific framework keycode support 194 */ 195 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes, 196 uint8_t* outFlags) const = 0; 197 198 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const = 0; 199 virtual bool hasLed(int32_t deviceId, int32_t led) const = 0; 200 virtual void setLedState(int32_t deviceId, int32_t led, bool on) = 0; 201 202 virtual void getVirtualKeyDefinitions(int32_t deviceId, 203 Vector<VirtualKeyDefinition>& outVirtualKeys) const = 0; 204 205 /* Requests the EventHub to reopen all input devices on the next call to getEvents(). */ 206 virtual void requestReopenDevices() = 0; 207 208 /* Wakes up getEvents() if it is blocked on a read. */ 209 virtual void wake() = 0; 210 211 virtual void dump(String8& dump) = 0; 212}; 213 214class EventHub : public EventHubInterface 215{ 216public: 217 EventHub(); 218 219 virtual uint32_t getDeviceClasses(int32_t deviceId) const; 220 221 virtual String8 getDeviceName(int32_t deviceId) const; 222 223 virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const; 224 225 virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis, 226 RawAbsoluteAxisInfo* outAxisInfo) const; 227 228 virtual bool hasRelativeAxis(int32_t deviceId, int axis) const; 229 230 virtual bool hasInputProperty(int32_t deviceId, int property) const; 231 232 virtual status_t mapKey(int32_t deviceId, int scancode, 233 int32_t* outKeycode, uint32_t* outFlags) const; 234 235 virtual status_t mapAxis(int32_t deviceId, int scancode, 236 AxisInfo* outAxisInfo) const; 237 238 virtual void setExcludedDevices(const Vector<String8>& devices); 239 240 virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const; 241 virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const; 242 virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const; 243 virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis, int32_t* outValue) const; 244 245 virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, 246 const int32_t* keyCodes, uint8_t* outFlags) const; 247 248 virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize); 249 250 virtual bool hasScanCode(int32_t deviceId, int32_t scanCode) const; 251 virtual bool hasLed(int32_t deviceId, int32_t led) const; 252 virtual void setLedState(int32_t deviceId, int32_t led, bool on); 253 254 virtual void getVirtualKeyDefinitions(int32_t deviceId, 255 Vector<VirtualKeyDefinition>& outVirtualKeys) const; 256 257 virtual void requestReopenDevices(); 258 259 virtual void wake(); 260 261 virtual void dump(String8& dump); 262 263protected: 264 virtual ~EventHub(); 265 266private: 267 struct Device { 268 Device* next; 269 270 int fd; 271 const int32_t id; 272 const String8 path; 273 const InputDeviceIdentifier identifier; 274 275 uint32_t classes; 276 277 uint8_t keyBitmask[(KEY_MAX + 1) / 8]; 278 uint8_t absBitmask[(ABS_MAX + 1) / 8]; 279 uint8_t relBitmask[(REL_MAX + 1) / 8]; 280 uint8_t swBitmask[(SW_MAX + 1) / 8]; 281 uint8_t ledBitmask[(LED_MAX + 1) / 8]; 282 uint8_t propBitmask[(INPUT_PROP_MAX + 1) / 8]; 283 284 String8 configurationFile; 285 PropertyMap* configuration; 286 VirtualKeyMap* virtualKeyMap; 287 KeyMap keyMap; 288 289 Device(int fd, int32_t id, const String8& path, const InputDeviceIdentifier& identifier); 290 ~Device(); 291 292 void close(); 293 }; 294 295 status_t openDeviceLocked(const char *devicePath); 296 status_t closeDeviceByPathLocked(const char *devicePath); 297 298 void closeDeviceLocked(Device* device); 299 void closeAllDevicesLocked(); 300 301 status_t scanDirLocked(const char *dirname); 302 void scanDevicesLocked(); 303 status_t readNotifyLocked(); 304 305 Device* getDeviceLocked(int32_t deviceId) const; 306 Device* getDeviceByPathLocked(const char* devicePath) const; 307 308 bool hasKeycodeLocked(Device* device, int keycode) const; 309 310 void loadConfigurationLocked(Device* device); 311 status_t loadVirtualKeyMapLocked(Device* device); 312 status_t loadKeyMapLocked(Device* device); 313 void setKeyboardPropertiesLocked(Device* device, bool builtInKeyboard); 314 void clearKeyboardPropertiesLocked(Device* device, bool builtInKeyboard); 315 316 bool isExternalDeviceLocked(Device* device); 317 318 // Protect all internal state. 319 mutable Mutex mLock; 320 321 // The actual id of the built-in keyboard, or -1 if none. 322 // EventHub remaps the built-in keyboard to id 0 externally as required by the API. 323 int32_t mBuiltInKeyboardId; 324 325 int32_t mNextDeviceId; 326 327 KeyedVector<int32_t, Device*> mDevices; 328 329 Device *mOpeningDevices; 330 Device *mClosingDevices; 331 332 bool mNeedToSendFinishedDeviceScan; 333 bool mNeedToReopenDevices; 334 bool mNeedToScanDevices; 335 Vector<String8> mExcludedDevices; 336 337 int mEpollFd; 338 int mINotifyFd; 339 int mWakeReadPipeFd; 340 int mWakeWritePipeFd; 341 342 // Ids used for epoll notifications not associated with devices. 343 static const uint32_t EPOLL_ID_INOTIFY = 0x80000001; 344 static const uint32_t EPOLL_ID_WAKE = 0x80000002; 345 346 // Epoll FD list size hint. 347 static const int EPOLL_SIZE_HINT = 8; 348 349 // Maximum number of signalled FDs to handle at a time. 350 static const int EPOLL_MAX_EVENTS = 16; 351 352 // The array of pending epoll events and the index of the next event to be handled. 353 struct epoll_event mPendingEventItems[EPOLL_MAX_EVENTS]; 354 size_t mPendingEventCount; 355 size_t mPendingEventIndex; 356 bool mPendingINotify; 357 358 // Set to the number of CPUs. 359 int32_t mNumCpus; 360}; 361 362}; // namespace android 363 364#endif // _RUNTIME_EVENT_HUB_H 365