Input: add open and close methods for polled devices
[safe/jmp/linux-2.6] / include / linux / input-polldev.h
1 #ifndef _INPUT_POLLDEV_H
2 #define _INPUT_POLLDEV_H
3
4 /*
5  * Copyright (c) 2007 Dmitry Torokhov
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License version 2 as published by
9  * the Free Software Foundation.
10  */
11
12 #include <linux/input.h>
13 #include <linux/workqueue.h>
14
15 /**
16  * struct input_polled_dev - simple polled input device
17  * @private: private driver data.
18  * @open: driver-supplied method that prepares device for polling
19  *      (enabled the device and maybe flushes device state).
20  * @close: driver-supplied method that is called when device is no
21  *      longer being polled. Used to put device into low power mode.
22  * @poll: driver-supplied method that polls the device and posts
23  *      input events (mandatory).
24  * @poll_interval: specifies how often the poll() method shoudl be called.
25  * @input: input device structire associated with the polled device.
26  *      Must be properly initialized by the driver (id, name, phys, bits).
27  *
28  * Polled input device provides a skeleton for supporting simple input
29  * devices that do not raise interrupts but have to be periodically
30  * scanned or polled to detect changes in their state.
31  */
32 struct input_polled_dev {
33         void *private;
34
35         void (*open)(struct input_polled_dev *dev);
36         void (*close)(struct input_polled_dev *dev);
37         void (*poll)(struct input_polled_dev *dev);
38         unsigned int poll_interval; /* msec */
39
40         struct input_dev *input;
41         struct delayed_work work;
42 };
43
44 struct input_polled_dev *input_allocate_polled_device(void);
45 void input_free_polled_device(struct input_polled_dev *dev);
46 int input_register_polled_device(struct input_polled_dev *dev);
47 void input_unregister_polled_device(struct input_polled_dev *dev);
48
49 #endif