hid: tmff2: add Thrustmaster T500RS wheel base driver

Add support for the Thrustmaster T500RS wheel base in the hid-tmff2 driver.

This driver has been built from scratch based the previous dirty driver (see #175) on captures from ffbsdl tool ran in windows for all possible effects (through SDL2 library).

Author: cazzoo

Kbuild

@@ -4,4 +4,8 @@ hid-tmff-new-y := \
 		src/tmt300rs/hid-tmt300rs.o \
 		src/tmt248/hid-tmt248.o \
 		src/tmtx/hid-tmtx.o \
-		src/tmtsxw/hid-tmtsxw.o
+		src/tmtsxw/hid-tmtsxw.o \
+		src/tmt500rs/hid-tmt500rs.o
+
+# Pass through the global TMFF2 version define from Makefile
+ccflags-y += $(TMFF2_VERSION_DEF)

Makefile

@@ -1,6 +1,30 @@
 KDIR ?= /lib/modules/$(shell uname -r)/build
 
+# Auto-generated global build-time version for TMFF2
+TMFF2_BASE_VERSION ?= 0.1
+
+# Allow packagers / CI to provide a fixed hash or full version:
+#   make GIT_HASH=deadbee
+#   make TMFF2_VERSION=0.1-1
+#
+# Only derive GIT_HASH from git if none was provided and this is a git checkout.
+ifeq ($(origin GIT_HASH), undefined)
+  GIT_HASH := $(shell if command -v git >/dev/null 2>&1 && [ -d .git ]; then \
+      git rev-parse --short=7 HEAD 2>/dev/null; \
+    else \
+      echo local; \
+    fi)
+endif
+
+BUILD_HASH := $(shell date +%s | sha1sum | cut -c1-7)
+
+TMFF2_VERSION ?= $(TMFF2_BASE_VERSION)-$(GIT_HASH)+b$(BUILD_HASH)
+export TMFF2_VERSION_DEF := -DTMFF2_DRIVER_VERSION=\"$(TMFF2_VERSION)\"
+
+
 all: deps/hid-tminit
+	@echo "TMFF2 build version: $(TMFF2_VERSION)"
+	@echo " - base: $(TMFF2_BASE_VERSION), commit: $(GIT_HASH), build: $(BUILD_HASH)"
 	$(MAKE) -C $(KDIR) M=$(shell pwd) modules
 
 install: deps/hid-tminit

docs/T500RS_USB_Protocol_Analysis.md

@@ -242,8 +242,31 @@ static ssize_t gain_store(struct device *dev,
 	}
 
 	gain = value;
-	if (tmff2->set_gain) /* if we can, update gain immediately */
-		tmff2->set_gain(tmff2->data, (GAIN_MAX * gain) / GAIN_MAX);
+
+	/* Rationale: two-level gain model
+	* - The input API's set_gain (pg) is the in-game gain (0..GAIN_MAX).
+	* - This driver also exposes a device/system gain via sysfs param `gain`.
+	* - The device callback receives the product: (pg * gain) / GAIN_MAX.
+	*   See worker at tmff2->set_gain(... (pg * gain) / GAIN_MAX ).
+	* When the sysfs `gain` changes, we trigger a recompute by pushing
+	* pending_gain_value = GAIN_MAX here so the effective device gain becomes
+	* exactly the sysfs value (GAIN_MAX * gain / GAIN_MAX == gain) and future
+	* in-game set_gain calls continue to multiply in.
+	*
+	* References:
+	* - docs/FFBEFFECTS.md: section "FF_GAIN" shows a dedicated device gain path.
+	* - docs/FFB_T500RS.md: Report glossary mentions 0x43 (gain), i.e., device-side
+	*   gain separate from per-effect magnitudes; drivers should expose both levels.
+	*/
+	if (tmff2->set_gain) {
+		unsigned long flags;
+		spin_lock_irqsave(&tmff2->lock, flags);
+		tmff2->pending_gain_value = GAIN_MAX;
+		tmff2->gain_pending = 1;
+		spin_unlock_irqrestore(&tmff2->lock, flags);
+		if (!delayed_work_pending(&tmff2->work) && tmff2->allow_scheduling)
+			schedule_delayed_work(&tmff2->work, 0);
+	}
 
 	return count;
 }
@@ -258,6 +281,7 @@ static DEVICE_ATTR_RW(gain);
 static void tmff2_set_gain(struct input_dev *dev, uint16_t value)
 {
 	struct tmff2_device_entry *tmff2 = tmff2_from_input(dev);
+	unsigned long flags;
 
 	if (!tmff2)
 		return;
@@ -267,13 +291,20 @@ static void tmff2_set_gain(struct input_dev *dev, uint16_t value)
 		return;
 	}
 
-	if (tmff2->set_gain(tmff2->data, (value * gain) / GAIN_MAX))
-		hid_warn(tmff2->hdev, "unable to set gain\n");
+	/* Defer to workqueue: store pending gain and schedule */
+	spin_lock_irqsave(&tmff2->lock, flags);
+	tmff2->pending_gain_value = value;
+	tmff2->gain_pending = 1;
+	spin_unlock_irqrestore(&tmff2->lock, flags);
+
+	if (!delayed_work_pending(&tmff2->work) && tmff2->allow_scheduling)
+		schedule_delayed_work(&tmff2->work, 0);
 }
 
 static void tmff2_set_autocenter(struct input_dev *dev, uint16_t value)
 {
 	struct tmff2_device_entry *tmff2 = tmff2_from_input(dev);
+	unsigned long flags;
 
 	if (!tmff2)
 		return;
@@ -283,8 +314,14 @@ static void tmff2_set_autocenter(struct input_dev *dev, uint16_t value)
 		return;
 	}
 
-	if (tmff2->set_autocenter(tmff2->data, value))
-		hid_warn(tmff2->hdev, "unable to set autocenter\n");
+	/* Defer to workqueue: store pending autocenter and schedule */
+	spin_lock_irqsave(&tmff2->lock, flags);
+	tmff2->pending_autocenter_value = value;
+	tmff2->autocenter_pending = 1;
+	spin_unlock_irqrestore(&tmff2->lock, flags);
+
+	if (!delayed_work_pending(&tmff2->work) && tmff2->allow_scheduling)
+		schedule_delayed_work(&tmff2->work, 0);
 }
 
 static void tmff2_work_handler(struct work_struct *w)
@@ -301,6 +338,30 @@ static void tmff2_work_handler(struct work_struct *w)
 	if (!tmff2)
 		return;
 
+	/* Apply pending control changes (gain/autocenter) in process context */
+	{
+		unsigned long f2;
+		uint16_t pg = 0, pac = 0;
+		int do_gain = 0, do_ac = 0;
+		spin_lock_irqsave(&tmff2->lock, f2);
+		if (tmff2->gain_pending) {
+			pg = tmff2->pending_gain_value;
+			tmff2->gain_pending = 0;
+			do_gain = 1;
+		}
+		if (tmff2->autocenter_pending) {
+			pac = tmff2->pending_autocenter_value;
+			tmff2->autocenter_pending = 0;
+			do_ac = 1;
+		}
+		spin_unlock_irqrestore(&tmff2->lock, f2);
+
+		if (do_gain && tmff2->set_gain)
+			tmff2->set_gain(tmff2->data, (pg * gain) / GAIN_MAX);
+		if (do_ac && tmff2->set_autocenter)
+			tmff2->set_autocenter(tmff2->data, pac);
+	}
+
 	for (effect_id = 0; effect_id < tmff2->max_effects; ++effect_id) {
 		unsigned long actions = 0;
 		struct tmff2_effect_state effect;
@@ -315,15 +376,26 @@ static void tmff2_work_handler(struct work_struct *w)
 
 		effect_delay = state->effect.replay.delay;
 		effect_length = state->effect.replay.length;
+		/* If playing with a finite length, stop when (delay + length) elapses */
 		if (test_bit(FF_EFFECT_PLAYING, &state->flags) && effect_length) {
 			if ((time_now - state->start_time) >=
 					(effect_delay + effect_length) * state->count) {
 				__clear_bit(FF_EFFECT_PLAYING, &state->flags);
 				__clear_bit(FF_EFFECT_QUEUE_UPDATE, &state->flags);
-
+				/* Request a STOP in process context */
+				__set_bit(FF_EFFECT_QUEUE_STOP, &actions);
 				state->count = 0;
 			}
 		}
+		/* Delay handling for start: only trigger START after replay.delay */
+		if (test_bit(FF_EFFECT_QUEUE_START, &state->flags)) {
+			if ((time_now - state->start_time) >= effect_delay) {
+				__set_bit(FF_EFFECT_QUEUE_START, &actions);
+				__clear_bit(FF_EFFECT_QUEUE_START, &state->flags);
+				/* effect is playing since we're starting it now */
+				__set_bit(FF_EFFECT_PLAYING, &state->flags);
+			} /* else: keep START pending until delay elapsed */
+		}
 
 		if (test_bit(FF_EFFECT_QUEUE_UPLOAD, &state->flags)) {
 			__set_bit(FF_EFFECT_QUEUE_UPLOAD, &actions);
@@ -694,6 +766,11 @@ static int tmff2_probe(struct hid_device *hdev, const struct hid_device_id *id)
 				goto wheel_err;
 			break;
 
+		case TMT500RS_PC_ID:
+			if ((ret = t500rs_populate_api(tmff2)))
+				goto wheel_err;
+			break;
+
 		case TMT248_PC_ID:
 			if ((ret = t248_populate_api(tmff2)))
 				goto wheel_err;
@@ -802,6 +879,8 @@ static const struct hid_device_id tmff2_devices[] = {
 	{HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, TMT300RS_PS3_NORM_ID)},
 	{HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, TMT300RS_PS3_ADV_ID)},
 	{HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, TMT300RS_PS4_NORM_ID)},
+	/* t500rs */
+	{HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, TMT500RS_PC_ID)},
 	/* t248 PC*/
 	{HID_USB_DEVICE(USB_VENDOR_ID_THRUSTMASTER, TMT248_PC_ID)},
 	/* tx */
@@ -822,4 +901,10 @@ static struct hid_driver tmff2_driver = {
 };
 module_hid_driver(tmff2_driver);
 
+
+#ifndef TMFF2_DRIVER_VERSION
+#define TMFF2_DRIVER_VERSION "dev"
+#endif
+MODULE_VERSION(TMFF2_DRIVER_VERSION);
+
 MODULE_LICENSE("GPL");

src/hid-tmff2.c

@@ -64,6 +64,12 @@ struct tmff2_device_entry {
 
 	spinlock_t lock;
 
+	/* Pending control changes to be applied from workqueue context */
+	uint16_t pending_gain_value;
+	uint16_t pending_autocenter_value;
+	int gain_pending;
+	int autocenter_pending;
+
 	int allow_scheduling;
 
 	/* fields relevant to each actual device (T300, T248...) */
@@ -92,6 +98,7 @@ struct tmff2_device_entry {
 	ssize_t (*alt_mode_show)(void *data, char *buf);
 	ssize_t (*alt_mode_store)(void *data, const char *buf, size_t count);
 	int (*set_autocenter)(void *data, uint16_t autocenter);
+
 	__u8 *(*wheel_fixup)(struct hid_device *hdev, __u8 *rdesc, unsigned int *rsize);
 
 	/* void pointers are dangerous, I know, but in this case likely the
@@ -100,6 +107,7 @@ struct tmff2_device_entry {
 
 /* external */
 int t300rs_populate_api(struct tmff2_device_entry *tmff2);
+int t500rs_populate_api(struct tmff2_device_entry *tmff2);
 int t248_populate_api(struct tmff2_device_entry *tmff2);
 int tx_populate_api(struct tmff2_device_entry *tmff2);
 int tsxw_populate_api(struct tmff2_device_entry *tmff2);
@@ -108,6 +116,8 @@ int tsxw_populate_api(struct tmff2_device_entry *tmff2);
 #define TMT300RS_PS3_ADV_ID	0xb66f
 #define TMT300RS_PS4_NORM_ID	0xb66d
 
+#define TMT500RS_PC_ID		0xb65e
+
 #define TMT248_PC_ID		0xb696
 
 #define TX_ACTIVE               0xb669