xref: /linux-6.15/drivers/input/ff-memless.c (revision 8fa7292f)
11a59d1b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
27d928a2bSAnssi Hannula /*
37d928a2bSAnssi Hannula  *  Force feedback support for memoryless devices
47d928a2bSAnssi Hannula  *
57d928a2bSAnssi Hannula  *  Copyright (c) 2006 Anssi Hannula <[email protected]>
67d928a2bSAnssi Hannula  *  Copyright (c) 2006 Dmitry Torokhov <[email protected]>
77d928a2bSAnssi Hannula  */
87d928a2bSAnssi Hannula 
97d928a2bSAnssi Hannula /* #define DEBUG */
107d928a2bSAnssi Hannula 
11da0c4901SJoe Perches #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
127d928a2bSAnssi Hannula 
135a0e3ad6STejun Heo #include <linux/slab.h>
147d928a2bSAnssi Hannula #include <linux/input.h>
157d928a2bSAnssi Hannula #include <linux/module.h>
167d928a2bSAnssi Hannula #include <linux/mutex.h>
177d928a2bSAnssi Hannula #include <linux/spinlock.h>
18cd354f1aSTim Schmielau #include <linux/jiffies.h>
19c8e1fb4aSAntonio Ospite #include <linux/fixp-arith.h>
207d928a2bSAnssi Hannula 
217d928a2bSAnssi Hannula MODULE_LICENSE("GPL");
227d928a2bSAnssi Hannula MODULE_AUTHOR("Anssi Hannula <[email protected]>");
237d928a2bSAnssi Hannula MODULE_DESCRIPTION("Force feedback support for memoryless devices");
247d928a2bSAnssi Hannula 
257d928a2bSAnssi Hannula /* Number of effects handled with memoryless devices */
267d928a2bSAnssi Hannula #define FF_MEMLESS_EFFECTS	16
277d928a2bSAnssi Hannula 
287d928a2bSAnssi Hannula /* Envelope update interval in ms */
297d928a2bSAnssi Hannula #define FF_ENVELOPE_INTERVAL	50
307d928a2bSAnssi Hannula 
317d928a2bSAnssi Hannula #define FF_EFFECT_STARTED	0
327d928a2bSAnssi Hannula #define FF_EFFECT_PLAYING	1
337d928a2bSAnssi Hannula #define FF_EFFECT_ABORTING	2
347d928a2bSAnssi Hannula 
357d928a2bSAnssi Hannula struct ml_effect_state {
367d928a2bSAnssi Hannula 	struct ff_effect *effect;
377d928a2bSAnssi Hannula 	unsigned long flags;	/* effect state (STARTED, PLAYING, etc) */
387d928a2bSAnssi Hannula 	int count;		/* loop count of the effect */
397d928a2bSAnssi Hannula 	unsigned long play_at;	/* start time */
407d928a2bSAnssi Hannula 	unsigned long stop_at;	/* stop time */
417d928a2bSAnssi Hannula 	unsigned long adj_at;	/* last time the effect was sent */
427d928a2bSAnssi Hannula };
437d928a2bSAnssi Hannula 
447d928a2bSAnssi Hannula struct ml_device {
457d928a2bSAnssi Hannula 	void *private;
467d928a2bSAnssi Hannula 	struct ml_effect_state states[FF_MEMLESS_EFFECTS];
477d928a2bSAnssi Hannula 	int gain;
487d928a2bSAnssi Hannula 	struct timer_list timer;
497d928a2bSAnssi Hannula 	struct input_dev *dev;
507d928a2bSAnssi Hannula 
517d928a2bSAnssi Hannula 	int (*play_effect)(struct input_dev *dev, void *data,
527d928a2bSAnssi Hannula 			   struct ff_effect *effect);
537d928a2bSAnssi Hannula };
547d928a2bSAnssi Hannula 
get_envelope(const struct ff_effect * effect)557d928a2bSAnssi Hannula static const struct ff_envelope *get_envelope(const struct ff_effect *effect)
567d928a2bSAnssi Hannula {
577d928a2bSAnssi Hannula 	static const struct ff_envelope empty_envelope;
587d928a2bSAnssi Hannula 
597d928a2bSAnssi Hannula 	switch (effect->type) {
607d928a2bSAnssi Hannula 	case FF_PERIODIC:
617d928a2bSAnssi Hannula 		return &effect->u.periodic.envelope;
6241091ad0SBaodong Chen 
637d928a2bSAnssi Hannula 	case FF_CONSTANT:
647d928a2bSAnssi Hannula 		return &effect->u.constant.envelope;
6541091ad0SBaodong Chen 
667d928a2bSAnssi Hannula 	default:
677d928a2bSAnssi Hannula 		return &empty_envelope;
687d928a2bSAnssi Hannula 	}
697d928a2bSAnssi Hannula }
707d928a2bSAnssi Hannula 
717d928a2bSAnssi Hannula /*
727d928a2bSAnssi Hannula  * Check for the next time envelope requires an update on memoryless devices
737d928a2bSAnssi Hannula  */
calculate_next_time(struct ml_effect_state * state)747d928a2bSAnssi Hannula static unsigned long calculate_next_time(struct ml_effect_state *state)
757d928a2bSAnssi Hannula {
767d928a2bSAnssi Hannula 	const struct ff_envelope *envelope = get_envelope(state->effect);
777d928a2bSAnssi Hannula 	unsigned long attack_stop, fade_start, next_fade;
787d928a2bSAnssi Hannula 
797d928a2bSAnssi Hannula 	if (envelope->attack_length) {
807d928a2bSAnssi Hannula 		attack_stop = state->play_at +
817d928a2bSAnssi Hannula 			msecs_to_jiffies(envelope->attack_length);
827d928a2bSAnssi Hannula 		if (time_before(state->adj_at, attack_stop))
837d928a2bSAnssi Hannula 			return state->adj_at +
847d928a2bSAnssi Hannula 					msecs_to_jiffies(FF_ENVELOPE_INTERVAL);
857d928a2bSAnssi Hannula 	}
867d928a2bSAnssi Hannula 
877d928a2bSAnssi Hannula 	if (state->effect->replay.length) {
887d928a2bSAnssi Hannula 		if (envelope->fade_length) {
897d928a2bSAnssi Hannula 			/* check when fading should start */
907d928a2bSAnssi Hannula 			fade_start = state->stop_at -
917d928a2bSAnssi Hannula 					msecs_to_jiffies(envelope->fade_length);
927d928a2bSAnssi Hannula 
937d928a2bSAnssi Hannula 			if (time_before(state->adj_at, fade_start))
947d928a2bSAnssi Hannula 				return fade_start;
957d928a2bSAnssi Hannula 
967d928a2bSAnssi Hannula 			/* already fading, advance to next checkpoint */
977d928a2bSAnssi Hannula 			next_fade = state->adj_at +
987d928a2bSAnssi Hannula 					msecs_to_jiffies(FF_ENVELOPE_INTERVAL);
997d928a2bSAnssi Hannula 			if (time_before(next_fade, state->stop_at))
1007d928a2bSAnssi Hannula 				return next_fade;
1017d928a2bSAnssi Hannula 		}
1027d928a2bSAnssi Hannula 
1037d928a2bSAnssi Hannula 		return state->stop_at;
1047d928a2bSAnssi Hannula 	}
1057d928a2bSAnssi Hannula 
1067d928a2bSAnssi Hannula 	return state->play_at;
1077d928a2bSAnssi Hannula }
1087d928a2bSAnssi Hannula 
ml_schedule_timer(struct ml_device * ml)1097d928a2bSAnssi Hannula static void ml_schedule_timer(struct ml_device *ml)
1107d928a2bSAnssi Hannula {
1117d928a2bSAnssi Hannula 	struct ml_effect_state *state;
1127d928a2bSAnssi Hannula 	unsigned long now = jiffies;
1137d928a2bSAnssi Hannula 	unsigned long earliest = 0;
1147d928a2bSAnssi Hannula 	unsigned long next_at;
1157d928a2bSAnssi Hannula 	int events = 0;
1167d928a2bSAnssi Hannula 	int i;
1177d928a2bSAnssi Hannula 
118da0c4901SJoe Perches 	pr_debug("calculating next timer\n");
1197d928a2bSAnssi Hannula 
1207d928a2bSAnssi Hannula 	for (i = 0; i < FF_MEMLESS_EFFECTS; i++) {
1217d928a2bSAnssi Hannula 
1227d928a2bSAnssi Hannula 		state = &ml->states[i];
1237d928a2bSAnssi Hannula 
1247d928a2bSAnssi Hannula 		if (!test_bit(FF_EFFECT_STARTED, &state->flags))
1257d928a2bSAnssi Hannula 			continue;
1267d928a2bSAnssi Hannula 
1277d928a2bSAnssi Hannula 		if (test_bit(FF_EFFECT_PLAYING, &state->flags))
1287d928a2bSAnssi Hannula 			next_at = calculate_next_time(state);
1297d928a2bSAnssi Hannula 		else
1307d928a2bSAnssi Hannula 			next_at = state->play_at;
1317d928a2bSAnssi Hannula 
1327d928a2bSAnssi Hannula 		if (time_before_eq(now, next_at) &&
1337d928a2bSAnssi Hannula 		    (++events == 1 || time_before(next_at, earliest)))
1347d928a2bSAnssi Hannula 			earliest = next_at;
1357d928a2bSAnssi Hannula 	}
1367d928a2bSAnssi Hannula 
1377d928a2bSAnssi Hannula 	if (!events) {
138da0c4901SJoe Perches 		pr_debug("no actions\n");
139*8fa7292fSThomas Gleixner 		timer_delete(&ml->timer);
1407d928a2bSAnssi Hannula 	} else {
141da0c4901SJoe Perches 		pr_debug("timer set\n");
1427d928a2bSAnssi Hannula 		mod_timer(&ml->timer, earliest);
1437d928a2bSAnssi Hannula 	}
1447d928a2bSAnssi Hannula }
1457d928a2bSAnssi Hannula 
1467d928a2bSAnssi Hannula /*
1477d928a2bSAnssi Hannula  * Apply an envelope to a value
1487d928a2bSAnssi Hannula  */
apply_envelope(struct ml_effect_state * state,int value,struct ff_envelope * envelope)1497d928a2bSAnssi Hannula static int apply_envelope(struct ml_effect_state *state, int value,
1507d928a2bSAnssi Hannula 			  struct ff_envelope *envelope)
1517d928a2bSAnssi Hannula {
1527d928a2bSAnssi Hannula 	struct ff_effect *effect = state->effect;
1537d928a2bSAnssi Hannula 	unsigned long now = jiffies;
1547d928a2bSAnssi Hannula 	int time_from_level;
1557d928a2bSAnssi Hannula 	int time_of_envelope;
1567d928a2bSAnssi Hannula 	int envelope_level;
1577d928a2bSAnssi Hannula 	int difference;
1587d928a2bSAnssi Hannula 
1597d928a2bSAnssi Hannula 	if (envelope->attack_length &&
1607d928a2bSAnssi Hannula 	    time_before(now,
1617d928a2bSAnssi Hannula 			state->play_at + msecs_to_jiffies(envelope->attack_length))) {
162da0c4901SJoe Perches 		pr_debug("value = 0x%x, attack_level = 0x%x\n",
163da0c4901SJoe Perches 			 value, envelope->attack_level);
1647d928a2bSAnssi Hannula 		time_from_level = jiffies_to_msecs(now - state->play_at);
1657d928a2bSAnssi Hannula 		time_of_envelope = envelope->attack_length;
1669a932145SDan Carpenter 		envelope_level = min_t(u16, envelope->attack_level, 0x7fff);
1677d928a2bSAnssi Hannula 
1687d928a2bSAnssi Hannula 	} else if (envelope->fade_length && effect->replay.length &&
1697d928a2bSAnssi Hannula 		   time_after(now,
1707d928a2bSAnssi Hannula 			      state->stop_at - msecs_to_jiffies(envelope->fade_length)) &&
1717d928a2bSAnssi Hannula 		   time_before(now, state->stop_at)) {
1727d928a2bSAnssi Hannula 		time_from_level = jiffies_to_msecs(state->stop_at - now);
1737d928a2bSAnssi Hannula 		time_of_envelope = envelope->fade_length;
1749a932145SDan Carpenter 		envelope_level = min_t(u16, envelope->fade_level, 0x7fff);
1757d928a2bSAnssi Hannula 	} else
1767d928a2bSAnssi Hannula 		return value;
1777d928a2bSAnssi Hannula 
1787d928a2bSAnssi Hannula 	difference = abs(value) - envelope_level;
1797d928a2bSAnssi Hannula 
180da0c4901SJoe Perches 	pr_debug("difference = %d\n", difference);
181da0c4901SJoe Perches 	pr_debug("time_from_level = 0x%x\n", time_from_level);
182da0c4901SJoe Perches 	pr_debug("time_of_envelope = 0x%x\n", time_of_envelope);
1837d928a2bSAnssi Hannula 
1847d928a2bSAnssi Hannula 	difference = difference * time_from_level / time_of_envelope;
1857d928a2bSAnssi Hannula 
186da0c4901SJoe Perches 	pr_debug("difference = %d\n", difference);
1877d928a2bSAnssi Hannula 
1887d928a2bSAnssi Hannula 	return value < 0 ?
1897d928a2bSAnssi Hannula 		-(difference + envelope_level) : (difference + envelope_level);
1907d928a2bSAnssi Hannula }
1917d928a2bSAnssi Hannula 
1927d928a2bSAnssi Hannula /*
1937d928a2bSAnssi Hannula  * Return the type the effect has to be converted into (memless devices)
1947d928a2bSAnssi Hannula  */
get_compatible_type(struct ff_device * ff,int effect_type)1957d928a2bSAnssi Hannula static int get_compatible_type(struct ff_device *ff, int effect_type)
1967d928a2bSAnssi Hannula {
1977d928a2bSAnssi Hannula 
1987d928a2bSAnssi Hannula 	if (test_bit(effect_type, ff->ffbit))
1997d928a2bSAnssi Hannula 		return effect_type;
2007d928a2bSAnssi Hannula 
2017d928a2bSAnssi Hannula 	if (effect_type == FF_PERIODIC && test_bit(FF_RUMBLE, ff->ffbit))
2027d928a2bSAnssi Hannula 		return FF_RUMBLE;
2037d928a2bSAnssi Hannula 
204da0c4901SJoe Perches 	pr_err("invalid type in get_compatible_type()\n");
2057d928a2bSAnssi Hannula 
2067d928a2bSAnssi Hannula 	return 0;
2077d928a2bSAnssi Hannula }
2087d928a2bSAnssi Hannula 
2097d928a2bSAnssi Hannula /*
21094ec26c8SJari Vanhala  * Only left/right direction should be used (under/over 0x8000) for
21194ec26c8SJari Vanhala  * forward/reverse motor direction (to keep calculation fast & simple).
21294ec26c8SJari Vanhala  */
ml_calculate_direction(u16 direction,u16 force,u16 new_direction,u16 new_force)21394ec26c8SJari Vanhala static u16 ml_calculate_direction(u16 direction, u16 force,
21494ec26c8SJari Vanhala 				  u16 new_direction, u16 new_force)
21594ec26c8SJari Vanhala {
21694ec26c8SJari Vanhala 	if (!force)
21794ec26c8SJari Vanhala 		return new_direction;
21894ec26c8SJari Vanhala 	if (!new_force)
21994ec26c8SJari Vanhala 		return direction;
22094ec26c8SJari Vanhala 	return (((u32)(direction >> 1) * force +
22194ec26c8SJari Vanhala 		 (new_direction >> 1) * new_force) /
22294ec26c8SJari Vanhala 		(force + new_force)) << 1;
22394ec26c8SJari Vanhala }
22494ec26c8SJari Vanhala 
225559addc2SMauro Carvalho Chehab #define FRAC_N 8
fixp_new16(s16 a)226559addc2SMauro Carvalho Chehab static inline s16 fixp_new16(s16 a)
227559addc2SMauro Carvalho Chehab {
228559addc2SMauro Carvalho Chehab 	return ((s32)a) >> (16 - FRAC_N);
229559addc2SMauro Carvalho Chehab }
230559addc2SMauro Carvalho Chehab 
fixp_mult(s16 a,s16 b)231559addc2SMauro Carvalho Chehab static inline s16 fixp_mult(s16 a, s16 b)
232559addc2SMauro Carvalho Chehab {
233559addc2SMauro Carvalho Chehab 	a = ((s32)a * 0x100) / 0x7fff;
234559addc2SMauro Carvalho Chehab 	return ((s32)(a * b)) >> FRAC_N;
235559addc2SMauro Carvalho Chehab }
236559addc2SMauro Carvalho Chehab 
23794ec26c8SJari Vanhala /*
2387d928a2bSAnssi Hannula  * Combine two effects and apply gain.
2397d928a2bSAnssi Hannula  */
ml_combine_effects(struct ff_effect * effect,struct ml_effect_state * state,int gain)2407d928a2bSAnssi Hannula static void ml_combine_effects(struct ff_effect *effect,
2417d928a2bSAnssi Hannula 			       struct ml_effect_state *state,
2421b11c88dSDmitry Torokhov 			       int gain)
2437d928a2bSAnssi Hannula {
2447d928a2bSAnssi Hannula 	struct ff_effect *new = state->effect;
2457d928a2bSAnssi Hannula 	unsigned int strong, weak, i;
2467d928a2bSAnssi Hannula 	int x, y;
247559addc2SMauro Carvalho Chehab 	s16 level;
2487d928a2bSAnssi Hannula 
2497d928a2bSAnssi Hannula 	switch (new->type) {
2507d928a2bSAnssi Hannula 	case FF_CONSTANT:
2517d928a2bSAnssi Hannula 		i = new->direction * 360 / 0xffff;
2527d928a2bSAnssi Hannula 		level = fixp_new16(apply_envelope(state,
2537d928a2bSAnssi Hannula 					new->u.constant.level,
2547d928a2bSAnssi Hannula 					&new->u.constant.envelope));
255559addc2SMauro Carvalho Chehab 		x = fixp_mult(fixp_sin16(i), level) * gain / 0xffff;
256559addc2SMauro Carvalho Chehab 		y = fixp_mult(-fixp_cos16(i), level) * gain / 0xffff;
2577d928a2bSAnssi Hannula 		/*
2587d928a2bSAnssi Hannula 		 * here we abuse ff_ramp to hold x and y of constant force
2597d928a2bSAnssi Hannula 		 * If in future any driver wants something else than x and y
2607d928a2bSAnssi Hannula 		 * in s8, this should be changed to something more generic
2617d928a2bSAnssi Hannula 		 */
2627d928a2bSAnssi Hannula 		effect->u.ramp.start_level =
26392310474SHarvey Harrison 			clamp_val(effect->u.ramp.start_level + x, -0x80, 0x7f);
2647d928a2bSAnssi Hannula 		effect->u.ramp.end_level =
26592310474SHarvey Harrison 			clamp_val(effect->u.ramp.end_level + y, -0x80, 0x7f);
2667d928a2bSAnssi Hannula 		break;
2677d928a2bSAnssi Hannula 
2687d928a2bSAnssi Hannula 	case FF_RUMBLE:
2691b11c88dSDmitry Torokhov 		strong = (u32)new->u.rumble.strong_magnitude * gain / 0xffff;
2701b11c88dSDmitry Torokhov 		weak = (u32)new->u.rumble.weak_magnitude * gain / 0xffff;
27194ec26c8SJari Vanhala 
27294ec26c8SJari Vanhala 		if (effect->u.rumble.strong_magnitude + strong)
27394ec26c8SJari Vanhala 			effect->direction = ml_calculate_direction(
27494ec26c8SJari Vanhala 				effect->direction,
27594ec26c8SJari Vanhala 				effect->u.rumble.strong_magnitude,
27694ec26c8SJari Vanhala 				new->direction, strong);
27794ec26c8SJari Vanhala 		else if (effect->u.rumble.weak_magnitude + weak)
27894ec26c8SJari Vanhala 			effect->direction = ml_calculate_direction(
27994ec26c8SJari Vanhala 				effect->direction,
28094ec26c8SJari Vanhala 				effect->u.rumble.weak_magnitude,
28194ec26c8SJari Vanhala 				new->direction, weak);
28294ec26c8SJari Vanhala 		else
28394ec26c8SJari Vanhala 			effect->direction = 0;
2847d928a2bSAnssi Hannula 		effect->u.rumble.strong_magnitude =
2857d928a2bSAnssi Hannula 			min(strong + effect->u.rumble.strong_magnitude,
2867d928a2bSAnssi Hannula 			    0xffffU);
2877d928a2bSAnssi Hannula 		effect->u.rumble.weak_magnitude =
2887d928a2bSAnssi Hannula 			min(weak + effect->u.rumble.weak_magnitude, 0xffffU);
2897d928a2bSAnssi Hannula 		break;
2907d928a2bSAnssi Hannula 
2917d928a2bSAnssi Hannula 	case FF_PERIODIC:
2927d928a2bSAnssi Hannula 		i = apply_envelope(state, abs(new->u.periodic.magnitude),
2937d928a2bSAnssi Hannula 				   &new->u.periodic.envelope);
2947d928a2bSAnssi Hannula 
2957d928a2bSAnssi Hannula 		/* here we also scale it 0x7fff => 0xffff */
2967d928a2bSAnssi Hannula 		i = i * gain / 0x7fff;
2977d928a2bSAnssi Hannula 
29894ec26c8SJari Vanhala 		if (effect->u.rumble.strong_magnitude + i)
29994ec26c8SJari Vanhala 			effect->direction = ml_calculate_direction(
30094ec26c8SJari Vanhala 				effect->direction,
30194ec26c8SJari Vanhala 				effect->u.rumble.strong_magnitude,
30294ec26c8SJari Vanhala 				new->direction, i);
30394ec26c8SJari Vanhala 		else
30494ec26c8SJari Vanhala 			effect->direction = 0;
3057d928a2bSAnssi Hannula 		effect->u.rumble.strong_magnitude =
3067d928a2bSAnssi Hannula 			min(i + effect->u.rumble.strong_magnitude, 0xffffU);
3077d928a2bSAnssi Hannula 		effect->u.rumble.weak_magnitude =
3087d928a2bSAnssi Hannula 			min(i + effect->u.rumble.weak_magnitude, 0xffffU);
3097d928a2bSAnssi Hannula 		break;
3107d928a2bSAnssi Hannula 
3117d928a2bSAnssi Hannula 	default:
312da0c4901SJoe Perches 		pr_err("invalid type in ml_combine_effects()\n");
3137d928a2bSAnssi Hannula 		break;
3147d928a2bSAnssi Hannula 	}
3157d928a2bSAnssi Hannula 
3167d928a2bSAnssi Hannula }
3177d928a2bSAnssi Hannula 
3187d928a2bSAnssi Hannula 
3197d928a2bSAnssi Hannula /*
3207d928a2bSAnssi Hannula  * Because memoryless devices have only one effect per effect type active
3217d928a2bSAnssi Hannula  * at one time we have to combine multiple effects into one
3227d928a2bSAnssi Hannula  */
ml_get_combo_effect(struct ml_device * ml,unsigned long * effect_handled,struct ff_effect * combo_effect)3237d928a2bSAnssi Hannula static int ml_get_combo_effect(struct ml_device *ml,
3247d928a2bSAnssi Hannula 			       unsigned long *effect_handled,
3257d928a2bSAnssi Hannula 			       struct ff_effect *combo_effect)
3267d928a2bSAnssi Hannula {
3277d928a2bSAnssi Hannula 	struct ff_effect *effect;
3287d928a2bSAnssi Hannula 	struct ml_effect_state *state;
3297d928a2bSAnssi Hannula 	int effect_type;
3307d928a2bSAnssi Hannula 	int i;
3317d928a2bSAnssi Hannula 
3327d928a2bSAnssi Hannula 	memset(combo_effect, 0, sizeof(struct ff_effect));
3337d928a2bSAnssi Hannula 
3347d928a2bSAnssi Hannula 	for (i = 0; i < FF_MEMLESS_EFFECTS; i++) {
3357d928a2bSAnssi Hannula 		if (__test_and_set_bit(i, effect_handled))
3367d928a2bSAnssi Hannula 			continue;
3377d928a2bSAnssi Hannula 
3387d928a2bSAnssi Hannula 		state = &ml->states[i];
3397d928a2bSAnssi Hannula 		effect = state->effect;
3407d928a2bSAnssi Hannula 
3417d928a2bSAnssi Hannula 		if (!test_bit(FF_EFFECT_STARTED, &state->flags))
3427d928a2bSAnssi Hannula 			continue;
3437d928a2bSAnssi Hannula 
3447d928a2bSAnssi Hannula 		if (time_before(jiffies, state->play_at))
3457d928a2bSAnssi Hannula 			continue;
3467d928a2bSAnssi Hannula 
3477d928a2bSAnssi Hannula 		/*
3487d928a2bSAnssi Hannula 		 * here we have started effects that are either
3497d928a2bSAnssi Hannula 		 * currently playing (and may need be aborted)
3507d928a2bSAnssi Hannula 		 * or need to start playing.
3517d928a2bSAnssi Hannula 		 */
3527d928a2bSAnssi Hannula 		effect_type = get_compatible_type(ml->dev->ff, effect->type);
3537d928a2bSAnssi Hannula 		if (combo_effect->type != effect_type) {
3547d928a2bSAnssi Hannula 			if (combo_effect->type != 0) {
3557d928a2bSAnssi Hannula 				__clear_bit(i, effect_handled);
3567d928a2bSAnssi Hannula 				continue;
3577d928a2bSAnssi Hannula 			}
3587d928a2bSAnssi Hannula 			combo_effect->type = effect_type;
3597d928a2bSAnssi Hannula 		}
3607d928a2bSAnssi Hannula 
3617d928a2bSAnssi Hannula 		if (__test_and_clear_bit(FF_EFFECT_ABORTING, &state->flags)) {
3627d928a2bSAnssi Hannula 			__clear_bit(FF_EFFECT_PLAYING, &state->flags);
3637d928a2bSAnssi Hannula 			__clear_bit(FF_EFFECT_STARTED, &state->flags);
3647d928a2bSAnssi Hannula 		} else if (effect->replay.length &&
3657d928a2bSAnssi Hannula 			   time_after_eq(jiffies, state->stop_at)) {
3667d928a2bSAnssi Hannula 
3677d928a2bSAnssi Hannula 			__clear_bit(FF_EFFECT_PLAYING, &state->flags);
3687d928a2bSAnssi Hannula 
3697d928a2bSAnssi Hannula 			if (--state->count <= 0) {
3707d928a2bSAnssi Hannula 				__clear_bit(FF_EFFECT_STARTED, &state->flags);
3717d928a2bSAnssi Hannula 			} else {
3727d928a2bSAnssi Hannula 				state->play_at = jiffies +
3737d928a2bSAnssi Hannula 					msecs_to_jiffies(effect->replay.delay);
3747d928a2bSAnssi Hannula 				state->stop_at = state->play_at +
3757d928a2bSAnssi Hannula 					msecs_to_jiffies(effect->replay.length);
3767d928a2bSAnssi Hannula 			}
3777d928a2bSAnssi Hannula 		} else {
3787d928a2bSAnssi Hannula 			__set_bit(FF_EFFECT_PLAYING, &state->flags);
3797d928a2bSAnssi Hannula 			state->adj_at = jiffies;
3807d928a2bSAnssi Hannula 			ml_combine_effects(combo_effect, state, ml->gain);
3817d928a2bSAnssi Hannula 		}
3827d928a2bSAnssi Hannula 	}
3837d928a2bSAnssi Hannula 
3847d928a2bSAnssi Hannula 	return combo_effect->type != 0;
3857d928a2bSAnssi Hannula }
3867d928a2bSAnssi Hannula 
ml_play_effects(struct ml_device * ml)3877d928a2bSAnssi Hannula static void ml_play_effects(struct ml_device *ml)
3887d928a2bSAnssi Hannula {
3897d928a2bSAnssi Hannula 	struct ff_effect effect;
3907d928a2bSAnssi Hannula 	DECLARE_BITMAP(handled_bm, FF_MEMLESS_EFFECTS);
3917d928a2bSAnssi Hannula 
3927d928a2bSAnssi Hannula 	memset(handled_bm, 0, sizeof(handled_bm));
3937d928a2bSAnssi Hannula 
3947d928a2bSAnssi Hannula 	while (ml_get_combo_effect(ml, handled_bm, &effect))
3957d928a2bSAnssi Hannula 		ml->play_effect(ml->dev, ml->private, &effect);
3967d928a2bSAnssi Hannula 
3977d928a2bSAnssi Hannula 	ml_schedule_timer(ml);
3987d928a2bSAnssi Hannula }
3997d928a2bSAnssi Hannula 
ml_effect_timer(struct timer_list * t)40034445d4bSKees Cook static void ml_effect_timer(struct timer_list *t)
4017d928a2bSAnssi Hannula {
40234445d4bSKees Cook 	struct ml_device *ml = from_timer(ml, t, timer);
40334445d4bSKees Cook 	struct input_dev *dev = ml->dev;
4047d928a2bSAnssi Hannula 
405da0c4901SJoe Perches 	pr_debug("timer: updating effects\n");
4067d928a2bSAnssi Hannula 
407cec6b33aSDmitry Torokhov 	guard(spinlock_irqsave)(&dev->event_lock);
4087d928a2bSAnssi Hannula 	ml_play_effects(ml);
4097d928a2bSAnssi Hannula }
4107d928a2bSAnssi Hannula 
411bf3204cbSDmitry Torokhov /*
412bf3204cbSDmitry Torokhov  * Sets requested gain for FF effects. Called with dev->event_lock held.
413bf3204cbSDmitry Torokhov  */
ml_ff_set_gain(struct input_dev * dev,u16 gain)4147d928a2bSAnssi Hannula static void ml_ff_set_gain(struct input_dev *dev, u16 gain)
4157d928a2bSAnssi Hannula {
4167d928a2bSAnssi Hannula 	struct ml_device *ml = dev->ff->private;
4177d928a2bSAnssi Hannula 	int i;
4187d928a2bSAnssi Hannula 
4197d928a2bSAnssi Hannula 	ml->gain = gain;
4207d928a2bSAnssi Hannula 
4217d928a2bSAnssi Hannula 	for (i = 0; i < FF_MEMLESS_EFFECTS; i++)
4227d928a2bSAnssi Hannula 		__clear_bit(FF_EFFECT_PLAYING, &ml->states[i].flags);
4237d928a2bSAnssi Hannula 
4247d928a2bSAnssi Hannula 	ml_play_effects(ml);
4257d928a2bSAnssi Hannula }
4267d928a2bSAnssi Hannula 
427bf3204cbSDmitry Torokhov /*
428bf3204cbSDmitry Torokhov  * Start/stop specified FF effect. Called with dev->event_lock held.
429bf3204cbSDmitry Torokhov  */
ml_ff_playback(struct input_dev * dev,int effect_id,int value)4307d928a2bSAnssi Hannula static int ml_ff_playback(struct input_dev *dev, int effect_id, int value)
4317d928a2bSAnssi Hannula {
4327d928a2bSAnssi Hannula 	struct ml_device *ml = dev->ff->private;
4337d928a2bSAnssi Hannula 	struct ml_effect_state *state = &ml->states[effect_id];
4347d928a2bSAnssi Hannula 
4357d928a2bSAnssi Hannula 	if (value > 0) {
436da0c4901SJoe Perches 		pr_debug("initiated play\n");
4377d928a2bSAnssi Hannula 
4387d928a2bSAnssi Hannula 		__set_bit(FF_EFFECT_STARTED, &state->flags);
4397d928a2bSAnssi Hannula 		state->count = value;
4407d928a2bSAnssi Hannula 		state->play_at = jiffies +
4417d928a2bSAnssi Hannula 				 msecs_to_jiffies(state->effect->replay.delay);
4427d928a2bSAnssi Hannula 		state->stop_at = state->play_at +
4437d928a2bSAnssi Hannula 				 msecs_to_jiffies(state->effect->replay.length);
4447d928a2bSAnssi Hannula 		state->adj_at = state->play_at;
4457d928a2bSAnssi Hannula 
4467d928a2bSAnssi Hannula 	} else {
447da0c4901SJoe Perches 		pr_debug("initiated stop\n");
4487d928a2bSAnssi Hannula 
4497d928a2bSAnssi Hannula 		if (test_bit(FF_EFFECT_PLAYING, &state->flags))
4507d928a2bSAnssi Hannula 			__set_bit(FF_EFFECT_ABORTING, &state->flags);
4517d928a2bSAnssi Hannula 		else
4527d928a2bSAnssi Hannula 			__clear_bit(FF_EFFECT_STARTED, &state->flags);
45325ae0831SJari Vanhala 	}
4547d928a2bSAnssi Hannula 
4557d928a2bSAnssi Hannula 	ml_play_effects(ml);
4567d928a2bSAnssi Hannula 
4577d928a2bSAnssi Hannula 	return 0;
4587d928a2bSAnssi Hannula }
4597d928a2bSAnssi Hannula 
ml_ff_upload(struct input_dev * dev,struct ff_effect * effect,struct ff_effect * old)4607d928a2bSAnssi Hannula static int ml_ff_upload(struct input_dev *dev,
4617d928a2bSAnssi Hannula 			struct ff_effect *effect, struct ff_effect *old)
4627d928a2bSAnssi Hannula {
4637d928a2bSAnssi Hannula 	struct ml_device *ml = dev->ff->private;
4647d928a2bSAnssi Hannula 	struct ml_effect_state *state = &ml->states[effect->id];
4657d928a2bSAnssi Hannula 
466cec6b33aSDmitry Torokhov 	guard(spinlock_irq)(&dev->event_lock);
4677d928a2bSAnssi Hannula 
4687d928a2bSAnssi Hannula 	if (test_bit(FF_EFFECT_STARTED, &state->flags)) {
4697d928a2bSAnssi Hannula 		__clear_bit(FF_EFFECT_PLAYING, &state->flags);
4707d928a2bSAnssi Hannula 		state->play_at = jiffies +
4717d928a2bSAnssi Hannula 				 msecs_to_jiffies(state->effect->replay.delay);
4727d928a2bSAnssi Hannula 		state->stop_at = state->play_at +
4737d928a2bSAnssi Hannula 				 msecs_to_jiffies(state->effect->replay.length);
4747d928a2bSAnssi Hannula 		state->adj_at = state->play_at;
4757d928a2bSAnssi Hannula 		ml_schedule_timer(ml);
4767d928a2bSAnssi Hannula 	}
4777d928a2bSAnssi Hannula 
4787d928a2bSAnssi Hannula 	return 0;
4797d928a2bSAnssi Hannula }
4807d928a2bSAnssi Hannula 
ml_ff_destroy(struct ff_device * ff)4817d928a2bSAnssi Hannula static void ml_ff_destroy(struct ff_device *ff)
4827d928a2bSAnssi Hannula {
4837d928a2bSAnssi Hannula 	struct ml_device *ml = ff->private;
4847d928a2bSAnssi Hannula 
485fa3a5a18SOliver Neukum 	/*
486fa3a5a18SOliver Neukum 	 * Even though we stop all playing effects when tearing down
487fa3a5a18SOliver Neukum 	 * an input device (via input_device_flush() that calls into
488fa3a5a18SOliver Neukum 	 * input_ff_flush() that stops and erases all effects), we
489fa3a5a18SOliver Neukum 	 * do not actually stop the timer, and therefore we should
490fa3a5a18SOliver Neukum 	 * do it here.
491fa3a5a18SOliver Neukum 	 */
492*8fa7292fSThomas Gleixner 	timer_delete_sync(&ml->timer);
493fa3a5a18SOliver Neukum 
4947d928a2bSAnssi Hannula 	kfree(ml->private);
4957d928a2bSAnssi Hannula }
4967d928a2bSAnssi Hannula 
4977d928a2bSAnssi Hannula /**
498e4477d2dSRandy Dunlap  * input_ff_create_memless() - create memoryless force-feedback device
4997d928a2bSAnssi Hannula  * @dev: input device supporting force-feedback
5007d928a2bSAnssi Hannula  * @data: driver-specific data to be passed into @play_effect
5017d928a2bSAnssi Hannula  * @play_effect: driver-specific method for playing FF effect
5027d928a2bSAnssi Hannula  */
input_ff_create_memless(struct input_dev * dev,void * data,int (* play_effect)(struct input_dev *,void *,struct ff_effect *))5037d928a2bSAnssi Hannula int input_ff_create_memless(struct input_dev *dev, void *data,
5047d928a2bSAnssi Hannula 		int (*play_effect)(struct input_dev *, void *, struct ff_effect *))
5057d928a2bSAnssi Hannula {
5067d928a2bSAnssi Hannula 	struct ff_device *ff;
5077d928a2bSAnssi Hannula 	int error;
5087d928a2bSAnssi Hannula 	int i;
5097d928a2bSAnssi Hannula 
51096173d61SDmitry Torokhov 	struct ml_device *ml __free(kfree) = kzalloc(sizeof(*ml), GFP_KERNEL);
5117d928a2bSAnssi Hannula 	if (!ml)
5127d928a2bSAnssi Hannula 		return -ENOMEM;
5137d928a2bSAnssi Hannula 
5147d928a2bSAnssi Hannula 	ml->dev = dev;
5157d928a2bSAnssi Hannula 	ml->private = data;
5167d928a2bSAnssi Hannula 	ml->play_effect = play_effect;
5177d928a2bSAnssi Hannula 	ml->gain = 0xffff;
51834445d4bSKees Cook 	timer_setup(&ml->timer, ml_effect_timer, 0);
5197d928a2bSAnssi Hannula 
5207d928a2bSAnssi Hannula 	set_bit(FF_GAIN, dev->ffbit);
5217d928a2bSAnssi Hannula 
5227d928a2bSAnssi Hannula 	error = input_ff_create(dev, FF_MEMLESS_EFFECTS);
52396173d61SDmitry Torokhov 	if (error)
5247d928a2bSAnssi Hannula 		return error;
5257d928a2bSAnssi Hannula 
5267d928a2bSAnssi Hannula 	ff = dev->ff;
5277d928a2bSAnssi Hannula 	ff->upload = ml_ff_upload;
5287d928a2bSAnssi Hannula 	ff->playback = ml_ff_playback;
5297d928a2bSAnssi Hannula 	ff->set_gain = ml_ff_set_gain;
5307d928a2bSAnssi Hannula 	ff->destroy = ml_ff_destroy;
5317d928a2bSAnssi Hannula 
5327d928a2bSAnssi Hannula 	/* we can emulate periodic effects with RUMBLE */
5337d928a2bSAnssi Hannula 	if (test_bit(FF_RUMBLE, ff->ffbit)) {
5347d928a2bSAnssi Hannula 		set_bit(FF_PERIODIC, dev->ffbit);
5357d928a2bSAnssi Hannula 		set_bit(FF_SINE, dev->ffbit);
5367d928a2bSAnssi Hannula 		set_bit(FF_TRIANGLE, dev->ffbit);
5377d928a2bSAnssi Hannula 		set_bit(FF_SQUARE, dev->ffbit);
5387d928a2bSAnssi Hannula 	}
5397d928a2bSAnssi Hannula 
5407d928a2bSAnssi Hannula 	for (i = 0; i < FF_MEMLESS_EFFECTS; i++)
5417d928a2bSAnssi Hannula 		ml->states[i].effect = &ff->effects[i];
5427d928a2bSAnssi Hannula 
54396173d61SDmitry Torokhov 	ff->private = no_free_ptr(ml);
54496173d61SDmitry Torokhov 
5457d928a2bSAnssi Hannula 	return 0;
5467d928a2bSAnssi Hannula }
5477d928a2bSAnssi Hannula EXPORT_SYMBOL_GPL(input_ff_create_memless);
548