xref: /linux/include/linux/input.h (revision 889600e21e3be388a6817c2a0dac0411df860751)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (c) 1999-2002 Vojtech Pavlik
4  */
5 #ifndef _INPUT_H
6 #define _INPUT_H
7 
8 #include <linux/time.h>
9 #include <linux/list.h>
10 #include <uapi/linux/input.h>
11 /* Implementation details, userspace should not care about these */
12 #define ABS_MT_FIRST		ABS_MT_TOUCH_MAJOR
13 #define ABS_MT_LAST		ABS_MT_TOOL_Y
14 
15 /*
16  * In-kernel definitions.
17  */
18 
19 #include <linux/device.h>
20 #include <linux/fs.h>
21 #include <linux/timer.h>
22 #include <linux/device-id/input.h>
23 
24 struct input_dev_poller;
25 
26 /**
27  * struct input_value - input value representation
28  * @type: type of value (EV_KEY, EV_ABS, etc)
29  * @code: the value code
30  * @value: the value
31  */
32 struct input_value {
33 	__u16 type;
34 	__u16 code;
35 	__s32 value;
36 };
37 
38 enum input_clock_type {
39 	INPUT_CLK_REAL = 0,
40 	INPUT_CLK_MONO,
41 	INPUT_CLK_BOOT,
42 	INPUT_CLK_MAX
43 };
44 
45 /**
46  * struct input_dev - represents an input device
47  * @name: name of the device
48  * @phys: physical path to the device in the system hierarchy
49  * @uniq: unique identification code for the device (if device has it)
50  * @id: id of the device (struct input_id)
51  * @propbit: bitmap of device properties and quirks
52  * @evbit: bitmap of types of events supported by the device (EV_KEY,
53  *	EV_REL, etc.)
54  * @keybit: bitmap of keys/buttons this device has
55  * @relbit: bitmap of relative axes for the device
56  * @absbit: bitmap of absolute axes for the device
57  * @mscbit: bitmap of miscellaneous events supported by the device
58  * @ledbit: bitmap of leds present on the device
59  * @sndbit: bitmap of sound effects supported by the device
60  * @ffbit: bitmap of force feedback effects supported by the device
61  * @swbit: bitmap of switches present on the device
62  * @hint_events_per_packet: average number of events generated by the
63  *	device in a packet (between EV_SYN/SYN_REPORT events). Used by
64  *	event handlers to estimate size of the buffer needed to hold
65  *	events.
66  * @keycodemax: size of keycode table
67  * @keycodesize: size of elements in keycode table
68  * @keycode: map of scancodes to keycodes for this device
69  * @getkeycode: optional legacy method to retrieve current keymap.
70  * @setkeycode: optional method to alter current keymap, used to implement
71  *	sparse keymaps. If not supplied default mechanism will be used.
72  *	The method is being called while holding event_lock and thus must
73  *	not sleep
74  * @ff: force feedback structure associated with the device if device
75  *	supports force feedback effects
76  * @poller: poller structure associated with the device if device is
77  *	set up to use polling mode
78  * @repeat_key: stores key code of the last key pressed; used to implement
79  *	software autorepeat
80  * @timer: timer for software autorepeat
81  * @rep: current values for autorepeat parameters (delay, rate)
82  * @mt: pointer to multitouch state
83  * @absinfo: array of &struct input_absinfo elements holding information
84  *	about absolute axes (current value, min, max, flat, fuzz,
85  *	resolution)
86  * @key: reflects current state of device's keys/buttons
87  * @led: reflects current state of device's LEDs
88  * @snd: reflects current state of sound effects
89  * @sw: reflects current state of device's switches
90  * @open: this method is called when the very first user calls
91  *	input_open_device(). The driver must prepare the device
92  *	to start generating events (start polling thread,
93  *	request an IRQ, submit URB, etc.). The meaning of open() is
94  *	to start providing events to the input core.
95  * @close: this method is called when the very last user calls
96  *	input_close_device(). The meaning of close() is to stop
97  *	providing events to the input core.
98  * @flush: purges the device. Most commonly used to get rid of force
99  *	feedback effects loaded into the device when disconnecting
100  *	from it
101  * @event: event handler for events sent _to_ the device, like EV_LED
102  *	or EV_SND. The device is expected to carry out the requested
103  *	action (turn on a LED, play sound, etc.) The call is protected
104  *	by @event_lock and must not sleep
105  * @grab: input handle that currently has the device grabbed (via
106  *	EVIOCGRAB ioctl). When a handle grabs a device it becomes sole
107  *	recipient for all input events coming from the device
108  * @event_lock: this spinlock is taken when input core receives
109  *	and processes a new event for the device (in input_event()).
110  *	Code that accesses and/or modifies parameters of a device
111  *	(such as keymap or absmin, absmax, absfuzz, etc.) after device
112  *	has been registered with input core must take this lock.
113  * @mutex: serializes calls to open(), close() and flush() methods
114  * @users: stores number of users (input handlers) that opened this
115  *	device. It is used by input_open_device() and input_close_device()
116  *	to make sure that dev->open() is only called when the first
117  *	user opens device and dev->close() is called when the very
118  *	last user closes the device
119  * @going_away: marks devices that are in a middle of unregistering and
120  *	causes input_open_device() and input_inhibit/uninhibit_device()
121  *	to fail with -ENODEV.
122  * @dev: driver model's view of this device
123  * @h_list: list of input handles associated with the device. When
124  *	accessing the list dev->mutex must be held
125  * @node: used to place the device onto input_dev_list
126  * @num_vals: number of values queued in the current frame
127  * @max_vals: maximum number of values queued in a frame
128  * @vals: array of values queued in the current frame
129  * @devres_managed: indicates that devices is managed with devres framework
130  *	and needs not be explicitly unregistered or freed.
131  * @timestamp: storage for a timestamp set by input_set_timestamp called
132  *	by a driver
133  * @inhibited: indicates that the input device is inhibited. If that is
134  *	the case then input core ignores any events generated by the device.
135  *	Device's close() is called when it is being inhibited and its open()
136  *	is called when it is being uninhibited.
137  * @ready: indicates that the device has been successfully opened and is
138  *	prepared to process events (like LEDs or sounds) sent from the
139  *	input core.
140  */
141 struct input_dev {
142 	const char *name;
143 	const char *phys;
144 	const char *uniq;
145 	struct input_id id;
146 
147 	unsigned long propbit[BITS_TO_LONGS(INPUT_PROP_CNT)];
148 
149 	unsigned long evbit[BITS_TO_LONGS(EV_CNT)];
150 	unsigned long keybit[BITS_TO_LONGS(KEY_CNT)];
151 	unsigned long relbit[BITS_TO_LONGS(REL_CNT)];
152 	unsigned long absbit[BITS_TO_LONGS(ABS_CNT)];
153 	unsigned long mscbit[BITS_TO_LONGS(MSC_CNT)];
154 	unsigned long ledbit[BITS_TO_LONGS(LED_CNT)];
155 	unsigned long sndbit[BITS_TO_LONGS(SND_CNT)];
156 	unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
157 	unsigned long swbit[BITS_TO_LONGS(SW_CNT)];
158 
159 	unsigned int hint_events_per_packet;
160 
161 	unsigned int keycodemax;
162 	unsigned int keycodesize;
163 	void *keycode;
164 
165 	int (*setkeycode)(struct input_dev *dev,
166 			  const struct input_keymap_entry *ke,
167 			  unsigned int *old_keycode);
168 	int (*getkeycode)(struct input_dev *dev,
169 			  struct input_keymap_entry *ke);
170 
171 	struct ff_device *ff;
172 
173 	struct input_dev_poller *poller;
174 
175 	unsigned int repeat_key;
176 	struct timer_list timer;
177 
178 	int rep[REP_CNT];
179 
180 	struct input_mt *mt;
181 
182 	struct input_absinfo *absinfo;
183 
184 	unsigned long key[BITS_TO_LONGS(KEY_CNT)];
185 	unsigned long led[BITS_TO_LONGS(LED_CNT)];
186 	unsigned long snd[BITS_TO_LONGS(SND_CNT)];
187 	unsigned long sw[BITS_TO_LONGS(SW_CNT)];
188 
189 	int (*open)(struct input_dev *dev);
190 	void (*close)(struct input_dev *dev);
191 	int (*flush)(struct input_dev *dev, struct file *file);
192 	int (*event)(struct input_dev *dev, unsigned int type, unsigned int code, int value);
193 
194 	struct input_handle __rcu *grab;
195 
196 	spinlock_t event_lock;
197 	struct mutex mutex;
198 
199 	unsigned int users;
200 	bool going_away;
201 
202 	struct device dev;
203 
204 	struct list_head	h_list;
205 	struct list_head	node;
206 
207 	unsigned int num_vals;
208 	unsigned int max_vals;
209 	struct input_value *vals;
210 
211 	bool devres_managed;
212 
213 	ktime_t timestamp[INPUT_CLK_MAX];
214 
215 	bool inhibited;
216 	bool ready;
217 };
218 #define to_input_dev(d) container_of(d, struct input_dev, dev)
219 
220 /*
221  * Verify that we are in sync with input_device_id mod_devicetable.h #defines
222  */
223 
224 #if EV_MAX != INPUT_DEVICE_ID_EV_MAX
225 #error "EV_MAX and INPUT_DEVICE_ID_EV_MAX do not match"
226 #endif
227 
228 #if KEY_MIN_INTERESTING != INPUT_DEVICE_ID_KEY_MIN_INTERESTING
229 #error "KEY_MIN_INTERESTING and INPUT_DEVICE_ID_KEY_MIN_INTERESTING do not match"
230 #endif
231 
232 #if KEY_MAX != INPUT_DEVICE_ID_KEY_MAX
233 #error "KEY_MAX and INPUT_DEVICE_ID_KEY_MAX do not match"
234 #endif
235 
236 #if REL_MAX != INPUT_DEVICE_ID_REL_MAX
237 #error "REL_MAX and INPUT_DEVICE_ID_REL_MAX do not match"
238 #endif
239 
240 #if ABS_MAX != INPUT_DEVICE_ID_ABS_MAX
241 #error "ABS_MAX and INPUT_DEVICE_ID_ABS_MAX do not match"
242 #endif
243 
244 #if MSC_MAX != INPUT_DEVICE_ID_MSC_MAX
245 #error "MSC_MAX and INPUT_DEVICE_ID_MSC_MAX do not match"
246 #endif
247 
248 #if LED_MAX != INPUT_DEVICE_ID_LED_MAX
249 #error "LED_MAX and INPUT_DEVICE_ID_LED_MAX do not match"
250 #endif
251 
252 #if SND_MAX != INPUT_DEVICE_ID_SND_MAX
253 #error "SND_MAX and INPUT_DEVICE_ID_SND_MAX do not match"
254 #endif
255 
256 #if FF_MAX != INPUT_DEVICE_ID_FF_MAX
257 #error "FF_MAX and INPUT_DEVICE_ID_FF_MAX do not match"
258 #endif
259 
260 #if SW_MAX != INPUT_DEVICE_ID_SW_MAX
261 #error "SW_MAX and INPUT_DEVICE_ID_SW_MAX do not match"
262 #endif
263 
264 #if INPUT_PROP_MAX != INPUT_DEVICE_ID_PROP_MAX
265 #error "INPUT_PROP_MAX and INPUT_DEVICE_ID_PROP_MAX do not match"
266 #endif
267 
268 #define INPUT_DEVICE_ID_MATCH_DEVICE \
269 	(INPUT_DEVICE_ID_MATCH_BUS | INPUT_DEVICE_ID_MATCH_VENDOR | INPUT_DEVICE_ID_MATCH_PRODUCT)
270 #define INPUT_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
271 	(INPUT_DEVICE_ID_MATCH_DEVICE | INPUT_DEVICE_ID_MATCH_VERSION)
272 
273 struct input_handle;
274 
275 /**
276  * struct input_handler - implements one of interfaces for input devices
277  * @private: driver-specific data
278  * @event: event handler. This method is being called by input core with
279  *	interrupts disabled and dev->event_lock spinlock held and so
280  *	it may not sleep
281  * @events: event sequence handler. This method is being called by
282  *	input core with interrupts disabled and dev->event_lock
283  *	spinlock held and so it may not sleep. The method must return
284  *	number of events passed to it.
285  * @filter: similar to @event; separates normal event handlers from
286  *	"filters".
287  * @match: called after comparing device's id with handler's id_table
288  *	to perform fine-grained matching between device and handler
289  * @connect: called when attaching a handler to an input device
290  * @disconnect: disconnects a handler from input device
291  * @start: starts handler for given handle. This function is called by
292  *	input core when device is open and ready to process events,
293  *	and also when device is uninhibited or when a process that "grabbed"
294  *	a device releases it
295  * @passive_observer: set to %true by drivers only interested in observing
296  *	data stream from devices if there are other users present. Such
297  *	drivers will not result in starting underlying hardware device
298  *	when input_open_device() is called for their handles
299  * @legacy_minors: set to %true by drivers using legacy minor ranges
300  * @minor: beginning of range of 32 legacy minors for devices this driver
301  *	can provide
302  * @name: name of the handler, to be shown in /proc/bus/input/handlers
303  * @id_table: pointer to a table of input_device_ids this driver can
304  *	handle
305  * @h_list: list of input handles associated with the handler
306  * @node: for placing the driver onto input_handler_list
307  *
308  * Input handlers attach to input devices and create input handles. There
309  * are likely several handlers attached to any given input device at the
310  * same time. All of them will get their copy of input event generated by
311  * the device.
312  *
313  * The very same structure is used to implement input filters. Input core
314  * allows filters to run first and will not pass event to regular handlers
315  * if any of the filters indicate that the event should be filtered (by
316  * returning %true from their filter() method).
317  *
318  * Note that input core serializes calls to connect() and disconnect()
319  * methods.
320  */
321 struct input_handler {
322 
323 	void *private;
324 
325 	void (*event)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
326 	unsigned int (*events)(struct input_handle *handle,
327 			       struct input_value *vals, unsigned int count);
328 	bool (*filter)(struct input_handle *handle, unsigned int type, unsigned int code, int value);
329 	bool (*match)(struct input_handler *handler, struct input_dev *dev);
330 	int (*connect)(struct input_handler *handler, struct input_dev *dev, const struct input_device_id *id);
331 	void (*disconnect)(struct input_handle *handle);
332 	void (*start)(struct input_handle *handle);
333 
334 	bool passive_observer;
335 	bool legacy_minors;
336 	int minor;
337 	const char *name;
338 
339 	const struct input_device_id *id_table;
340 
341 	struct list_head	h_list;
342 	struct list_head	node;
343 };
344 
345 /**
346  * struct input_handle - links input device with an input handler
347  * @private: handler-specific data
348  * @open: counter showing whether the handle is 'open', i.e. should deliver
349  *	events from its device
350  * @name: name given to the handle by handler that created it
351  * @dev: input device the handle is attached to
352  * @handler: handler that works with the device through this handle
353  * @handle_events: event sequence handler. It is set up by the input core
354  *	according to event handling method specified in the @handler. See
355  *	input_handle_setup_event_handler().
356  *	This method is being called by the input core with interrupts disabled
357  *	and dev->event_lock spinlock held and so it may not sleep.
358  * @d_node: used to put the handle on device's list of attached handles
359  * @h_node: used to put the handle on handler's list of handles from which
360  *	it gets events
361  */
362 struct input_handle {
363 	void *private;
364 
365 	int open;
366 	const char *name;
367 
368 	struct input_dev *dev;
369 	struct input_handler *handler;
370 
371 	unsigned int (*handle_events)(struct input_handle *handle,
372 				      struct input_value *vals,
373 				      unsigned int count);
374 
375 	struct list_head	d_node;
376 	struct list_head	h_node;
377 };
378 
379 struct input_dev __must_check *input_allocate_device(void);
380 struct input_dev __must_check *devm_input_allocate_device(struct device *);
381 void input_free_device(struct input_dev *dev);
382 
input_get_device(struct input_dev * dev)383 static inline struct input_dev *input_get_device(struct input_dev *dev)
384 {
385 	return dev ? to_input_dev(get_device(&dev->dev)) : NULL;
386 }
387 
input_put_device(struct input_dev * dev)388 static inline void input_put_device(struct input_dev *dev)
389 {
390 	if (dev)
391 		put_device(&dev->dev);
392 }
393 
input_get_drvdata(struct input_dev * dev)394 static inline void *input_get_drvdata(struct input_dev *dev)
395 {
396 	return dev_get_drvdata(&dev->dev);
397 }
398 
input_set_drvdata(struct input_dev * dev,void * data)399 static inline void input_set_drvdata(struct input_dev *dev, void *data)
400 {
401 	dev_set_drvdata(&dev->dev, data);
402 }
403 
404 int __must_check input_register_device(struct input_dev *);
405 void input_unregister_device(struct input_dev *);
406 
407 void input_reset_device(struct input_dev *);
408 
409 int input_setup_polling(struct input_dev *dev,
410 			void (*poll_fn)(struct input_dev *dev));
411 void input_set_poll_interval(struct input_dev *dev, unsigned int interval);
412 void input_set_min_poll_interval(struct input_dev *dev, unsigned int interval);
413 void input_set_max_poll_interval(struct input_dev *dev, unsigned int interval);
414 int input_get_poll_interval(struct input_dev *dev);
415 
416 int __must_check input_register_handler(struct input_handler *);
417 void input_unregister_handler(struct input_handler *);
418 
419 int __must_check input_get_new_minor(int legacy_base, unsigned int legacy_num,
420 				     bool allow_dynamic);
421 void input_free_minor(unsigned int minor);
422 
423 int input_handler_for_each_handle(struct input_handler *, void *data,
424 				  int (*fn)(struct input_handle *, void *));
425 
426 int input_register_handle(struct input_handle *);
427 void input_unregister_handle(struct input_handle *);
428 
429 int input_grab_device(struct input_handle *);
430 void input_release_device(struct input_handle *);
431 
432 int input_open_device(struct input_handle *);
433 void input_close_device(struct input_handle *);
434 
435 int input_flush_device(struct input_handle *handle, struct file *file);
436 
437 void input_set_timestamp(struct input_dev *dev, ktime_t timestamp);
438 ktime_t *input_get_timestamp(struct input_dev *dev);
439 
440 void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
441 void input_inject_event(struct input_handle *handle, unsigned int type, unsigned int code, int value);
442 
input_report_key(struct input_dev * dev,unsigned int code,int value)443 static inline void input_report_key(struct input_dev *dev, unsigned int code, int value)
444 {
445 	input_event(dev, EV_KEY, code, !!value);
446 }
447 
input_report_rel(struct input_dev * dev,unsigned int code,int value)448 static inline void input_report_rel(struct input_dev *dev, unsigned int code, int value)
449 {
450 	input_event(dev, EV_REL, code, value);
451 }
452 
input_report_abs(struct input_dev * dev,unsigned int code,int value)453 static inline void input_report_abs(struct input_dev *dev, unsigned int code, int value)
454 {
455 	input_event(dev, EV_ABS, code, value);
456 }
457 
input_report_ff_status(struct input_dev * dev,unsigned int code,int value)458 static inline void input_report_ff_status(struct input_dev *dev, unsigned int code, int value)
459 {
460 	input_event(dev, EV_FF_STATUS, code, value);
461 }
462 
input_report_switch(struct input_dev * dev,unsigned int code,int value)463 static inline void input_report_switch(struct input_dev *dev, unsigned int code, int value)
464 {
465 	input_event(dev, EV_SW, code, !!value);
466 }
467 
input_sync(struct input_dev * dev)468 static inline void input_sync(struct input_dev *dev)
469 {
470 	input_event(dev, EV_SYN, SYN_REPORT, 0);
471 }
472 
input_mt_sync(struct input_dev * dev)473 static inline void input_mt_sync(struct input_dev *dev)
474 {
475 	input_event(dev, EV_SYN, SYN_MT_REPORT, 0);
476 }
477 
478 void input_set_capability(struct input_dev *dev, unsigned int type, unsigned int code);
479 
480 /**
481  * input_set_events_per_packet - tell handlers about the driver event rate
482  * @dev: the input device used by the driver
483  * @n_events: the average number of events between calls to input_sync()
484  *
485  * If the event rate sent from a device is unusually large, use this
486  * function to set the expected event rate. This will allow handlers
487  * to set up an appropriate buffer size for the event stream, in order
488  * to minimize information loss.
489  */
input_set_events_per_packet(struct input_dev * dev,int n_events)490 static inline void input_set_events_per_packet(struct input_dev *dev, int n_events)
491 {
492 	dev->hint_events_per_packet = n_events;
493 }
494 
495 void input_alloc_absinfo(struct input_dev *dev);
496 void input_set_abs_params(struct input_dev *dev, unsigned int axis,
497 			  int min, int max, int fuzz, int flat);
498 void input_copy_abs(struct input_dev *dst, unsigned int dst_axis,
499 		    const struct input_dev *src, unsigned int src_axis);
500 
501 #define INPUT_GENERATE_ABS_ACCESSORS(_suffix, _item)			\
502 static inline int input_abs_get_##_suffix(struct input_dev *dev,	\
503 					  unsigned int axis)		\
504 {									\
505 	return dev->absinfo ? dev->absinfo[axis]._item : 0;		\
506 }									\
507 									\
508 static inline void input_abs_set_##_suffix(struct input_dev *dev,	\
509 					   unsigned int axis, int val)	\
510 {									\
511 	input_alloc_absinfo(dev);					\
512 	if (dev->absinfo)						\
513 		dev->absinfo[axis]._item = val;				\
514 }
515 
516 INPUT_GENERATE_ABS_ACCESSORS(val, value)
517 INPUT_GENERATE_ABS_ACCESSORS(min, minimum)
518 INPUT_GENERATE_ABS_ACCESSORS(max, maximum)
519 INPUT_GENERATE_ABS_ACCESSORS(fuzz, fuzz)
520 INPUT_GENERATE_ABS_ACCESSORS(flat, flat)
521 INPUT_GENERATE_ABS_ACCESSORS(res, resolution)
522 
523 int input_scancode_to_scalar(const struct input_keymap_entry *ke,
524 			     unsigned int *scancode);
525 
526 int input_default_setkeycode(struct input_dev *dev,
527 			     const struct input_keymap_entry *ke,
528 			     unsigned int *old_keycode);
529 
530 int input_get_keycode(struct input_dev *dev, struct input_keymap_entry *ke);
531 int input_set_keycode(struct input_dev *dev,
532 		      const struct input_keymap_entry *ke);
533 
534 bool input_match_device_id(const struct input_dev *dev,
535 			   const struct input_device_id *id);
536 
537 void input_enable_softrepeat(struct input_dev *dev, int delay, int period);
538 
539 bool input_device_enabled(struct input_dev *dev);
540 
541 extern const struct class input_class;
542 
543 /**
544  * struct ff_device - force-feedback part of an input device
545  * @upload: Called to upload an new effect into device
546  * @erase: Called to erase an effect from device
547  * @playback: Called to request device to start playing specified effect
548  * @set_gain: Called to set specified gain
549  * @set_autocenter: Called to auto-center device
550  * @destroy: called by input core when parent input device is being
551  *	destroyed
552  * @stop: called by input core when parent input device is being
553  *	unregistered
554  * @private: driver-specific data, will be freed automatically
555  * @ffbit: bitmap of force feedback capabilities truly supported by
556  *	device (not emulated like ones in input_dev->ffbit)
557  * @mutex: mutex for serializing access to the device
558  * @max_effects: maximum number of effects supported by device
559  * @effects: pointer to an array of effects currently loaded into device
560  * @effect_owners: array of effect owners; when file handle owning
561  *	an effect gets closed the effect is automatically erased
562  *
563  * Every force-feedback device must implement upload() and playback()
564  * methods; erase() is optional. set_gain() and set_autocenter() need
565  * only be implemented if driver sets up FF_GAIN and FF_AUTOCENTER
566  * bits.
567  *
568  * Note that playback(), set_gain() and set_autocenter() are called with
569  * dev->event_lock spinlock held and interrupts off and thus may not
570  * sleep.
571  */
572 struct ff_device {
573 	int (*upload)(struct input_dev *dev, struct ff_effect *effect,
574 		      struct ff_effect *old);
575 	int (*erase)(struct input_dev *dev, int effect_id);
576 
577 	int (*playback)(struct input_dev *dev, int effect_id, int value);
578 	void (*set_gain)(struct input_dev *dev, u16 gain);
579 	void (*set_autocenter)(struct input_dev *dev, u16 magnitude);
580 
581 	void (*destroy)(struct ff_device *);
582 	void (*stop)(struct ff_device *);
583 
584 	void *private;
585 
586 	unsigned long ffbit[BITS_TO_LONGS(FF_CNT)];
587 
588 	struct mutex mutex;
589 
590 	int max_effects;
591 	struct ff_effect *effects;
592 	struct file *effect_owners[] __counted_by(max_effects);
593 };
594 
595 int input_ff_create(struct input_dev *dev, unsigned int max_effects);
596 void input_ff_destroy(struct input_dev *dev);
597 
598 int input_ff_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);
599 
600 int input_ff_upload(struct input_dev *dev, struct ff_effect *effect, struct file *file);
601 int input_ff_erase(struct input_dev *dev, int effect_id, struct file *file);
602 int input_ff_flush(struct input_dev *dev, struct file *file);
603 
604 int input_ff_create_memless(struct input_dev *dev, void *data,
605 		int (*play_effect)(struct input_dev *, void *, struct ff_effect *));
606 
607 #endif
608