diff mbox series

[3/3,SRU,OEM-6.0/Unstable] Documentation/ABI/testing/sysfs-amd-pmf: Add ABI doc for AMD PMF

Message ID 20221006153834.573628-4-vicamo.yang@canonical.com
State New
Headers show
Series Support for AMD PMF Cool and Quiet Framework (CnQF) | expand

Commit Message

You-Sheng Yang Oct. 6, 2022, 3:38 p.m. UTC 
From: Shyam Sundar S K <Shyam-sundar.S-k@amd.com>

BugLink: https://bugs.launchpad.net/bugs/1991609

AMD PMF driver provides the flexibility to turn "on" or "off"
CnQF feature (introduced in the earlier patch).

Add corresponding ABI documentation for the new sysfs node and
also update MAINTAINERS file with this new information

Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Signed-off-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
Link: https://lore.kernel.org/r/20220922131202.56529-4-Shyam-sundar.S-k@amd.com
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
(cherry picked from commit 1590ac2c6615329d30e25753e03c295cdaf2ae44 linux-next)
Signed-off-by: You-Sheng Yang (vicamo) <vicamo.yang@canonical.com>
---
 Documentation/ABI/testing/sysfs-amd-pmf | 13 +++++++++++++
 MAINTAINERS                             |  1 +
 2 files changed, 14 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-amd-pmf
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-amd-pmf b/Documentation/ABI/testing/sysfs-amd-pmf
new file mode 100644
index 000000000000..7fc0e1c2b76b
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-amd-pmf
@@ -0,0 +1,13 @@ 
+What:		/sys/devices/platform/*/cnqf_enable
+Date:		September 2022
+Contact:	Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
+Description:	Reading this file tells if the AMD Platform Management(PMF)
+		Cool n Quiet Framework(CnQF) feature is enabled or not.
+
+		This feature is not enabled by default and gets only turned on
+		if OEM BIOS passes a "flag" to PMF ACPI function (index 11 or 12)
+		or in case the user writes "on".
+
+		To turn off CnQF user can write "off" to the sysfs node.
+		Note: Systems that support auto mode will not have this sysfs file
+		available.
diff --git a/MAINTAINERS b/MAINTAINERS
index 5c50ea8b8389..c3c29610526f 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1038,6 +1038,7 @@  AMD PMF DRIVER
 M:	Shyam Sundar S K <Shyam-sundar.S-k@amd.com>
 L:	platform-driver-x86@vger.kernel.org
 S:	Maintained
+F:	Documentation/ABI/testing/sysfs-amd-pmf
 F:	drivers/platform/x86/amd/pmf/
 
 AMD HSMP DRIVER