input-polldev.h 2.17 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
#ifndef _INPUT_POLLDEV_H
#define _INPUT_POLLDEV_H

/*
 * Copyright (c) 2007 Dmitry Torokhov
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */

#include <linux/input.h>
#include <linux/workqueue.h>

/**
 * struct input_polled_dev - simple polled input device
17 18 19 20 21
 * @private: private driver data.
 * @open: driver-supplied method that prepares device for polling
 *	(enabled the device and maybe flushes device state).
 * @close: driver-supplied method that is called when device is no
 *	longer being polled. Used to put device into low power mode.
22 23
 * @poll: driver-supplied method that polls the device and posts
 *	input events (mandatory).
24
 * @poll_interval: specifies how often the poll() method should be called.
25
 *	Defaults to 500 msec unless overridden when registering the device.
26 27 28 29
 * @poll_interval_max: specifies upper bound for the poll interval.
 *	Defaults to the initial value of @poll_interval.
 * @poll_interval_min: specifies lower bound for the poll interval.
 *	Defaults to 0.
30
 * @input: input device structure associated with the polled device.
31 32 33 34 35 36 37 38 39
 *	Must be properly initialized by the driver (id, name, phys, bits).
 *
 * Polled input device provides a skeleton for supporting simple input
 * devices that do not raise interrupts but have to be periodically
 * scanned or polled to detect changes in their state.
 */
struct input_polled_dev {
	void *private;

40 41
	void (*open)(struct input_polled_dev *dev);
	void (*close)(struct input_polled_dev *dev);
42 43
	void (*poll)(struct input_polled_dev *dev);
	unsigned int poll_interval; /* msec */
44 45
	unsigned int poll_interval_max; /* msec */
	unsigned int poll_interval_min; /* msec */
46 47

	struct input_dev *input;
48 49

/* private: */
50
	struct delayed_work work;
51 52

	bool devres_managed;
53 54 55
};

struct input_polled_dev *input_allocate_polled_device(void);
56
struct input_polled_dev *devm_input_allocate_polled_device(struct device *dev);
57 58 59 60 61
void input_free_polled_device(struct input_polled_dev *dev);
int input_register_polled_device(struct input_polled_dev *dev);
void input_unregister_polled_device(struct input_polled_dev *dev);

#endif