public inbox for linux-input@vger.kernel.org
 help / color / mirror / Atom feed
From: Sriman Achanta <srimanachanta@gmail.com>
To: Jiri Kosina <jikos@kernel.org>, Benjamin Tissoires <bentiss@kernel.org>
Cc: linux-input@vger.kernel.org, linux-kernel@vger.kernel.org,
	Bastien Nocera <hadess@hadess.net>,
	Simon Wood <simon@mungewell.org>,
	Christian Mayer <git@mayer-bgk.de>,
	Sriman Achanta <srimanachanta@gmail.com>
Subject: [PATCH v3 18/18] HID: steelseries: Document sysfs ABI
Date: Fri, 27 Feb 2026 18:50:42 -0500	[thread overview]
Message-ID: <20260227235042.410062-19-srimanachanta@gmail.com> (raw)
In-Reply-To: <20260227235042.410062-1-srimanachanta@gmail.com>

Add Documentation/ABI/testing/sysfs-driver-hid-steelseries documenting
the sysfs attributes and LED class device exposed by the driver:

- bt_enabled, bt_device_connected: read-only Bluetooth radio state
- inactive_time: read/write auto-shutoff timer in minutes
- bt_auto_enable: read/write Bluetooth radio power-on behavior
- <dev>::micmute/brightness: mic mute LED brightness via LED class

Signed-off-by: Sriman Achanta <srimanachanta@gmail.com>
---
 .../ABI/testing/sysfs-driver-hid-steelseries  | 87 +++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-driver-hid-steelseries

diff --git a/Documentation/ABI/testing/sysfs-driver-hid-steelseries b/Documentation/ABI/testing/sysfs-driver-hid-steelseries
new file mode 100644
index 000000000000..7b8d29282ed6
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-hid-steelseries
@@ -0,0 +1,87 @@
+What:		/sys/bus/hid/drivers/steelseries/<dev>/bt_enabled
+Date:		February 2026
+KernelVersion:	6.20
+Contact:	Sriman Achanta <srimanachanta@gmail.com>
+Description:	(RO) Whether the Bluetooth radio on the headset is currently
+		enabled.
+
+		* 0 = Bluetooth radio off
+		* 1 = Bluetooth radio on
+
+		Returns -ENODEV if the headset is not connected to the
+		receiver.
+
+		Supported on: Arctis Nova 7 Gen2, Arctis Nova Pro Wireless
+
+What:		/sys/bus/hid/drivers/steelseries/<dev>/bt_device_connected
+Date:		February 2026
+KernelVersion:	6.20
+Contact:	Sriman Achanta <srimanachanta@gmail.com>
+Description:	(RO) Whether a Bluetooth device is currently connected to
+		the headset.
+
+		* 0 = no Bluetooth device connected
+		* 1 = Bluetooth device connected
+
+		Returns -ENODEV if the headset is not connected to the
+		receiver.
+
+		Supported on: Arctis Nova 7 Gen2, Arctis Nova Pro Wireless
+
+What:		/sys/bus/hid/drivers/steelseries/<dev>/inactive_time
+Date:		February 2026
+KernelVersion:	6.20
+Contact:	Sriman Achanta <srimanachanta@gmail.com>
+Description:	(RW) Auto-shutoff timer for the headset, in minutes. A
+		value of 0 disables the timer. The maximum accepted value
+		is device-specific.
+
+		The encoding sent to the firmware varies by device family:
+		the Arctis 9 converts the value to seconds, the Nova 3P
+		rounds down to its nearest supported discrete step, and the
+		Nova Pro maps to six firmware-defined level indices. For all
+		other devices the value is sent in minutes directly.
+
+		Reading the attribute returns the last value reported by the
+		firmware. Writing immediately sends the new timeout to the
+		device.
+
+		Returns -ENODEV if the headset is not connected to the
+		receiver.
+
+		Supported on: Arctis 1 Wireless, Arctis 7, Arctis 7+,
+		Arctis 9, Arctis Nova 3P, Arctis Nova 5, Arctis Nova 5X,
+		Arctis Nova 7, Arctis Nova 7P, Arctis Nova 7 Gen2,
+		Arctis Nova Pro Wireless
+
+What:		/sys/bus/hid/drivers/steelseries/<dev>/bt_auto_enable
+Date:		February 2026
+KernelVersion:	6.20
+Contact:	Sriman Achanta <srimanachanta@gmail.com>
+Description:	(RW) Whether the headset automatically enables its
+		Bluetooth radio on power-on.
+
+		* 0 = Bluetooth radio stays off at power-on
+		* 1 = Bluetooth radio activates automatically at power-on
+
+		Returns -ENODEV if the headset is not connected to the
+		receiver.
+
+		Supported on: Arctis Nova 7, Arctis Nova 7P,
+		Arctis Nova 7 Gen2
+
+What:		/sys/class/leds/<dev>::micmute/brightness
+Date:		February 2026
+KernelVersion:	6.20
+Contact:	Sriman Achanta <srimanachanta@gmail.com>
+Description:	(RW) Brightness of the microphone mute status LED.
+		<dev> is the HID device node name (e.g.
+		0003:1038:12AE.0001).
+
+		* 0 = off
+		* 1 = low
+		* 2 = medium
+		* 3 = high
+
+		Supported on: Arctis Nova 5, Arctis Nova 5X, Arctis Nova 7,
+		Arctis Nova 7P, Arctis Nova 7 Gen2
-- 
2.53.0


  parent reply	other threads:[~2026-02-27 23:51 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-27 23:50 [PATCH v3 00/18] HID: steelseries: Add support for Arctis headset lineup Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 01/18] HID: steelseries: Fix ARCTIS_1_X device mislabeling Sriman Achanta
2026-03-03 10:58   ` Bastien Nocera
2026-02-27 23:50 ` [PATCH v3 02/18] HID: hid-ids: Add SteelSeries Arctis headset device IDs Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 03/18] HID: quirks: Add additional " Sriman Achanta
2026-03-03 10:58   ` Bastien Nocera
2026-02-27 23:50 ` [PATCH v3 04/18] HID: steelseries: Add async support and unify device definitions Sriman Achanta
2026-03-03 10:58   ` Bastien Nocera
2026-02-27 23:50 ` [PATCH v3 05/18] HID: steelseries: Update Kconfig help text for expanded headset support Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 06/18] HID: steelseries: Add ALSA sound card infrastructure Sriman Achanta
2026-03-03 10:58   ` Bastien Nocera
2026-02-27 23:50 ` [PATCH v3 07/18] HID: steelseries: Add ChatMix ALSA mixer controls Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 08/18] HID: steelseries: Add mic mute ALSA mixer control Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 09/18] HID: steelseries: Add Bluetooth state sysfs attributes Sriman Achanta
2026-03-03 10:58   ` Bastien Nocera
2026-02-27 23:50 ` [PATCH v3 10/18] HID: steelseries: Add settings poll infrastructure Sriman Achanta
2026-03-03 10:58   ` Bastien Nocera
2026-02-27 23:50 ` [PATCH v3 11/18] HID: steelseries: Add sidetone ALSA mixer control Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 12/18] HID: steelseries: Add mic volume " Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 13/18] HID: steelseries: Add volume limiter " Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 14/18] HID: steelseries: Add Bluetooth call audio ducking control Sriman Achanta
2026-03-03 10:59   ` Bastien Nocera
2026-02-27 23:50 ` [PATCH v3 15/18] HID: steelseries: Add inactive time sysfs attribute Sriman Achanta
2026-03-03 10:59   ` Bastien Nocera
2026-02-27 23:50 ` [PATCH v3 16/18] HID: steelseries: Add Bluetooth auto-enable " Sriman Achanta
2026-02-27 23:50 ` [PATCH v3 17/18] HID: steelseries: Add mic mute LED brightness control Sriman Achanta
2026-02-27 23:50 ` Sriman Achanta [this message]
2026-03-03 10:58   ` [PATCH v3 18/18] HID: steelseries: Document sysfs ABI Bastien Nocera
2026-03-03 10:59 ` [PATCH v3 00/18] HID: steelseries: Add support for Arctis headset lineup Bastien Nocera

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260227235042.410062-19-srimanachanta@gmail.com \
    --to=srimanachanta@gmail.com \
    --cc=bentiss@kernel.org \
    --cc=git@mayer-bgk.de \
    --cc=hadess@hadess.net \
    --cc=jikos@kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=simon@mungewell.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox