Re: [PATCH v3 18/18] HID: steelseries: Document sysfs ABI

[Bastien Nocera <hadess@hadess.net>]

On Fri, 2026-02-27 at 18:50 -0500, Sriman Achanta wrote:
> 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

This should probably be documented in the commit that introduces the
new attribute, rather than all of them being updated at once.

> 
> 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_con
> nected
> +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_enabl
> e
> +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