linux-yocto/Documentation/ABI/testing/sysfs-class-platform-profile
Kurt Borja ee7f3e2b49 ACPI: platform_profile: Add documentation
Add kerneldoc and sysfs class documentation.

Reviewed-by: Mario Limonciello <mario.limonciello@amd.com>
Signed-off-by: Kurt Borja <kuurtb@gmail.com>
Reviewed-by: Mark Pearson <mpearson-lenovo@squebb.ca>
Tested-by: Mark Pearson <mpearson-lenovo@squebb.ca>
Link: https://lore.kernel.org/r/20250116002721.75592-19-kuurtb@gmail.com
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
2025-01-17 19:16:53 +02:00

1.6 KiB

What: /sys/class/platform-profile/platform-profile-X/name Date: March 2025 KernelVersion: 6.14 Description: Name of the class device given by the driver.

	RO

What: /sys/class/platform-profile/platform-profile-X/choices Date: March 2025 KernelVersion: 6.14 Description: This file contains a space-separated list of profiles supported for this device.

	Drivers must use the following standard profile-names:

	====================	========================================
	low-power		Low power consumption
	cool			Cooler operation
	quiet			Quieter operation
	balanced		Balance between low power consumption
				and performance
	balanced-performance	Balance between performance and low
				power consumption with a slight bias
				towards performance
	performance		High performance operation
	custom			Driver defined custom profile
	====================	========================================

	RO

What: /sys/class/platform-profile/platform-profile-X/profile Date: March 2025 KernelVersion: 6.14 Description: Reading this file gives the current selected profile for this device. Writing this file with one of the strings from platform_profile_choices changes the profile to the new value.

	This file can be monitored for changes by polling for POLLPRI,
	POLLPRI will be signaled on any changes, independent of those
	changes coming from a userspace write; or coming from another
	source such as e.g. a hotkey triggered profile change handled
	either directly by the embedded-controller or fully handled
	inside the kernel.

	This file may also emit the string 'custom' to indicate
	that the driver is using a driver defined custom profile.

	RW