[PATCH 2/3] ABI: sysfs-platform: Document uevent ABI for reg-userspace-consumer

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Document the new uevent-based ABI provided by the userspace-consumer
regulator driver. These uevents expose regulator events such as OVER_CURRENT,
ENABLE, DISABLE, UNDER_VOLTAGE, and others to userspace.

Clearly describe the ABI entries and possible event values to ensure stable
and predictable userspace integration.

Signed-off-by: Johann Neuhauser <jneuhauser@xxxxxxxxxxxxxxxxxx>
---
Cc: Jonathan Corbet <corbet@xxxxxxx>
Cc: Liam Girdwood <lgirdwood@xxxxxxxxx>
Cc: linux-doc@xxxxxxxxxxxxxxx
Cc: linux-kernel@xxxxxxxxxxxxxxx
Cc: Mark Brown <broonie@xxxxxxxxxx>
---
 ...ysfs-platform-regulator-userspace-consumer | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-platform-regulator-userspace-consumer

diff --git a/Documentation/ABI/testing/sysfs-platform-regulator-userspace-consumer b/Documentation/ABI/testing/sysfs-platform-regulator-userspace-consumer
new file mode 100644
index 000000000000..2d518afb0d32
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-regulator-userspace-consumer
@@ -0,0 +1,23 @@
+What:		/devices/platform/<device>/uevent EVENT=
+Date:		April 2025
+Contact:	Johann Neuhauser <jneuhauser@xxxxxxxxxxxxxxxxxx>
+Description:
+		Reports regulator events via uevents for platform devices
+		controlled by the userspace-consumer regulator driver.
+		
+		Possible EVENT= values:
+		 - ABORT_DISABLE
+		 - ABORT_VOLTAGE_CHANGE
+		 - DISABLE
+		 - ENABLE
+		 - FAIL
+		 - FORCE_DISABLE
+		 - OVER_CURRENT
+		 - OVER_TEMP
+		 - PRE_DISABLE
+		 - PRE_VOLTAGE_CHANGE
+		 - REGULATION_OUT
+		 - UNDER_VOLTAGE
+		 - VOLTAGE_CHANGE
+
+Userspace can monitor these events using udev and respond accordingly.
-- 
2.39.5





[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux