public inbox for linux-acpi@vger.kernel.org
 help / color / mirror / Atom feed
From: Mario Limonciello <mario.limonciello@amd.com>
To: "Hans de Goede" <hdegoede@redhat.com>,
	"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>
Cc: "Rafael J . Wysocki" <rafael@kernel.org>,
	"Len Brown" <lenb@kernel.org>,
	"Maximilian Luz" <luzmaximilian@gmail.com>,
	"Lee Chun-Yi" <jlee@suse.com>,
	"Shyam Sundar S K" <Shyam-sundar.S-k@amd.com>,
	"Corentin Chary" <corentin.chary@gmail.com>,
	"Luke D . Jones" <luke@ljones.dev>,
	"Ike Panhc" <ike.pan@canonical.com>,
	"Henrique de Moraes Holschuh" <hmh@hmh.eng.br>,
	"Alexis Belmonte" <alexbelm48@gmail.com>,
	"Uwe Kleine-König" <u.kleine-koenig@pengutronix.de>,
	"Ai Chao" <aichao@kylinos.cn>, "Gergo Koteles" <soyer@irl.hu>,
	"open list" <linux-kernel@vger.kernel.org>,
	"open list:ACPI" <linux-acpi@vger.kernel.org>,
	"open list:MICROSOFT SURFACE PLATFORM PROFILE DRIVER"
	<platform-driver-x86@vger.kernel.org>,
	"open list:THINKPAD ACPI EXTRAS DRIVER"
	<ibm-acpi-devel@lists.sourceforge.net>,
	"Mark Pearson" <mpearson-lenovo@squebb.ca>,
	"Matthew Schwartz" <matthew.schwartz@linux.dev>,
	"Mario Limonciello" <mario.limonciello@amd.com>,
	"Armin Wolf" <W_Armin@gmx.de>
Subject: [PATCH v8 22/22] Documentation: Add documentation about class interface for platform profiles
Date: Sat, 30 Nov 2024 08:04:54 -0600	[thread overview]
Message-ID: <20241130140454.455-23-mario.limonciello@amd.com> (raw)
In-Reply-To: <20241130140454.455-1-mario.limonciello@amd.com>

The class interface allows changing multiple platform profiles on a system
to different values. The semantics of it are similar to the legacy
interface.

Reviewed-by: Armin Wolf <W_Armin@gmx.de>
Tested-by: Mark Pearson <mpearson-lenovo@squebb.ca>
Reviewed-by: Mark Pearson <mpearson-lenovo@squebb.ca>
Signed-off-by: Mario Limonciello <mario.limonciello@amd.com>
---
 .../ABI/testing/sysfs-platform_profile        |  5 +++
 .../userspace-api/sysfs-platform_profile.rst  | 31 +++++++++++++++++++
 2 files changed, 36 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-platform_profile b/Documentation/ABI/testing/sysfs-platform_profile
index baf1d125f9f83..125324ab53a96 100644
--- a/Documentation/ABI/testing/sysfs-platform_profile
+++ b/Documentation/ABI/testing/sysfs-platform_profile
@@ -33,3 +33,8 @@ Description:	Reading this file gives the current selected profile for this
 		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 multiple platform profiles drivers are in use but
+		have different values.  This string can not be written to
+		this interface and is solely for informational purposes.
diff --git a/Documentation/userspace-api/sysfs-platform_profile.rst b/Documentation/userspace-api/sysfs-platform_profile.rst
index 4fccde2e45639..0aa384c75095a 100644
--- a/Documentation/userspace-api/sysfs-platform_profile.rst
+++ b/Documentation/userspace-api/sysfs-platform_profile.rst
@@ -40,3 +40,34 @@ added. Drivers which wish to introduce new profile names must:
  1. Explain why the existing profile names cannot be used.
  2. Add the new profile name, along with a clear description of the
     expected behaviour, to the sysfs-platform_profile ABI documentation.
+
+Multiple driver support
+=======================
+When multiple drivers on a system advertise a platform profile handler, the
+platform profile handler core will only advertise the profiles that are
+common between all drivers to the ``/sys/firmware/acpi`` interfaces.
+
+This is to ensure there is no ambiguity on what the profile names mean when
+all handlers don't support a profile.
+
+Individual drivers will register a 'platform_profile' class device that has
+similar semantics as the ``/sys/firmware/acpi/platform_profile`` interface.
+
+To discover which driver is associated with a platform profile handler the
+user can read the ``name`` attribute of the class device.
+
+To discover available profiles from the class interface the user can read the
+``choices`` attribute.
+
+If a user wants to select a profile for a specific driver, they can do so
+by writing to the ``profile`` attribute of the driver's class device.
+
+This will allow users to set different profiles for different drivers on the
+same system. If the selected profile by individual drivers differs the
+platform profile handler core will display the profile 'custom' to indicate
+that the profiles are not the same.
+
+While the ``platform_profile`` attribute has the value ``custom``, writing a
+common profile from ``platform_profile_choices`` to the platform_profile
+attribute of the platform profile handler core will set the profile for all
+drivers.
-- 
2.43.0


      parent reply	other threads:[~2024-11-30 14:06 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-30 14:04 [PATCH v8 00/22] Add support for binding ACPI platform profile to multiple drivers Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 01/22] ACPI: platform-profile: Add a name member to handlers Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 02/22] platform/x86/dell: dell-pc: Create platform device Mario Limonciello
2024-11-30 17:42   ` kernel test robot
2024-12-01  2:55   ` kernel test robot
2024-12-01 17:20   ` Armin Wolf
2024-11-30 14:04 ` [PATCH v8 03/22] ACPI: platform_profile: Add device pointer into platform profile handler Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 04/22] ACPI: platform_profile: Add platform handler argument to platform_profile_remove() Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 05/22] ACPI: platform_profile: Pass the profile handler into platform_profile_notify() Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 06/22] ACPI: platform_profile: Move sanity check out of the mutex Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 07/22] ACPI: platform_profile: Move matching string for new profile out of mutex Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 08/22] ACPI: platform_profile: Use guard(mutex) for register/unregister Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 09/22] ACPI: platform_profile: Use `scoped_cond_guard` Mario Limonciello
2024-12-01 17:18   ` Markus Elfring
2024-11-30 14:04 ` [PATCH v8 10/22] ACPI: platform_profile: Create class for ACPI platform profile Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 11/22] ACPI: platform_profile: Add name attribute to class interface Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 12/22] ACPI: platform_profile: Add choices attribute for " Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 13/22] ACPI: platform_profile: Add profile " Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 14/22] ACPI: platform_profile: Notify change events on register and unregister Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 15/22] ACPI: platform_profile: Only show profiles common for all handlers Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 16/22] ACPI: platform_profile: Add concept of a "custom" profile Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 17/22] ACPI: platform_profile: Make sure all profile handlers agree on profile Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 18/22] ACPI: platform_profile: Check all profile handler to calculate next Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 19/22] ACPI: platform_profile: Notify class device from platform_profile_notify() Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 20/22] ACPI: platform_profile: Allow multiple handlers Mario Limonciello
2024-11-30 14:04 ` [PATCH v8 21/22] platform/x86/amd: pmf: Drop all quirks Mario Limonciello
2024-11-30 14:04 ` Mario Limonciello [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241130140454.455-23-mario.limonciello@amd.com \
    --to=mario.limonciello@amd.com \
    --cc=Shyam-sundar.S-k@amd.com \
    --cc=W_Armin@gmx.de \
    --cc=aichao@kylinos.cn \
    --cc=alexbelm48@gmail.com \
    --cc=corentin.chary@gmail.com \
    --cc=hdegoede@redhat.com \
    --cc=hmh@hmh.eng.br \
    --cc=ibm-acpi-devel@lists.sourceforge.net \
    --cc=ike.pan@canonical.com \
    --cc=ilpo.jarvinen@linux.intel.com \
    --cc=jlee@suse.com \
    --cc=lenb@kernel.org \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luke@ljones.dev \
    --cc=luzmaximilian@gmail.com \
    --cc=matthew.schwartz@linux.dev \
    --cc=mpearson-lenovo@squebb.ca \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=rafael@kernel.org \
    --cc=soyer@irl.hu \
    --cc=u.kleine-koenig@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox