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 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 */
145extern 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 */
160class EventHubInterface : public virtual RefBase {
161protected:
162    EventHubInterface() { }
163    virtual ~EventHubInterface() { }
164
165public:
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    virtual bool hasLed(int32_t deviceId, int32_t led) const = 0;
235    virtual void setLedState(int32_t deviceId, int32_t led, bool on) = 0;
236
237    virtual void getVirtualKeyDefinitions(int32_t deviceId,
238            Vector<VirtualKeyDefinition>& outVirtualKeys) const = 0;
239
240    virtual sp<KeyCharacterMap> getKeyCharacterMap(int32_t deviceId) const = 0;
241    virtual bool setKeyboardLayoutOverlay(int32_t deviceId, const sp<KeyCharacterMap>& map) = 0;
242
243    /* Control the vibrator. */
244    virtual void vibrate(int32_t deviceId, nsecs_t duration) = 0;
245    virtual void cancelVibrate(int32_t deviceId) = 0;
246
247    /* Requests the EventHub to reopen all input devices on the next call to getEvents(). */
248    virtual void requestReopenDevices() = 0;
249
250    /* Wakes up getEvents() if it is blocked on a read. */
251    virtual void wake() = 0;
252
253    /* Dump EventHub state to a string. */
254    virtual void dump(String8& dump) = 0;
255
256    /* Called by the heatbeat to ensures that the reader has not deadlocked. */
257    virtual void monitor() = 0;
258};
259
260class EventHub : public EventHubInterface
261{
262public:
263    EventHub();
264
265    virtual uint32_t getDeviceClasses(int32_t deviceId) const;
266
267    virtual InputDeviceIdentifier getDeviceIdentifier(int32_t deviceId) const;
268
269    virtual int32_t getDeviceControllerNumber(int32_t deviceId) const;
270
271    virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const;
272
273    virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
274            RawAbsoluteAxisInfo* outAxisInfo) const;
275
276    virtual bool hasRelativeAxis(int32_t deviceId, int axis) const;
277
278    virtual bool hasInputProperty(int32_t deviceId, int property) const;
279
280    virtual status_t mapKey(int32_t deviceId, int32_t scanCode, int32_t usageCode,
281            int32_t* outKeycode, uint32_t* outFlags) const;
282
283    virtual status_t mapAxis(int32_t deviceId, int32_t scanCode,
284            AxisInfo* outAxisInfo) const;
285
286    virtual void setExcludedDevices(const Vector<String8>& devices);
287
288    virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const;
289    virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const;
290    virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const;
291    virtual status_t getAbsoluteAxisValue(int32_t deviceId, int32_t axis, int32_t* outValue) const;
292
293    virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes,
294            const int32_t* keyCodes, uint8_t* outFlags) const;
295
296    virtual size_t getEvents(int timeoutMillis, RawEvent* buffer, size_t bufferSize);
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            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(String8& dump);
316    virtual void monitor();
317
318protected:
319    virtual ~EventHub();
320
321private:
322    struct Device {
323        Device* next;
324
325        int fd; // may be -1 if device is virtual
326        const int32_t id;
327        const String8 path;
328        const InputDeviceIdentifier identifier;
329
330        uint32_t classes;
331
332        uint8_t keyBitmask[(KEY_MAX + 1) / 8];
333        uint8_t absBitmask[(ABS_MAX + 1) / 8];
334        uint8_t relBitmask[(REL_MAX + 1) / 8];
335        uint8_t swBitmask[(SW_MAX + 1) / 8];
336        uint8_t ledBitmask[(LED_MAX + 1) / 8];
337        uint8_t ffBitmask[(FF_MAX + 1) / 8];
338        uint8_t propBitmask[(INPUT_PROP_MAX + 1) / 8];
339
340        String8 configurationFile;
341        PropertyMap* configuration;
342        VirtualKeyMap* virtualKeyMap;
343        KeyMap keyMap;
344
345        sp<KeyCharacterMap> overlayKeyMap;
346        sp<KeyCharacterMap> combinedKeyMap;
347
348        bool ffEffectPlaying;
349        int16_t ffEffectId; // initially -1
350
351        int32_t controllerNumber;
352
353        int32_t timestampOverrideSec;
354        int32_t timestampOverrideUsec;
355
356        Device(int fd, int32_t id, const String8& path, const InputDeviceIdentifier& identifier);
357        ~Device();
358
359        void close();
360
361        inline bool isVirtual() const { return fd < 0; }
362
363        const sp<KeyCharacterMap>& getKeyCharacterMap() const {
364            if (combinedKeyMap != NULL) {
365                return combinedKeyMap;
366            }
367            return keyMap.keyCharacterMap;
368        }
369    };
370
371    status_t openDeviceLocked(const char *devicePath);
372    void createVirtualKeyboardLocked();
373    void addDeviceLocked(Device* device);
374
375    status_t closeDeviceByPathLocked(const char *devicePath);
376    void closeDeviceLocked(Device* device);
377    void closeAllDevicesLocked();
378
379    status_t scanDirLocked(const char *dirname);
380    void scanDevicesLocked();
381    status_t readNotifyLocked();
382
383    Device* getDeviceLocked(int32_t deviceId) const;
384    Device* getDeviceByPathLocked(const char* devicePath) const;
385
386    bool hasKeycodeLocked(Device* device, int keycode) const;
387
388    void loadConfigurationLocked(Device* device);
389    status_t loadVirtualKeyMapLocked(Device* device);
390    status_t loadKeyMapLocked(Device* device);
391
392    bool isExternalDeviceLocked(Device* device);
393
394    int32_t getNextControllerNumberLocked(Device* device);
395    void releaseControllerNumberLocked(Device* device);
396
397    // Protect all internal state.
398    mutable Mutex mLock;
399
400    // The actual id of the built-in keyboard, or NO_BUILT_IN_KEYBOARD if none.
401    // EventHub remaps the built-in keyboard to id 0 externally as required by the API.
402    enum {
403        // Must not conflict with any other assigned device ids, including
404        // the virtual keyboard id (-1).
405        NO_BUILT_IN_KEYBOARD = -2,
406    };
407    int32_t mBuiltInKeyboardId;
408
409    int32_t mNextDeviceId;
410
411    BitSet32 mControllerNumbers;
412
413    KeyedVector<int32_t, Device*> mDevices;
414
415    Device *mOpeningDevices;
416    Device *mClosingDevices;
417
418    bool mNeedToSendFinishedDeviceScan;
419    bool mNeedToReopenDevices;
420    bool mNeedToScanDevices;
421    Vector<String8> mExcludedDevices;
422
423    int mEpollFd;
424    int mINotifyFd;
425    int mWakeReadPipeFd;
426    int mWakeWritePipeFd;
427
428    // Ids used for epoll notifications not associated with devices.
429    static const uint32_t EPOLL_ID_INOTIFY = 0x80000001;
430    static const uint32_t EPOLL_ID_WAKE = 0x80000002;
431
432    // Epoll FD list size hint.
433    static const int EPOLL_SIZE_HINT = 8;
434
435    // Maximum number of signalled FDs to handle at a time.
436    static const int EPOLL_MAX_EVENTS = 16;
437
438    // The array of pending epoll events and the index of the next event to be handled.
439    struct epoll_event mPendingEventItems[EPOLL_MAX_EVENTS];
440    size_t mPendingEventCount;
441    size_t mPendingEventIndex;
442    bool mPendingINotify;
443};
444
445}; // namespace android
446
447#endif // _RUNTIME_EVENT_HUB_H
448