From nobody Mon May 25 08:11:33 2026 Received: from mail-dl1-f52.google.com (mail-dl1-f52.google.com [74.125.82.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7DEA530171A for ; Sun, 17 May 2026 01:39:29 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778981971; cv=none; b=KVD/ZP3f6BSwWLmCbSE6pgw9736RCWckMJBvv3KcoEuSLjDcOuvLaOJ3BgAaJvEjWO1FChh8IN3ATsIM+zQaM1val2nutTjYG8NnSF4DTkEG1FYt9+kwlYlmdEJuo+Owl/G+zmm7hlGKl41M1qzpD2+6uIXyOhYqdaPSf74VCQ8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778981971; c=relaxed/simple; bh=aCFLgU/DpeGgVUWldDT6vloOWelEwVGZ8HO8EoCryog=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=SPAk2MaH6Cs6t530z9isGjl6msw6DHIQCJWRkcpLyE8WcCYjZS9e7neiadeCxx6/PmG3J6Z8mkR9Acc/zFKxD/DjPsA1vJbqL/1lTjBe6WD+bH3jDu91txDAxlCEj/hhm5VqqsgGNBToTaxrzf6ZovnHJPDi2lcovhqhhp2OcJY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=PEjdSxr2; arc=none smtp.client-ip=74.125.82.52 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="PEjdSxr2" Received: by mail-dl1-f52.google.com with SMTP id a92af1059eb24-132830d8281so5231994c88.1 for ; Sat, 16 May 2026 18:39:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1778981969; x=1779586769; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=wDSsM0yzMQIBs1lHCyxfOUpY8CG48p3DLYal91ifkow=; b=PEjdSxr2f5VDg766LrBcpcg2HQbyRvMmCorKg/KBI2dZsB3Y/PGTmOVNGWjcpX7BmO tLFGMgMga/nPDuRd/zG0EAr5qkkolQ3PVKkS03rIHZ/mkrs5RJDMVkh9H8tB/tz3U7NL K7jW2sBDbyJi1aoTPLpdGxj8x8E4KiggIFi823z372WwXwFOQ3WCYy7a2eP35eYVMENj GCGue8LlV2R2FbCN2Yo9nVT+Eb5C8Dq+vQBNMk68c2d6VdXs+7VOvlXARcSzsxQMfJhm OMvWMNpD+gfk9YK0Lq76BQA80utw7/B0rpml4YKIe9/kMgJNddnVXll5HMmlx2dCf3ei 2mvw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1778981969; x=1779586769; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=wDSsM0yzMQIBs1lHCyxfOUpY8CG48p3DLYal91ifkow=; b=B39XWDadeC5ZbXfveCTu32ON10++VTvNKzr1c/Bx6XPCdMjTcFeka3yDPwPI1RsmD5 DmPvFq/FbnoBLMpU8xo8JgUT5TiLe5hl2WEXuluZuXkLoy4CYD+LD8SD1NFe2WOwpcPT 8ls4nefs+6m7sx6dlDkxQr/k9/BMbvnd0w8zvegQ09jPOmharcd9uXeZNUsQn4qhaMx4 VoTkrU75AwbbnguyZIBnWRMwa7GBl62cP92esFMag51AjqglNVF3+tIMu5pj/rpPIEwB UZ7LPfRhzATHbSuHpdNmFIGV0hDEoV9cWJPt9Ira+ibeK7HkPqmJJ/7mbYD7ucRkL3Zw IYgQ== X-Forwarded-Encrypted: i=1; AFNElJ/vZHjsgjfOg99jBX8LTGun5/7QgV/7lJ4nVzBfNCiBpafrPU2ALoozmWoAvgRVAg6vtPYSd+DjRT+sJRA=@vger.kernel.org X-Gm-Message-State: AOJu0YzuypAYUuksgGjeQ0sfWrBcJ0tV26gpkR0KiMiJlCHt7CMJPWlW s8OaBTQZc8Kiauq/XAMhhNph9wTbbAaj4irAwQxX3j1DK+u+5NzFYsfU X-Gm-Gg: Acq92OG3T1NeqdpusGTEZKn4Yhy4sRRU4mSiCG7BHfnD7tsiFf23ZLI1EynaFBZEh3Q PplXKTjgZiWVvJipLnlT6wHkuQlQy/0z2ZClMImPkPLvYFAnz8jwioh85zGX0WIfCmTAg8YnnMl SwzyseuN4s0I1xQNbnyikDEc6GFSQnZpSIelGcFJKvoOK2+iFvLMqZsmSrgYc38NyFxqaBIB671 HHDOJTseuIEk0i8JwVWtSnEUkUWyxyZRJUhTFMhnsg85EhhXN5FvVGwZlnzTIrpEgpwHzQ0yHSH LEbPX63NthQ2JNvkN8u3csL7wKpQBF7ue8/htvxLEapVRiFFJ2UxVPk3K1ujnjCQYgb7O0b7YLq 9VmL0kzZGOTIp2p6Q0e4Xmwjhr5zGKZLZ0+SPEM2gOm6QfvRye8C7hK/rmZsa/90mh1JIjz46OT RXpW4RL8kPSw+fC8HRPXhdfCGtaS5SqrMfy9akSZIhQRZOrxe8TH5ysaHeJbBu2h8g9mhOJnSZH pPCuxQylDMr0Kw= X-Received: by 2002:a05:7022:1a85:b0:12d:d972:b96e with SMTP id a92af1059eb24-1350542e8e5mr4578695c88.20.1778981968599; Sat, 16 May 2026 18:39:28 -0700 (PDT) Received: from lappy (108-228-232-20.lightspeed.sndgca.sbcglobal.net. [108.228.232.20]) by smtp.gmail.com with ESMTPSA id a92af1059eb24-134cb5b3c20sm15898086c88.0.2026.05.16.18.39.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 May 2026 18:39:28 -0700 (PDT) From: "Derek J. Clark" To: Jiri Kosina , Benjamin Tissoires Cc: "Pierre-Loup A . Griffais" , Denis Benato , Zhouwang Huang , "Derek J . Clark" , linux-input@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5 1/4] HID: hid-msi: Add MSI Claw configuration driver Date: Sun, 17 May 2026 01:39:22 +0000 Message-ID: <20260517013925.3120314-2-derekjohn.clark@gmail.com> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20260517013925.3120314-1-derekjohn.clark@gmail.com> References: <20260517013925.3120314-1-derekjohn.clark@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Adds configuration HID driver for the MSI Claw series of handheld PC's. In this initial patch add the initial driver outline and attributes for changing the gamepad mode, M-key behavior, and add a WO reset function. Sending the SWITCH_MODE and RESET commands causes a USB disconnect in the device. The completion will therefore never get hit and would trigger an -EIO. To avoid showing the user an error for every write to these attrs a bypass for the completion handling is introduced when timeout =3D= =3D 0. The initial version of this patch was written by Denis Benato, which contained the initial reverse-engineering and implementation for the gamepad mode switching. This work was later expanded by Zhouwang Huang to include more gamepad modes. Finally, I refactored the drivers data in/out flow and overall format to conform to kernel driver best practices and style guides. Claude was used as an initial reviewer of this patch. Assisted-by: Claude:claude-sonnet-4-6 Co-developed-by: Denis Benato Signed-off-by: Denis Benato Co-developed-by: Zhouwang Huang Signed-off-by: Zhouwang Huang Signed-off-by: Derek J. Clark --- v5: - Swap disabled & combination mkeys_function enum values. - Ensure mode_mutex is properly init. - Ensure claw_remove is calling hid_hw_close and not hid_hw_stop for all paths. v4: - Add msi_suspend/claw_suspend. - Reorder claw_remove to cancel all work before removing sysfs. - Add mutex lock for removing sysfs attributes. - Add mutex lock for MODE command data read/write. v3: - Ensure claw_hw_output_report is properly guarded. - Reoder claw_probe to ensure all mutex, completion, and variable assignments are in place prior to setting drvdata. - Ensure gamepad_mode is set to a valid enum value in claw_probe. v2: - Rename driver to hid-msi from hid-msi-claw. - Rename reusable/generic functions to msi_* from claw_*, retaining claw specific functions. - Add generic entrypoints for probe, remove, and raw event that route to claw specific functions. --- MAINTAINERS | 6 + drivers/hid/Kconfig | 12 + drivers/hid/Makefile | 1 + drivers/hid/hid-ids.h | 5 + drivers/hid/hid-msi.c | 630 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 654 insertions(+) create mode 100644 drivers/hid/hid-msi.c diff --git a/MAINTAINERS b/MAINTAINERS index 6f6517bf4f970..8e2de98b768f7 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -17965,6 +17965,12 @@ S: Odd Fixes F: Documentation/devicetree/bindings/net/ieee802154/mrf24j40.txt F: drivers/net/ieee802154/mrf24j40.c =20 +MSI HID DRIVER +M: Derek J. Clark +L: linux-input@vger.kernel.org +S: Maintained +F: drivers/hid/hid-msi.c + MSI EC DRIVER M: Nikita Kravets L: platform-driver-x86@vger.kernel.org diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig index 10c12d8e65579..af146691bd481 100644 --- a/drivers/hid/Kconfig +++ b/drivers/hid/Kconfig @@ -492,6 +492,18 @@ config HID_GT683R Currently the following devices are know to be supported: - MSI GT683R =20 +config HID_MSI + tristate "MSI Claw Gamepad Support" + depends on USB_HID + select LEDS_CLASS + select LEDS_CLASS_MULTICOLOR + help + Support for the MSI Claw RGB and controller configuration + + Say Y here to include configuration interface support for the MSI Claw Li= ne + of Handheld Console Controllers. Say M here to compile this driver as a + module. The module will be called hid-msi. + config HID_KEYTOUCH tristate "Keytouch HID devices" help diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile index 07dfdb6a49c59..80925a17b059c 100644 --- a/drivers/hid/Makefile +++ b/drivers/hid/Makefile @@ -92,6 +92,7 @@ obj-$(CONFIG_HID_MAYFLASH) +=3D hid-mf.o obj-$(CONFIG_HID_MEGAWORLD_FF) +=3D hid-megaworld.o obj-$(CONFIG_HID_MICROSOFT) +=3D hid-microsoft.o obj-$(CONFIG_HID_MONTEREY) +=3D hid-monterey.o +obj-$(CONFIG_HID_MSI) +=3D hid-msi.o obj-$(CONFIG_HID_MULTITOUCH) +=3D hid-multitouch.o obj-$(CONFIG_HID_NINTENDO) +=3D hid-nintendo.o obj-$(CONFIG_HID_NTI) +=3D hid-nti.o diff --git a/drivers/hid/hid-ids.h b/drivers/hid/hid-ids.h index 933b7943bdb50..94a9b89dc240a 100644 --- a/drivers/hid/hid-ids.h +++ b/drivers/hid/hid-ids.h @@ -1047,7 +1047,12 @@ #define USB_DEVICE_ID_MOZA_R16_R21_2 0x0010 =20 #define USB_VENDOR_ID_MSI 0x1770 +#define USB_VENDOR_ID_MSI_2 0x0db0 #define USB_DEVICE_ID_MSI_GT683R_LED_PANEL 0xff00 +#define USB_DEVICE_ID_MSI_CLAW_XINPUT 0x1901 +#define USB_DEVICE_ID_MSI_CLAW_DINPUT 0x1902 +#define USB_DEVICE_ID_MSI_CLAW_DESKTOP 0x1903 +#define USB_DEVICE_ID_MSI_CLAW_BIOS 0x1904 =20 #define USB_VENDOR_ID_NATIONAL_SEMICONDUCTOR 0x0400 #define USB_DEVICE_ID_N_S_HARMONY 0xc359 diff --git a/drivers/hid/hid-msi.c b/drivers/hid/hid-msi.c new file mode 100644 index 0000000000000..3f809dc70a4cc --- /dev/null +++ b/drivers/hid/hid-msi.c @@ -0,0 +1,630 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * HID driver for MSI Claw Handheld PC gamepads. + * + * Provides configuration support for the MSI Claw series of handheld PC + * gamepads. Multiple iterations of the device firmware has led to some + * quirks for how certain attributes are handled. The original firmware + * did not support remapping of the M1 (right) and M2 (left) rear paddles. + * Additionally, the MCU RAM address for writing configuration data has + * changed twice. Checks are done during probe to enumerate these varianc= es. + * + * Copyright (c) 2026 Zhouwang Huang + * Copyright (c) 2026 Denis Benato + * Copyright (c) 2026 Valve Corporation + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "hid-ids.h" + +#define CLAW_OUTPUT_REPORT_ID 0x0f +#define CLAW_INPUT_REPORT_ID 0x10 + +#define CLAW_PACKET_SIZE 64 + +#define CLAW_DINPUT_CFG_INTF_IN 0x82 +#define CLAW_XINPUT_CFG_INTF_IN 0x83 + +enum claw_command_index { + CLAW_COMMAND_TYPE_READ_PROFILE =3D 0x04, + CLAW_COMMAND_TYPE_READ_PROFILE_ACK =3D 0x05, + CLAW_COMMAND_TYPE_ACK =3D 0x06, + CLAW_COMMAND_TYPE_WRITE_PROFILE_DATA =3D 0x21, + CLAW_COMMAND_TYPE_SYNC_TO_ROM =3D 0x22, + CLAW_COMMAND_TYPE_SWITCH_MODE =3D 0x24, + CLAW_COMMAND_TYPE_READ_GAMEPAD_MODE =3D 0x26, + CLAW_COMMAND_TYPE_GAMEPAD_MODE_ACK =3D 0x27, + CLAW_COMMAND_TYPE_RESET_DEVICE =3D 0x28, +}; + +enum claw_gamepad_mode_index { + CLAW_GAMEPAD_MODE_XINPUT =3D 0x01, + CLAW_GAMEPAD_MODE_DINPUT =3D 0x02, + CLAW_GAMEPAD_MODE_DESKTOP =3D 0x04, +}; + +static const char * const claw_gamepad_mode_text[] =3D { + [CLAW_GAMEPAD_MODE_XINPUT] =3D "xinput", + [CLAW_GAMEPAD_MODE_DINPUT] =3D "dinput", + [CLAW_GAMEPAD_MODE_DESKTOP] =3D "desktop", +}; + +enum claw_mkeys_function_index { + CLAW_MKEY_FUNCTION_MACRO, + CLAW_MKEY_FUNCTION_DISABLED, + CLAW_MKEY_FUNCTION_COMBO, +}; + +static const char * const claw_mkeys_function_text[] =3D { + [CLAW_MKEY_FUNCTION_MACRO] =3D "macro", + [CLAW_MKEY_FUNCTION_DISABLED] =3D "disabled", + [CLAW_MKEY_FUNCTION_COMBO] =3D "combination", +}; + +struct claw_command_report { + u8 report_id; + u8 padding[2]; + u8 header_tail; + u8 cmd; + u8 data[59]; +} __packed; + +struct claw_drvdata { + /* MCU General Variables */ + struct completion send_cmd_complete; + struct delayed_work cfg_resume; + struct delayed_work cfg_setup; + struct hid_device *hdev; + struct mutex mode_mutex; /* mutex for mode calls */ + struct mutex cfg_mutex; /* mutex for synchronous data */ + u8 ep; + + /* Gamepad Variables */ + enum claw_mkeys_function_index mkeys_function; + enum claw_gamepad_mode_index gamepad_mode; + bool gamepad_registered; +}; + +static int get_endpoint_address(struct hid_device *hdev) +{ + struct usb_host_endpoint *ep; + struct usb_interface *intf; + + intf =3D to_usb_interface(hdev->dev.parent); + ep =3D intf->cur_altsetting->endpoint; + if (ep) + return ep->desc.bEndpointAddress; + + return -ENODEV; +} + +static int claw_gamepad_mode_event(struct claw_drvdata *drvdata, + struct claw_command_report *cmd_rep) +{ + if (cmd_rep->data[0] >=3D ARRAY_SIZE(claw_gamepad_mode_text) || + !claw_gamepad_mode_text[cmd_rep->data[0]] || + cmd_rep->data[1] >=3D ARRAY_SIZE(claw_mkeys_function_text)) + return -EINVAL; + + drvdata->gamepad_mode =3D cmd_rep->data[0]; + drvdata->mkeys_function =3D cmd_rep->data[1]; + + return 0; +} + +static int claw_raw_event(struct claw_drvdata *drvdata, struct hid_report = *report, + u8 *data, int size) +{ + struct claw_command_report *cmd_rep; + int ret =3D 0; + + if (size !=3D CLAW_PACKET_SIZE) + return 0; + + cmd_rep =3D (struct claw_command_report *)data; + + if (cmd_rep->report_id !=3D CLAW_INPUT_REPORT_ID || cmd_rep->header_tail = !=3D 0x3c) + return 0; + + dev_dbg(&drvdata->hdev->dev, "Rx data as raw input report: [%*ph]\n", + CLAW_PACKET_SIZE, data); + + switch (cmd_rep->cmd) { + case CLAW_COMMAND_TYPE_GAMEPAD_MODE_ACK: + ret =3D claw_gamepad_mode_event(drvdata, cmd_rep); + break; + case CLAW_COMMAND_TYPE_ACK: + break; + default: + dev_dbg(&drvdata->hdev->dev, "Unknown command: %x\n", cmd_rep->cmd); + return 0; + } + + complete(&drvdata->send_cmd_complete); + + return ret; +} + +static int msi_raw_event(struct hid_device *hdev, struct hid_report *repor= t, + u8 *data, int size) +{ + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + + if (!drvdata || (drvdata->ep !=3D CLAW_XINPUT_CFG_INTF_IN && + drvdata->ep !=3D CLAW_DINPUT_CFG_INTF_IN)) + return 0; + + return claw_raw_event(drvdata, report, data, size); +} + +static int claw_hw_output_report(struct hid_device *hdev, u8 index, u8 *da= ta, + size_t len, unsigned int timeout) +{ + unsigned char *dmabuf __free(kfree) =3D NULL; + u8 header[] =3D { CLAW_OUTPUT_REPORT_ID, 0, 0, 0x3c, index }; + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + size_t header_size =3D ARRAY_SIZE(header); + int ret; + + if (header_size + len > CLAW_PACKET_SIZE) + return -EINVAL; + + /* We can't use a devm_alloc reusable buffer without side effects during = suspend */ + dmabuf =3D kzalloc(CLAW_PACKET_SIZE, GFP_KERNEL); + if (!dmabuf) + return -ENOMEM; + + memcpy(dmabuf, header, header_size); + if (data && len) + memcpy(dmabuf + header_size, data, len); + + guard(mutex)(&drvdata->cfg_mutex); + if (timeout) + reinit_completion(&drvdata->send_cmd_complete); + + dev_dbg(&hdev->dev, "Send data as raw output report: [%*ph]\n", + CLAW_PACKET_SIZE, dmabuf); + + ret =3D hid_hw_output_report(hdev, dmabuf, CLAW_PACKET_SIZE); + if (ret < 0) + return ret; + + ret =3D ret =3D=3D CLAW_PACKET_SIZE ? 0 : -EIO; + if (ret) + return ret; + + if (timeout) { + ret =3D wait_for_completion_interruptible_timeout(&drvdata->send_cmd_com= plete, + msecs_to_jiffies(timeout)); + + dev_dbg(&hdev->dev, "Remaining timeout: %u\n", ret); + if (ret >=3D 0) /* preserve errors */ + ret =3D ret =3D=3D 0 ? -EBUSY : 0; /* timeout occurred : time remained = */ + } + + return ret; +} + +static ssize_t gamepad_mode_store(struct device *dev, struct device_attrib= ute *attr, + const char *buf, size_t count) +{ + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + int i, ret =3D -EINVAL; + u8 data[2]; + + for (i =3D 0; i < ARRAY_SIZE(claw_gamepad_mode_text); i++) { + if (claw_gamepad_mode_text[i] && sysfs_streq(buf, claw_gamepad_mode_text= [i])) { + ret =3D i; + break; + } + } + if (ret < 0) + return ret; + + guard(mutex)(&drvdata->mode_mutex); + data[0] =3D ret; + data[1] =3D drvdata->mkeys_function; + + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_SWITCH_MODE, data, = ARRAY_SIZE(data), 0); + if (ret) + return ret; + + return count; +} + +static ssize_t gamepad_mode_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + int ret, i; + + guard(mutex)(&drvdata->mode_mutex); + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_READ_GAMEPAD_MODE, = NULL, 0, 8); + if (ret) + return ret; + + i =3D drvdata->gamepad_mode; + + if (!claw_gamepad_mode_text[i] || claw_gamepad_mode_text[i][0] =3D=3D '\0= ') + return sysfs_emit(buf, "unsupported\n"); + + return sysfs_emit(buf, "%s\n", claw_gamepad_mode_text[i]); +} +static DEVICE_ATTR_RW(gamepad_mode); + +static ssize_t gamepad_mode_index_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + ssize_t count =3D 0; + int i; + + for (i =3D 0; i < ARRAY_SIZE(claw_gamepad_mode_text); i++) { + if (!claw_gamepad_mode_text[i] || claw_gamepad_mode_text[i][0] =3D=3D '\= 0') + continue; + count +=3D sysfs_emit_at(buf, count, "%s ", claw_gamepad_mode_text[i]); + } + + buf[count - 1] =3D '\n'; + + return count; +} +static DEVICE_ATTR_RO(gamepad_mode_index); + +static ssize_t mkeys_function_store(struct device *dev, struct device_attr= ibute *attr, + const char *buf, size_t count) +{ + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + int i, ret =3D -EINVAL; + u8 data[2]; + + for (i =3D 0; i < ARRAY_SIZE(claw_mkeys_function_text); i++) { + if (claw_mkeys_function_text[i] && sysfs_streq(buf, claw_mkeys_function_= text[i])) { + ret =3D i; + break; + } + } + if (ret < 0) + return ret; + + guard(mutex)(&drvdata->mode_mutex); + data[0] =3D drvdata->gamepad_mode; + data[1] =3D ret; + + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_SWITCH_MODE, data, = ARRAY_SIZE(data), 0); + if (ret) + return ret; + + return count; +} + +static ssize_t mkeys_function_show(struct device *dev, struct device_attri= bute *attr, + char *buf) +{ + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + int ret, i; + + guard(mutex)(&drvdata->mode_mutex); + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_READ_GAMEPAD_MODE, = NULL, 0, 8); + if (ret) + return ret; + + i =3D drvdata->mkeys_function; + + if (i >=3D ARRAY_SIZE(claw_mkeys_function_text)) + return sysfs_emit(buf, "unsupported\n"); + + return sysfs_emit(buf, "%s\n", claw_mkeys_function_text[i]); +} +static DEVICE_ATTR_RW(mkeys_function); + +static ssize_t mkeys_function_index_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + int i, count =3D 0; + + for (i =3D 0; i < ARRAY_SIZE(claw_mkeys_function_text); i++) + count +=3D sysfs_emit_at(buf, count, "%s ", claw_mkeys_function_text[i]); + + buf[count - 1] =3D '\n'; + + return count; +} +static DEVICE_ATTR_RO(mkeys_function_index); + +static ssize_t reset_store(struct device *dev, struct device_attribute *at= tr, + const char *buf, size_t count) +{ + struct hid_device *hdev =3D to_hid_device(dev); + bool val; + int ret; + + ret =3D kstrtobool(buf, &val); + if (ret) + return ret; + + if (!val) + return -EINVAL; + + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_RESET_DEVICE, NULL,= 0, 0); + if (ret) + return ret; + + return count; +} +static DEVICE_ATTR_WO(reset); + +static umode_t claw_gamepad_attr_is_visible(struct kobject *kobj, struct a= ttribute *attr, + int n) +{ + struct hid_device *hdev =3D to_hid_device(kobj_to_dev(kobj)); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + + if (!drvdata) { + dev_warn(&hdev->dev, + "Failed to get drvdata from kobj. Gamepad attributes are not available= .\n"); + return 0; + } + + return attr->mode; +} + +static struct attribute *claw_gamepad_attrs[] =3D { + &dev_attr_gamepad_mode.attr, + &dev_attr_gamepad_mode_index.attr, + &dev_attr_mkeys_function.attr, + &dev_attr_mkeys_function_index.attr, + &dev_attr_reset.attr, + NULL, +}; + +static const struct attribute_group claw_gamepad_attr_group =3D { + .attrs =3D claw_gamepad_attrs, + .is_visible =3D claw_gamepad_attr_is_visible, +}; + +static void cfg_setup_fn(struct work_struct *work) +{ + struct delayed_work *dwork =3D container_of(work, struct delayed_work, wo= rk); + struct claw_drvdata *drvdata =3D container_of(dwork, struct claw_drvdata,= cfg_setup); + int ret; + + ret =3D claw_hw_output_report(drvdata->hdev, CLAW_COMMAND_TYPE_READ_GAMEP= AD_MODE, NULL, 0, 8); + if (ret) { + dev_err(&drvdata->hdev->dev, + "Failed to setup device, can't read gamepad mode: %d\n", ret); + return; + } + + /* Add sysfs attributes after we get the device state */ + ret =3D device_add_group(&drvdata->hdev->dev, &claw_gamepad_attr_group); + if (ret) { + dev_err(&drvdata->hdev->dev, + "Failed to setup device, can't create gamepad attrs: %d\n", ret); + return; + } + drvdata->gamepad_registered =3D true; + + kobject_uevent(&drvdata->hdev->dev.kobj, KOBJ_CHANGE); +} + +static void cfg_resume_fn(struct work_struct *work) +{ + struct delayed_work *dwork =3D container_of(work, struct delayed_work, wo= rk); + struct claw_drvdata *drvdata =3D container_of(dwork, struct claw_drvdata,= cfg_resume); + u8 data[2] =3D { drvdata->gamepad_mode, drvdata->mkeys_function }; + int ret; + + ret =3D claw_hw_output_report(drvdata->hdev, CLAW_COMMAND_TYPE_SWITCH_MOD= E, data, + ARRAY_SIZE(data), 0); + if (ret) + dev_err(&drvdata->hdev->dev, "Failed to set gamepad mode settings: %d\n"= , ret); +} + +static int claw_probe(struct hid_device *hdev, u8 ep) +{ + struct claw_drvdata *drvdata; + int ret; + + drvdata =3D devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL); + if (!drvdata) + return -ENOMEM; + + drvdata->gamepad_mode =3D CLAW_GAMEPAD_MODE_XINPUT; + drvdata->hdev =3D hdev; + drvdata->ep =3D ep; + + mutex_init(&drvdata->mode_mutex); + mutex_init(&drvdata->cfg_mutex); + init_completion(&drvdata->send_cmd_complete); + INIT_DELAYED_WORK(&drvdata->cfg_resume, &cfg_resume_fn); + INIT_DELAYED_WORK(&drvdata->cfg_setup, &cfg_setup_fn); + + /* For control interface: open the HID transport for sending commands. */ + ret =3D hid_hw_open(hdev); + if (ret) + return ret; + + hid_set_drvdata(hdev, drvdata); + schedule_delayed_work(&drvdata->cfg_setup, msecs_to_jiffies(500)); + + return 0; +} + +static int msi_probe(struct hid_device *hdev, const struct hid_device_id *= id) +{ + int ret; + u8 ep; + + if (!hid_is_usb(hdev)) { + ret =3D -ENODEV; + goto err_probe; + } + + ret =3D hid_parse(hdev); + if (ret) + goto err_probe; + + /* Set quirk to create separate input devices per HID application */ + hdev->quirks |=3D HID_QUIRK_INPUT_PER_APP | HID_QUIRK_MULTI_INPUT; + ret =3D hid_hw_start(hdev, HID_CONNECT_DEFAULT); + if (ret) + goto err_probe; + + /* For non-control interfaces (keyboard/mouse), allow userspace to grab t= he devices. */ + ret =3D get_endpoint_address(hdev); + if (ret < 0) + goto err_stop_hw; + + ep =3D ret; + if (ep =3D=3D CLAW_XINPUT_CFG_INTF_IN || ep =3D=3D CLAW_DINPUT_CFG_INTF_I= N) { + ret =3D claw_probe(hdev, ep); + if (ret) + goto err_stop_hw; + } + + return 0; + +err_stop_hw: + hid_hw_stop(hdev); +err_probe: + return dev_err_probe(&hdev->dev, ret, "Failed to init device\n"); +} + +static void claw_remove(struct hid_device *hdev) +{ + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + + if (!drvdata) { + hid_hw_close(hdev); + return; + } + + cancel_delayed_work_sync(&drvdata->cfg_setup); + cancel_delayed_work_sync(&drvdata->cfg_resume); + + guard(mutex)(&drvdata->cfg_mutex); + if (drvdata->gamepad_registered) + device_remove_group(&hdev->dev, &claw_gamepad_attr_group); + + hid_hw_close(hdev); +} + +static void msi_remove(struct hid_device *hdev) +{ + int ret; + u8 ep; + + ret =3D get_endpoint_address(hdev); + if (ret <=3D 0) + goto hw_stop; + + ep =3D ret; + if (ep =3D=3D CLAW_XINPUT_CFG_INTF_IN || ep =3D=3D CLAW_DINPUT_CFG_INTF_I= N) + claw_remove(hdev); + +hw_stop: + hid_hw_stop(hdev); +} + +static int claw_resume(struct hid_device *hdev) +{ + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + + if (!drvdata) + return -ENODEV; + + /* MCU can take up to 500ms to be ready after resume */ + schedule_delayed_work(&drvdata->cfg_resume, msecs_to_jiffies(500)); + return 0; +} + +static int msi_resume(struct hid_device *hdev) +{ + int ret; + u8 ep; + + ret =3D get_endpoint_address(hdev); + if (ret <=3D 0) + return 0; + + ep =3D ret; + if (ep =3D=3D CLAW_XINPUT_CFG_INTF_IN || ep =3D=3D CLAW_DINPUT_CFG_INTF_I= N) + return claw_resume(hdev); + + return 0; +} + +static int claw_suspend(struct hid_device *hdev) +{ + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + + if (!drvdata) + return -ENODEV; + + cancel_delayed_work_sync(&drvdata->cfg_setup); + cancel_delayed_work_sync(&drvdata->cfg_resume); + + return 0; +} + +static int msi_suspend(struct hid_device *hdev, pm_message_t msg) +{ + int ret; + u8 ep; + + ret =3D get_endpoint_address(hdev); + if (ret <=3D 0) + return 0; + + ep =3D ret; + if (ep =3D=3D CLAW_XINPUT_CFG_INTF_IN || ep =3D=3D CLAW_DINPUT_CFG_INTF_I= N) + return claw_suspend(hdev); + + return 0; +} + +static const struct hid_device_id msi_devices[] =3D { + { HID_USB_DEVICE(USB_VENDOR_ID_MSI_2, USB_DEVICE_ID_MSI_CLAW_XINPUT) }, + { HID_USB_DEVICE(USB_VENDOR_ID_MSI_2, USB_DEVICE_ID_MSI_CLAW_DINPUT) }, + { HID_USB_DEVICE(USB_VENDOR_ID_MSI_2, USB_DEVICE_ID_MSI_CLAW_DESKTOP) }, + { HID_USB_DEVICE(USB_VENDOR_ID_MSI_2, USB_DEVICE_ID_MSI_CLAW_BIOS) }, + { } +}; +MODULE_DEVICE_TABLE(hid, msi_devices); + +static struct hid_driver msi_driver =3D { + .name =3D "hid-msi", + .id_table =3D msi_devices, + .raw_event =3D msi_raw_event, + .probe =3D msi_probe, + .remove =3D msi_remove, + .resume =3D msi_resume, + .suspend =3D pm_ptr(msi_suspend), +}; +module_hid_driver(msi_driver); + +MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Denis Benato "); +MODULE_AUTHOR("Zhouwang Huang "); +MODULE_AUTHOR("Derek J. Clark "); +MODULE_DESCRIPTION("HID driver for MSI Claw Handheld PC gamepads"); --=20 2.53.0 From nobody Mon May 25 08:11:33 2026 Received: from mail-dl1-f44.google.com (mail-dl1-f44.google.com [74.125.82.44]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CDE9B3054EB for ; Sun, 17 May 2026 01:39:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.44 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778981972; cv=none; b=on1Jn74N/Ko12ifuV7T97aTWe0RsbQzj3eNn57cYS44amRXRfqaJmy+2lSY8/wtCZ+pyrMFlX8/e9JV+t1XMltyDDjvMsDG1LMyk4g//VBshre+qwjaMspWyFAQH47hbmn4FO9BqlkBrCRmlO9XXbgSu/xHkhoVjlc0HzJ8E00A= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778981972; c=relaxed/simple; bh=914l8ePDBQaFTccMua0YHTTjbdoF9N3OQAxBig+j8P0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=UJO1MpJPGLO7P2zc21GyvTKNZMmy6h9IkfdDOnbRV95bbblubImtpniP3o9ZJ7zLn9d+i2iXs1X5k4fEodjgWyLsDGYsPGpIWy0pyho+duHL5LvULjog9Mj1zFAjBKb8uZFAHdSepzkbeJQvwU44L/XPF7SfvzDHbaiyz2WJ9hQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=rLHzNDMV; arc=none smtp.client-ip=74.125.82.44 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="rLHzNDMV" Received: by mail-dl1-f44.google.com with SMTP id a92af1059eb24-1331e851faaso457571c88.1 for ; Sat, 16 May 2026 18:39:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1778981970; x=1779586770; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=D4N6GL+LnlQCe9GCl0mwC7StR6g4mMaRywTmywgm5Rs=; b=rLHzNDMVoz/8ldumz2rUxD7GNyCawQzQBz0hgh0iDZTdBEsbCINBp84QKgrbL0E6S2 RRnVDCGMyFss2U5g88Wv1FQ7p07m5UiMcb1cjo7g4DmfgmZpvFZI1mbKWpue3AV03TgA XDZMijrODd+V6kU/rTu49BS02lXoqWQrrnMxB8UxKSIIetrtd1Sx+BwHDx9p0MMRPjHR Q96+XyQmGqBOnfNMD2uuSroY5tnbr8QgGPJsm4T/tWpFkcBaic3ZR4i+akoz6RdITn4J WORJUMM1iY9D6p7lmpl7mJASIbz6A6jXLpZHLIC4VO0jh84VWEtboJ1+T/h4UwX8yacY hVFw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1778981970; x=1779586770; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=D4N6GL+LnlQCe9GCl0mwC7StR6g4mMaRywTmywgm5Rs=; b=idnp+qGiDEkS1sVqHGHwNuGPbs/KKNH3i71o7zFMO40/HpJj4nqYfiuIr4B77Il5r+ qB2hJGo6d0TJSfN+WuMgV1L08xML5Kv33nYu7MYcA75hKAlhrleIctPRvuN/awIeYILK BGHr884gPwR0nO+kfmj4e/gEWOp5K1AEiFJchJ1DB03lYEoKHdR+bPcIHabw6la64RQI DYZpbl18FDf/TzG3XdgEB6lZ2ytrUiP/ooZZ56Oe6g3wKKahDdcBFXv1SWKaWCfQLfdA G7OOjCJeltqbt4beQP2GolYo3wkd1fyQXTcPMEOVkRWsD0uaav7/qEHgm+vA52RfPe7S 3EbA== X-Forwarded-Encrypted: i=1; AFNElJ8ihnqDPa3mFEGSYfwYCXuE2DivOkjDBj5s7VBKXXTA2TBhNPvy1Oa9MZaWJ9tGq6PLI5yynsutfGdC1pY=@vger.kernel.org X-Gm-Message-State: AOJu0YyMyrvlf9UHyKGenpqg/p1H7TJ7c5KLrroKz7+68j8mWpAS0nos 3Z7yeb9VnJRDwXgFM0MCuDMFuKRytX/aLxsuJQgOHLNN5m/RMxYJMkoj X-Gm-Gg: Acq92OE47DS3okf5LeP684aIhvd8g55dxUnIG/m56rFRNjPhQjjZeYti6bm37JstY4i gxo+Fk0CRwf32KQe+xRFh95ust0HRCeDQsLlBIiXVQshhtLgSkThFzh/fPDx6a1OI2jm18JwR8f ZMqwuBkpt63zZVtS39aU9iIPKYvir9cyrFeI2nd/rCcdLGNGzB3qKcN4lsf17TtL74fGrPs8CBe 2Wm6ulP7ywIZSfYdTRLdAWh0ygSp+7EatGw7Glyni+sxgHzmUKAMi4xJVrNiUl2cImWbiwTcIvS uTpHKCJANMYvmrUTePIMy6P4/pBXZnp67r5pQDc0eQQnZLBugKF5afw7DpxtRGzOM/DqrPVdgN+ 8DQJMPKZp/7RQ66KOZqtdscUvWEGjz2I5hSJQHPg75uqaTWukL5zoZGfz/MaOHu/9piAYITNsQd izXqBFnwZWnqoF9NQ6BgzOEpjPkFXicDjQ4p9T7HQjv7IYGXUi1klKjVvNQarz7yhnSCFNRZbTn kS1 X-Received: by 2002:a05:7022:6b98:b0:132:1e00:f6e8 with SMTP id a92af1059eb24-134c8c3e281mr7109558c88.14.1778981969710; Sat, 16 May 2026 18:39:29 -0700 (PDT) Received: from lappy (108-228-232-20.lightspeed.sndgca.sbcglobal.net. [108.228.232.20]) by smtp.gmail.com with ESMTPSA id a92af1059eb24-134cb5b3c20sm15898086c88.0.2026.05.16.18.39.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 May 2026 18:39:29 -0700 (PDT) From: "Derek J. Clark" To: Jiri Kosina , Benjamin Tissoires Cc: "Pierre-Loup A . Griffais" , Denis Benato , Zhouwang Huang , "Derek J . Clark" , linux-input@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5 2/4] HID: hid-msi: Add M-key mapping attributes Date: Sun, 17 May 2026 01:39:23 +0000 Message-ID: <20260517013925.3120314-3-derekjohn.clark@gmail.com> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20260517013925.3120314-1-derekjohn.clark@gmail.com> References: <20260517013925.3120314-1-derekjohn.clark@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Adds attributes that allow for remapping the M-keys with up to 5 values when in macro mode. There are 2 mappable buttons on the rear of the device, M1 on the right and M2 on the left. When mapped, the events will fire from one of three event devices: gamepad buttons will fire from the device handled by xpad, while keyboard and mouse events will fire from respectively typed evdevs provided by the input core. Names of each mapping have been kept as close to the event that will fire from the evdev as possible, with context added to the ABS_ events on the direction of the movement. Initial reverse-engineering and implementation of this feature was done by Zhouwang Huang. I refactored the overall format to conform to kernel driver best practices and style guides. Claude was used as an initial reviewer of this patch. Assisted-by: Claude:claude-sonnet-4-6 Co-developed-by: Zhouwang Huang Signed-off-by: Zhouwang Huang Signed-off-by: Derek J. Clark --- v5: - Ensure adding "DISABLED" key to valid entries is done in the correct patch. - Re-enable sending an empty string to clear button mappings in addition to setting DISABLED. v4: - Change dev_warn to dev_dbg in claw_profile_event. - use __free with DEFINE_FREE macro for argv instead of manually running argv_free, cleaining up scoped_guard goto. v3: - Use scoped_guard where necessary. v2: - Add mutex for SYNC_TO_ROM commands to ensure every SYNC is completed before more data is written to the MCU volatile memory. - Add mutex for profile_pending to ensure every profile action response is serialized to the generating command. --- drivers/hid/hid-msi.c | 401 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 400 insertions(+), 1 deletion(-) diff --git a/drivers/hid/hid-msi.c b/drivers/hid/hid-msi.c index 3f809dc70a4cc..991d5a25d3de0 100644 --- a/drivers/hid/hid-msi.c +++ b/drivers/hid/hid-msi.c @@ -41,6 +41,8 @@ #define CLAW_DINPUT_CFG_INTF_IN 0x82 #define CLAW_XINPUT_CFG_INTF_IN 0x83 =20 +#define CLAW_KEYS_MAX 5 + enum claw_command_index { CLAW_COMMAND_TYPE_READ_PROFILE =3D 0x04, CLAW_COMMAND_TYPE_READ_PROFILE_ACK =3D 0x05, @@ -65,6 +67,17 @@ static const char * const claw_gamepad_mode_text[] =3D { [CLAW_GAMEPAD_MODE_DESKTOP] =3D "desktop", }; =20 +enum claw_profile_ack_pending { + CLAW_NO_PENDING, + CLAW_M1_PENDING, + CLAW_M2_PENDING, +}; + +enum claw_key_index { + CLAW_KEY_M1, + CLAW_KEY_M2, +}; + enum claw_mkeys_function_index { CLAW_MKEY_FUNCTION_MACRO, CLAW_MKEY_FUNCTION_DISABLED, @@ -77,6 +90,155 @@ static const char * const claw_mkeys_function_text[] = =3D { [CLAW_MKEY_FUNCTION_COMBO] =3D "combination", }; =20 +static const struct { + u8 code; + const char *name; +} claw_button_mapping_key_map[] =3D { + /* Gamepad buttons */ + { 0x01, "ABS_HAT0Y_UP" }, + { 0x02, "ABS_HAT0Y_DOWN" }, + { 0x03, "ABS_HAT0X_LEFT" }, + { 0x04, "ABS_HAT0X_RIGHT" }, + { 0x05, "BTN_TL" }, + { 0x06, "BTN_TR" }, + { 0x07, "BTN_THUMBL" }, + { 0x08, "BTN_THUMBR" }, + { 0x09, "BTN_SOUTH" }, + { 0x0a, "BTN_EAST" }, + { 0x0b, "BTN_NORTH" }, + { 0x0c, "BTN_WEST" }, + { 0x0d, "BTN_MODE" }, + { 0x0e, "BTN_SELECT" }, + { 0x0f, "BTN_START" }, + { 0x13, "BTN_TL2"}, + { 0x14, "BTN_TR2"}, + { 0x15, "ABS_Y_UP"}, + { 0x16, "ABS_Y_DOWN"}, + { 0x17, "ABS_X_LEFT"}, + { 0x18, "ABS_X_LEFT_RIGHT"}, + { 0x19, "ABS_RY_UP"}, + { 0x1a, "ABS_RY_DOWN"}, + { 0x1b, "ABS_RX_LEFT"}, + { 0x1c, "ABS_RX_RIGHT"}, + /* Keyboard keys */ + { 0x32, "KEY_ESC" }, + { 0x33, "KEY_F1" }, + { 0x34, "KEY_F2" }, + { 0x35, "KEY_F3" }, + { 0x36, "KEY_F4" }, + { 0x37, "KEY_F5" }, + { 0x38, "KEY_F6" }, + { 0x39, "KEY_F7" }, + { 0x3a, "KEY_F8" }, + { 0x3b, "KEY_F9" }, + { 0x3c, "KEY_F10" }, + { 0x3d, "KEY_F11" }, + { 0x3e, "KEY_F12" }, + { 0x3f, "KEY_GRAVE" }, + { 0x40, "KEY_1" }, + { 0x41, "KEY_2" }, + { 0x42, "KEY_3" }, + { 0x43, "KEY_4" }, + { 0x44, "KEY_5" }, + { 0x45, "KEY_6" }, + { 0x46, "KEY_7" }, + { 0x47, "KEY_8" }, + { 0x48, "KEY_9" }, + { 0x49, "KEY_0" }, + { 0x4a, "KEY_MINUS" }, + { 0x4b, "KEY_EQUAL" }, + { 0x4c, "KEY_BACKSPACE" }, + { 0x4d, "KEY_TAB" }, + { 0x4e, "KEY_Q" }, + { 0x4f, "KEY_W" }, + { 0x50, "KEY_E" }, + { 0x51, "KEY_R" }, + { 0x52, "KEY_T" }, + { 0x53, "KEY_Y" }, + { 0x54, "KEY_U" }, + { 0x55, "KEY_I" }, + { 0x56, "KEY_O" }, + { 0x57, "KEY_P" }, + { 0x58, "KEY_LEFTBRACE" }, + { 0x59, "KEY_RIGHTBRACE" }, + { 0x5a, "KEY_BACKSLASH" }, + { 0x5b, "KEY_CAPSLOCK" }, + { 0x5c, "KEY_A" }, + { 0x5d, "KEY_S" }, + { 0x5e, "KEY_D" }, + { 0x5f, "KEY_F" }, + { 0x60, "KEY_G" }, + { 0x61, "KEY_H" }, + { 0x62, "KEY_J" }, + { 0x63, "KEY_K" }, + { 0x64, "KEY_L" }, + { 0x65, "KEY_SEMICOLON" }, + { 0x66, "KEY_APOSTROPHE" }, + { 0x67, "KEY_ENTER" }, + { 0x68, "KEY_LEFTSHIFT" }, + { 0x69, "KEY_Z" }, + { 0x6a, "KEY_X" }, + { 0x6b, "KEY_C" }, + { 0x6c, "KEY_V" }, + { 0x6d, "KEY_B" }, + { 0x6e, "KEY_N" }, + { 0x6f, "KEY_M" }, + { 0x70, "KEY_COMMA" }, + { 0x71, "KEY_DOT" }, + { 0x72, "KEY_SLASH" }, + { 0x73, "KEY_RIGHTSHIFT" }, + { 0x74, "KEY_LEFTCTRL" }, + { 0x75, "KEY_LEFTMETA" }, + { 0x76, "KEY_LEFTALT" }, + { 0x77, "KEY_SPACE" }, + { 0x78, "KEY_RIGHTALT" }, + { 0x79, "KEY_RIGHTCTRL" }, + { 0x7a, "KEY_INSERT" }, + { 0x7b, "KEY_HOME" }, + { 0x7c, "KEY_PAGEUP" }, + { 0x7d, "KEY_DELETE" }, + { 0x7e, "KEY_END" }, + { 0x7f, "KEY_PAGEDOWN" }, + { 0x8a, "KEY_KPENTER" }, + { 0x8b, "KEY_KP0" }, + { 0x8c, "KEY_KP1" }, + { 0x8d, "KEY_KP2" }, + { 0x8e, "KEY_KP3" }, + { 0x8f, "KEY_KP4" }, + { 0x90, "KEY_KP5" }, + { 0x91, "KEY_KP6" }, + { 0x92, "KEY_KP7" }, + { 0x93, "KEY_KP8" }, + { 0x94, "KEY_KP9" }, + { 0x95, "MD_PLAY" }, + { 0x96, "MD_STOP" }, + { 0x97, "MD_NEXT" }, + { 0x98, "MD_PREV" }, + { 0x99, "MD_VOL_UP" }, + { 0x9a, "MD_VOL_DOWN" }, + { 0x9b, "MD_VOL_MUTE" }, + { 0x9c, "KEY_F23" }, + /* Mouse events */ + { 0xc8, "BTN_LEFT" }, + { 0xc9, "BTN_MIDDLE" }, + { 0xca, "BTN_RIGHT" }, + { 0xcb, "BTN_SIDE" }, + { 0xcc, "BTN_EXTRA" }, + { 0xcd, "REL_WHEEL_UP" }, + { 0xce, "REL_WHEEL_DOWN" }, + { 0xff, "DISABLED" }, +}; + +static const u16 button_mapping_addr_old[] =3D { + 0x007a, /* M1 */ + 0x011f, /* M2 */ +}; + +static const u16 button_mapping_addr_new[] =3D { + 0x00bb, /* M1 */ + 0x0164, /* M2 */ +}; + struct claw_command_report { u8 report_id; u8 padding[2]; @@ -87,18 +249,26 @@ struct claw_command_report { =20 struct claw_drvdata { /* MCU General Variables */ + enum claw_profile_ack_pending profile_pending; struct completion send_cmd_complete; struct delayed_work cfg_resume; struct delayed_work cfg_setup; + struct mutex profile_mutex; /* mutex for profile_pending calls */ struct hid_device *hdev; struct mutex mode_mutex; /* mutex for mode calls */ struct mutex cfg_mutex; /* mutex for synchronous data */ + struct mutex rom_mutex; /* mutex for SYNC_TO_ROM calls */ + u16 bcd_device; u8 ep; =20 /* Gamepad Variables */ enum claw_mkeys_function_index mkeys_function; enum claw_gamepad_mode_index gamepad_mode; + u8 m1_codes[CLAW_KEYS_MAX]; + u8 m2_codes[CLAW_KEYS_MAX]; bool gamepad_registered; + const u16 *bmap_addr; + bool bmap_support; }; =20 static int get_endpoint_address(struct hid_device *hdev) @@ -128,6 +298,30 @@ static int claw_gamepad_mode_event(struct claw_drvdata= *drvdata, return 0; } =20 +static int claw_profile_event(struct claw_drvdata *drvdata, struct claw_co= mmand_report *cmd_rep) +{ + u8 *codes; + int i; + + switch (drvdata->profile_pending) { + case CLAW_M1_PENDING: + case CLAW_M2_PENDING: + codes =3D (drvdata->profile_pending =3D=3D CLAW_M1_PENDING) ? + drvdata->m1_codes : drvdata->m2_codes; + for (i =3D 0; i < CLAW_KEYS_MAX; i++) + codes[i] =3D (cmd_rep->data[6 + i]); + break; + default: + dev_dbg(&drvdata->hdev->dev, + "Got profile event without changes pending from command: %x\n", + cmd_rep->cmd); + return -EINVAL; + } + drvdata->profile_pending =3D CLAW_NO_PENDING; + + return 0; +} + static int claw_raw_event(struct claw_drvdata *drvdata, struct hid_report = *report, u8 *data, int size) { @@ -149,6 +343,9 @@ static int claw_raw_event(struct claw_drvdata *drvdata,= struct hid_report *repor case CLAW_COMMAND_TYPE_GAMEPAD_MODE_ACK: ret =3D claw_gamepad_mode_event(drvdata, cmd_rep); break; + case CLAW_COMMAND_TYPE_READ_PROFILE_ACK: + ret =3D claw_profile_event(drvdata, cmd_rep); + break; case CLAW_COMMAND_TYPE_ACK: break; default: @@ -373,6 +570,164 @@ static ssize_t reset_store(struct device *dev, struct= device_attribute *attr, } static DEVICE_ATTR_WO(reset); =20 +static int button_mapping_name_to_code(const char *name) +{ + int i; + + for (i =3D 0; i < ARRAY_SIZE(claw_button_mapping_key_map); i++) { + if (!strcmp(name, claw_button_mapping_key_map[i].name)) + return claw_button_mapping_key_map[i].code; + } + + return -EINVAL; +} + +static const char *button_mapping_code_to_name(u8 code) +{ + int i; + + if (code =3D=3D 0xff) + return NULL; + + for (i =3D 0; i < ARRAY_SIZE(claw_button_mapping_key_map); i++) { + if (claw_button_mapping_key_map[i].code =3D=3D code) + return claw_button_mapping_key_map[i].name; + } + + return NULL; +} + +DEFINE_FREE(argv, char **, if (_T) argv_free(_T)) + +static int claw_buttons_store(struct device *dev, const char *buf, u8 mkey= _idx) +{ + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + u8 data[] =3D { 0x01, (drvdata->bmap_addr[mkey_idx] >> 8) & 0xff, + drvdata->bmap_addr[mkey_idx] & 0xff, 0x07, + 0x04, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff }; + char **raw_keys __free(argv) =3D NULL; + size_t len =3D ARRAY_SIZE(data); + int ret, key_count, i; + + raw_keys =3D argv_split(GFP_KERNEL, buf, &key_count); + if (!raw_keys) + return -ENOMEM; + + if (key_count > CLAW_KEYS_MAX) + return -EINVAL; + + if (key_count =3D=3D 0) + goto set_buttons; + + for (i =3D 0; i < key_count; i++) { + ret =3D button_mapping_name_to_code(raw_keys[i]); + if (ret < 0) + return ret; + + data[6 + i] =3D ret; + } + +set_buttons: + scoped_guard(mutex, &drvdata->rom_mutex) { + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_WRITE_PROFILE_DATA, + data, len, 8); + if (ret) + return ret; + + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_SYNC_TO_ROM, NULL,= 0, 8); + } + + return ret; +} + +static int claw_buttons_show(struct device *dev, char *buf, enum claw_key_= index m_key) +{ + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + u8 data[] =3D { 0x01, (drvdata->bmap_addr[m_key] >> 8) & 0xff, + drvdata->bmap_addr[m_key] & 0xff, 0x07 }; + size_t len =3D ARRAY_SIZE(data); + int i, ret, count =3D 0; + const char *name; + u8 *codes; + + codes =3D (m_key =3D=3D CLAW_KEY_M1) ? drvdata->m1_codes : drvdata->m2_co= des; + + guard(mutex)(&drvdata->profile_mutex); + drvdata->profile_pending =3D (m_key =3D=3D CLAW_KEY_M1) ? CLAW_M1_PENDING= : CLAW_M2_PENDING; + + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_READ_PROFILE, data,= len, 8); + if (ret) { + drvdata->profile_pending =3D CLAW_NO_PENDING; + return ret; + } + for (i =3D 0; i < CLAW_KEYS_MAX; i++) { + name =3D button_mapping_code_to_name(codes[i]); + if (name) + count +=3D sysfs_emit_at(buf, count, "%s ", name); + } + + if (!count) + return sysfs_emit(buf, "(not set)\n"); + + buf[count - 1] =3D '\n'; + + return count; +} + +static ssize_t button_m1_store(struct device *dev, struct device_attribute= *attr, + const char *buf, size_t count) +{ + int ret; + + ret =3D claw_buttons_store(dev, buf, CLAW_KEY_M1); + if (ret) + return ret; + + return count; +} + +static ssize_t button_m1_show(struct device *dev, struct device_attribute = *attr, + char *buf) +{ + return claw_buttons_show(dev, buf, CLAW_KEY_M1); +} +static DEVICE_ATTR_RW(button_m1); + +static ssize_t button_m2_store(struct device *dev, struct device_attribute= *attr, + const char *buf, size_t count) +{ + int ret; + + ret =3D claw_buttons_store(dev, buf, CLAW_KEY_M2); + if (ret) + return ret; + + return count; +} + +static ssize_t button_m2_show(struct device *dev, struct device_attribute = *attr, + char *buf) +{ + return claw_buttons_show(dev, buf, CLAW_KEY_M2); +} +static DEVICE_ATTR_RW(button_m2); + +static ssize_t button_mapping_options_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + int i, count =3D 0; + + for (i =3D 0; i < ARRAY_SIZE(claw_button_mapping_key_map); i++) + count +=3D sysfs_emit_at(buf, count, "%s ", claw_button_mapping_key_map[= i].name); + + buf[count - 1] =3D '\n'; + + return count; +} +static DEVICE_ATTR_RO(button_mapping_options); + static umode_t claw_gamepad_attr_is_visible(struct kobject *kobj, struct a= ttribute *attr, int n) { @@ -385,10 +740,22 @@ static umode_t claw_gamepad_attr_is_visible(struct ko= bject *kobj, struct attribu return 0; } =20 - return attr->mode; + /* Always show attrs available on all firmware */ + if (attr =3D=3D &dev_attr_gamepad_mode.attr || + attr =3D=3D &dev_attr_gamepad_mode_index.attr || + attr =3D=3D &dev_attr_mkeys_function.attr || + attr =3D=3D &dev_attr_mkeys_function_index.attr || + attr =3D=3D &dev_attr_reset.attr) + return attr->mode; + + /* Hide button mapping attrs if it isn't supported */ + return drvdata->bmap_support ? attr->mode : 0; } =20 static struct attribute *claw_gamepad_attrs[] =3D { + &dev_attr_button_m1.attr, + &dev_attr_button_m2.attr, + &dev_attr_button_mapping_options.attr, &dev_attr_gamepad_mode.attr, &dev_attr_gamepad_mode_index.attr, &dev_attr_mkeys_function.attr, @@ -440,8 +807,31 @@ static void cfg_resume_fn(struct work_struct *work) dev_err(&drvdata->hdev->dev, "Failed to set gamepad mode settings: %d\n"= , ret); } =20 +static void claw_features_supported(struct claw_drvdata *drvdata) +{ + u8 major =3D (drvdata->bcd_device >> 8) & 0xff; + u8 minor =3D drvdata->bcd_device & 0xff; + + if (major =3D=3D 0x01) { + drvdata->bmap_support =3D true; + if (minor >=3D 0x66) + drvdata->bmap_addr =3D button_mapping_addr_new; + else + drvdata->bmap_addr =3D button_mapping_addr_old; + return; + } + + if ((major =3D=3D 0x02 && minor >=3D 0x17) || major >=3D 0x03) { + drvdata->bmap_support =3D true; + drvdata->bmap_addr =3D button_mapping_addr_new; + return; + } +} + static int claw_probe(struct hid_device *hdev, u8 ep) { + struct usb_interface *intf =3D to_usb_interface(hdev->dev.parent); + struct usb_device *udev =3D interface_to_usbdev(intf); struct claw_drvdata *drvdata; int ret; =20 @@ -453,8 +843,17 @@ static int claw_probe(struct hid_device *hdev, u8 ep) drvdata->hdev =3D hdev; drvdata->ep =3D ep; =20 + /* Determine feature level from firmware version */ + drvdata->bcd_device =3D le16_to_cpu(udev->descriptor.bcdDevice); + claw_features_supported(drvdata); + + if (!drvdata->bmap_support) + dev_dbg(&hdev->dev, "M-Key mapping is not supported. Update firmware to = enable.\n"); + mutex_init(&drvdata->mode_mutex); mutex_init(&drvdata->cfg_mutex); + mutex_init(&drvdata->profile_mutex); + mutex_init(&drvdata->rom_mutex); init_completion(&drvdata->send_cmd_complete); INIT_DELAYED_WORK(&drvdata->cfg_resume, &cfg_resume_fn); INIT_DELAYED_WORK(&drvdata->cfg_setup, &cfg_setup_fn); --=20 2.53.0 From nobody Mon May 25 08:11:33 2026 Received: from mail-dy1-f176.google.com (mail-dy1-f176.google.com [74.125.82.176]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D0374306B37 for ; Sun, 17 May 2026 01:39:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778981974; cv=none; b=noHfHXOttmzSrDrhy14cSeB/EvgPFqKiWCs6kw6kIOOgCMfjnGtHAN1YRzL9AsfxnCY/GnqobvmOqhSa7rc418hcvjqQPEYIV0UoGfFn+z69qogl+oHImotjFx6ofJizBTP2gePSPPnKFbRJtKTnQMurkJNtvRuxVq7x6ZPDkQ8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778981974; c=relaxed/simple; bh=iDN+PbwP30FtMBe/1QrYpSVuymKznzftoLiqzpaazkw=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Tb/IEerIe8pKTIizBLpZmxHANAH+ocZXatHCbTWAM5tqkUBVp//8yJE/xkehCSLdg8EQT0sJbHL03xa8ZDVYYXXmM4+3vEZCLYbnsh066YN/U+jKZfSUYbb0FUmvKFT9UycIKf5/vzx3nfQGVeCWIuysoCH1mw+/npeKhgdOFCM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=swjgrnEV; arc=none smtp.client-ip=74.125.82.176 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="swjgrnEV" Received: by mail-dy1-f176.google.com with SMTP id 5a478bee46e88-2b4520f6b32so1524011eec.0 for ; Sat, 16 May 2026 18:39:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1778981971; x=1779586771; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=e0LbQkkDqOJtjpa40Ppg/Z7zPO9euNvpJUQuJ3QO2L8=; b=swjgrnEVQyqPj/31yQwNEF5u2m6nJ8KKfdD+u+3yv/txNK78KWIp7gzVHRdE68tuCQ knH/4eBRrhVgFwRt5DL9ZLbDl0emksbuLEj05wHREcUylkDZTd1j3RP1sCRFoCYdaevV 4W7z5F5x2ldEwBck3AHJV5JuU5e3pN2iH2wxgpNXNHHXWalnGIoIeWEcoBjRvHhMq/ux BjpTNdxTIoQUgoKjWXOrNCaSrYqcRq4Op90waHkQMIoL/G1GJNRC4BVd0uQRzCNN3xXc sJqQrouHwwWn3oR52r91i3Tcvg5ooHXnU1P3rnVce9kOLRdf15yxG7khUQg90utfMnfs eBtw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1778981971; x=1779586771; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=e0LbQkkDqOJtjpa40Ppg/Z7zPO9euNvpJUQuJ3QO2L8=; b=syXOh5CulA4JXrKj65ktuAqh3S2J/Lkut7GKvn+zLeo5uq+jrhQOP0WiNBCNmUjqGT WQixYZIoXw3n7MroZkG8ftY4nMY2RS74lHLy2fa6Vtp5JxpPkFLiy9nY4zxBlK8MKuhb LWlgcpA5sCcI7T8d/eio6yAkb3mnKczgjKmOF24Lt/TJeiwI3ohy3q0HHvvyA6spbXFN tIzTHJJak3ynf3SU7lVD4L0fwBAxoX6/gYqZKwjh8m7gdSwGNujuAuWXSysXPdGoaGm3 ktTqWUbJ9eyIr6wlt78gPSBRiqFlXAZjw3FAGa+iKRfhHGqCke8NbuSyN2nmhwefcnmj MEPw== X-Forwarded-Encrypted: i=1; AFNElJ+NhwonmmJuPbCCeMi0+3mV4JABbCqgejxdb2Dzx4ufGa8JQrn+3Y7ofYMPGCAUkAcfzfK0arkwYAa6Ds0=@vger.kernel.org X-Gm-Message-State: AOJu0YzvsALT5Uudry0DNQNLzzb9arSTw70IstWDKT++kHKyHiQWO0d6 TqKPmJgznNeudMzicKEY3amhNqAPI30QyNskhqnxPrAoGZDcdGKLkFmq X-Gm-Gg: Acq92OE6J3jOBiDXAlV4OYlBz1bs2sKnbUHir8eXX46X1ES6+700P91mlzi3DlzlumL DfuxswDHDgxzjizSh1NEl7bM5x4G0RwuW2P23ktKHPTmaW/EEn29zCfy+eXe7epqmiPLZ1HvH+t n3eLHFSZfbJlxOGh2Z2e666eIaY5ykmIhJMEVe7MzB8FmIQ26VzIQuokGX6Qj9qNkI85gcQX/3A XsPPUK27e+5+yrpIB2UnqbS2wwHz7l5If2/M2LA4UOAGdge3YvJkIyBZeOEdCcMjW9SRFtIKBs4 TtOKSjUY1V/d+M1eCsN3/C4SlU8ZtdczBXrDB/fgBdPymUUzb9mfbhtrahPxZqeyx7MqWyAvQ8k XJ0MOi9t5s1rz4KN81TIxfZAGoKnRHSdvSDN0hpefOwGt+GrR0eS9AnnGSpGSEDbXQR7amKo/WG /UuorJcs6Lbiq99AMfkyNV5k7nnhei5GUsG5XEa6uEEB9JEu144tPbiYMP+3tfFk2AF+Qll3wuV 0D4 X-Received: by 2002:a05:7301:198e:b0:2ef:2878:7ad0 with SMTP id 5a478bee46e88-303986524b5mr3908087eec.27.1778981970851; Sat, 16 May 2026 18:39:30 -0700 (PDT) Received: from lappy (108-228-232-20.lightspeed.sndgca.sbcglobal.net. [108.228.232.20]) by smtp.gmail.com with ESMTPSA id a92af1059eb24-134cb5b3c20sm15898086c88.0.2026.05.16.18.39.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 May 2026 18:39:30 -0700 (PDT) From: "Derek J. Clark" To: Jiri Kosina , Benjamin Tissoires Cc: "Pierre-Loup A . Griffais" , Denis Benato , Zhouwang Huang , "Derek J . Clark" , linux-input@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5 3/4] HID: hid-msi: Add RGB control interface Date: Sun, 17 May 2026 01:39:24 +0000 Message-ID: <20260517013925.3120314-4-derekjohn.clark@gmail.com> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20260517013925.3120314-1-derekjohn.clark@gmail.com> References: <20260517013925.3120314-1-derekjohn.clark@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Adds RGB control interface for MSI Claw devices. The MSI Claw uses a fairly unique RGB interface. It has 9 total zones (4 per joystick ring and 1 for the ABXY buttons), and supports up to 8 sequential frames of RGB zone data. Each frame is written to a specific area of MCU memory by the profile command, the value of which changes based on the firmware of the device. Unlike other devices (such as the Legion Go or the OneXPlayer devices), there are no hard coded effects built into the MCU. Instead, the basic effects are provided as a series of frame data. I have mirrored the effects available in Windows in this driver, while keeping the effect names consistent with the Lenovo drivers for the effects that are similar. Initial reverse-engineering and implementation of this feature was done by Zhouwang Huang. I refactored the overall format to conform to kernel driver best practices and style guides. Claude was used as an initial reviewer of this patch. Assisted-by: Claude:claude-sonnet-4-6 Co-developed-by: Zhouwang Huang Signed-off-by: Zhouwang Huang Signed-off-by: Derek J. Clark --- v5: - Move adding the RGB device into cfg_setup to prevent led core attributes from being written to prior to setup completing. - Ensure frame_lock is properly init. - Change variable names in RGB functions from frame and zone to f and z respectively to fit all scoped_guard actions in 100 columns. v4: - Fix frame_calc validity check to use >=3D. - USe spinlock instead of mutex in raw_event and related attribute _store function. - Ensure delayed work is canceled in suspend & canceled before sysfs attribute removal. v3: - Add mutex for read/write of rgb frame data. - Remove setting rgb_frame_count when reading rgb profiles as it always returns garbage data. - Ensure rgb_speed is getting drvdata from a valid lookup (not hdev). v2: - Use pending_profile mutex --- drivers/hid/hid-msi.c | 573 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 568 insertions(+), 5 deletions(-) diff --git a/drivers/hid/hid-msi.c b/drivers/hid/hid-msi.c index 991d5a25d3de0..4443f53b54cb1 100644 --- a/drivers/hid/hid-msi.c +++ b/drivers/hid/hid-msi.c @@ -21,10 +21,13 @@ #include #include #include +#include #include #include #include #include +#include +#include #include #include #include @@ -43,6 +46,10 @@ =20 #define CLAW_KEYS_MAX 5 =20 +#define CLAW_RGB_ZONES 9 +#define CLAW_RGB_MAX_FRAMES 8 +#define CLAW_RGB_FRAME_OFFSET 0x24 + enum claw_command_index { CLAW_COMMAND_TYPE_READ_PROFILE =3D 0x04, CLAW_COMMAND_TYPE_READ_PROFILE_ACK =3D 0x05, @@ -71,6 +78,7 @@ enum claw_profile_ack_pending { CLAW_NO_PENDING, CLAW_M1_PENDING, CLAW_M2_PENDING, + CLAW_RGB_PENDING, }; =20 enum claw_key_index { @@ -229,6 +237,22 @@ static const struct { { 0xff, "DISABLED" }, }; =20 +enum claw_rgb_effect_index { + CLAW_RGB_EFFECT_MONOCOLOR, + CLAW_RGB_EFFECT_BREATHE, + CLAW_RGB_EFFECT_CHROMA, + CLAW_RGB_EFFECT_RAINBOW, + CLAW_RGB_EFFECT_FROSTFIRE, +}; + +static const char * const claw_rgb_effect_text[] =3D { + [CLAW_RGB_EFFECT_MONOCOLOR] =3D "monocolor", + [CLAW_RGB_EFFECT_BREATHE] =3D "breathe", + [CLAW_RGB_EFFECT_CHROMA] =3D "chroma", + [CLAW_RGB_EFFECT_RAINBOW] =3D "rainbow", + [CLAW_RGB_EFFECT_FROSTFIRE] =3D "frostfire", +}; + static const u16 button_mapping_addr_old[] =3D { 0x007a, /* M1 */ 0x011f, /* M2 */ @@ -239,6 +263,9 @@ static const u16 button_mapping_addr_new[] =3D { 0x0164, /* M2 */ }; =20 +static const u16 rgb_addr_old =3D 0x01fa; +static const u16 rgb_addr_new =3D 0x024a; + struct claw_command_report { u8 report_id; u8 padding[2]; @@ -247,6 +274,28 @@ struct claw_command_report { u8 data[59]; } __packed; =20 +struct rgb_zone { + u8 red; + u8 green; + u8 blue; +}; + +struct rgb_frame { + struct rgb_zone zone[CLAW_RGB_ZONES]; +}; + +struct rgb_report { + u8 profile; + __be16 read_addr; + u8 frame_bytes; + u8 padding; + u8 frame_count; + u8 state; /* Always 0x09 */ + u8 speed; + u8 brightness; + struct rgb_frame zone_data; +} __packed; + struct claw_drvdata { /* MCU General Variables */ enum claw_profile_ack_pending profile_pending; @@ -258,6 +307,7 @@ struct claw_drvdata { struct mutex mode_mutex; /* mutex for mode calls */ struct mutex cfg_mutex; /* mutex for synchronous data */ struct mutex rom_mutex; /* mutex for SYNC_TO_ROM calls */ + spinlock_t frame_lock; /* lock for read/write rgb_frames */ u16 bcd_device; u8 ep; =20 @@ -269,6 +319,17 @@ struct claw_drvdata { bool gamepad_registered; const u16 *bmap_addr; bool bmap_support; + + /* RGB Variables */ + struct rgb_frame rgb_frames[CLAW_RGB_MAX_FRAMES]; + enum claw_rgb_effect_index rgb_effect; + struct led_classdev_mc led_mc; + struct delayed_work rgb_queue; + bool rgb_registered; + u8 rgb_frame_count; + bool rgb_enabled; + u8 rgb_speed; + u16 rgb_addr; }; =20 static int get_endpoint_address(struct hid_device *hdev) @@ -300,8 +361,11 @@ static int claw_gamepad_mode_event(struct claw_drvdata= *drvdata, =20 static int claw_profile_event(struct claw_drvdata *drvdata, struct claw_co= mmand_report *cmd_rep) { - u8 *codes; - int i; + struct rgb_report *frame; + u16 rgb_addr, read_addr; + u8 *codes, f_idx; + u16 frame_calc; + int i, ret =3D 0; =20 switch (drvdata->profile_pending) { case CLAW_M1_PENDING: @@ -311,15 +375,45 @@ static int claw_profile_event(struct claw_drvdata *dr= vdata, struct claw_command_ for (i =3D 0; i < CLAW_KEYS_MAX; i++) codes[i] =3D (cmd_rep->data[6 + i]); break; + case CLAW_RGB_PENDING: + frame =3D (struct rgb_report *)cmd_rep->data; + rgb_addr =3D drvdata->rgb_addr; + read_addr =3D be16_to_cpu(frame->read_addr); + frame_calc =3D (read_addr - rgb_addr) / CLAW_RGB_FRAME_OFFSET; + if (frame_calc >=3D CLAW_RGB_MAX_FRAMES) { + dev_err(drvdata->led_mc.led_cdev.dev, "Got unsupported frame index: %x\= n", + frame_calc); + drvdata->profile_pending =3D CLAW_NO_PENDING; + return -EINVAL; + } + f_idx =3D frame_calc; + + scoped_guard(spinlock_irqsave, &drvdata->frame_lock) { + memcpy(&drvdata->rgb_frames[f_idx], &frame->zone_data, + sizeof(struct rgb_frame)); + + /* Only use frame 0 for remaining variable assignment */ + if (f_idx !=3D 0) + break; + + drvdata->rgb_speed =3D frame->speed; + drvdata->led_mc.led_cdev.brightness =3D frame->brightness; + drvdata->led_mc.subled_info[0].intensity =3D frame->zone_data.zone[0].r= ed; + drvdata->led_mc.subled_info[1].intensity =3D frame->zone_data.zone[0].g= reen; + drvdata->led_mc.subled_info[2].intensity =3D frame->zone_data.zone[0].b= lue; + } + + break; default: dev_dbg(&drvdata->hdev->dev, "Got profile event without changes pending from command: %x\n", cmd_rep->cmd); return -EINVAL; } + drvdata->profile_pending =3D CLAW_NO_PENDING; =20 - return 0; + return ret; } =20 static int claw_raw_event(struct claw_drvdata *drvdata, struct hid_report = *report, @@ -769,6 +863,420 @@ static const struct attribute_group claw_gamepad_attr= _group =3D { .is_visible =3D claw_gamepad_attr_is_visible, }; =20 +/* Read RGB config from device */ +static int claw_read_rgb_config(struct hid_device *hdev) +{ + u8 data[4] =3D { 0x01, 0x00, 0x00, CLAW_RGB_FRAME_OFFSET }; + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + u16 read_addr =3D drvdata->rgb_addr; + size_t len =3D ARRAY_SIZE(data); + int ret, i; + + if (!drvdata->rgb_addr) + return -ENODEV; + + /* Loop through all 8 pages of RGB data */ + guard(mutex)(&drvdata->profile_mutex); + for (i =3D 0; i < 8; i++) { + drvdata->profile_pending =3D CLAW_RGB_PENDING; + data[1] =3D (read_addr >> 8) & 0xff; + data[2] =3D read_addr & 0x00ff; + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_READ_PROFILE, data= , len, 8); + if (ret) { + drvdata->profile_pending =3D CLAW_NO_PENDING; + return ret; + } + read_addr +=3D CLAW_RGB_FRAME_OFFSET; + } + + return 0; +} + +/* Send RGB configuration to device */ +static int claw_write_rgb_state(struct claw_drvdata *drvdata) +{ + struct rgb_report report =3D { 0x01, 0x0000, CLAW_RGB_FRAME_OFFSET, 0x00, + drvdata->rgb_frame_count, 0x09, drvdata->rgb_speed, + drvdata->led_mc.led_cdev.brightness }; + u16 write_addr =3D drvdata->rgb_addr; + size_t len =3D sizeof(report); + int f, ret; + + if (!drvdata->rgb_addr) + return -ENODEV; + + if (!drvdata->rgb_frame_count) + return -EINVAL; + + guard(mutex)(&drvdata->rom_mutex); + /* Loop through (up to) 8 pages of RGB data */ + for (f =3D 0; f < drvdata->rgb_frame_count; f++) { + scoped_guard(spinlock_irqsave, &drvdata->frame_lock) + report.zone_data =3D drvdata->rgb_frames[f]; + + /* Set the MCU address to write the frame data to */ + report.read_addr =3D cpu_to_be16(write_addr); + + /* Serialize the rgb_report and write it to MCU */ + ret =3D claw_hw_output_report(drvdata->hdev, CLAW_COMMAND_TYPE_WRITE_PRO= FILE_DATA, + (u8 *)&report, len, 8); + if (ret) + return ret; + + /* Increment the write addr by the offset for the next frame */ + write_addr +=3D CLAW_RGB_FRAME_OFFSET; + } + + ret =3D claw_hw_output_report(drvdata->hdev, CLAW_COMMAND_TYPE_SYNC_TO_RO= M, NULL, 0, 8); + + return ret; +} + +/* Fill all zones with the same color */ +static void claw_frame_fill_solid(struct rgb_frame *frame, struct rgb_zone= zone) +{ + int z; + + for (z =3D 0; z < CLAW_RGB_ZONES; z++) + frame->zone[z] =3D zone; +} + +/* Apply solid effect (1 frame, no color) */ +static int claw_apply_disabled(struct claw_drvdata *drvdata) +{ + struct rgb_zone off =3D { 0x00, 0x00, 0x00}; + + scoped_guard(spinlock_irqsave, &drvdata->frame_lock) { + drvdata->rgb_frame_count =3D 1; + claw_frame_fill_solid(&drvdata->rgb_frames[0], off); + } + + return claw_write_rgb_state(drvdata); +} + +/* Apply solid effect (1 frame, all zones same color) */ +static int claw_apply_monocolor(struct claw_drvdata *drvdata) +{ + struct mc_subled *subleds =3D drvdata->led_mc.subled_info; + struct rgb_zone zone =3D { subleds[0].intensity, subleds[1].intensity, + subleds[2].intensity }; + + scoped_guard(spinlock_irqsave, &drvdata->frame_lock) { + drvdata->rgb_frame_count =3D 1; + claw_frame_fill_solid(&drvdata->rgb_frames[0], zone); + } + + return claw_write_rgb_state(drvdata); +} + +/* Apply breathe effect (2 frames: color -> off) */ +static int claw_apply_breathe(struct claw_drvdata *drvdata) +{ + struct mc_subled *subleds =3D drvdata->led_mc.subled_info; + struct rgb_zone zone =3D { subleds[0].intensity, subleds[1].intensity, + subleds[2].intensity }; + static const struct rgb_zone off =3D { 0, 0, 0 }; + + scoped_guard(spinlock_irqsave, &drvdata->frame_lock) { + drvdata->rgb_frame_count =3D 2; + claw_frame_fill_solid(&drvdata->rgb_frames[0], zone); + claw_frame_fill_solid(&drvdata->rgb_frames[1], off); + } + + return claw_write_rgb_state(drvdata); +} + +/* Apply chroma effect (6 frames: rainbow cycle, all zones sync) */ +static int claw_apply_chroma(struct claw_drvdata *drvdata) +{ + static const struct rgb_zone colors[] =3D { + {255, 0, 0}, /* red */ + {255, 255, 0}, /* yellow */ + { 0, 255, 0}, /* green */ + { 0, 255, 255}, /* cyan */ + { 0, 0, 255}, /* blue */ + {255, 0, 255}, /* magenta */ + }; + u8 frame_count =3D ARRAY_SIZE(colors); + int f; + + scoped_guard(spinlock_irqsave, &drvdata->frame_lock) { + drvdata->rgb_frame_count =3D frame_count; + + for (f =3D 0; f < frame_count; f++) + claw_frame_fill_solid(&drvdata->rgb_frames[f], colors[f]); + } + + return claw_write_rgb_state(drvdata); +} + +/* Apply rainbow effect (4 frames: rotating colors around joysticks) */ +static int claw_apply_rainbow(struct claw_drvdata *drvdata) +{ + static const struct rgb_zone colors[] =3D { + {255, 0, 0}, /* red */ + { 0, 255, 0}, /* green */ + { 0, 255, 255}, /* cyan */ + { 0, 0, 255}, /* blue */ + }; + u8 frame_count =3D ARRAY_SIZE(colors); + int f, z; + + scoped_guard(spinlock_irqsave, &drvdata->frame_lock) { + drvdata->rgb_frame_count =3D frame_count; + + for (f =3D 0; f < frame_count; f++) { + for (z =3D 0; z < 4; z++) { + drvdata->rgb_frames[f].zone[z] =3D colors[(z + f) % 4]; + drvdata->rgb_frames[f].zone[z + 4] =3D colors[(z + f) % 4]; + } + drvdata->rgb_frames[f].zone[8] =3D colors[f]; + } + } + + return claw_write_rgb_state(drvdata); +} + +/* + * Apply frostfire effect (4 frames: fire vs ice rotating) + * Right joystick: fire red -> dark -> ice blue -> dark (clockwise) + * Left joystick: ice blue -> dark -> fire red -> dark (counter-clockwise) + * ABXY: fire red -> dark -> ice blue -> dark + */ +static int claw_apply_frostfire(struct claw_drvdata *drvdata) +{ + static const struct rgb_zone colors[] =3D { + {255, 0, 0}, /* fire red */ + { 0, 0, 0}, /* dark */ + { 0, 0, 255}, /* ice blue */ + { 0, 0, 0}, /* dark */ + }; + u8 frame_count =3D ARRAY_SIZE(colors); + int f, z; + + scoped_guard(spinlock_irqsave, &drvdata->frame_lock) { + drvdata->rgb_frame_count =3D frame_count; + + for (f =3D 0; f < frame_count; f++) { + for (z =3D 0; z < 4; z++) { + drvdata->rgb_frames[f].zone[z] =3D colors[(z + f) % 4]; + drvdata->rgb_frames[f].zone[z + 4] =3D colors[(z - f + 6) % 4]; + } + drvdata->rgb_frames[f].zone[8] =3D colors[f]; + } + } + + return claw_write_rgb_state(drvdata); +} + +/* Apply current state to device */ +static int claw_apply_rgb_state(struct claw_drvdata *drvdata) +{ + if (!drvdata->rgb_enabled) + return claw_apply_disabled(drvdata); + + switch (drvdata->rgb_effect) { + case CLAW_RGB_EFFECT_MONOCOLOR: + return claw_apply_monocolor(drvdata); + case CLAW_RGB_EFFECT_BREATHE: + return claw_apply_breathe(drvdata); + case CLAW_RGB_EFFECT_CHROMA: + return claw_apply_chroma(drvdata); + case CLAW_RGB_EFFECT_RAINBOW: + return claw_apply_rainbow(drvdata); + case CLAW_RGB_EFFECT_FROSTFIRE: + return claw_apply_frostfire(drvdata); + default: + dev_err(drvdata->led_mc.led_cdev.dev, + "No supported rgb_effect selected\n"); + return -EINVAL; + } +} + +static void claw_rgb_queue_fn(struct work_struct *work) +{ + struct delayed_work *dwork =3D container_of(work, struct delayed_work, wo= rk); + struct claw_drvdata *drvdata =3D container_of(dwork, struct claw_drvdata,= rgb_queue); + int ret; + + if (!drvdata->rgb_registered) + return; + + ret =3D claw_apply_rgb_state(drvdata); + if (ret) + dev_err(drvdata->led_mc.led_cdev.dev, + "Failed to apply RGB state: %d\n", ret); +} + +static ssize_t effect_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + struct led_classdev *led_cdev =3D dev_get_drvdata(dev); + struct led_classdev_mc *led_mc =3D container_of(led_cdev, struct led_clas= sdev_mc, led_cdev); + struct claw_drvdata *drvdata =3D container_of(led_mc, struct claw_drvdata= , led_mc); + int ret; + + ret =3D sysfs_match_string(claw_rgb_effect_text, buf); + if (ret < 0) + return ret; + + drvdata->rgb_effect =3D ret; + mod_delayed_work(system_wq, &drvdata->rgb_queue, msecs_to_jiffies(50)); + + return count; +} + +static ssize_t effect_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + struct led_classdev *led_cdev =3D dev_get_drvdata(dev); + struct led_classdev_mc *led_mc =3D container_of(led_cdev, struct led_clas= sdev_mc, led_cdev); + struct claw_drvdata *drvdata =3D container_of(led_mc, struct claw_drvdata= , led_mc); + + if (drvdata->rgb_effect >=3D ARRAY_SIZE(claw_rgb_effect_text)) + return -EINVAL; + + return sysfs_emit(buf, "%s\n", claw_rgb_effect_text[drvdata->rgb_effect]); +} + +static DEVICE_ATTR_RW(effect); + +static ssize_t effect_index_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + int i, count =3D 0; + + for (i =3D 0; i < ARRAY_SIZE(claw_rgb_effect_text); i++) + count +=3D sysfs_emit_at(buf, count, "%s ", claw_rgb_effect_text[i]); + + if (count) + buf[count - 1] =3D '\n'; + + return count; +} +static DEVICE_ATTR_RO(effect_index); + +static ssize_t enabled_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + struct led_classdev *led_cdev =3D dev_get_drvdata(dev); + struct led_classdev_mc *led_mc =3D container_of(led_cdev, struct led_clas= sdev_mc, led_cdev); + struct claw_drvdata *drvdata =3D container_of(led_mc, struct claw_drvdata= , led_mc); + bool val; + int ret; + + ret =3D kstrtobool(buf, &val); + if (ret) + return ret; + + drvdata->rgb_enabled =3D val; + mod_delayed_work(system_wq, &drvdata->rgb_queue, msecs_to_jiffies(50)); + + return count; +} + +static ssize_t enabled_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + struct led_classdev *led_cdev =3D dev_get_drvdata(dev); + struct led_classdev_mc *led_mc =3D container_of(led_cdev, struct led_clas= sdev_mc, led_cdev); + struct claw_drvdata *drvdata =3D container_of(led_mc, struct claw_drvdata= , led_mc); + + return sysfs_emit(buf, "%s\n", drvdata->rgb_enabled ? "true" : "false"); +} +static DEVICE_ATTR_RW(enabled); + +static ssize_t enabled_index_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + return sysfs_emit(buf, "true false\n"); +} +static DEVICE_ATTR_RO(enabled_index); + +static ssize_t speed_store(struct device *dev, struct device_attribute *at= tr, + const char *buf, size_t count) +{ + struct led_classdev *led_cdev =3D dev_get_drvdata(dev); + struct led_classdev_mc *led_mc =3D container_of(led_cdev, struct led_clas= sdev_mc, led_cdev); + struct claw_drvdata *drvdata =3D container_of(led_mc, struct claw_drvdata= , led_mc); + unsigned int val, speed; + int ret; + + ret =3D kstrtouint(buf, 10, &val); + if (ret) + return ret; + + if (val > 20) + return -EINVAL; + + /* 0 is fastest, invert value for intuitive userspace speed */ + speed =3D 20 - val; + + drvdata->rgb_speed =3D speed; + mod_delayed_work(system_wq, &drvdata->rgb_queue, msecs_to_jiffies(50)); + + return count; +} + +static ssize_t speed_show(struct device *dev, struct device_attribute *att= r, + char *buf) +{ + struct led_classdev *led_cdev =3D dev_get_drvdata(dev); + struct led_classdev_mc *led_mc =3D container_of(led_cdev, struct led_clas= sdev_mc, led_cdev); + struct claw_drvdata *drvdata =3D container_of(led_mc, struct claw_drvdata= , led_mc); + u8 speed =3D 20 - drvdata->rgb_speed; + + return sysfs_emit(buf, "%u\n", speed); +} +static DEVICE_ATTR_RW(speed); + +static ssize_t speed_range_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + return sysfs_emit(buf, "0-20\n"); +} +static DEVICE_ATTR_RO(speed_range); + +static void claw_led_brightness_set(struct led_classdev *led_cdev, + enum led_brightness _brightness) +{ + struct led_classdev_mc *led_mc =3D container_of(led_cdev, struct led_clas= sdev_mc, led_cdev); + struct claw_drvdata *drvdata =3D container_of(led_mc, struct claw_drvdata= , led_mc); + + mod_delayed_work(system_wq, &drvdata->rgb_queue, msecs_to_jiffies(50)); +} + +static struct attribute *claw_rgb_attrs[] =3D { + &dev_attr_effect.attr, + &dev_attr_effect_index.attr, + &dev_attr_enabled.attr, + &dev_attr_enabled_index.attr, + &dev_attr_speed.attr, + &dev_attr_speed_range.attr, + NULL, +}; + +static const struct attribute_group claw_rgb_attr_group =3D { + .attrs =3D claw_rgb_attrs, +}; + +static struct mc_subled claw_rgb_subled_info[] =3D { + { + .color_index =3D LED_COLOR_ID_RED, + .channel =3D 0x1, + }, + { + .color_index =3D LED_COLOR_ID_GREEN, + .channel =3D 0x2, + }, + { + .color_index =3D LED_COLOR_ID_BLUE, + .channel =3D 0x3, + }, +}; + static void cfg_setup_fn(struct work_struct *work) { struct delayed_work *dwork =3D container_of(work, struct delayed_work, wo= rk); @@ -782,6 +1290,13 @@ static void cfg_setup_fn(struct work_struct *work) return; } =20 + ret =3D claw_read_rgb_config(drvdata->hdev); + if (ret) { + dev_err(drvdata->led_mc.led_cdev.dev, + "Failed to setup device, can't read RGB config: %d\n", ret); + return; + } + /* Add sysfs attributes after we get the device state */ ret =3D device_add_group(&drvdata->hdev->dev, &claw_gamepad_attr_group); if (ret) { @@ -791,7 +1306,25 @@ static void cfg_setup_fn(struct work_struct *work) } drvdata->gamepad_registered =3D true; =20 + /* Add and enable RGB interface once we have the device state */ + INIT_DELAYED_WORK(&drvdata->rgb_queue, &claw_rgb_queue_fn); + ret =3D devm_led_classdev_multicolor_register(&drvdata->hdev->dev, &drvda= ta->led_mc); + if (ret) { + dev_err(&drvdata->hdev->dev, + "Failed to setup device, can't create led device: %d\n", ret); + return; + } + + ret =3D device_add_group(drvdata->led_mc.led_cdev.dev, &claw_rgb_attr_gro= up); + if (ret) { + dev_err(&drvdata->hdev->dev, + "Failed to setup device, can't create led attributes: %d\n", ret); + return; + } + drvdata->rgb_registered =3D true; + kobject_uevent(&drvdata->hdev->dev.kobj, KOBJ_CHANGE); + kobject_uevent(&drvdata->led_mc.led_cdev.dev->kobj, KOBJ_CHANGE); } =20 static void cfg_resume_fn(struct work_struct *work) @@ -801,6 +1334,10 @@ static void cfg_resume_fn(struct work_struct *work) u8 data[2] =3D { drvdata->gamepad_mode, drvdata->mkeys_function }; int ret; =20 + ret =3D claw_read_rgb_config(drvdata->hdev); + if (ret) + dev_err(&drvdata->hdev->dev, "Failed to read RGB config: %d\n", ret); + ret =3D claw_hw_output_report(drvdata->hdev, CLAW_COMMAND_TYPE_SWITCH_MOD= E, data, ARRAY_SIZE(data), 0); if (ret) @@ -814,18 +1351,24 @@ static void claw_features_supported(struct claw_drvd= ata *drvdata) =20 if (major =3D=3D 0x01) { drvdata->bmap_support =3D true; - if (minor >=3D 0x66) + if (minor >=3D 0x66) { drvdata->bmap_addr =3D button_mapping_addr_new; - else + drvdata->rgb_addr =3D rgb_addr_new; + } else { drvdata->bmap_addr =3D button_mapping_addr_old; + drvdata->rgb_addr =3D rgb_addr_old; + } return; } =20 if ((major =3D=3D 0x02 && minor >=3D 0x17) || major >=3D 0x03) { drvdata->bmap_support =3D true; drvdata->bmap_addr =3D button_mapping_addr_new; + drvdata->rgb_addr =3D rgb_addr_new; return; } + + drvdata->rgb_addr =3D rgb_addr_old; } =20 static int claw_probe(struct hid_device *hdev, u8 ep) @@ -840,6 +1383,7 @@ static int claw_probe(struct hid_device *hdev, u8 ep) return -ENOMEM; =20 drvdata->gamepad_mode =3D CLAW_GAMEPAD_MODE_XINPUT; + drvdata->rgb_enabled =3D true; drvdata->hdev =3D hdev; drvdata->ep =3D ep; =20 @@ -850,10 +1394,22 @@ static int claw_probe(struct hid_device *hdev, u8 ep) if (!drvdata->bmap_support) dev_dbg(&hdev->dev, "M-Key mapping is not supported. Update firmware to = enable.\n"); =20 + drvdata->led_mc.led_cdev.name =3D "msi_claw:rgb:joystick_rings"; + drvdata->led_mc.led_cdev.brightness =3D 0x50; + drvdata->led_mc.led_cdev.max_brightness =3D 0x64; + drvdata->led_mc.led_cdev.color =3D LED_COLOR_ID_RGB; + drvdata->led_mc.led_cdev.brightness_set =3D claw_led_brightness_set; + drvdata->led_mc.num_colors =3D 3; + drvdata->led_mc.subled_info =3D devm_kmemdup(&hdev->dev, claw_rgb_subled_= info, + sizeof(claw_rgb_subled_info), GFP_KERNEL); + if (!drvdata->led_mc.subled_info) + return -ENOMEM; + mutex_init(&drvdata->mode_mutex); mutex_init(&drvdata->cfg_mutex); mutex_init(&drvdata->profile_mutex); mutex_init(&drvdata->rom_mutex); + spin_lock_init(&drvdata->frame_lock); init_completion(&drvdata->send_cmd_complete); INIT_DELAYED_WORK(&drvdata->cfg_resume, &cfg_resume_fn); INIT_DELAYED_WORK(&drvdata->cfg_setup, &cfg_setup_fn); @@ -864,6 +1420,7 @@ static int claw_probe(struct hid_device *hdev, u8 ep) return ret; =20 hid_set_drvdata(hdev, drvdata); + schedule_delayed_work(&drvdata->cfg_setup, msecs_to_jiffies(500)); =20 return 0; @@ -918,10 +1475,15 @@ static void claw_remove(struct hid_device *hdev) return; } =20 + /* Block writes to brightness/multi_intensity during teardown */ + drvdata->led_mc.led_cdev.brightness_set =3D NULL; cancel_delayed_work_sync(&drvdata->cfg_setup); cancel_delayed_work_sync(&drvdata->cfg_resume); + cancel_delayed_work_sync(&drvdata->rgb_queue); =20 guard(mutex)(&drvdata->cfg_mutex); + if (drvdata->rgb_registered) + device_remove_group(drvdata->led_mc.led_cdev.dev, &claw_rgb_attr_group); if (drvdata->gamepad_registered) device_remove_group(&hdev->dev, &claw_gamepad_attr_group); =20 @@ -982,6 +1544,7 @@ static int claw_suspend(struct hid_device *hdev) =20 cancel_delayed_work_sync(&drvdata->cfg_setup); cancel_delayed_work_sync(&drvdata->cfg_resume); + cancel_delayed_work_sync(&drvdata->rgb_queue); =20 return 0; } --=20 2.53.0 From nobody Mon May 25 08:11:33 2026 Received: from mail-dl1-f45.google.com (mail-dl1-f45.google.com [74.125.82.45]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 63A7A309EFA for ; Sun, 17 May 2026 01:39:32 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.45 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778981975; cv=none; b=FByyHbIvwdmvFuoej46+hT1q90EhWu4yscEXbmj2NaH4JwBgplOZL7RzLvXyTnPNZvoX5bwH2RTPgGW5Dqg2aEH8pHVKuubrEa5ACNdVbL0l3nVX7QvB25Yrvkpnzwq82JFP+0YmcaJYdhEoOqG0+ck9y7Y8aI5OxgNrXeBogh0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778981975; c=relaxed/simple; bh=f+QDDurMGfhxQmUZ65LQ5eMxnphu4dd2AYmUoc6GMvM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=eOzCfUN+CEFGbb22zD/4BUXYy5Eumfw4vPGQj3JYevmv9wEi4KhpKnr91iNVimHEuUIbFvajEk0vPtzTqgdPGjZDY3sUQuRg8qmZh6b1BFKP8NyMR4ifBK4YLRLhG/Ach6yje0ZVWYePdCFazGHXemi9kdRqJc2tYwSWmPZGN8o= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=ZBaQzoVq; arc=none smtp.client-ip=74.125.82.45 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ZBaQzoVq" Received: by mail-dl1-f45.google.com with SMTP id a92af1059eb24-12db2e415a7so412383c88.1 for ; Sat, 16 May 2026 18:39:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1778981971; x=1779586771; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=u0pPLxc8J/TCGTd8DK6oQFMrdSIfZluTMrmkXxci8Ac=; b=ZBaQzoVq9z7imL/fIQBctmABR4ES26rxnSnNVJhnz1PFIkozCZT38OFWcjLiUkt0GQ afyPROLnFm93aQ4HBmgZWcy4UJvNIlW0kwfOEggJJ0P8sHDfUsW80/iT7aSyGSvejBz6 J3w66cSte0KmykLHsN/H24+j0hQo+JSfVyyrrSYKO/Sudn4m7tUATbv9+PhdRV+fMY2G txbvuS5Pns8KVEcgve30eYw0RA5leNi5+GkKgoPa1qKqOWvp20u7EeEUokgz5Q1npI/i hAJPLRGcvvHMAEGsOPyDaM9nj6KqThVbDHqwyUZKESNCcmZ0jM4TNoRH3qQwaA2yeU71 etCQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1778981971; x=1779586771; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=u0pPLxc8J/TCGTd8DK6oQFMrdSIfZluTMrmkXxci8Ac=; b=ac1UQwHX+icnBc0vwcVLtLCF4ywn/YzZxr/JZ4o1A7DNZmwXI0BhqyCz8GwcBGJuSI 0/37bRjcVVqdhRdATdGds9nSjs9vGE1Ayxxg2dLZqqRtuNrQPDex1ciE/YlfEZcPZKCW AT6ki857IHu1wfIxozxrJWXvGdJxRvJlZGEC+7RrM35yA2+k/dHXHIZZSuQ4s1pHrV2R cHhkiE5xjKpi/4IZweSuDdMqw15FL2vi7QH+2yA+W0NmgYlNPFv4U40mHM+U+CV3pJN+ d6d1z/MjyIa+YVoDbGimyWEmw7LHRAorvaiXUDdY0Z2vlat/e6i4DpoFqtsVZe6tVkAb GEfA== X-Forwarded-Encrypted: i=1; AFNElJ92n0uJGYnuWiqe1+90dPGjjOjcmu9ZANiRceLdCAXRQvVWSYGXlDwYBEAwDyKFFtqfYacl5tLf/ObI28w=@vger.kernel.org X-Gm-Message-State: AOJu0Yw43aWo0bTfm4T0TQH2M+f+E2gdJw60bS55USX701B8fjPvde9O ReKHwQVGOY9Nt6gAcEZmOVRwE+vhNLwuiehxnu8Uq3KohchKLNPUrn09 X-Gm-Gg: Acq92OHNisCGkcwnQ7KoN4e/XGVK76KFk3j1RxGGFyi4i7SXU0GFgREJvjAScX/cDiQ ay/kNahmC6O85ev4QXvMd7hCVEL6Q48racjeO/Cm8/wkV1V1MFX9Qpzr4MYrN9XKJ3mTBAzVfLD bGRryPmUk5GIvopzW/9BQX604nN22hjjBR0wpW6oDTmJm12TJwaC9GciRJoWS44/JaBldnFewbf IznlwZQJTHJSw3HuB9GmGF8+KNHfhdESXJYoL46Az36IokpTK2UjvXeD5fyxZkNTmnksob9FMR7 spYrTFpvM86j7azl6FpMZiAY49zLkt7Qmw5XkmuNzaOPzHPoQ91HtalEFE58ntnddQq4enCTbJd iCotVgY1N1eOvWY+KSzv+vs0lvl3umK3zywDqtTOeUwD4bFDBmI45xQvHZGp+8JoFM623e+3Vx+ 2I5FiIBwaei+/dbl+BeOg/ASfMLMsbmVW6Nb7uwOqAFHcbJqTlaK6aRUlHDZbECaw9y+vEKdCtW NwU X-Received: by 2002:a05:7022:797:b0:12d:c4cf:cd7 with SMTP id a92af1059eb24-1350440c566mr4972957c88.8.1778981971532; Sat, 16 May 2026 18:39:31 -0700 (PDT) Received: from lappy (108-228-232-20.lightspeed.sndgca.sbcglobal.net. [108.228.232.20]) by smtp.gmail.com with ESMTPSA id a92af1059eb24-134cb5b3c20sm15898086c88.0.2026.05.16.18.39.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 May 2026 18:39:31 -0700 (PDT) From: "Derek J. Clark" To: Jiri Kosina , Benjamin Tissoires Cc: "Pierre-Loup A . Griffais" , Denis Benato , Zhouwang Huang , "Derek J . Clark" , linux-input@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v5 4/4] HID: hid-msi: Add Rumble Intensity Attributes Date: Sun, 17 May 2026 01:39:25 +0000 Message-ID: <20260517013925.3120314-5-derekjohn.clark@gmail.com> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20260517013925.3120314-1-derekjohn.clark@gmail.com> References: <20260517013925.3120314-1-derekjohn.clark@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Adds intensity adjustment for the left and right rumble motors. Claude was used during the reverse-engineering data gathering for this feature done by Zhouwang Huang. As the code had already been affected, I used Claude to create the initial framing for the feature, then did manual cleanup of the _show and _store functions afterwards to fix bugs and keep the coding style consistent. Claude was also used as an initial reviewer of this patch. Assisted-by: Claude:claude-sonnet-4-6 Co-developed-by: Zhouwang Huang Signed-off-by: Zhouwang Huang Signed-off-by: Derek J. Clark --- v5: - Remove mkey related changes. v2: - Use pending_profile and sync to rom mutexes. --- drivers/hid/hid-msi.c | 149 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 148 insertions(+), 1 deletion(-) diff --git a/drivers/hid/hid-msi.c b/drivers/hid/hid-msi.c index 4443f53b54cb1..d9951bffc8019 100644 --- a/drivers/hid/hid-msi.c +++ b/drivers/hid/hid-msi.c @@ -79,6 +79,8 @@ enum claw_profile_ack_pending { CLAW_M1_PENDING, CLAW_M2_PENDING, CLAW_RGB_PENDING, + CLAW_RUMBLE_LEFT_PENDING, + CLAW_RUMBLE_RIGHT_PENDING, }; =20 enum claw_key_index { @@ -266,6 +268,11 @@ static const u16 button_mapping_addr_new[] =3D { static const u16 rgb_addr_old =3D 0x01fa; static const u16 rgb_addr_new =3D 0x024a; =20 +static const u16 rumble_addr[] =3D { + 0x0022, /* left */ + 0x0023, /* right */ +}; + struct claw_command_report { u8 report_id; u8 padding[2]; @@ -316,8 +323,11 @@ struct claw_drvdata { enum claw_gamepad_mode_index gamepad_mode; u8 m1_codes[CLAW_KEYS_MAX]; u8 m2_codes[CLAW_KEYS_MAX]; - bool gamepad_registered; + u8 rumble_intensity_right; + u8 rumble_intensity_left; + bool gamepad_registered;=09 const u16 *bmap_addr; + bool rumble_support; bool bmap_support; =20 /* RGB Variables */ @@ -403,6 +413,12 @@ static int claw_profile_event(struct claw_drvdata *drv= data, struct claw_command_ drvdata->led_mc.subled_info[2].intensity =3D frame->zone_data.zone[0].b= lue; } =20 + break; + case CLAW_RUMBLE_LEFT_PENDING: + drvdata->rumble_intensity_left =3D cmd_rep->data[4]; + break; + case CLAW_RUMBLE_RIGHT_PENDING: + drvdata->rumble_intensity_right =3D cmd_rep->data[4]; break; default: dev_dbg(&drvdata->hdev->dev, @@ -822,6 +838,126 @@ static ssize_t button_mapping_options_show(struct dev= ice *dev, } static DEVICE_ATTR_RO(button_mapping_options); =20 +static ssize_t rumble_intensity_left_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + u8 data[] =3D { 0x01, (rumble_addr[0] >> 8) & 0xff, rumble_addr[0] & 0xff= , 0x01, 0x00 }; + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + u8 val; + int ret; + + ret =3D kstrtou8(buf, 10, &val); + if (ret) + return ret; + + if (val > 100) + return -EINVAL; + + data[4] =3D val; + + guard(mutex)(&drvdata->rom_mutex); + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_WRITE_PROFILE_DATA, + data, ARRAY_SIZE(data), 8); + if (ret) + return ret; + + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_SYNC_TO_ROM, NULL, = 0, 8); + if (ret) + return ret; + + drvdata->rumble_intensity_left =3D val; + + return count; +} + +static ssize_t rumble_intensity_left_show(struct device *dev, + struct device_attribute *attr, + char *buf) +{ + u8 data[4] =3D { 0x01, (rumble_addr[0] >> 8) & 0xff, rumble_addr[0] & 0xf= f, 0x01 }; + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + int ret; + + guard(mutex)(&drvdata->profile_mutex); + drvdata->profile_pending =3D CLAW_RUMBLE_LEFT_PENDING; + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_READ_PROFILE, data, + ARRAY_SIZE(data), 8); + if (ret) { + drvdata->profile_pending =3D CLAW_NO_PENDING; + return ret; + } + + return sysfs_emit(buf, "%u\n", drvdata->rumble_intensity_left); +} +static DEVICE_ATTR_RW(rumble_intensity_left); + +static ssize_t rumble_intensity_right_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + u8 data[] =3D { 0x01, (rumble_addr[1] >> 8) & 0xff, rumble_addr[1] & 0xff= , 0x01, 0x00 }; + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + u8 val; + int ret; + + ret =3D kstrtou8(buf, 10, &val); + if (ret) + return ret; + + if (val > 100) + return -EINVAL; + + data[4] =3D val; + + guard(mutex)(&drvdata->rom_mutex); + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_WRITE_PROFILE_DATA, + data, ARRAY_SIZE(data), 8); + if (ret) + return ret; + + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_SYNC_TO_ROM, NULL, = 0, 8); + if (ret) + return ret; + + drvdata->rumble_intensity_right =3D val; + + return count; +} + +static ssize_t rumble_intensity_right_show(struct device *dev, + struct device_attribute *attr, + char *buf) +{ + u8 data[4] =3D { 0x01, (rumble_addr[1] >> 8) & 0xff, rumble_addr[1] & 0xf= f, 0x01 }; + struct hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + int ret; + + guard(mutex)(&drvdata->profile_mutex); + drvdata->profile_pending =3D CLAW_RUMBLE_RIGHT_PENDING; + ret =3D claw_hw_output_report(hdev, CLAW_COMMAND_TYPE_READ_PROFILE, data, + ARRAY_SIZE(data), 8); + if (ret) { + drvdata->profile_pending =3D CLAW_NO_PENDING; + return ret; + } + + return sysfs_emit(buf, "%u\n", drvdata->rumble_intensity_right); +} +static DEVICE_ATTR_RW(rumble_intensity_right); + +static ssize_t rumble_intensity_range_show(struct device *dev, + struct device_attribute *attr, + char *buf) +{ + return sysfs_emit(buf, "0-100\n"); +} +static DEVICE_ATTR_RO(rumble_intensity_range); + static umode_t claw_gamepad_attr_is_visible(struct kobject *kobj, struct a= ttribute *attr, int n) { @@ -842,6 +978,12 @@ static umode_t claw_gamepad_attr_is_visible(struct kob= ject *kobj, struct attribu attr =3D=3D &dev_attr_reset.attr) return attr->mode; =20 + /* Hide rumble attrs if not supported */ + if (attr =3D=3D &dev_attr_rumble_intensity_left.attr || + attr =3D=3D &dev_attr_rumble_intensity_right.attr || + attr =3D=3D &dev_attr_rumble_intensity_range.attr) + return drvdata->rumble_support ? attr->mode : 0; + /* Hide button mapping attrs if it isn't supported */ return drvdata->bmap_support ? attr->mode : 0; } @@ -855,6 +997,9 @@ static struct attribute *claw_gamepad_attrs[] =3D { &dev_attr_mkeys_function.attr, &dev_attr_mkeys_function_index.attr, &dev_attr_reset.attr, + &dev_attr_rumble_intensity_left.attr, + &dev_attr_rumble_intensity_right.attr, + &dev_attr_rumble_intensity_range.attr, NULL, }; =20 @@ -1353,6 +1498,7 @@ static void claw_features_supported(struct claw_drvda= ta *drvdata) drvdata->bmap_support =3D true; if (minor >=3D 0x66) { drvdata->bmap_addr =3D button_mapping_addr_new; + drvdata->rumble_support =3D true; drvdata->rgb_addr =3D rgb_addr_new; } else { drvdata->bmap_addr =3D button_mapping_addr_old; @@ -1364,6 +1510,7 @@ static void claw_features_supported(struct claw_drvda= ta *drvdata) if ((major =3D=3D 0x02 && minor >=3D 0x17) || major >=3D 0x03) { drvdata->bmap_support =3D true; drvdata->bmap_addr =3D button_mapping_addr_new; + drvdata->rumble_support =3D true; drvdata->rgb_addr =3D rgb_addr_new; return; } --=20 2.53.0