From nobody Sat May 30 08:43:31 2026 Received: from mail-dy1-f181.google.com (mail-dy1-f181.google.com [74.125.82.181]) (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 8AB79279DB6 for ; Sun, 10 May 2026 04:35:17 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.181 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778387719; cv=none; b=TJe88P0hNGNIo21qDsvMlPsQ+wX8HUmGGTMholyzPsBQmKSCjawzNrVKtED/RGiY/wdFMHc2gqUFd6UG8yGHusA2spIrkd7uoYn3by3MbI9icm8ck8zqxXdnyoYfgAdAKWW3JVMdE2JuIZAyy7VlHBf0BBoIVwrtXrLptXaTL0o= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778387719; c=relaxed/simple; bh=GgEdS01djtvyT8ifwFDhef72E6cCjq5GA0rPX5E4oZ8=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=jgHFKqSMtUvbX6CbRfh2tDiv7EcRGRKsU04vzlPIEfhhOQSmj/QTy2sGdHxtSqBx/zCxeX5pddQH2XH+EllHM/yVinANY4au5s1Khuai8wXII0WjDbO7r1BhvU/4yCZcfGJwdLSyRwArrA/tSYuBtPXHgtFohDU03H3BFQZGE0c= 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=NTj8zp+8; arc=none smtp.client-ip=74.125.82.181 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="NTj8zp+8" Received: by mail-dy1-f181.google.com with SMTP id 5a478bee46e88-2f0d3e07e30so8385916eec.0 for ; Sat, 09 May 2026 21:35:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1778387717; x=1778992517; 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=44Jpd/GKI4LUhFhEW7AvVW2vl/MUioKrwAeiH0GhW6Y=; b=NTj8zp+8Tw7yGoetkTj8AvRvs/J7OrWJypU9Wrp1m1WMPIWTh9eO6QjQ+UXSHzYG4w wSo4VCsXq2qDh0bJ/bu76P+eWSxyF41QaoC1aFYgU27lQ0T2hCNC6TRIqGM7QtI2ZEXp lvYR4300KQvqVhg6Iar9yrsbRECwoluoiclEDoLbcdZdPveMwzNjjT5VJo/2oppoEy8w HVQMJgxqmcBUY1V7vqE2ZPJ6jORz2DaEacKdHccN9TFfpAYZ4QNxpCe2Hbvz4qBAj/lD tPtEY/e6kDkBN125JP6VufnQ+IPDGf/S73urqL3gpFpE6jbFBNpzjI3Eybrpzu4DPC8+ WkrA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1778387717; x=1778992517; 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=44Jpd/GKI4LUhFhEW7AvVW2vl/MUioKrwAeiH0GhW6Y=; b=gr7UcYnBTXfSngS6J9bJHW4IbdXVSMwRzTKahJW4FnksjjKq8r/4Y/J0qkNR9HhoVo Mj+A4fG8yMd1t5IZFAojCvCrqF6xWzgY5sFJ5mBJV0Jcpjh4lXqZ+m+7JVQCGukiTf+B vc0JL+6eEc5nQ7A5AWVlUwQqV6tRuQSCPZj1tTf82L8Jytdqwl1YXEMyaHw6mb5moAMf X/KG6Qvd/3xZiSulACyRmqN1c+zAfKhRqHTa0spj6PWNB3y48ZxBRkDEgYUM2vIQTwOP tSrLD5woSnBzwyzGm6ru6KN1I39X0vYU+vi5YVEL8iT8Qfk4Bcb4Fw9XFUzsin2Ik9cA RTVQ== X-Forwarded-Encrypted: i=1; AFNElJ/hpHrz2eJV2ykwB2N52UfwcGt9KxETcuyP0LYyGF5s3fnJuvkwjTfPw0SQPSyFunXTU48SGusedibU/SY=@vger.kernel.org X-Gm-Message-State: AOJu0YwJ20Yq0VmgGNfKz4L4cDz0Bw9Agkq9tHjaxq2h2XRf1NGtJOLA xttzdDyPGc4u9MT1kxP7jCef6Srgs2bINnfPPOmF37np8F/4B4xKRbHQ X-Gm-Gg: Acq92OHO2hxSXVy5h1fpnh9x/Ve0Anqumw40G6IRtHS4QDAN+EroOhGewE0WlNTnu4+ 1KcOtIkyFUEibMPJ9hhRCymw8JfHJg87AY11sVDLWlrZojif0qHCC7hwDdiTDbxRcj7Htl9PbsV bpvv6SElpxAh223/h6yrMv9x4SfkHclcYuqLQKm8G7D8bqA3KbPelL7ZVwhTfsXDzcPQ2BT+16m 4SJJmtXgiBwL2T8lHs0p2O09kcNKhIZFmiURuyLLa8cjEO6l47EGIWeN7HvJASJ4f62P/6p/XdO 22IPkcxFS0PLTYWJtDvCNhQLG0tr6t11F2isg3IVuLRUIjr2CAHdGEtd7AlNI2DhSOhRg7bPGbp Gtkj3nPofOmESZXlh/cso+ZhpqnRHDT2Uwab11d+FdC20pXgJLesw2clhPkBKurTNOxdmX4VbcB ibj/7IyXJoEKvUArRgqaOxMjFwtA2Li0bQNv3WvFB8YWl4GcZ/sTLuguhngjVtanuQMfWFzcZ8R oUG+NF3smTosHg= X-Received: by 2002:a05:7301:5792:b0:2e6:e504:5435 with SMTP id 5a478bee46e88-2f5493978dcmr10081543eec.12.1778387716469; Sat, 09 May 2026 21:35:16 -0700 (PDT) Received: from lappy (108-228-232-20.lightspeed.sndgca.sbcglobal.net. [108.228.232.20]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2f88885be8esm8667953eec.22.2026.05.09.21.35.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 May 2026 21:35:16 -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 1/4] HID: hid-msi-claw: Add MSI Claw configuration driver Date: Sun, 10 May 2026 04:35:07 +0000 Message-ID: <20260510043510.442807-2-derekjohn.clark@gmail.com> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20260510043510.442807-1-derekjohn.clark@gmail.com> References: <20260510043510.442807-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 --- MAINTAINERS | 6 + drivers/hid/Kconfig | 12 + drivers/hid/Makefile | 1 + drivers/hid/hid-ids.h | 6 + drivers/hid/hid-msi-claw.c | 538 +++++++++++++++++++++++++++++++++++++ 5 files changed, 563 insertions(+) create mode 100644 drivers/hid/hid-msi-claw.c diff --git a/MAINTAINERS b/MAINTAINERS index 6f6517bf4f97..5de5e62d9c92 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 CLAW HID DRIVER +M: Derek J. Clark +L: linux-input@vger.kernel.org +S: Maintained +F: drivers/hid/hid-msi-claw.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 10c12d8e6557..0cbe10ad6367 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_CLAW + 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-claw. + config HID_KEYTOUCH tristate "Keytouch HID devices" help diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile index 07dfdb6a49c5..c1dea89f1e87 100644 --- a/drivers/hid/Makefile +++ b/drivers/hid/Makefile @@ -62,6 +62,7 @@ obj-$(CONFIG_HID_GOOGLE_HAMMER) +=3D hid-google-hammer.o obj-$(CONFIG_HID_GOOGLE_STADIA_FF) +=3D hid-google-stadiaff.o obj-$(CONFIG_HID_VIVALDI) +=3D hid-vivaldi.o obj-$(CONFIG_HID_GT683R) +=3D hid-gt683r.o +obj-$(CONFIG_HID_MSI_CLAW) +=3D hid-msi-claw.o obj-$(CONFIG_HID_GYRATION) +=3D hid-gyration.o obj-$(CONFIG_HID_HOLTEK) +=3D hid-holtek-kbd.o obj-$(CONFIG_HID_HOLTEK) +=3D hid-holtek-mouse.o diff --git a/drivers/hid/hid-ids.h b/drivers/hid/hid-ids.h index 933b7943bdb5..6d0d34806931 100644 --- a/drivers/hid/hid-ids.h +++ b/drivers/hid/hid-ids.h @@ -1047,7 +1047,13 @@ #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-claw.c b/drivers/hid/hid-msi-claw.c new file mode 100644 index 000000000000..7a3cd940ec49 --- /dev/null +++ b/drivers/hid/hid-msi-claw.c @@ -0,0 +1,538 @@ +// 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 "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_COMBO, + CLAW_MKEY_FUNCTION_DISABLED, +}; + +static const char * const claw_mkeys_function_text[] =3D { + [CLAW_MKEY_FUNCTION_MACRO] =3D "macro", + [CLAW_MKEY_FUNCTION_COMBO] =3D "combination", + [CLAW_MKEY_FUNCTION_DISABLED] =3D "disabled", +}; + +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 cfg_mutex; /* mutex for synchronous data */ + int endpoint; + + /* Gamepad Variables */ + enum claw_mkeys_function_index mkeys_function; + enum claw_gamepad_mode_index gamepad_mode; +}; + +static int get_endpoint_address(struct hid_device *hdev) +{ + struct usb_interface *intf =3D to_usb_interface(hdev->dev.parent); + struct usb_host_endpoint *ep; + + 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) || + 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 hid_device *hdev, struct hid_report *repo= rt, + u8 *data, int size) +{ + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + struct claw_command_report *cmd_rep; + int ret =3D 0; + + if (size !=3D CLAW_PACKET_SIZE) + return 0; + + if (drvdata->endpoint !=3D CLAW_XINPUT_CFG_INTF_IN && + drvdata->endpoint !=3D CLAW_DINPUT_CFG_INTF_IN) + 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(&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(&hdev->dev, "Unknown command: %x\n", cmd_rep->cmd); + return 0; + } + + complete(&drvdata->send_cmd_complete); + return ret; +} + +static int mcu_property_out(struct hid_device *hdev, u8 index, u8 *data, + 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); + + /* Don't hold a mutex when timeout=3D0, those commands cause USB disconne= ct */ + if (timeout) { + guard(mutex)(&drvdata->cfg_mutex); + 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); + u8 data[2] =3D { 0x00, drvdata->mkeys_function }; + int i, ret =3D -EINVAL; + + 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; + + data[0] =3D ret; + + ret =3D mcu_property_out(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; + + ret =3D mcu_property_out(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); + u8 data[2] =3D { drvdata->gamepad_mode, 0x00 }; + int i, ret =3D -EINVAL; + + 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; + + data[1] =3D ret; + + ret =3D mcu_property_out(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; + + ret =3D mcu_property_out(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 mcu_property_out(hdev, CLAW_COMMAND_TYPE_RESET_DEVICE, NULL, 0, 0= ); + if (ret < 0) + 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 claw_remove(struct hid_device *hdev); + +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 mcu_property_out(drvdata->hdev, CLAW_COMMAND_TYPE_READ_GAMEPAD_MO= DE, NULL, 0, 8); + if (ret) { + dev_err(&drvdata->hdev->dev, + "Failed to setup device, can't read gamepad mode: %d\n", ret); + claw_remove(drvdata->hdev); + } + + /* Add sysfs attributes after we get the device state */ + ret =3D sysfs_create_group(&drvdata->hdev->dev.kobj, &claw_gamepad_attr_g= roup); + if (ret) { + dev_err(&drvdata->hdev->dev, + "Failed to setup device, can't create gamepad attrs: %d\n", ret); + claw_remove(drvdata->hdev); + } + + 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 mcu_property_out(drvdata->hdev, CLAW_COMMAND_TYPE_SWITCH_MODE, da= ta, + 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, const struct hid_device_id = *id) +{ + struct claw_drvdata *drvdata; + struct usb_interface *intf; + struct usb_device *udev; + int ret; + + if (!hid_is_usb(hdev)) { + ret =3D -ENODEV; + goto err_probe; + } + + intf =3D to_usb_interface(hdev->dev.parent); + udev =3D interface_to_usbdev(intf); + drvdata =3D devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL); + if (!drvdata) { + ret =3D -ENOMEM; + goto err_probe; + } + + mutex_init(&drvdata->cfg_mutex); + + hid_set_drvdata(hdev, drvdata); + drvdata->hdev =3D hdev; + + 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. */ + drvdata->endpoint =3D get_endpoint_address(hdev); + if (drvdata->endpoint !=3D CLAW_XINPUT_CFG_INTF_IN && + drvdata->endpoint !=3D CLAW_DINPUT_CFG_INTF_IN) + return 0; + + /* For control interface: open the HID transport for sending commands. */ + ret =3D hid_hw_open(hdev); + if (ret) + goto err_stop_hw; + + init_completion(&drvdata->send_cmd_complete); + + INIT_DELAYED_WORK(&drvdata->cfg_resume, &cfg_resume_fn); + INIT_DELAYED_WORK(&drvdata->cfg_setup, &cfg_setup_fn); + schedule_delayed_work(&drvdata->cfg_setup, msecs_to_jiffies(500)); + + return 0; + +err_stop_hw: + hid_hw_stop(hdev); +err_probe: + return dev_err_probe(&hdev->dev, ret, "Failed to init configuration devic= e\n"); +} + +static void claw_remove(struct hid_device *hdev) +{ + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + + if (!drvdata) + return; + + if (drvdata->endpoint =3D=3D CLAW_XINPUT_CFG_INTF_IN || + drvdata->endpoint =3D=3D CLAW_DINPUT_CFG_INTF_IN) { + sysfs_remove_group(&hdev->dev.kobj, &claw_gamepad_attr_group); + cancel_delayed_work_sync(&drvdata->cfg_setup); + cancel_delayed_work_sync(&drvdata->cfg_resume); + hid_hw_close(hdev); + } + + hid_hw_stop(hdev); +} + +static int claw_resume(struct hid_device *hdev) +{ + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + + /* MCU can take up to 500ms to be ready after resume */ + schedule_delayed_work(&drvdata->cfg_resume, msecs_to_jiffies(500)); + + return 0; +} + +static const struct hid_device_id claw_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, claw_devices); + +static struct hid_driver claw_driver =3D { + .name =3D "hid-msi-claw", + .id_table =3D claw_devices, + .raw_event =3D claw_raw_event, + .probe =3D claw_probe, + .remove =3D claw_remove, + .resume =3D claw_resume, +}; +module_hid_driver(claw_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 Sat May 30 08:43:32 2026 Received: from mail-dy1-f179.google.com (mail-dy1-f179.google.com [74.125.82.179]) (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 2274F2BDC0F for ; Sun, 10 May 2026 04:35:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778387720; cv=none; b=DqHv9gXUbCsJVYYYx0rX+K5EvAFk6yQ75quvrC+qfztDTEuFkdgDX37idltfO9jeAs6DEzhMZPBpHD54li9mMvyFtytUa/eJR/a+nbX1eGN7+hgj5Xen8UI2qeOozzqR6QB0oQwKnfEnd6RccBuvPwoXb6GF9v8oH23gtctGxjA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778387720; c=relaxed/simple; bh=B4eqyK2/ses2fm5iQ42pZaV2HPhinkuINfSbH4LJX6A=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=CLGYl8DccvlWyPvoKLo8I1rKqEuYs5Z3DAARwmOjozlp++Yz46KgBrFha12CS8QAFG8F8Jnjinzolz/h2+/jgOnLW9WpP19dOR664LcByGUIRGUgsnBLmo0wJ4a63VFrrMfw6fp0PY7x+Qh6/cnzPDqAtonMbJOsZMJ3wtBpdvY= 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=ZvtKvMX8; arc=none smtp.client-ip=74.125.82.179 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="ZvtKvMX8" Received: by mail-dy1-f179.google.com with SMTP id 5a478bee46e88-2f68f3b075fso3375465eec.0 for ; Sat, 09 May 2026 21:35:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1778387717; x=1778992517; 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=9Kvspb//2uPVBOq8cvbVC9IwVr42DLgYuGn/9uOI75E=; b=ZvtKvMX8AdmMVN5UvLFq3I1ZsdLBXQUd+gXTcnOjffBtVRMgshfP0X2sb1kGV7L4Uy dXoOguNcjtNr+Ckxp79vr1n7d0HSmj0j50meJuAZLhVmJAq6t+aaLErQTrVGwCZRtpB6 Ah0OtLbGHHhlG8xvMZ6c9vYcqSp9+4DVDR2fxKckdfyqGdMOewAf3QakHKp1Ycs0avgu vt5CK0qysKfJOkC5d0+M1FfD5QOWuVjf1y2RfTfNF74xr+REHUMSeDzydg7eEd08SerW TYKxQdkHFZouRgj4LV6notmPiwnblYuXQSnIzQE0G66bQTyqjLUdgsbL4Ol7zXQUrhT8 1MvA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1778387717; x=1778992517; 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=9Kvspb//2uPVBOq8cvbVC9IwVr42DLgYuGn/9uOI75E=; b=PWFWzG3WbbHobyeJffJx+wLB3+scu3PD9l+0Sx2GSnIk0smJl50pdBDH+mkqQjkanH C9FBK64cAv7Eh6WEMCHkiLe4hpPcbdhVTSEtW0XpXe8H7sg/KV5CUcLuT3q/GqnDfKIj JyO2RbWKlwee+rvMAqweaGPxXqTK9ReFXPbnK/7yMAacubTPHzvhbrrQJzmoU/pT0zM+ 7vT5NZjYsHpOQpivWRxX/W71cGWUNr0OA81IVRm9BbnXjJRNHYtoqTCYDsOuGNQsQViF Iai9PRs6CDGAzTI/f2O0YKZai6sq0R8E0P+JF45xhEP4fHjQ2yNrY2Izwc/b6r47tJQp KU1g== X-Forwarded-Encrypted: i=1; AFNElJ805c+3dxT0V1kWcYr7X1bHbjiA0rQ9/x0OS9rEexWJBAxN8wBg6Hqhj+2jYmw6tsIj4llNapWcnZYDlBA=@vger.kernel.org X-Gm-Message-State: AOJu0Ywka0n9G0ncDBLW0kwFWifubTxkVwb7BdQp/yl/iuGhhI0l8DTB oL71CA1Qq+O05XJ9/uGj1/NJs0gaIxOr+dCE+e2jVeBZ45p4WatfoXGN X-Gm-Gg: Acq92OGGLxjDZNGsifHk9U5omTif6XkRBily3vAOP4ShzZoHE6OQHWYK74hWSJ7j8I2 PRJ3P6surATLirO9MF7I7Na93aueKlX3BVEjv6vuXJwyOzKgbEdUfM9pwo2cox2hyMMl3RIKYL/ TKTNyzKos4/HioJy8HLPbuCSV5pq4wxOfuRvWGcxibpep2ilO5iKVMRMjALHD9IZpBG6ZnE7pEH eYeVYK5Wn8DKerMd4BRmHI74WitKWCgjz9F9u16rGbzVahew49orP8LCCpFyE0s6EjcYWEQoa5p E2ach2/pAtRYiyaASbwTp8sqb01x4Q9Hswq/pdi4C8rgERNHK8ZOuTTxpuBisvTMBJ1Xnzt0yTR HfOxtXoltbuNpm3aqe+cT/G/zhEKgTwl7sVGwT5RVWLVCOZlbjLKP1EXke5cTWJJaVwo3sUjszV ezocbcCxS73zRpIc71WP1IqP6tjxuccpAusqpVQ71cCNW+6Yc6hG9m8+xvKJ3V7raVLFUAcEkVO myo X-Received: by 2002:a05:7301:2b07:b0:2ea:3370:6e51 with SMTP id 5a478bee46e88-2f85bb7309bmr4380757eec.4.1778387717322; Sat, 09 May 2026 21:35:17 -0700 (PDT) Received: from lappy (108-228-232-20.lightspeed.sndgca.sbcglobal.net. [108.228.232.20]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2f88885be8esm8667953eec.22.2026.05.09.21.35.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 May 2026 21:35:17 -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 2/4] HID: hid-msi-claw: Add M-key mapping attributes Date: Sun, 10 May 2026 04:35:08 +0000 Message-ID: <20260510043510.442807-3-derekjohn.clark@gmail.com> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20260510043510.442807-1-derekjohn.clark@gmail.com> References: <20260510043510.442807-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 --- drivers/hid/hid-msi-claw.c | 390 ++++++++++++++++++++++++++++++++++++- 1 file changed, 389 insertions(+), 1 deletion(-) diff --git a/drivers/hid/hid-msi-claw.c b/drivers/hid/hid-msi-claw.c index 7a3cd940ec49..60694d075d56 100644 --- a/drivers/hid/hid-msi-claw.c +++ b/drivers/hid/hid-msi-claw.c @@ -40,6 +40,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, @@ -64,6 +66,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_COMBO, @@ -76,6 +89,154 @@ static const char * const claw_mkeys_function_text[] = =3D { [CLAW_MKEY_FUNCTION_DISABLED] =3D "disabled", }; =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" }, +}; + +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]; @@ -86,16 +247,22 @@ 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 hid_device *hdev; struct mutex cfg_mutex; /* mutex for synchronous data */ + u16 bcd_device; int endpoint; =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]; + const u16 *bmap_addr; + bool bmap_support; }; =20 static int get_endpoint_address(struct hid_device *hdev) @@ -123,6 +290,31 @@ 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; + /* Extract key codes; replace disabled (0xff) with 0x00, which is (null)= in _show */ + for (i =3D 0; i < CLAW_KEYS_MAX; i++) + codes[i] =3D (cmd_rep->data[6 + i] !=3D 0xff) ? cmd_rep->data[6 + i] : = 0x00; + break; + default: + dev_warn(&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 hid_device *hdev, struct hid_report *repo= rt, u8 *data, int size) { @@ -149,6 +341,9 @@ static int claw_raw_event(struct hid_device *hdev, stru= ct hid_report *report, 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: @@ -356,6 +551,157 @@ 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; + + 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; +} + +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 }; + size_t len =3D ARRAY_SIZE(data); + int ret, key_count, i; + char **raw_keys; + + raw_keys =3D argv_split(GFP_KERNEL, buf, &key_count); + if (!raw_keys) + return -ENOMEM; + + if (key_count > CLAW_KEYS_MAX) { + ret =3D -EINVAL; + goto err_free; + } + + 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) + goto err_free; + + data[6 + i] =3D ret; + } + +set_buttons: + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_WRITE_PROFILE_DATA, data= , len, 8); + if (ret < 0) + goto err_free; + + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_SYNC_TO_ROM, NULL, 0, 0); + +err_free: + argv_free(raw_keys); + 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; + drvdata->profile_pending =3D (m_key =3D=3D CLAW_KEY_M1) ? CLAW_M1_PENDING= : CLAW_M2_PENDING; + + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_READ_PROFILE, data, len,= 8); + if (ret) + 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) { @@ -368,10 +714,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, @@ -424,6 +782,29 @@ 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; + } + + drvdata->bmap_support =3D false; +} + static int claw_probe(struct hid_device *hdev, const struct hid_device_id = *id) { struct claw_drvdata *drvdata; @@ -470,6 +851,13 @@ static int claw_probe(struct hid_device *hdev, const s= truct hid_device_id *id) if (ret) goto err_stop_hw; =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_warn(&hdev->dev, "M-Key mapping is not supported. Update firmware to= enable.\n"); + init_completion(&drvdata->send_cmd_complete); =20 INIT_DELAYED_WORK(&drvdata->cfg_resume, &cfg_resume_fn); --=20 2.53.0 From nobody Sat May 30 08:43:32 2026 Received: from mail-dy1-f174.google.com (mail-dy1-f174.google.com [74.125.82.174]) (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 24C712C0299 for ; Sun, 10 May 2026 04:35:19 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.174 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778387721; cv=none; b=H9TOgRPj052bvb5to8PcAHcRjwQCi8irmbAzBus3BDss6EV0AxLXi9pWA9jSQRTfi36hvhed/fdcAOlR41PC0dTvE5pnzOmhjJY+JN3zSYs7VzcTFnrR34oMxPWe8qr2YxUYhbbNu50lIz3VzHmKUIhoYJDkryY9DTl8W9uMtIY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778387721; c=relaxed/simple; bh=d3jSGPOBaWc4UIC9sfI5W44LvBygx5/+tFvoKgA9SJ4=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=kFWxyjAO3xJWPQsYXwv/pUP5KO+iVNLi/ndOrhTT4j0Md1WVQsqi22x+5lDeagPEQfn0g8Lqh/92yAoh+eGRyxb42qdP8xBdDAqJPXBS0oKQ6eNVICpYm4pg1nM3RRtZhlxTgU7L8ZhT0waOOaExC9KNSFMCWsFWBZ13lr7jclI= 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=QKBfgit0; arc=none smtp.client-ip=74.125.82.174 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="QKBfgit0" Received: by mail-dy1-f174.google.com with SMTP id 5a478bee46e88-2bdcf5970cdso2351301eec.0 for ; Sat, 09 May 2026 21:35:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1778387718; x=1778992518; 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=2FiuvqqOksN6dfl3g7NjkZEHTTgF2ns2opUTPjbkspo=; b=QKBfgit0aWZ1eg/84csc3im2vOhWF1PYGVJArKVSD/F1voMSgSRtKjAyhNiQEtr1PH oY8g6AsSc6op4sChHjgF/micMBL29MBhUt3n7834qUvV5owcYlY1uEeh6b/Sd1z+CMDD pdWDCB+cKsn/UTEOj2ytL+RMXglGfakc0WY9wQ6PcnRSn2yts0KP6Mn/1nDF1cZ57UV7 MMcehJ6A8BGj8LV7kBceodmJeE9S39UnQXTG4hp4DJ2MXAhRjapq5GhnEgPT7V5MVLFT fh7CQNJ3VLcdMTp/arHpu4OOvxaNhpkreu7Wy3luyYYFmMPj3g9UXqu6FXl7ouKeP9D1 KikA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1778387718; x=1778992518; 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=2FiuvqqOksN6dfl3g7NjkZEHTTgF2ns2opUTPjbkspo=; b=adJMTmgonCqVudIS+8Eyc+3eaIfKPDhN5RqL1wS341DJuBAg3X3N7jxhosNv2XZ/9U hb4kQVWHeauZ9Gp4ZWP/+LbbgI7FQsi4J0nosMApEl7Fi/TUtMA5Wch3GGS8sU5i8viz uaqF+Q9v3TSudeftFvzJDSghFbpIq/THZwc1/DMh8XIqygFgeODuP7sCrhF+6/w+0xFc Ftzjg8SHtFAtZ3Hg/kws1rUsmQ1jUOGBgNFGJ2a0d1E7dCAjVExs7GWHVWLRcfT/1vzb HdAPZYRGHL2T+iWDuI6SJzxkApL1GzYj6sGYAmJ3bLslwiWDR1R3D+2xtB1d4EZwUAlX xVrg== X-Forwarded-Encrypted: i=1; AFNElJ/EC907w+SX6YkkRyL4tlnvrHtLuUlU2di6WcxPFDy45d7ADKGzscyQ/e/HeYevVwqiVvXRngJEpz89Ohs=@vger.kernel.org X-Gm-Message-State: AOJu0YzDwIN/j8vxaZ9mrPAO0KbZrIivmMT4LVkRTMrCXECD2sqxaQyr eEFwdd+tBlEibASUiFVSmZXZSFaqF7aibnj8wKUZ6yLUCYYZUayay2Fp X-Gm-Gg: Acq92OF1fOqUspuvdS5d2urS8hD3ZfipyZJXEO8a/6s3OB4AoGsSFHv9TYLWD+7JNOg mtm3vwbsdUsU3/xInHSMhu965w1jgs+JbUEmdXaW8NJLhlLkY5BejqTXnEEUDLjMMbRBKXy/ntW A3sI0POq7Gu1qW7GQcYOjxKBD+jB2Rg9Ym9XJ/M9CVOwFhCw7rZdy7PDzQN/7F30Mw3r026oSfi YFYKuVL5rAbTwKoHw44WL8nKMHOH9AGkOP05jb0qVNZuIz7AXP/RY+wjKNPctyKDhLUO4528dC+ mJ/XgCrHUIYDN2cXmUImacF+8PykVWjfvmOXtvt5WOW+MS3L31myEmRT76QJuRn4M5e94Aqrsxj 6sMV4sMNtPEUgJGuu2C4KBuJlyWEo6o+drLOCmmPvf1lmcvaoUq88VfBr4tHAAUVe1UN/DDiqlL 3S9DlEMUbtHgisiRXptuRGV6pAuYgD+KcQY8A/P/QB7+9pz8Kjm6oZM6yF9yTH2Otgzv/1eesHY wR6IqkXAjdQ/JE= X-Received: by 2002:a05:7300:2311:b0:2c6:67b6:3acc with SMTP id 5a478bee46e88-2f6e4562378mr5992938eec.15.1778387718089; Sat, 09 May 2026 21:35:18 -0700 (PDT) Received: from lappy (108-228-232-20.lightspeed.sndgca.sbcglobal.net. [108.228.232.20]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2f88885be8esm8667953eec.22.2026.05.09.21.35.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 May 2026 21:35:17 -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 3/4] HID: hid-msi-claw: Add RGB control interface Date: Sun, 10 May 2026 04:35:09 +0000 Message-ID: <20260510043510.442807-4-derekjohn.clark@gmail.com> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20260510043510.442807-1-derekjohn.clark@gmail.com> References: <20260510043510.442807-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 --- drivers/hid/hid-msi-claw.c | 533 ++++++++++++++++++++++++++++++++++++- 1 file changed, 530 insertions(+), 3 deletions(-) diff --git a/drivers/hid/hid-msi-claw.c b/drivers/hid/hid-msi-claw.c index 60694d075d56..f4fe74a784c2 100644 --- a/drivers/hid/hid-msi-claw.c +++ b/drivers/hid/hid-msi-claw.c @@ -21,6 +21,7 @@ #include #include #include +#include #include #include #include @@ -42,6 +43,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, @@ -70,6 +75,7 @@ enum claw_profile_ack_pending { CLAW_NO_PENDING, CLAW_M1_PENDING, CLAW_M2_PENDING, + CLAW_RGB_PENDING, }; =20 enum claw_key_index { @@ -227,6 +233,22 @@ static const struct { { 0xce, "REL_WHEEL_DOWN" }, }; =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 */ @@ -237,6 +259,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]; @@ -245,6 +270,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[9]; +}; + +struct rgb_report { + u8 profile; + __be16 read_addr; + u8 frame_bytes; + u8 padding; + u8 frame_count; + u8 state; + u8 speed; + u8 brightness; + struct rgb_frame zone_data; +} __packed; + struct claw_drvdata { /* MCU General Variables */ enum claw_profile_ack_pending profile_pending; @@ -263,6 +310,16 @@ struct claw_drvdata { u8 m2_codes[CLAW_KEYS_MAX]; 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; + u8 rgb_frame_count; + bool rgb_enabled; + u8 rgb_speed; + u16 rgb_addr; }; =20 static int get_endpoint_address(struct hid_device *hdev) @@ -292,7 +349,10 @@ 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; + struct rgb_report *frame; + u16 rgb_addr, read_addr; + u8 *codes, f_idx; + u16 frame_calc; int i; =20 switch (drvdata->profile_pending) { @@ -304,6 +364,39 @@ static int claw_profile_event(struct claw_drvdata *drv= data, struct claw_command_ for (i =3D 0; i < CLAW_KEYS_MAX; i++) codes[i] =3D (cmd_rep->data[6 + i] !=3D 0xff) ? cmd_rep->data[6 + i] : = 0x00; 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 > U8_MAX) { + dev_err(drvdata->led_mc.led_cdev.dev, "Got unsupported frame index: %x\= n", + frame_calc); + return -EINVAL; + } + f_idx =3D frame_calc; + + if (f_idx >=3D CLAW_RGB_MAX_FRAMES) { + dev_err(drvdata->led_mc.led_cdev.dev, "Got illegal frame index: %x\n", + f_idx); + return -EINVAL; + } + + /* Always treat the first frame as the truth for these constants */ + if (f_idx =3D=3D 0) { + drvdata->rgb_frame_count =3D frame->frame_count; + /* Invert device speed (20-0) to sysfs speed (0-20) */ + 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; + } + + memcpy(&drvdata->rgb_frames[f_idx], &frame->zone_data, + sizeof(struct rgb_frame)); + + break; default: dev_warn(&drvdata->hdev->dev, "Got profile event without changes pending from command:%x\n", @@ -743,6 +836,389 @@ 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 */ + 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 mcu_property_out(hdev, CLAW_COMMAND_TYPE_READ_PROFILE, data, len= , 8); + if (ret) + 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; + + /* Loop through (up to) 8 pages of RGB data */ + for (f =3D 0; f < drvdata->rgb_frame_count; f++) { + 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 mcu_property_out(drvdata->hdev, CLAW_COMMAND_TYPE_WRITE_PROFILE_= 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; + } + + return 0; +} + +/* 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, 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 }; + + 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 }; + + 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 frame; + + drvdata->rgb_frame_count =3D frame_count; + + for (frame =3D 0; frame < frame_count; frame++) + claw_frame_fill_solid(&drvdata->rgb_frames[frame], colors[frame]); + + 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 frame, zone; + + drvdata->rgb_frame_count =3D frame_count; + + for (frame =3D 0; frame < frame_count; frame++) { + for (zone =3D 0; zone < 4; zone++) { + drvdata->rgb_frames[frame].zone[zone] =3D colors[(zone + frame) % 4= ]; + drvdata->rgb_frames[frame].zone[zone + 4] =3D colors[(zone + frame) % 4= ]; + } + drvdata->rgb_frames[frame].zone[8] =3D colors[frame]; + } + + 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 frame, zone; + + drvdata->rgb_frame_count =3D frame_count; + + for (frame =3D 0; frame < frame_count; frame++) { + for (zone =3D 0; zone < 4; zone++) { + drvdata->rgb_frames[frame].zone[zone] =3D colors[(zone + frame) % 4= ]; + drvdata->rgb_frames[frame].zone[zone + 4] =3D colors[(zone - frame + 6)= % 4]; + } + drvdata->rgb_frames[frame].zone[8] =3D colors[frame]; + } + + return claw_write_rgb_state(drvdata); +} + +/* Apply current state to device */ +static int claw_apply_rgb_state(struct claw_drvdata *drvdata) +{ + static const struct rgb_zone off =3D { 0, 0, 0 }; + + if (!drvdata->rgb_enabled) { + drvdata->rgb_frame_count =3D 1; + claw_frame_fill_solid(&drvdata->rgb_frames[0], off); + return claw_write_rgb_state(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; + + 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 hid_device *hdev =3D to_hid_device(dev); + struct claw_drvdata *drvdata =3D hid_get_drvdata(hdev); + 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 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 claw_remove(struct hid_device *hdev); =20 static void cfg_setup_fn(struct work_struct *work) @@ -758,6 +1234,13 @@ static void cfg_setup_fn(struct work_struct *work) claw_remove(drvdata->hdev); } =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); + claw_remove(drvdata->hdev); + } + /* Add sysfs attributes after we get the device state */ ret =3D sysfs_create_group(&drvdata->hdev->dev.kobj, &claw_gamepad_attr_g= roup); if (ret) { @@ -766,7 +1249,15 @@ static void cfg_setup_fn(struct work_struct *work) claw_remove(drvdata->hdev); } =20 + ret =3D device_add_group(drvdata->led_mc.led_cdev.dev, &rgb_attr_group); + if (ret) { + dev_err(&drvdata->hdev->dev, + "Failed to setup device, can't create led attributes: %d\n", ret); + claw_remove(drvdata->hdev); + } + 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) @@ -776,6 +1267,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->led_mc.led_cdev.dev, "Failed to read RGB config: %d\n",= ret); + ret =3D mcu_property_out(drvdata->hdev, CLAW_COMMAND_TYPE_SWITCH_MODE, da= ta, ARRAY_SIZE(data), 0); if (ret) @@ -789,20 +1284,25 @@ 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; } =20 drvdata->bmap_support =3D false; + drvdata->rgb_addr =3D rgb_addr_old; } =20 static int claw_probe(struct hid_device *hdev, const struct hid_device_id = *id) @@ -860,12 +1360,36 @@ static int claw_probe(struct hid_device *hdev, const= struct hid_device_id *id) =20 init_completion(&drvdata->send_cmd_complete); =20 + /* Initialize RGB LED */ + INIT_DELAYED_WORK(&drvdata->rgb_queue, &claw_rgb_queue_fn); + + 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) { + ret =3D -ENOMEM; + goto err_close; + } + + drvdata->rgb_enabled =3D true; + + ret =3D devm_led_classdev_multicolor_register(&hdev->dev, &drvdata->led_m= c); + if (ret) + goto err_close; + INIT_DELAYED_WORK(&drvdata->cfg_resume, &cfg_resume_fn); INIT_DELAYED_WORK(&drvdata->cfg_setup, &cfg_setup_fn); schedule_delayed_work(&drvdata->cfg_setup, msecs_to_jiffies(500)); =20 return 0; =20 +err_close: + hid_hw_close(hdev); err_stop_hw: hid_hw_stop(hdev); err_probe: @@ -881,6 +1405,9 @@ static void claw_remove(struct hid_device *hdev) =20 if (drvdata->endpoint =3D=3D CLAW_XINPUT_CFG_INTF_IN || drvdata->endpoint =3D=3D CLAW_DINPUT_CFG_INTF_IN) { + /* Block writes to brightness/multi_intensity during teardown */ + drvdata->led_mc.led_cdev.brightness_set =3D NULL; + cancel_delayed_work_sync(&drvdata->rgb_queue); sysfs_remove_group(&hdev->dev.kobj, &claw_gamepad_attr_group); cancel_delayed_work_sync(&drvdata->cfg_setup); cancel_delayed_work_sync(&drvdata->cfg_resume); --=20 2.53.0 From nobody Sat May 30 08:43:32 2026 Received: from mail-dy1-f175.google.com (mail-dy1-f175.google.com [74.125.82.175]) (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 C66FD2D060D for ; Sun, 10 May 2026 04:35:19 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.175 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778387721; cv=none; b=cEzyC/fXeK6XW+0eSr8Lso+ccuNYpiqbN7VQIopZ+SJAexbBAnQDAh7FKhYb9eoNFYMT5D1+GcS1hPbrrG5BZ9L68GQcfM4VlIpYr6UJrGethgCRhuBlLm2tJ1Ifb9PaWVIIKXnCvqa3WX26lA09+GOwJS9CV5D9NWw/q8ddmmM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1778387721; c=relaxed/simple; bh=FAOkFs8X/R5/5IEnqSvNpaSToQ1zQw0+Tg6WMsit6LU=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=PQ887ssYaxeARDgPlL/ajNWf3/lVLfcRY6n0GgyZJofFZEqU4hOVNguNWD57q4ncanUdz2i4UlXL7CqRYqpkfWYIUWvxr794xdiZHHc3iNrq/SRfgRl+8hPw53bYYYgDzKZ085tRJEk2Gn+UX+DfzJ4wt8td0Zt9ALrE61P3O1M= 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=Xq219Q/D; arc=none smtp.client-ip=74.125.82.175 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="Xq219Q/D" Received: by mail-dy1-f175.google.com with SMTP id 5a478bee46e88-2f0d3e07e30so8385954eec.0 for ; Sat, 09 May 2026 21:35:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1778387719; x=1778992519; 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=/EGUJdZkAXTYXhJtuXt7hGQ/eEs1hEecVhStNhxjmFI=; b=Xq219Q/DLpuwrJlIQlszjgYKKFAiThqflisJUy/EpW+G6P3Nbkro5b8wz/SRxhhS5y 5cvNJx/RaottwaV6B5TzthRG3B+FvXp/Fa4rrQEnwI/7EsF+0dfrY65lhuE5thaxYl4W zzG5ogyZFoVqa5gIvYtjl8/M1Rn4maXCYZwD4RJn7emnVxL+DeIdAjH0EePGNiSE/cw+ tkI6zAAXGBpVwUwpgjwbAusIv8hcJwVIy/qVgIctJf6aZMQ1O7+GygJOK7Vbe/n5+i9U zb+KmCkuy5KayAQyrIe0nm/BqcsowhYKddi0v0/1P3pHZA2tarLfbCIvs1VO7y/g/HLP 8dsw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1778387719; x=1778992519; 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=/EGUJdZkAXTYXhJtuXt7hGQ/eEs1hEecVhStNhxjmFI=; b=i0qgrGNLRG4Sc7g/JoOR5UT4K9bR0V1LZTh4M9QJpMA8CN75XvAgtStqpMPD0Tm5LZ N0CFORNoKdsW6a3yyEEz+EhE+RTFfJwRgiDir2XyaMlxAXzEvBJbS++23yTbl0mif5NE 1f1wJQig/EcNLtiyEFlujBp/t1LUcm9jR0Vk/KaP8vnfA59K5HUWr13qqMsJM8HwqGDb HQGhkq6wMUuQ3kXZih7ESQSVstxbULaPDPKDZCQNinZQPjZucQWGny3RAwrkXj5ttTDP 1xp1qCgs4BYvfbBvg536SBvMQjXMKkqsZW1zE7PVM57xscv/idSLBbCUNzxGpt4sJI+l GPHQ== X-Forwarded-Encrypted: i=1; AFNElJ/3Rj2CHfsGaLHJuuDhPng4N6Hom0SdSMSe6o5P2o0aLAsDtDDo5EuVTYVP116ds2ESxvDJpBkqIFi7aw4=@vger.kernel.org X-Gm-Message-State: AOJu0YyHzz1PYF07CUKu0TlM4aQIBHl430zeupZjFWYbysvhlcCbFBvp WFO4GDKMxYOtMaDgmzJ+8PsSTDJC+fGMJUfeAhZ2sjpjhsOfd4WCsvz+C3lpKQ== X-Gm-Gg: Acq92OGN8DLWyswysnJXTomhDsxuaJr7l3e4fjFff4Cku5nukgEFEDAcvtAX4p5DWEM CCMhon9MCsQr2bLhtCORNBEpTvKGL77ERGw+3reDSxUZu/w3YhKsV8wreOUMJBkz7aM3SbL4CDq Aqw4Mzti6K1gWPQzdwAbin9W5MXlOZrZToN2z29blOF5arLytoidnorQ1EPm/dB9NqB7yTuj5N2 Es9qMOlbY1uPGRIWwZEn7avaFCCMm2yN0qZgKIfmMUguSFvY1kEIN0WBAlneqrmRdHdV20V+Kqn eJjtoZ3C/CtutmRyeYCYEcgtTT/w5maWkgrUfcBwJZsO71eWiefy+ncJZs6vE/T9MEcW94DTR4k wVvCuaTTV5ZbWrKaYshIJYCwyX5UJVW7/FO//1Vre2Qi5fLz2bDUGzsyu5tEqZH3pYpUiwHX2hY 4vDjyurYhIaqo2TYDdaq5rKaLWHxJ/lz7k0nD1/q+NB6zgcgb2rew9/YReJjUz73rel0QRSbdMN /9scDxkMQ9OpyQ= X-Received: by 2002:a05:693c:2c97:b0:2ed:e15:c926 with SMTP id 5a478bee46e88-2f54be949a5mr10343672eec.34.1778387718923; Sat, 09 May 2026 21:35:18 -0700 (PDT) Received: from lappy (108-228-232-20.lightspeed.sndgca.sbcglobal.net. [108.228.232.20]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-2f88885be8esm8667953eec.22.2026.05.09.21.35.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 May 2026 21:35:18 -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 4/4] HID: hid-msi-claw: Add Rumble Intensity Attributes Date: Sun, 10 May 2026 04:35:10 +0000 Message-ID: <20260510043510.442807-5-derekjohn.clark@gmail.com> X-Mailer: git-send-email 2.53.0 In-Reply-To: <20260510043510.442807-1-derekjohn.clark@gmail.com> References: <20260510043510.442807-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 --- drivers/hid/hid-msi-claw.c | 139 +++++++++++++++++++++++++++++++++++++ 1 file changed, 139 insertions(+) diff --git a/drivers/hid/hid-msi-claw.c b/drivers/hid/hid-msi-claw.c index f4fe74a784c2..6d089f49abdb 100644 --- a/drivers/hid/hid-msi-claw.c +++ b/drivers/hid/hid-msi-claw.c @@ -76,6 +76,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 { @@ -262,6 +264,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]; @@ -308,7 +315,10 @@ struct claw_drvdata { enum claw_gamepad_mode_index gamepad_mode; u8 m1_codes[CLAW_KEYS_MAX]; u8 m2_codes[CLAW_KEYS_MAX]; + u8 rumble_intensity_right; + u8 rumble_intensity_left; const u16 *bmap_addr; + bool rumble_support; bool bmap_support; =20 /* RGB Variables */ @@ -396,6 +406,12 @@ static int claw_profile_event(struct claw_drvdata *drv= data, struct claw_command_ memcpy(&drvdata->rgb_frames[f_idx], &frame->zone_data, sizeof(struct rgb_frame)); =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_warn(&drvdata->hdev->dev, @@ -795,6 +811,116 @@ 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; + + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_WRITE_PROFILE_DATA, + data, ARRAY_SIZE(data), 8); + if (ret) + return ret; + + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_SYNC_TO_ROM, NULL, 0, 0); + 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; + + drvdata->profile_pending =3D CLAW_RUMBLE_LEFT_PENDING; + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_READ_PROFILE, data, ARRA= Y_SIZE(data), 8); + if (ret) + 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; + + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_WRITE_PROFILE_DATA, + data, ARRAY_SIZE(data), 8); + if (ret) + return ret; + + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_SYNC_TO_ROM, NULL, 0, 0); + 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; + + drvdata->profile_pending =3D CLAW_RUMBLE_RIGHT_PENDING; + ret =3D mcu_property_out(hdev, CLAW_COMMAND_TYPE_READ_PROFILE, data, ARRA= Y_SIZE(data), 8); + if (ret) + 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) { @@ -815,6 +941,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; } @@ -828,6 +960,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 @@ -1286,9 +1421,11 @@ static void claw_features_supported(struct claw_drvd= ata *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; + drvdata->rumble_support =3D false; drvdata->rgb_addr =3D rgb_addr_old; } return; @@ -1297,11 +1434,13 @@ static void claw_features_supported(struct claw_drv= data *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 drvdata->bmap_support =3D false; + drvdata->rumble_support =3D false; drvdata->rgb_addr =3D rgb_addr_old; } =20 --=20 2.53.0