EventHub.h revision cc0c159e9b3dd4e0f48da0ce3e33d2c68a651413 
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
131/*
132 * Grand Central Station for events.
133 *
134 * The event hub aggregates input events received across all known input
135 * devices on the system, including devices that may be emulated by the simulator
136 * environment.  In addition, the event hub generates fake input events to indicate
137 * when devices are added or removed.
138 *
139 * The event hub provides a stream of input events (via the getEvent function).
140 * It also supports querying the current actual state of input devices such as identifying
141 * which keys are currently down.  Finally, the event hub keeps track of the capabilities of
142 * individual input devices, such as their class and the set of key codes that they support.
143 */
144class EventHubInterface : public virtual RefBase {
145protected:
146    EventHubInterface() { }
147    virtual ~EventHubInterface() { }
148
149public:
150    // Synthetic raw event type codes produced when devices are added or removed.
151    enum {
152        // Sent when a device is added.
153        DEVICE_ADDED = 0x10000000,
154        // Sent when a device is removed.
155        DEVICE_REMOVED = 0x20000000,
156        // Sent when all added/removed devices from the most recent scan have been reported.
157        // This event is always sent at least once.
158        FINISHED_DEVICE_SCAN = 0x30000000,
159    };
160
161    virtual uint32_t getDeviceClasses(int32_t deviceId) const = 0;
162
163    virtual String8 getDeviceName(int32_t deviceId) const = 0;
164
165    virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const = 0;
166
167    virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
168            RawAbsoluteAxisInfo* outAxisInfo) const = 0;
169
170    virtual bool hasRelativeAxis(int32_t deviceId, int axis) const = 0;
171
172    virtual status_t mapKey(int32_t deviceId, int scancode,
173            int32_t* outKeycode, uint32_t* outFlags) const = 0;
174
175    virtual status_t mapAxis(int32_t deviceId, int scancode,
176            int32_t* outAxis) const = 0;
177
178    // exclude a particular device from opening
179    // this can be used to ignore input devices for sensors
180    virtual void addExcludedDevice(const char* deviceName) = 0;
181
182    /*
183     * Wait for the next event to become available and return it.
184     * After returning, the EventHub holds onto a wake lock until the next call to getEvent.
185     * This ensures that the device will not go to sleep while the event is being processed.
186     * If the device needs to remain awake longer than that, then the caller is responsible
187     * for taking care of it (say, by poking the power manager user activity timer).
188     */
189    virtual bool getEvent(RawEvent* outEvent) = 0;
190
191    /*
192     * Query current input state.
193     */
194    virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const = 0;
195    virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const = 0;
196    virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const = 0;
197
198    /*
199     * Examine key input devices for specific framework keycode support
200     */
201    virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes, const int32_t* keyCodes,
202            uint8_t* outFlags) const = 0;
203
204    virtual bool hasLed(int32_t deviceId, int32_t led) const = 0;
205    virtual void setLedState(int32_t deviceId, int32_t led, bool on) = 0;
206
207    virtual void getVirtualKeyDefinitions(int32_t deviceId,
208            Vector<VirtualKeyDefinition>& outVirtualKeys) const = 0;
209
210    virtual void dump(String8& dump) = 0;
211};
212
213class EventHub : public EventHubInterface
214{
215public:
216    EventHub();
217
218    status_t errorCheck() const;
219
220    virtual uint32_t getDeviceClasses(int32_t deviceId) const;
221
222    virtual String8 getDeviceName(int32_t deviceId) const;
223
224    virtual void getConfiguration(int32_t deviceId, PropertyMap* outConfiguration) const;
225
226    virtual status_t getAbsoluteAxisInfo(int32_t deviceId, int axis,
227            RawAbsoluteAxisInfo* outAxisInfo) const;
228
229    virtual bool hasRelativeAxis(int32_t deviceId, int axis) const;
230
231    virtual status_t mapKey(int32_t deviceId, int scancode,
232            int32_t* outKeycode, uint32_t* outFlags) const;
233
234    virtual status_t mapAxis(int32_t deviceId, int scancode,
235            int32_t* outAxis) const;
236
237    virtual void addExcludedDevice(const char* deviceName);
238
239    virtual int32_t getScanCodeState(int32_t deviceId, int32_t scanCode) const;
240    virtual int32_t getKeyCodeState(int32_t deviceId, int32_t keyCode) const;
241    virtual int32_t getSwitchState(int32_t deviceId, int32_t sw) const;
242
243    virtual bool markSupportedKeyCodes(int32_t deviceId, size_t numCodes,
244            const int32_t* keyCodes, uint8_t* outFlags) const;
245
246    virtual bool getEvent(RawEvent* outEvent);
247
248    virtual bool hasLed(int32_t deviceId, int32_t led) const;
249    virtual void setLedState(int32_t deviceId, int32_t led, bool on);
250
251    virtual void getVirtualKeyDefinitions(int32_t deviceId,
252            Vector<VirtualKeyDefinition>& outVirtualKeys) const;
253
254    virtual void dump(String8& dump);
255
256protected:
257    virtual ~EventHub();
258
259private:
260    bool openPlatformInput(void);
261
262    int openDevice(const char *devicePath);
263    int closeDevice(const char *devicePath);
264    int scanDir(const char *dirname);
265    int readNotify(int nfd);
266
267    status_t mError;
268
269    struct Device {
270        Device* next;
271
272        int fd;
273        const int32_t id;
274        const String8 path;
275        const InputDeviceIdentifier identifier;
276
277        uint32_t classes;
278        uint8_t* keyBitmask;
279        uint8_t* relBitmask;
280        String8 configurationFile;
281        PropertyMap* configuration;
282        VirtualKeyMap* virtualKeyMap;
283        KeyMap keyMap;
284
285        Device(int fd, int32_t id, const String8& path, const InputDeviceIdentifier& identifier);
286        ~Device();
287
288        void close();
289    };
290
291    Device* getDeviceLocked(int32_t deviceId) const;
292    bool hasKeycodeLocked(Device* device, int keycode) const;
293
294    int32_t getScanCodeStateLocked(Device* device, int32_t scanCode) const;
295    int32_t getKeyCodeStateLocked(Device* device, int32_t keyCode) const;
296    int32_t getSwitchStateLocked(Device* device, int32_t sw) const;
297    bool markSupportedKeyCodesLocked(Device* device, size_t numCodes,
298            const int32_t* keyCodes, uint8_t* outFlags) const;
299
300    void loadConfiguration(Device* device);
301    status_t loadVirtualKeyMap(Device* device);
302    status_t loadKeyMap(Device* device);
303    void setKeyboardProperties(Device* device, bool builtInKeyboard);
304    void clearKeyboardProperties(Device* device, bool builtInKeyboard);
305
306    // Protect all internal state.
307    mutable Mutex mLock;
308
309    // The actual id of the built-in keyboard, or -1 if none.
310    // EventHub remaps the built-in keyboard to id 0 externally as required by the API.
311    int32_t mBuiltInKeyboardId;
312
313    int32_t mNextDeviceId;
314
315    // Parallel arrays of fds and devices.
316    // First index is reserved for inotify.
317    Vector<struct pollfd> mFds;
318    Vector<Device*> mDevices;
319
320    Device *mOpeningDevices;
321    Device *mClosingDevices;
322
323    bool mOpened;
324    bool mNeedToSendFinishedDeviceScan;
325    List<String8> mExcludedDevices;
326
327    // device ids that report particular switches.
328    int32_t mSwitches[SW_MAX + 1];
329
330    static const int INPUT_BUFFER_SIZE = 64;
331    struct input_event mInputBufferData[INPUT_BUFFER_SIZE];
332    size_t mInputBufferIndex;
333    size_t mInputBufferCount;
334    size_t mInputFdIndex;
335};
336
337}; // namespace android
338
339#endif // _RUNTIME_EVENT_HUB_H
340