This commit adds ABI documentation for the UFS hwmon driver, detailing
the sysfs attributes exposed by the driver. It includes the missing
temperature notification entries, that were added back in 2021.

The following sysfs attributes are documented:
- /sys/class/hwmon/hwmon*/temp*_input
- /sys/class/hwmon/hwmon*/temp*_crit
- /sys/class/hwmon/hwmon*/temp*_lcrit
- /sys/class/hwmon/hwmon*/temp*_enable

While at it, update a missing reference to the ufs ABI doc in the
MAINTAINERS file.

Fixes: e88e2d32200a ("scsi: ufs: core: Probe for temperature notification support")
Signed-off-by: Avri Altman <avri.altman@wdc.com>
---
 .../ABI/testing/sysfs-driver-ufs-hwmon        | 31 +++++++++++++++++++
 MAINTAINERS                                   |  2 ++
 2 files changed, 33 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-driver-ufs-hwmon

diff --git a/Documentation/ABI/testing/sysfs-driver-ufs-hwmon b/Documentation/ABI/testing/sysfs-driver-ufs-hwmon
new file mode 100644
index 000000000000..a27a108ffd28
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-ufs-hwmon
@@ -0,0 +1,31 @@
+What:		/sys/class/hwmon/hwmon*/temp*_input
+Date:		September 2021
+KernelVersion:	5.16
+Contact:	avri.altman@wdc.com
+Description:
+		Temperature input value in millidegrees Celsius.
+		Read-only.
+
+What:		/sys/class/hwmon/hwmon*/temp*_crit
+Date:		September 2021
+KernelVersion:	5.16
+Contact:	avri.altman@wdc.com
+Description:
+		Critical temperature value in millidegrees Celsius.
+		Read-only.
+
+What:		/sys/class/hwmon/hwmon*/temp*_lcrit
+Date:		September 2021
+KernelVersion:	5.16
+Contact:	avri.altman@wdc.com
+Description:
+		Lower critical temperature value in millidegrees Celsius.
+		Read-only.
+
+What:		/sys/class/hwmon/hwmon*/temp*_enable
+Date:		September 2021
+KernelVersion:	5.16
+Contact:	avri.altman@wdc.com
+Description:
+		Enable (1) or disable (0) this temperature sensor.
+		Read-write.
diff --git a/MAINTAINERS b/MAINTAINERS
index 838d3038e1ea..71a69551aee2 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -24070,6 +24070,8 @@ R:	Avri Altman <avri.altman@wdc.com>
 R:	Bart Van Assche <bvanassche@acm.org>
 L:	linux-scsi@vger.kernel.org
 S:	Supported
+F:	Documentation/ABI/testing/sysfs-driver-ufs
+F:	Documentation/ABI/testing/sysfs-driver-ufs-hwmon
 F:	Documentation/devicetree/bindings/ufs/
 F:	Documentation/scsi/ufs.rst
 F:	drivers/ufs/core/
-- 
2.25.1

On 1/14/25 01:35, Avri Altman wrote:
> This commit adds ABI documentation for the UFS hwmon driver, detailing
> the sysfs attributes exposed by the driver. It includes the missing
> temperature notification entries, that were added back in 2021.
> 
> The following sysfs attributes are documented:
> - /sys/class/hwmon/hwmon*/temp*_input
> - /sys/class/hwmon/hwmon*/temp*_crit
> - /sys/class/hwmon/hwmon*/temp*_lcrit
> - /sys/class/hwmon/hwmon*/temp*_enable
> 
> While at it, update a missing reference to the ufs ABI doc in the
> MAINTAINERS file.
> 
> Fixes: e88e2d32200a ("scsi: ufs: core: Probe for temperature notification support")
> Signed-off-by: Avri Altman <avri.altman@wdc.com>
> ---
>   .../ABI/testing/sysfs-driver-ufs-hwmon        | 31 +++++++++++++++++++

The hardware monitoring ABI is documented in ABI/testing/sysfs-class-hwmon.
It does not make sense to document hwmon driver sysfs attributes per driver
unless there are non-standard attributes.

Guenter

>   MAINTAINERS                                   |  2 ++
>   2 files changed, 33 insertions(+)
>   create mode 100644 Documentation/ABI/testing/sysfs-driver-ufs-hwmon
> 
> diff --git a/Documentation/ABI/testing/sysfs-driver-ufs-hwmon b/Documentation/ABI/testing/sysfs-driver-ufs-hwmon
> new file mode 100644
> index 000000000000..a27a108ffd28
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-driver-ufs-hwmon
> @@ -0,0 +1,31 @@
> +What:		/sys/class/hwmon/hwmon*/temp*_input
> +Date:		September 2021
> +KernelVersion:	5.16
> +Contact:	avri.altman@wdc.com
> +Description:
> +		Temperature input value in millidegrees Celsius.
> +		Read-only.
> +
> +What:		/sys/class/hwmon/hwmon*/temp*_crit
> +Date:		September 2021
> +KernelVersion:	5.16
> +Contact:	avri.altman@wdc.com
> +Description:
> +		Critical temperature value in millidegrees Celsius.
> +		Read-only.
> +
> +What:		/sys/class/hwmon/hwmon*/temp*_lcrit
> +Date:		September 2021
> +KernelVersion:	5.16
> +Contact:	avri.altman@wdc.com
> +Description:
> +		Lower critical temperature value in millidegrees Celsius.
> +		Read-only.
> +
> +What:		/sys/class/hwmon/hwmon*/temp*_enable
> +Date:		September 2021
> +KernelVersion:	5.16
> +Contact:	avri.altman@wdc.com
> +Description:
> +		Enable (1) or disable (0) this temperature sensor.
> +		Read-write.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 838d3038e1ea..71a69551aee2 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -24070,6 +24070,8 @@ R:	Avri Altman <avri.altman@wdc.com>
>   R:	Bart Van Assche <bvanassche@acm.org>
>   L:	linux-scsi@vger.kernel.org
>   S:	Supported
> +F:	Documentation/ABI/testing/sysfs-driver-ufs
> +F:	Documentation/ABI/testing/sysfs-driver-ufs-hwmon
>   F:	Documentation/devicetree/bindings/ufs/
>   F:	Documentation/scsi/ufs.rst
>   F:	drivers/ufs/core/