blob: ce0b72464eb814bf5902e3daf423522934963b8c [file] [log] [blame]
Dmitry Torokhov0dcd8072007-04-29 23:42:45 -04001#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
Samu Onkalob0aba1e2009-10-18 00:38:57 -070017 * @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.
Dmitry Torokhov0dcd8072007-04-29 23:42:45 -040022 * @poll: driver-supplied method that polls the device and posts
23 * input events (mandatory).
Samu Onkalodad725d2009-11-13 21:13:22 -080024 * @poll_interval: specifies how often the poll() method should be called.
Dmitry Torokhov2546bcc2011-01-31 21:06:34 -080025 * Defaults to 500 msec unless overridden when registering the device.
Samu Onkalodad725d2009-11-13 21:13:22 -080026 * @poll_interval_max: specifies upper bound for the poll interval.
27 * Defaults to the initial value of @poll_interval.
28 * @poll_interval_min: specifies lower bound for the poll interval.
29 * Defaults to 0.
Dmitry Torokhov2546bcc2011-01-31 21:06:34 -080030 * @input: input device structure associated with the polled device.
Dmitry Torokhov0dcd8072007-04-29 23:42:45 -040031 * Must be properly initialized by the driver (id, name, phys, bits).
32 *
33 * Polled input device provides a skeleton for supporting simple input
34 * devices that do not raise interrupts but have to be periodically
35 * scanned or polled to detect changes in their state.
36 */
37struct input_polled_dev {
38 void *private;
39
Samu Onkalob0aba1e2009-10-18 00:38:57 -070040 void (*open)(struct input_polled_dev *dev);
41 void (*close)(struct input_polled_dev *dev);
Dmitry Torokhov0dcd8072007-04-29 23:42:45 -040042 void (*poll)(struct input_polled_dev *dev);
43 unsigned int poll_interval; /* msec */
Samu Onkalodad725d2009-11-13 21:13:22 -080044 unsigned int poll_interval_max; /* msec */
45 unsigned int poll_interval_min; /* msec */
Dmitry Torokhov0dcd8072007-04-29 23:42:45 -040046
47 struct input_dev *input;
Samu Onkalodad725d2009-11-13 21:13:22 -080048
49/* private: */
Dmitry Torokhov0dcd8072007-04-29 23:42:45 -040050 struct delayed_work work;
51};
52
53struct input_polled_dev *input_allocate_polled_device(void);
54void input_free_polled_device(struct input_polled_dev *dev);
55int input_register_polled_device(struct input_polled_dev *dev);
56void input_unregister_polled_device(struct input_polled_dev *dev);
57
58#endif