Merge tag 'acpi-5.12-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm (3c8f504b) · Commits · EulixOS / Software / Kernel

Documentation/ABI/testing/sysfs-platform_profile

0 → 100644

+24 −0

Original line number	Diff line number	Diff line
		What: /sys/firmware/acpi/platform_profile_choices
		Date: October 2020
		Contact: Hans de Goede <hdegoede@redhat.com>
		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
		performance High performance operation
		============ ============================================

		Userspace may expect drivers to offer more than one of these
		standard profile names.

		What: /sys/firmware/acpi/platform_profile
		Date: October 2020
		Contact: Hans de Goede <hdegoede@redhat.com>
		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.

Documentation/firmware-guide/acpi/debug.rst

+6 −13

Original line number	Diff line number	Diff line
		@@ -52,19 +52,12 @@ shows the supported mask values, currently these::
		ACPI_CA_DISASSEMBLER 0x00000800
		ACPI_COMPILER 0x00001000
		ACPI_TOOLS 0x00002000
		ACPI_BUS_COMPONENT 0x00010000
		ACPI_AC_COMPONENT 0x00020000
		ACPI_BATTERY_COMPONENT 0x00040000
		ACPI_BUTTON_COMPONENT 0x00080000
		ACPI_SBS_COMPONENT 0x00100000
		ACPI_FAN_COMPONENT 0x00200000
		ACPI_PCI_COMPONENT 0x00400000
		ACPI_POWER_COMPONENT 0x00800000
		ACPI_CONTAINER_COMPONENT 0x01000000
		ACPI_SYSTEM_COMPONENT 0x02000000
		ACPI_THERMAL_COMPONENT 0x04000000
		ACPI_MEMORY_DEVICE_COMPONENT 0x08000000
		ACPI_VIDEO_COMPONENT 0x10000000
		ACPI_PROCESSOR_COMPONENT 0x20000000

		debug_level
		@@ -118,15 +111,15 @@ currently these::
		Examples
		========

		For example, drivers/acpi/bus.c contains this::
		For example, drivers/acpi/acpica/evxfevnt.c contains this::

		#define _COMPONENT ACPI_BUS_COMPONENT
		#define _COMPONENT ACPI_EVENTS
		...
		ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device insertion detected\n"));
		ACPI_DEBUG_PRINT((ACPI_DB_INIT, "ACPI mode disabled\n"));

		To turn on this message, set the ACPI_BUS_COMPONENT bit in acpi.debug_layer
		and the ACPI_LV_INFO bit in acpi.debug_level. (The ACPI_DEBUG_PRINT
		statement uses ACPI_DB_INFO, which is macro based on the ACPI_LV_INFO
		To turn on this message, set the ACPI_EVENTS bit in acpi.debug_layer
		and the ACPI_LV_INIT bit in acpi.debug_level. (The ACPI_DEBUG_PRINT
		statement uses ACPI_DB_INIT, which is a macro based on the ACPI_LV_INIT
		definition.)

		Enable all AML "Debug" output (stores to the Debug object while interpreting

Documentation/firmware-guide/acpi/gpio-properties.rst

+1 −0

Original line number	Diff line number	Diff line
		@@ -146,6 +146,7 @@ following rules (see also the examples):
		other words, it is not mandatory to fill all the GPIO lines
		- empty names are allowed (two quotation marks ``""`` correspond to an empty
		name)
		- names inside one GPIO controller/expander must be unique

		Example of a GPIO controller of 16 lines, with an incomplete list with two
		empty names::

Documentation/userspace-api/index.rst

+1 −0

Original line number	Diff line number	Diff line
		@@ -24,6 +24,7 @@ place where this information is gathered.
		ioctl/index
		iommu
		media/index
		sysfs-platform_profile

		.. only:: subproject and html

Documentation/userspace-api/sysfs-platform_profile.rst

0 → 100644

+42 −0

Original line number	Diff line number	Diff line
		=====================================================================
		Platform Profile Selection (e.g. /sys/firmware/acpi/platform_profile)
		=====================================================================

		On modern systems the platform performance, temperature, fan and other
		hardware related characteristics are often dynamically configurable. The
		platform configuration is often automatically adjusted to the current
		conditions by some automatic mechanism (which may very well live outside
		the kernel).

		These auto platform adjustment mechanisms often can be configured with
		one of several platform profiles, with either a bias towards low power
		operation or towards performance.

		The purpose of the platform_profile attribute is to offer a generic sysfs
		API for selecting the platform profile of these automatic mechanisms.

		Note that this API is only for selecting the platform profile, it is
		NOT a goal of this API to allow monitoring the resulting performance
		characteristics. Monitoring performance is best done with device/vendor
		specific tools such as e.g. turbostat.

		Specifically when selecting a high performance profile the actual achieved
		performance may be limited by various factors such as: the heat generated
		by other components, room temperature, free air flow at the bottom of a
		laptop, etc. It is explicitly NOT a goal of this API to let userspace know
		about any sub-optimal conditions which are impeding reaching the requested
		performance level.

		Since numbers on their own cannot represent the multiple variables that a
		profile will adjust (power consumption, heat generation, etc) this API
		uses strings to describe the various profiles. To make sure that userspace
		gets a consistent experience the sysfs-platform_profile ABI document defines
		a fixed set of profile names. Drivers must map their internal profile
		representation onto this fixed set.

		If there is no good match when mapping then a new profile name may be
		added. Drivers which wish to introduce new profile names must:

		1. Explain why the existing profile names canot be used.
		2. Add the new profile name, along with a clear description of the
		expected behaviour, to the sysfs-platform_profile ABI documentation.