xref: /linux-6.15/drivers/input/ff-memless.c (revision 9e68177e)
17d928a2bSAnssi Hannula /*
27d928a2bSAnssi Hannula  *  Force feedback support for memoryless devices
37d928a2bSAnssi Hannula  *
47d928a2bSAnssi Hannula  *  Copyright (c) 2006 Anssi Hannula <[email protected]>
57d928a2bSAnssi Hannula  *  Copyright (c) 2006 Dmitry Torokhov <[email protected]>
67d928a2bSAnssi Hannula  */
77d928a2bSAnssi Hannula 
87d928a2bSAnssi Hannula /*
97d928a2bSAnssi Hannula  * This program is free software; you can redistribute it and/or modify
107d928a2bSAnssi Hannula  * it under the terms of the GNU General Public License as published by
117d928a2bSAnssi Hannula  * the Free Software Foundation; either version 2 of the License, or
127d928a2bSAnssi Hannula  * (at your option) any later version.
137d928a2bSAnssi Hannula  *
147d928a2bSAnssi Hannula  * This program is distributed in the hope that it will be useful,
157d928a2bSAnssi Hannula  * but WITHOUT ANY WARRANTY; without even the implied warranty of
167d928a2bSAnssi Hannula  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
177d928a2bSAnssi Hannula  * GNU General Public License for more details.
187d928a2bSAnssi Hannula  *
197d928a2bSAnssi Hannula  * You should have received a copy of the GNU General Public License
207d928a2bSAnssi Hannula  * along with this program; if not, write to the Free Software
217d928a2bSAnssi Hannula  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
227d928a2bSAnssi Hannula  */
237d928a2bSAnssi Hannula 
247d928a2bSAnssi Hannula /* #define DEBUG */
257d928a2bSAnssi Hannula 
267d928a2bSAnssi Hannula #define debug(format, arg...) pr_debug("ff-memless: " format "\n", ## arg)
277d928a2bSAnssi Hannula 
287d928a2bSAnssi Hannula #include <linux/input.h>
297d928a2bSAnssi Hannula #include <linux/module.h>
307d928a2bSAnssi Hannula #include <linux/mutex.h>
317d928a2bSAnssi Hannula #include <linux/spinlock.h>
32cd354f1aSTim Schmielau #include <linux/jiffies.h>
337d928a2bSAnssi Hannula 
347d928a2bSAnssi Hannula #include "fixp-arith.h"
357d928a2bSAnssi Hannula 
367d928a2bSAnssi Hannula MODULE_LICENSE("GPL");
377d928a2bSAnssi Hannula MODULE_AUTHOR("Anssi Hannula <[email protected]>");
387d928a2bSAnssi Hannula MODULE_DESCRIPTION("Force feedback support for memoryless devices");
397d928a2bSAnssi Hannula 
407d928a2bSAnssi Hannula /* Number of effects handled with memoryless devices */
417d928a2bSAnssi Hannula #define FF_MEMLESS_EFFECTS	16
427d928a2bSAnssi Hannula 
437d928a2bSAnssi Hannula /* Envelope update interval in ms */
447d928a2bSAnssi Hannula #define FF_ENVELOPE_INTERVAL	50
457d928a2bSAnssi Hannula 
467d928a2bSAnssi Hannula #define FF_EFFECT_STARTED	0
477d928a2bSAnssi Hannula #define FF_EFFECT_PLAYING	1
487d928a2bSAnssi Hannula #define FF_EFFECT_ABORTING	2
497d928a2bSAnssi Hannula 
507d928a2bSAnssi Hannula struct ml_effect_state {
517d928a2bSAnssi Hannula 	struct ff_effect *effect;
527d928a2bSAnssi Hannula 	unsigned long flags;	/* effect state (STARTED, PLAYING, etc) */
537d928a2bSAnssi Hannula 	int count;		/* loop count of the effect */
547d928a2bSAnssi Hannula 	unsigned long play_at;	/* start time */
557d928a2bSAnssi Hannula 	unsigned long stop_at;	/* stop time */
567d928a2bSAnssi Hannula 	unsigned long adj_at;	/* last time the effect was sent */
577d928a2bSAnssi Hannula };
587d928a2bSAnssi Hannula 
597d928a2bSAnssi Hannula struct ml_device {
607d928a2bSAnssi Hannula 	void *private;
617d928a2bSAnssi Hannula 	struct ml_effect_state states[FF_MEMLESS_EFFECTS];
627d928a2bSAnssi Hannula 	int gain;
637d928a2bSAnssi Hannula 	struct timer_list timer;
647d928a2bSAnssi Hannula 	spinlock_t timer_lock;
657d928a2bSAnssi Hannula 	struct input_dev *dev;
667d928a2bSAnssi Hannula 
677d928a2bSAnssi Hannula 	int (*play_effect)(struct input_dev *dev, void *data,
687d928a2bSAnssi Hannula 			   struct ff_effect *effect);
697d928a2bSAnssi Hannula };
707d928a2bSAnssi Hannula 
717d928a2bSAnssi Hannula static const struct ff_envelope *get_envelope(const struct ff_effect *effect)
727d928a2bSAnssi Hannula {
737d928a2bSAnssi Hannula 	static const struct ff_envelope empty_envelope;
747d928a2bSAnssi Hannula 
757d928a2bSAnssi Hannula 	switch (effect->type) {
767d928a2bSAnssi Hannula 		case FF_PERIODIC:
777d928a2bSAnssi Hannula 			return &effect->u.periodic.envelope;
787d928a2bSAnssi Hannula 		case FF_CONSTANT:
797d928a2bSAnssi Hannula 			return &effect->u.constant.envelope;
807d928a2bSAnssi Hannula 		default:
817d928a2bSAnssi Hannula 			return &empty_envelope;
827d928a2bSAnssi Hannula 	}
837d928a2bSAnssi Hannula }
847d928a2bSAnssi Hannula 
857d928a2bSAnssi Hannula /*
867d928a2bSAnssi Hannula  * Check for the next time envelope requires an update on memoryless devices
877d928a2bSAnssi Hannula  */
887d928a2bSAnssi Hannula static unsigned long calculate_next_time(struct ml_effect_state *state)
897d928a2bSAnssi Hannula {
907d928a2bSAnssi Hannula 	const struct ff_envelope *envelope = get_envelope(state->effect);
917d928a2bSAnssi Hannula 	unsigned long attack_stop, fade_start, next_fade;
927d928a2bSAnssi Hannula 
937d928a2bSAnssi Hannula 	if (envelope->attack_length) {
947d928a2bSAnssi Hannula 		attack_stop = state->play_at +
957d928a2bSAnssi Hannula 			msecs_to_jiffies(envelope->attack_length);
967d928a2bSAnssi Hannula 		if (time_before(state->adj_at, attack_stop))
977d928a2bSAnssi Hannula 			return state->adj_at +
987d928a2bSAnssi Hannula 					msecs_to_jiffies(FF_ENVELOPE_INTERVAL);
997d928a2bSAnssi Hannula 	}
1007d928a2bSAnssi Hannula 
1017d928a2bSAnssi Hannula 	if (state->effect->replay.length) {
1027d928a2bSAnssi Hannula 		if (envelope->fade_length) {
1037d928a2bSAnssi Hannula 			/* check when fading should start */
1047d928a2bSAnssi Hannula 			fade_start = state->stop_at -
1057d928a2bSAnssi Hannula 					msecs_to_jiffies(envelope->fade_length);
1067d928a2bSAnssi Hannula 
1077d928a2bSAnssi Hannula 			if (time_before(state->adj_at, fade_start))
1087d928a2bSAnssi Hannula 				return fade_start;
1097d928a2bSAnssi Hannula 
1107d928a2bSAnssi Hannula 			/* already fading, advance to next checkpoint */
1117d928a2bSAnssi Hannula 			next_fade = state->adj_at +
1127d928a2bSAnssi Hannula 					msecs_to_jiffies(FF_ENVELOPE_INTERVAL);
1137d928a2bSAnssi Hannula 			if (time_before(next_fade, state->stop_at))
1147d928a2bSAnssi Hannula 				return next_fade;
1157d928a2bSAnssi Hannula 		}
1167d928a2bSAnssi Hannula 
1177d928a2bSAnssi Hannula 		return state->stop_at;
1187d928a2bSAnssi Hannula 	}
1197d928a2bSAnssi Hannula 
1207d928a2bSAnssi Hannula 	return state->play_at;
1217d928a2bSAnssi Hannula }
1227d928a2bSAnssi Hannula 
1237d928a2bSAnssi Hannula static void ml_schedule_timer(struct ml_device *ml)
1247d928a2bSAnssi Hannula {
1257d928a2bSAnssi Hannula 	struct ml_effect_state *state;
1267d928a2bSAnssi Hannula 	unsigned long now = jiffies;
1277d928a2bSAnssi Hannula 	unsigned long earliest = 0;
1287d928a2bSAnssi Hannula 	unsigned long next_at;
1297d928a2bSAnssi Hannula 	int events = 0;
1307d928a2bSAnssi Hannula 	int i;
1317d928a2bSAnssi Hannula 
1327d928a2bSAnssi Hannula 	debug("calculating next timer");
1337d928a2bSAnssi Hannula 
1347d928a2bSAnssi Hannula 	for (i = 0; i < FF_MEMLESS_EFFECTS; i++) {
1357d928a2bSAnssi Hannula 
1367d928a2bSAnssi Hannula 		state = &ml->states[i];
1377d928a2bSAnssi Hannula 
1387d928a2bSAnssi Hannula 		if (!test_bit(FF_EFFECT_STARTED, &state->flags))
1397d928a2bSAnssi Hannula 			continue;
1407d928a2bSAnssi Hannula 
1417d928a2bSAnssi Hannula 		if (test_bit(FF_EFFECT_PLAYING, &state->flags))
1427d928a2bSAnssi Hannula 			next_at = calculate_next_time(state);
1437d928a2bSAnssi Hannula 		else
1447d928a2bSAnssi Hannula 			next_at = state->play_at;
1457d928a2bSAnssi Hannula 
1467d928a2bSAnssi Hannula 		if (time_before_eq(now, next_at) &&
1477d928a2bSAnssi Hannula 		    (++events == 1 || time_before(next_at, earliest)))
1487d928a2bSAnssi Hannula 			earliest = next_at;
1497d928a2bSAnssi Hannula 	}
1507d928a2bSAnssi Hannula 
1517d928a2bSAnssi Hannula 	if (!events) {
1527d928a2bSAnssi Hannula 		debug("no actions");
1537d928a2bSAnssi Hannula 		del_timer(&ml->timer);
1547d928a2bSAnssi Hannula 	} else {
1557d928a2bSAnssi Hannula 		debug("timer set");
1567d928a2bSAnssi Hannula 		mod_timer(&ml->timer, earliest);
1577d928a2bSAnssi Hannula 	}
1587d928a2bSAnssi Hannula }
1597d928a2bSAnssi Hannula 
1607d928a2bSAnssi Hannula /*
1617d928a2bSAnssi Hannula  * Apply an envelope to a value
1627d928a2bSAnssi Hannula  */
1637d928a2bSAnssi Hannula static int apply_envelope(struct ml_effect_state *state, int value,
1647d928a2bSAnssi Hannula 			  struct ff_envelope *envelope)
1657d928a2bSAnssi Hannula {
1667d928a2bSAnssi Hannula 	struct ff_effect *effect = state->effect;
1677d928a2bSAnssi Hannula 	unsigned long now = jiffies;
1687d928a2bSAnssi Hannula 	int time_from_level;
1697d928a2bSAnssi Hannula 	int time_of_envelope;
1707d928a2bSAnssi Hannula 	int envelope_level;
1717d928a2bSAnssi Hannula 	int difference;
1727d928a2bSAnssi Hannula 
1737d928a2bSAnssi Hannula 	if (envelope->attack_length &&
1747d928a2bSAnssi Hannula 	    time_before(now,
1757d928a2bSAnssi Hannula 			state->play_at + msecs_to_jiffies(envelope->attack_length))) {
1767d928a2bSAnssi Hannula 		debug("value = 0x%x, attack_level = 0x%x", value,
1777d928a2bSAnssi Hannula 		      envelope->attack_level);
1787d928a2bSAnssi Hannula 		time_from_level = jiffies_to_msecs(now - state->play_at);
1797d928a2bSAnssi Hannula 		time_of_envelope = envelope->attack_length;
1807d928a2bSAnssi Hannula 		envelope_level = min_t(__s16, envelope->attack_level, 0x7fff);
1817d928a2bSAnssi Hannula 
1827d928a2bSAnssi Hannula 	} else if (envelope->fade_length && effect->replay.length &&
1837d928a2bSAnssi Hannula 		   time_after(now,
1847d928a2bSAnssi Hannula 			      state->stop_at - msecs_to_jiffies(envelope->fade_length)) &&
1857d928a2bSAnssi Hannula 		   time_before(now, state->stop_at)) {
1867d928a2bSAnssi Hannula 		time_from_level = jiffies_to_msecs(state->stop_at - now);
1877d928a2bSAnssi Hannula 		time_of_envelope = envelope->fade_length;
1887d928a2bSAnssi Hannula 		envelope_level = min_t(__s16, envelope->fade_level, 0x7fff);
1897d928a2bSAnssi Hannula 	} else
1907d928a2bSAnssi Hannula 		return value;
1917d928a2bSAnssi Hannula 
1927d928a2bSAnssi Hannula 	difference = abs(value) - envelope_level;
1937d928a2bSAnssi Hannula 
1947d928a2bSAnssi Hannula 	debug("difference = %d", difference);
1957d928a2bSAnssi Hannula 	debug("time_from_level = 0x%x", time_from_level);
1967d928a2bSAnssi Hannula 	debug("time_of_envelope = 0x%x", time_of_envelope);
1977d928a2bSAnssi Hannula 
1987d928a2bSAnssi Hannula 	difference = difference * time_from_level / time_of_envelope;
1997d928a2bSAnssi Hannula 
2007d928a2bSAnssi Hannula 	debug("difference = %d", difference);
2017d928a2bSAnssi Hannula 
2027d928a2bSAnssi Hannula 	return value < 0 ?
2037d928a2bSAnssi Hannula 		-(difference + envelope_level) : (difference + envelope_level);
2047d928a2bSAnssi Hannula }
2057d928a2bSAnssi Hannula 
2067d928a2bSAnssi Hannula /*
2077d928a2bSAnssi Hannula  * Return the type the effect has to be converted into (memless devices)
2087d928a2bSAnssi Hannula  */
2097d928a2bSAnssi Hannula static int get_compatible_type(struct ff_device *ff, int effect_type)
2107d928a2bSAnssi Hannula {
2117d928a2bSAnssi Hannula 
2127d928a2bSAnssi Hannula 	if (test_bit(effect_type, ff->ffbit))
2137d928a2bSAnssi Hannula 		return effect_type;
2147d928a2bSAnssi Hannula 
2157d928a2bSAnssi Hannula 	if (effect_type == FF_PERIODIC && test_bit(FF_RUMBLE, ff->ffbit))
2167d928a2bSAnssi Hannula 		return FF_RUMBLE;
2177d928a2bSAnssi Hannula 
2187d928a2bSAnssi Hannula 	printk(KERN_ERR
2197d928a2bSAnssi Hannula 	       "ff-memless: invalid type in get_compatible_type()\n");
2207d928a2bSAnssi Hannula 
2217d928a2bSAnssi Hannula 	return 0;
2227d928a2bSAnssi Hannula }
2237d928a2bSAnssi Hannula 
2247d928a2bSAnssi Hannula /*
2257d928a2bSAnssi Hannula  * Combine two effects and apply gain.
2267d928a2bSAnssi Hannula  */
2277d928a2bSAnssi Hannula static void ml_combine_effects(struct ff_effect *effect,
2287d928a2bSAnssi Hannula 			       struct ml_effect_state *state,
229*9e68177eSJussi Kivilinna 			       unsigned int gain)
2307d928a2bSAnssi Hannula {
2317d928a2bSAnssi Hannula 	struct ff_effect *new = state->effect;
2327d928a2bSAnssi Hannula 	unsigned int strong, weak, i;
2337d928a2bSAnssi Hannula 	int x, y;
2347d928a2bSAnssi Hannula 	fixp_t level;
2357d928a2bSAnssi Hannula 
2367d928a2bSAnssi Hannula 	switch (new->type) {
2377d928a2bSAnssi Hannula 	case FF_CONSTANT:
2387d928a2bSAnssi Hannula 		i = new->direction * 360 / 0xffff;
2397d928a2bSAnssi Hannula 		level = fixp_new16(apply_envelope(state,
2407d928a2bSAnssi Hannula 					new->u.constant.level,
2417d928a2bSAnssi Hannula 					&new->u.constant.envelope));
2427d928a2bSAnssi Hannula 		x = fixp_mult(fixp_sin(i), level) * gain / 0xffff;
2437d928a2bSAnssi Hannula 		y = fixp_mult(-fixp_cos(i), level) * gain / 0xffff;
2447d928a2bSAnssi Hannula 		/*
2457d928a2bSAnssi Hannula 		 * here we abuse ff_ramp to hold x and y of constant force
2467d928a2bSAnssi Hannula 		 * If in future any driver wants something else than x and y
2477d928a2bSAnssi Hannula 		 * in s8, this should be changed to something more generic
2487d928a2bSAnssi Hannula 		 */
2497d928a2bSAnssi Hannula 		effect->u.ramp.start_level =
25092310474SHarvey Harrison 			clamp_val(effect->u.ramp.start_level + x, -0x80, 0x7f);
2517d928a2bSAnssi Hannula 		effect->u.ramp.end_level =
25292310474SHarvey Harrison 			clamp_val(effect->u.ramp.end_level + y, -0x80, 0x7f);
2537d928a2bSAnssi Hannula 		break;
2547d928a2bSAnssi Hannula 
2557d928a2bSAnssi Hannula 	case FF_RUMBLE:
2567d928a2bSAnssi Hannula 		strong = new->u.rumble.strong_magnitude * gain / 0xffff;
2577d928a2bSAnssi Hannula 		weak = new->u.rumble.weak_magnitude * gain / 0xffff;
2587d928a2bSAnssi Hannula 		effect->u.rumble.strong_magnitude =
2597d928a2bSAnssi Hannula 			min(strong + effect->u.rumble.strong_magnitude,
2607d928a2bSAnssi Hannula 			    0xffffU);
2617d928a2bSAnssi Hannula 		effect->u.rumble.weak_magnitude =
2627d928a2bSAnssi Hannula 			min(weak + effect->u.rumble.weak_magnitude, 0xffffU);
2637d928a2bSAnssi Hannula 		break;
2647d928a2bSAnssi Hannula 
2657d928a2bSAnssi Hannula 	case FF_PERIODIC:
2667d928a2bSAnssi Hannula 		i = apply_envelope(state, abs(new->u.periodic.magnitude),
2677d928a2bSAnssi Hannula 				   &new->u.periodic.envelope);
2687d928a2bSAnssi Hannula 
2697d928a2bSAnssi Hannula 		/* here we also scale it 0x7fff => 0xffff */
2707d928a2bSAnssi Hannula 		i = i * gain / 0x7fff;
2717d928a2bSAnssi Hannula 
2727d928a2bSAnssi Hannula 		effect->u.rumble.strong_magnitude =
2737d928a2bSAnssi Hannula 			min(i + effect->u.rumble.strong_magnitude, 0xffffU);
2747d928a2bSAnssi Hannula 		effect->u.rumble.weak_magnitude =
2757d928a2bSAnssi Hannula 			min(i + effect->u.rumble.weak_magnitude, 0xffffU);
2767d928a2bSAnssi Hannula 		break;
2777d928a2bSAnssi Hannula 
2787d928a2bSAnssi Hannula 	default:
2797d928a2bSAnssi Hannula 		printk(KERN_ERR "ff-memless: invalid type in ml_combine_effects()\n");
2807d928a2bSAnssi Hannula 		break;
2817d928a2bSAnssi Hannula 	}
2827d928a2bSAnssi Hannula 
2837d928a2bSAnssi Hannula }
2847d928a2bSAnssi Hannula 
2857d928a2bSAnssi Hannula 
2867d928a2bSAnssi Hannula /*
2877d928a2bSAnssi Hannula  * Because memoryless devices have only one effect per effect type active
2887d928a2bSAnssi Hannula  * at one time we have to combine multiple effects into one
2897d928a2bSAnssi Hannula  */
2907d928a2bSAnssi Hannula static int ml_get_combo_effect(struct ml_device *ml,
2917d928a2bSAnssi Hannula 			       unsigned long *effect_handled,
2927d928a2bSAnssi Hannula 			       struct ff_effect *combo_effect)
2937d928a2bSAnssi Hannula {
2947d928a2bSAnssi Hannula 	struct ff_effect *effect;
2957d928a2bSAnssi Hannula 	struct ml_effect_state *state;
2967d928a2bSAnssi Hannula 	int effect_type;
2977d928a2bSAnssi Hannula 	int i;
2987d928a2bSAnssi Hannula 
2997d928a2bSAnssi Hannula 	memset(combo_effect, 0, sizeof(struct ff_effect));
3007d928a2bSAnssi Hannula 
3017d928a2bSAnssi Hannula 	for (i = 0; i < FF_MEMLESS_EFFECTS; i++) {
3027d928a2bSAnssi Hannula 		if (__test_and_set_bit(i, effect_handled))
3037d928a2bSAnssi Hannula 			continue;
3047d928a2bSAnssi Hannula 
3057d928a2bSAnssi Hannula 		state = &ml->states[i];
3067d928a2bSAnssi Hannula 		effect = state->effect;
3077d928a2bSAnssi Hannula 
3087d928a2bSAnssi Hannula 		if (!test_bit(FF_EFFECT_STARTED, &state->flags))
3097d928a2bSAnssi Hannula 			continue;
3107d928a2bSAnssi Hannula 
3117d928a2bSAnssi Hannula 		if (time_before(jiffies, state->play_at))
3127d928a2bSAnssi Hannula 			continue;
3137d928a2bSAnssi Hannula 
3147d928a2bSAnssi Hannula 		/*
3157d928a2bSAnssi Hannula 		 * here we have started effects that are either
3167d928a2bSAnssi Hannula 		 * currently playing (and may need be aborted)
3177d928a2bSAnssi Hannula 		 * or need to start playing.
3187d928a2bSAnssi Hannula 		 */
3197d928a2bSAnssi Hannula 		effect_type = get_compatible_type(ml->dev->ff, effect->type);
3207d928a2bSAnssi Hannula 		if (combo_effect->type != effect_type) {
3217d928a2bSAnssi Hannula 			if (combo_effect->type != 0) {
3227d928a2bSAnssi Hannula 				__clear_bit(i, effect_handled);
3237d928a2bSAnssi Hannula 				continue;
3247d928a2bSAnssi Hannula 			}
3257d928a2bSAnssi Hannula 			combo_effect->type = effect_type;
3267d928a2bSAnssi Hannula 		}
3277d928a2bSAnssi Hannula 
3287d928a2bSAnssi Hannula 		if (__test_and_clear_bit(FF_EFFECT_ABORTING, &state->flags)) {
3297d928a2bSAnssi Hannula 			__clear_bit(FF_EFFECT_PLAYING, &state->flags);
3307d928a2bSAnssi Hannula 			__clear_bit(FF_EFFECT_STARTED, &state->flags);
3317d928a2bSAnssi Hannula 		} else if (effect->replay.length &&
3327d928a2bSAnssi Hannula 			   time_after_eq(jiffies, state->stop_at)) {
3337d928a2bSAnssi Hannula 
3347d928a2bSAnssi Hannula 			__clear_bit(FF_EFFECT_PLAYING, &state->flags);
3357d928a2bSAnssi Hannula 
3367d928a2bSAnssi Hannula 			if (--state->count <= 0) {
3377d928a2bSAnssi Hannula 				__clear_bit(FF_EFFECT_STARTED, &state->flags);
3387d928a2bSAnssi Hannula 			} else {
3397d928a2bSAnssi Hannula 				state->play_at = jiffies +
3407d928a2bSAnssi Hannula 					msecs_to_jiffies(effect->replay.delay);
3417d928a2bSAnssi Hannula 				state->stop_at = state->play_at +
3427d928a2bSAnssi Hannula 					msecs_to_jiffies(effect->replay.length);
3437d928a2bSAnssi Hannula 			}
3447d928a2bSAnssi Hannula 		} else {
3457d928a2bSAnssi Hannula 			__set_bit(FF_EFFECT_PLAYING, &state->flags);
3467d928a2bSAnssi Hannula 			state->adj_at = jiffies;
3477d928a2bSAnssi Hannula 			ml_combine_effects(combo_effect, state, ml->gain);
3487d928a2bSAnssi Hannula 		}
3497d928a2bSAnssi Hannula 	}
3507d928a2bSAnssi Hannula 
3517d928a2bSAnssi Hannula 	return combo_effect->type != 0;
3527d928a2bSAnssi Hannula }
3537d928a2bSAnssi Hannula 
3547d928a2bSAnssi Hannula static void ml_play_effects(struct ml_device *ml)
3557d928a2bSAnssi Hannula {
3567d928a2bSAnssi Hannula 	struct ff_effect effect;
3577d928a2bSAnssi Hannula 	DECLARE_BITMAP(handled_bm, FF_MEMLESS_EFFECTS);
3587d928a2bSAnssi Hannula 
3597d928a2bSAnssi Hannula 	memset(handled_bm, 0, sizeof(handled_bm));
3607d928a2bSAnssi Hannula 
3617d928a2bSAnssi Hannula 	while (ml_get_combo_effect(ml, handled_bm, &effect))
3627d928a2bSAnssi Hannula 		ml->play_effect(ml->dev, ml->private, &effect);
3637d928a2bSAnssi Hannula 
3647d928a2bSAnssi Hannula 	ml_schedule_timer(ml);
3657d928a2bSAnssi Hannula }
3667d928a2bSAnssi Hannula 
3677d928a2bSAnssi Hannula static void ml_effect_timer(unsigned long timer_data)
3687d928a2bSAnssi Hannula {
3697d928a2bSAnssi Hannula 	struct input_dev *dev = (struct input_dev *)timer_data;
3707d928a2bSAnssi Hannula 	struct ml_device *ml = dev->ff->private;
3717d928a2bSAnssi Hannula 
3727d928a2bSAnssi Hannula 	debug("timer: updating effects");
3737d928a2bSAnssi Hannula 
3747d928a2bSAnssi Hannula 	spin_lock(&ml->timer_lock);
3757d928a2bSAnssi Hannula 	ml_play_effects(ml);
3767d928a2bSAnssi Hannula 	spin_unlock(&ml->timer_lock);
3777d928a2bSAnssi Hannula }
3787d928a2bSAnssi Hannula 
3797d928a2bSAnssi Hannula static void ml_ff_set_gain(struct input_dev *dev, u16 gain)
3807d928a2bSAnssi Hannula {
3817d928a2bSAnssi Hannula 	struct ml_device *ml = dev->ff->private;
3827d928a2bSAnssi Hannula 	int i;
3837d928a2bSAnssi Hannula 
3847d928a2bSAnssi Hannula 	spin_lock_bh(&ml->timer_lock);
3857d928a2bSAnssi Hannula 
3867d928a2bSAnssi Hannula 	ml->gain = gain;
3877d928a2bSAnssi Hannula 
3887d928a2bSAnssi Hannula 	for (i = 0; i < FF_MEMLESS_EFFECTS; i++)
3897d928a2bSAnssi Hannula 		__clear_bit(FF_EFFECT_PLAYING, &ml->states[i].flags);
3907d928a2bSAnssi Hannula 
3917d928a2bSAnssi Hannula 	ml_play_effects(ml);
3927d928a2bSAnssi Hannula 
3937d928a2bSAnssi Hannula 	spin_unlock_bh(&ml->timer_lock);
3947d928a2bSAnssi Hannula }
3957d928a2bSAnssi Hannula 
3967d928a2bSAnssi Hannula static int ml_ff_playback(struct input_dev *dev, int effect_id, int value)
3977d928a2bSAnssi Hannula {
3987d928a2bSAnssi Hannula 	struct ml_device *ml = dev->ff->private;
3997d928a2bSAnssi Hannula 	struct ml_effect_state *state = &ml->states[effect_id];
400211f05a0SArjan van de Ven 	unsigned long flags;
4017d928a2bSAnssi Hannula 
402211f05a0SArjan van de Ven 	spin_lock_irqsave(&ml->timer_lock, flags);
4037d928a2bSAnssi Hannula 
4047d928a2bSAnssi Hannula 	if (value > 0) {
4057d928a2bSAnssi Hannula 		debug("initiated play");
4067d928a2bSAnssi Hannula 
4077d928a2bSAnssi Hannula 		__set_bit(FF_EFFECT_STARTED, &state->flags);
4087d928a2bSAnssi Hannula 		state->count = value;
4097d928a2bSAnssi Hannula 		state->play_at = jiffies +
4107d928a2bSAnssi Hannula 				 msecs_to_jiffies(state->effect->replay.delay);
4117d928a2bSAnssi Hannula 		state->stop_at = state->play_at +
4127d928a2bSAnssi Hannula 				 msecs_to_jiffies(state->effect->replay.length);
4137d928a2bSAnssi Hannula 		state->adj_at = state->play_at;
4147d928a2bSAnssi Hannula 
4157d928a2bSAnssi Hannula 		ml_schedule_timer(ml);
4167d928a2bSAnssi Hannula 
4177d928a2bSAnssi Hannula 	} else {
4187d928a2bSAnssi Hannula 		debug("initiated stop");
4197d928a2bSAnssi Hannula 
4207d928a2bSAnssi Hannula 		if (test_bit(FF_EFFECT_PLAYING, &state->flags))
4217d928a2bSAnssi Hannula 			__set_bit(FF_EFFECT_ABORTING, &state->flags);
4227d928a2bSAnssi Hannula 		else
4237d928a2bSAnssi Hannula 			__clear_bit(FF_EFFECT_STARTED, &state->flags);
4247d928a2bSAnssi Hannula 
4257d928a2bSAnssi Hannula 		ml_play_effects(ml);
4267d928a2bSAnssi Hannula 	}
4277d928a2bSAnssi Hannula 
428211f05a0SArjan van de Ven 	spin_unlock_irqrestore(&ml->timer_lock, flags);
4297d928a2bSAnssi Hannula 
4307d928a2bSAnssi Hannula 	return 0;
4317d928a2bSAnssi Hannula }
4327d928a2bSAnssi Hannula 
4337d928a2bSAnssi Hannula static int ml_ff_upload(struct input_dev *dev,
4347d928a2bSAnssi Hannula 			struct ff_effect *effect, struct ff_effect *old)
4357d928a2bSAnssi Hannula {
4367d928a2bSAnssi Hannula 	struct ml_device *ml = dev->ff->private;
4377d928a2bSAnssi Hannula 	struct ml_effect_state *state = &ml->states[effect->id];
4387d928a2bSAnssi Hannula 
4397d928a2bSAnssi Hannula 	spin_lock_bh(&ml->timer_lock);
4407d928a2bSAnssi Hannula 
4417d928a2bSAnssi Hannula 	if (test_bit(FF_EFFECT_STARTED, &state->flags)) {
4427d928a2bSAnssi Hannula 		__clear_bit(FF_EFFECT_PLAYING, &state->flags);
4437d928a2bSAnssi Hannula 		state->play_at = jiffies +
4447d928a2bSAnssi Hannula 				 msecs_to_jiffies(state->effect->replay.delay);
4457d928a2bSAnssi Hannula 		state->stop_at = state->play_at +
4467d928a2bSAnssi Hannula 				 msecs_to_jiffies(state->effect->replay.length);
4477d928a2bSAnssi Hannula 		state->adj_at = state->play_at;
4487d928a2bSAnssi Hannula 		ml_schedule_timer(ml);
4497d928a2bSAnssi Hannula 	}
4507d928a2bSAnssi Hannula 
4517d928a2bSAnssi Hannula 	spin_unlock_bh(&ml->timer_lock);
4527d928a2bSAnssi Hannula 
4537d928a2bSAnssi Hannula 	return 0;
4547d928a2bSAnssi Hannula }
4557d928a2bSAnssi Hannula 
4567d928a2bSAnssi Hannula static void ml_ff_destroy(struct ff_device *ff)
4577d928a2bSAnssi Hannula {
4587d928a2bSAnssi Hannula 	struct ml_device *ml = ff->private;
4597d928a2bSAnssi Hannula 
4607d928a2bSAnssi Hannula 	kfree(ml->private);
4617d928a2bSAnssi Hannula }
4627d928a2bSAnssi Hannula 
4637d928a2bSAnssi Hannula /**
464e4477d2dSRandy Dunlap  * input_ff_create_memless() - create memoryless force-feedback device
4657d928a2bSAnssi Hannula  * @dev: input device supporting force-feedback
4667d928a2bSAnssi Hannula  * @data: driver-specific data to be passed into @play_effect
4677d928a2bSAnssi Hannula  * @play_effect: driver-specific method for playing FF effect
4687d928a2bSAnssi Hannula  */
4697d928a2bSAnssi Hannula int input_ff_create_memless(struct input_dev *dev, void *data,
4707d928a2bSAnssi Hannula 		int (*play_effect)(struct input_dev *, void *, struct ff_effect *))
4717d928a2bSAnssi Hannula {
4727d928a2bSAnssi Hannula 	struct ml_device *ml;
4737d928a2bSAnssi Hannula 	struct ff_device *ff;
4747d928a2bSAnssi Hannula 	int error;
4757d928a2bSAnssi Hannula 	int i;
4767d928a2bSAnssi Hannula 
4777d928a2bSAnssi Hannula 	ml = kzalloc(sizeof(struct ml_device), GFP_KERNEL);
4787d928a2bSAnssi Hannula 	if (!ml)
4797d928a2bSAnssi Hannula 		return -ENOMEM;
4807d928a2bSAnssi Hannula 
4817d928a2bSAnssi Hannula 	ml->dev = dev;
4827d928a2bSAnssi Hannula 	ml->private = data;
4837d928a2bSAnssi Hannula 	ml->play_effect = play_effect;
4847d928a2bSAnssi Hannula 	ml->gain = 0xffff;
4857d928a2bSAnssi Hannula 	spin_lock_init(&ml->timer_lock);
4867d928a2bSAnssi Hannula 	setup_timer(&ml->timer, ml_effect_timer, (unsigned long)dev);
4877d928a2bSAnssi Hannula 
4887d928a2bSAnssi Hannula 	set_bit(FF_GAIN, dev->ffbit);
4897d928a2bSAnssi Hannula 
4907d928a2bSAnssi Hannula 	error = input_ff_create(dev, FF_MEMLESS_EFFECTS);
4917d928a2bSAnssi Hannula 	if (error) {
4927d928a2bSAnssi Hannula 		kfree(ml);
4937d928a2bSAnssi Hannula 		return error;
4947d928a2bSAnssi Hannula 	}
4957d928a2bSAnssi Hannula 
4967d928a2bSAnssi Hannula 	ff = dev->ff;
4977d928a2bSAnssi Hannula 	ff->private = ml;
4987d928a2bSAnssi Hannula 	ff->upload = ml_ff_upload;
4997d928a2bSAnssi Hannula 	ff->playback = ml_ff_playback;
5007d928a2bSAnssi Hannula 	ff->set_gain = ml_ff_set_gain;
5017d928a2bSAnssi Hannula 	ff->destroy = ml_ff_destroy;
5027d928a2bSAnssi Hannula 
5037d928a2bSAnssi Hannula 	/* we can emulate periodic effects with RUMBLE */
5047d928a2bSAnssi Hannula 	if (test_bit(FF_RUMBLE, ff->ffbit)) {
5057d928a2bSAnssi Hannula 		set_bit(FF_PERIODIC, dev->ffbit);
5067d928a2bSAnssi Hannula 		set_bit(FF_SINE, dev->ffbit);
5077d928a2bSAnssi Hannula 		set_bit(FF_TRIANGLE, dev->ffbit);
5087d928a2bSAnssi Hannula 		set_bit(FF_SQUARE, dev->ffbit);
5097d928a2bSAnssi Hannula 	}
5107d928a2bSAnssi Hannula 
5117d928a2bSAnssi Hannula 	for (i = 0; i < FF_MEMLESS_EFFECTS; i++)
5127d928a2bSAnssi Hannula 		ml->states[i].effect = &ff->effects[i];
5137d928a2bSAnssi Hannula 
5147d928a2bSAnssi Hannula 	return 0;
5157d928a2bSAnssi Hannula }
5167d928a2bSAnssi Hannula EXPORT_SYMBOL_GPL(input_ff_create_memless);
517