mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Lukasz Luba <lukasz.luba@arm.com>
To: linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org,
	rafael@kernel.org
Cc: lukasz.luba@arm.com, dietmar.eggemann@arm.com,
	rui.zhang@intel.com, amit.kucheria@verdurent.com,
	amit.kachhap@gmail.com, daniel.lezcano@linaro.org,
	viresh.kumar@linaro.org, len.brown@intel.com, pavel@ucw.cz,
	Pierre.Gondois@arm.com, ionela.voinescu@arm.com,
	rostedt@goodmis.org, mhiramat@kernel.org
Subject: [PATCH 14/17] Documentation: EM: Add a new section about the design
Date: Tue, 14 Mar 2023 10:33:54 +0000	[thread overview]
Message-ID: <20230314103357.26010-15-lukasz.luba@arm.com> (raw)
In-Reply-To: <20230314103357.26010-1-lukasz.luba@arm.com>

Add a new section 'Design' which covers the information about Energy
Model. It contains the design decisions, describes models and how they
reflect the reality. Add description of the basic const. EM. Change the
other section IDs.

Signed-off-by: Lukasz Luba <lukasz.luba@arm.com>
---
 Documentation/power/energy-model.rst | 36 +++++++++++++++++++++-------
 1 file changed, 27 insertions(+), 9 deletions(-)

diff --git a/Documentation/power/energy-model.rst b/Documentation/power/energy-model.rst
index ef341be2882b..e97c7f18d8bd 100644
--- a/Documentation/power/energy-model.rst
+++ b/Documentation/power/energy-model.rst
@@ -72,16 +72,34 @@ required to have the same micro-architecture. CPUs in different performance
 domains can have different micro-architectures.
 
 
-2. Core APIs
+2. Design
+-----------------
+
+2.1 Basic EM
+^^^^^^^^^^^^
+
+The basic EM is built around const. power information for each performance
+state. This model can be derived based on power measurements of the device
+e.g. CPU while running some benchmark. The benchmark might be integer heavy
+or floating point computation with a data set fitting into the CPU cache or
+registers. Bare in mind that this model might not be covering all possible
+workloads running on CPUs. Thus, please run a few different benchmarks and
+verify with some real workloads your power model values. The power variation
+due to the workload instruction mix and data set is not modeled.
+Also static power which can change during runtime due to variation of SOC
+temperature is not modeled in EM.
+
+
+3. Core APIs
 ------------
 
-2.1 Config options
+3.1 Config options
 ^^^^^^^^^^^^^^^^^^
 
 CONFIG_ENERGY_MODEL must be enabled to use the EM framework.
 
 
-2.2 Registration of performance domains
+3.2 Registration of performance domains
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Registration of 'advanced' EM
@@ -110,8 +128,8 @@ The last argument 'microwatts' is important to set with correct value. Kernel
 subsystems which use EM might rely on this flag to check if all EM devices use
 the same scale. If there are different scales, these subsystems might decide
 to return warning/error, stop working or panic.
-See Section 3. for an example of driver implementing this
-callback, or Section 2.4 for further documentation on this API
+See Section 4. for an example of driver implementing this
+callback, or Section 3.4 for further documentation on this API
 
 Registration of EM using DT
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -156,7 +174,7 @@ The EM which is registered using this method might not reflect correctly the
 physics of a real device, e.g. when static power (leakage) is important.
 
 
-2.3 Accessing performance domains
+3.3 Accessing performance domains
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 There are two API functions which provide the access to the energy model:
@@ -175,10 +193,10 @@ CPUfreq governor is in use in case of CPU device. Currently this calculation is
 not provided for other type of devices.
 
 More details about the above APIs can be found in ``<linux/energy_model.h>``
-or in Section 2.4
+or in Section 3.4
 
 
-2.4 Description details of this API
+3.4 Description details of this API
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. kernel-doc:: include/linux/energy_model.h
    :internal:
@@ -187,7 +205,7 @@ or in Section 2.4
    :export:
 
 
-3. Example driver
+4. Example driver
 -----------------
 
 The CPUFreq framework supports dedicated callback for registering
-- 
2.17.1


  parent reply	other threads:[~2023-03-14 10:36 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-14 10:33 [PATCH 00/17] Introduce runtime modifiable Energy Model Lukasz Luba
2023-03-14 10:33 ` [PATCH 01/17] PM: EM: Refactor em_cpufreq_update_efficiencies() arguments Lukasz Luba
2023-03-27 17:16   ` Rafael J. Wysocki
2023-04-11 15:43     ` Pierre Gondois
2023-05-10  7:00       ` Lukasz Luba
2023-04-18 22:41     ` Lukasz Luba
2023-03-14 10:33 ` [PATCH 02/17] PM: EM: Find first CPU online while updating OPP efficiency Lukasz Luba
2023-04-11 15:40   ` Pierre Gondois
2023-05-10  7:08     ` Lukasz Luba
2023-05-15  8:47       ` Pierre Gondois
2023-03-14 10:33 ` [PATCH 03/17] PM: EM: Refactor em_pd_get_efficient_state() to be more flexible Lukasz Luba
2023-03-14 10:33 ` [PATCH 04/17] PM: EM: Create a new function em_compute_costs() Lukasz Luba
2023-03-14 10:33 ` [PATCH 05/17] trace: energy_model: Add trace event for EM runtime modifications Lukasz Luba
2023-04-11 15:39   ` Pierre Gondois
2023-05-10  6:59     ` Lukasz Luba
2023-03-14 10:33 ` [PATCH 06/17] PM: EM: Add update_power() callback for " Lukasz Luba
2023-03-14 10:33 ` [PATCH 07/17] PM: EM: Check if the get_cost() callback is present in em_compute_costs() Lukasz Luba
2023-03-14 10:33 ` [PATCH 08/17] PM: EM: Introduce runtime modifiable table Lukasz Luba
2023-03-14 10:33 ` [PATCH 09/17] PM: EM: Add RCU mechanism which safely cleans the old data Lukasz Luba
2023-03-14 10:33 ` [PATCH 10/17] PM: EM: Add runtime update interface to modify EM power Lukasz Luba
2023-04-11 15:40   ` Pierre Gondois
2023-05-10  6:55     ` Lukasz Luba
2023-05-15  8:48       ` Pierre Gondois
2023-03-14 10:33 ` [PATCH 11/17] PM: EM: Use runtime modified EM for CPUs energy estimation in EAS Lukasz Luba
2023-03-14 10:33 ` [PATCH 12/17] PM: EM: Add argument to get_cost() for runtime modification Lukasz Luba
2023-03-14 10:33 ` [PATCH 13/17] PM: EM: Refactor struct em_perf_domain and add default_table Lukasz Luba
2023-03-15 11:32   ` kernel test robot
2023-03-21 11:30     ` Lukasz Luba
2023-03-14 10:33 ` Lukasz Luba [this message]
2023-03-14 10:33 ` [PATCH 15/17] Documentation: EM: Add a runtime modifiable EM design description Lukasz Luba
2023-03-14 10:33 ` [PATCH 16/17] Documentation: EM: Add example with driver modifying the EM Lukasz Luba
2023-03-14 10:33 ` [PATCH 17/17] Documentation: EM: Describe the API of runtime modifications Lukasz Luba

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=20230314103357.26010-15-lukasz.luba@arm.com \
    --to=lukasz.luba@arm.com \
    --cc=Pierre.Gondois@arm.com \
    --cc=amit.kachhap@gmail.com \
    --cc=amit.kucheria@verdurent.com \
    --cc=daniel.lezcano@linaro.org \
    --cc=dietmar.eggemann@arm.com \
    --cc=ionela.voinescu@arm.com \
    --cc=len.brown@intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=mhiramat@kernel.org \
    --cc=pavel@ucw.cz \
    --cc=rafael@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=rui.zhang@intel.com \
    --cc=viresh.kumar@linaro.org \
    /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

all inboxes | Powered by JetHome®