EventHub.h revision 56194ebec6212e229f4ccdaa4b187166d20013ef 
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
35#include <linux/input.h>
36
37/* These constants are not defined in linux/input.h but they are part of the multitouch
38 * input protocol. */
39
40#define ABS_MT_TOUCH_MAJOR 0x30  /* Major axis of touching ellipse */
41#define ABS_MT_TOUCH_MINOR 0x31  /* Minor axis (omit if circular) */
42#define ABS_MT_WIDTH_MAJOR 0x32  /* Major axis of approaching ellipse */
43#define ABS_MT_WIDTH_MINOR 0x33  /* Minor axis (omit if circular) */
44#define ABS_MT_ORIENTATION 0x34  /* Ellipse orientation */
45#define ABS_MT_POSITION_X 0x35   /* Center X ellipse position */
46#define ABS_MT_POSITION_Y 0x36   /* Center Y ellipse position */
47#define ABS_MT_TOOL_TYPE 0x37    /* Type of touching device (finger, pen, ...) */
48#define ABS_MT_BLOB_ID 0x38      /* Group a set of packets as a blob */
49#define ABS_MT_TRACKING_ID 0x39  /* Unique ID of initiated contact */
50#define ABS_MT_PRESSURE 0x3a     /* Pressure on contact area */
51
52#define MT_TOOL_FINGER 0 /* Identifies a finger */
53#define MT_TOOL_PEN 1    /* Identifies a pen */
54
55#define SYN_MT_REPORT 2
56
57/* Convenience constants. */
58
59#define BTN_FIRST 0x100  // first button scancode
60#define BTN_LAST 0x15f   // last button scancode
61
62struct pollfd;
63
64namespace android {
65
66/*
67 * A raw event as retrieved from the EventHub.
68 */
69struct RawEvent {
70    nsecs_t when;
71    int32_t deviceId;
72    int32_t type;
73    int32_t scanCode;
74    int32_t keyCode;
75    int32_t value;
76    uint32_t flags;
77};
78
79/* Describes an absolute axis. */
80struct RawAbsoluteAxisInfo {
81    bool valid; // true if the information is valid, false otherwise
82
83    int32_t minValue;  // minimum value
84    int32_t maxValue;  // maximum value
85    int32_t flat;      // center flat position, eg. flat == 8 means center is between -8 and 8
86    int32_t fuzz;      // error tolerance, eg. fuzz == 4 means value is +/- 4 due to noise
87
88    inline int32_t getRange() const { return maxValue - minValue; }
89
90    inline void clear() {
91        valid = false;
92        minValue = 0;
93        maxValue = 0;
94        flat = 0;
95        fuzz = 0;
96    }
97};
98
99/*
100 * Input device classes.
101 */
102enum {
103    /* The input device is a keyboard or has buttons. */
104    INPUT_DEVICE_CLASS_KEYBOARD      = 0x00000001,
105
106    /* The input device is an alpha-numeric keyboard (not just a dial pad). */
107    INPUT_DEVICE_CLASS_ALPHAKEY      = 0x00000002,
108
109    /* The input device is a touchscreen or a touchpad (either single-touch or multi-touch). */
110    INPUT_DEVICE_CLASS_TOUCH         = 0x00000004,
111
112    /* The input device is a cursor device such as a trackball or mouse. */
113    INPUT_DEVICE_CLASS_CURSOR        = 0x00000008,
114
115    /* The input device is a multi-touch touchscreen. */
116    INPUT_DEVICE_CLASS_TOUCH_MT      = 0x00000010,
117
118    /* The input device is a directional pad (implies keyboard, has DPAD keys). */
119    INPUT_DEVICE_CLASS_DPAD          = 0x00000020,
120
121    /* The input device is a gamepad (implies keyboard, has BUTTON keys). */
122    INPUT_DEVICE_CLASS_GAMEPAD       = 0x00000040,
123
124    /* The input device has switches. */
125    INPUT_DEVICE_CLASS_SWITCH        = 0x00000080,
126
127    /* The input device is a joystick (implies gamepad, has joystick absolute axes). */
128    INPUT_DEVICE_CLASS_JOYSTICK      = 0x00000100,
129
130    /* The input device is external (not built-in). */
131    INPUT_DEVICE_CLASS_EXTERNAL      = 0x80000000,
132};
133
134/*
135 * Grand Central Station for events.
136 *
137 * The event hub aggregates input events received across all known input
138 * devices on the system, including devices that may be emulated by the simulator
139 * environment.  In addition, the event hub generates fake input events to indicate
140 * when devices are added or removed.
141 *
142 * The event hub provides a stream of input events (via the getEvent function).
143 * It also supports querying the current actual state of input devices such as identifying
144 * which keys are currently down.  Finally, the event hub keeps track of the capabilities of
145 * individual input devices, such as their class and the set of key codes that they support.
146 */
147class EventHubInterface : public virtual RefBase {
148protected:
149    EventHubInterface() { }
150    virtual ~EventHubInterface() { }
151
152public:
153    // Synthetic raw event type codes produced when devices are added or removed.
154    enum {
155        // Sent when a device is added.
156        DEVICE_ADDED = 0x10000000,
157        // Sent when a device is removed.
158        DEVICE_REMOVED = 0x20000000,
159        // Sent when all added/removed devices from the most recent scan have been reported.
160        // This event is always sent at least once.
161        FINISHED_DEVICE_SCAN = 0x30000000,
162    };
163
164    virtual uint32_t getDeviceClasses(int32_t deviceId) const = 0;
165
166    virtual String8 getDeviceName(int32_t deviceId) const = 0;
167
168    virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const = 0;
169
170    virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
171            RawAbsoluteAxisInfo* outAxisInfo) const = 0;
172
173    virtual bool hasRelativeAxis(int32_t deviceId, int axis) const = 0;
174
175    virtual status_t mapKey(int32_t deviceId, int scancode,
176            int32_t* outKeycode, uint32_t* outFlags) const = 0;
177
178    virtual status_t mapAxis(int32_t deviceId, int scancode,
179            int32_t* outAxis) const = 0;
180
181    // exclude a particular device from opening
182    // this can be used to ignore input devices for sensors
183    virtual void addExcludedDevice(const char* deviceName) = 0;
184
185    /*
186     * Wait for the next event to become available and return it.
187     * After returning, the EventHub holds onto a wake lock until the next call to getEvent.
188     * This ensures that the device will not go to sleep while the event is being processed.
189     * If the device needs to remain awake longer than that, then the caller is responsible
190     * for taking care of it (say, by poking the power manager user activity timer).
191     */
192    virtual bool getEvent(RawEvent* outEvent) = 0;
193
194    /*
195     * Query current input state.
196     */
197    virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const = 0;
198    virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const = 0;
199    virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const = 0;
200
201    /*
202     * Examine key input devices for specific framework keycode support
203     */
204    virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes,
205            uint8_t* outFlags) const = 0;
206
207    virtual bool hasLed(int32_t deviceId, int32_t led) const = 0;
208    virtual void setLedState(int32_t deviceId, int32_t led, bool on) = 0;
209
210    virtual void getVirtualKeyDefinitions(int32_t deviceId,
211            Vector<VirtualKeyDefinition>& outVirtualKeys) const = 0;
212
213    virtual void dump(String8& dump) = 0;
214};
215
216class EventHub : public EventHubInterface
217{
218public:
219    EventHub();
220
221    status_t errorCheck() const;
222
223    virtual uint32_t getDeviceClasses(int32_t deviceId) const;
224
225    virtual String8 getDeviceName(int32_t deviceId) const;
226
227    virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const;
228
229    virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
230            RawAbsoluteAxisInfo* outAxisInfo) const;
231
232    virtual bool hasRelativeAxis(int32_t deviceId, int axis) const;
233
234    virtual status_t mapKey(int32_t deviceId, int scancode,
235            int32_t* outKeycode, uint32_t* outFlags) const;
236
237    virtual status_t mapAxis(int32_t deviceId, int scancode,
238            int32_t* outAxis) const;
239
240    virtual void addExcludedDevice(const char* deviceName);
241
242    virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const;
243    virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const;
244    virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const;
245
246    virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes,
247            const int32_t* keyCodes, uint8_t* outFlags) const;
248
249    virtual bool getEvent(RawEvent* outEvent);
250
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 dump(String8& dump);
258
259protected:
260    virtual ~EventHub();
261
262private:
263    bool openPlatformInput(void);
264
265    int openDevice(const char *devicePath);
266    int closeDevice(const char *devicePath);
267    int closeDeviceAtIndexLocked(int index);
268    int scanDir(const char *dirname);
269    int readNotify(int nfd);
270
271    status_t mError;
272
273    struct Device {
274        Device* next;
275
276        int fd;
277        const int32_t id;
278        const String8 path;
279        const InputDeviceIdentifier identifier;
280
281        uint32_t classes;
282        uint8_t* keyBitmask;
283        uint8_t* relBitmask;
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    Device* getDeviceLocked(int32_t deviceId) const;
296    bool hasKeycodeLocked(Device* device, int keycode) const;
297
298    int32_t getScanCodeStateLocked(Device* device, int32_t scanCode) const;
299    int32_t getKeyCodeStateLocked(Device* device, int32_t keyCode) const;
300    int32_t getSwitchStateLocked(Device* device, int32_t sw) const;
301    bool markSupportedKeyCodesLocked(Device* device, size_t numCodes,
302            const int32_t* keyCodes, uint8_t* outFlags) const;
303
304    void loadConfiguration(Device* device);
305    status_t loadVirtualKeyMap(Device* device);
306    status_t loadKeyMap(Device* device);
307    void setKeyboardProperties(Device* device, bool builtInKeyboard);
308    void clearKeyboardProperties(Device* device, bool builtInKeyboard);
309
310    bool isExternalDevice(Device* device);
311
312    // Protect all internal state.
313    mutable Mutex mLock;
314
315    // The actual id of the built-in keyboard, or -1 if none.
316    // EventHub remaps the built-in keyboard to id 0 externally as required by the API.
317    int32_t mBuiltInKeyboardId;
318
319    int32_t mNextDeviceId;
320
321    // Parallel arrays of fds and devices.
322    // First index is reserved for inotify.
323    Vector<struct pollfd> mFds;
324    Vector<Device*> mDevices;
325
326    Device *mOpeningDevices;
327    Device *mClosingDevices;
328
329    bool mOpened;
330    bool mNeedToSendFinishedDeviceScan;
331    List<String8> mExcludedDevices;
332
333    // device ids that report particular switches.
334    int32_t mSwitches[SW_MAX + 1];
335
336    static const int INPUT_BUFFER_SIZE = 64;
337    struct input_event mInputBufferData[INPUT_BUFFER_SIZE];
338    size_t mInputBufferIndex;
339    size_t mInputBufferCount;
340    size_t mInputFdIndex;
341};
342
343}; // namespace android
344
345#endif // _RUNTIME_EVENT_HUB_H
346