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