From: "Derek J. Clark" <derekjohn.clark@gmail.com>
To: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
"Hans de Goede" <hansg@kernel.org>
Cc: Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
Alok Tiwari <alok.a.tiwari@oracle.com>,
David Box <david.e.box@linux.intel.com>,
"Derek J . Clark" <derekjohn.clark@gmail.com>,
platform-driver-x86@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-hwmon@vger.kernel.org,
linux-doc@vger.kernel.org
Subject: [PATCH v3 4/4] platform/x86: (ayn-ec) Add AYN EC Platform Documentation
Date: Sat, 26 Jul 2025 13:40:41 -0700 [thread overview]
Message-ID: <20250726204041.516440-5-derekjohn.clark@gmail.com> (raw)
In-Reply-To: <20250726204041.516440-1-derekjohn.clark@gmail.com>
Adds ABI documentation for the ayn-ec platform driver
Signed-off-by: Derek J. Clark <derekjohn.clark@gmail.com>
---
.../ABI/testing/sysfs-platform-ayn-ec | 59 +++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 60 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-platform-ayn-ec
diff --git a/Documentation/ABI/testing/sysfs-platform-ayn-ec b/Documentation/ABI/testing/sysfs-platform-ayn-ec
new file mode 100644
index 000000000000..32cb6f7ca2fc
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-ayn-ec
@@ -0,0 +1,59 @@
+What: /sys/class/hwmon/hwmon[0-9]/pwm1_enable
+Date: July 2025
+KernelVersion: 6.17
+Contact: "Derek J. Clark" <derekjohn.clark@gmail.com>
+Description:
+ This sets the PWM fan mode of operation. Valid values are [0-3].
+ Values [0-2] conform with standard hwmon operating modes. Value 3
+ enables user defined fan curve settings.
+
+ Applies to AYN Loki and Tectoy Zeenix lines of handheld devices.
+
+What: /sys/class/hwmon/hwmon[0-9]/pwm1_auto_point[1-5]_pwm
+Date: July 2025
+KernelVersion: 6.17
+Contact: "Derek J. Clark" <derekjohn.clark@gmail.com>
+Description:
+ This sets the PWM fan duty cycle for the given index of the fan curve.
+ When the temperature reaches the corresponding pwm1_auto_point[1-5]_temp,
+ the EC will automatically increase the fan duty cycle to the given value.
+
+ Values are [0-255]
+
+ Applies to AYN Loki and Tectoy Zeenix lines of handheld devices.
+
+What: /sys/class/hwmon/hwmon[0-9]/pwm1_auto_point[1-5]_temp
+Date: July 2025
+KernelVersion: 6.17
+Contact: "Derek J. Clark" <derekjohn.clark@gmail.com>
+Description:
+ This sets the activation temperature for the given index of the fan curve.
+ When the temperature reaches the given value, the EC will automatically
+ increase the fan duty cycle to the corresponding pwm1_auto_point[1-5]_pwm
+ value.
+
+ Values are [0-100]
+
+ Applies to AYN Loki and Tectoy Zeenix lines of handheld devices.
+
+What: /sys/class/leds/ayn:rgb:joystick_rings/effect
+Date: July 2025
+KernelVersion: 6.17
+Contact: "Derek J. Clark" <derekjohn.clark@gmail.com>
+Description:
+ This controls the display effect of the RGB interface.
+
+ Values are monocolor or breathe.
+
+ Applies to AYN Loki and Tectoy Zeenix lines of handheld devices.
+
+What: /sys/class/leds/ayn:rgb:joystick_rings/effect_index
+Date: July 2025
+KernelVersion: 6.17
+Contact: "Derek J. Clark" <derekjohn.clark@gmail.com>
+Description:
+ This displays the available options for the effect attribute.
+
+ Values are monocolor or breathe.
+
+ Applies to AYN Loki and Tectoy Zeenix lines of handheld devices.
diff --git a/MAINTAINERS b/MAINTAINERS
index 5b816883fe7d..199bebbffa0d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4039,6 +4039,7 @@ AYN PLATFORM EC DRIVER
M: Derek J. Clark <derekjohn.clark@gmail.com>
L: platform-driver-x86@vger.kernel.org
S: Maintained
+F: Documentation/ABI/testing/sysfs-platform-ayn-ec
F: drivers/platform/x86/ayn-ec.c
AZ6007 DVB DRIVER
--
2.50.1
next prev parent reply other threads:[~2025-07-26 20:40 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-26 20:40 [PATCH v3 0/4] Add AYN EC Platform Driver Derek J. Clark
2025-07-26 20:40 ` [PATCH v3 1/4] platform/x86: (ayn-ec) Add PWM Fan HWMON Interface Derek J. Clark
2025-07-26 23:32 ` Armin Wolf
2025-07-29 2:58 ` Derek John Clark
2025-07-29 4:09 ` Armin Wolf
2025-08-10 22:27 ` Derek John Clark
2025-08-11 8:38 ` Armin Wolf
2025-07-28 16:31 ` kernel test robot
2025-07-29 3:39 ` Randy Dunlap
2025-07-28 21:34 ` kernel test robot
2025-07-26 20:40 ` [PATCH v3 2/4] platform/x86: (ayn-ec) Add Temperature Sensors Derek J. Clark
2025-07-26 23:37 ` Armin Wolf
2025-07-29 3:02 ` Derek John Clark
2025-07-26 20:40 ` [PATCH v3 3/4] platform/x86: (ayn-ec) Add RGB Interface Derek J. Clark
2025-07-26 23:58 ` Armin Wolf
2025-07-29 3:25 ` Derek John Clark
2025-07-29 4:18 ` Armin Wolf
2025-07-28 23:36 ` kernel test robot
2025-07-26 20:40 ` Derek J. Clark [this message]
2025-07-27 0:03 ` [PATCH v3 4/4] platform/x86: (ayn-ec) Add AYN EC Platform Documentation Armin Wolf
2025-07-29 3:26 ` Derek John Clark
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=20250726204041.516440-5-derekjohn.clark@gmail.com \
--to=derekjohn.clark@gmail.com \
--cc=alok.a.tiwari@oracle.com \
--cc=david.e.box@linux.intel.com \
--cc=hansg@kernel.org \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=platform-driver-x86@vger.kernel.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;
as well as URLs for NNTP newsgroup(s).