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