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 16/17] Documentation: EM: Add example with driver modifying the EM
Date: Tue, 14 Mar 2023 10:33:56 +0000 [thread overview]
Message-ID: <20230314103357.26010-17-lukasz.luba@arm.com> (raw)
In-Reply-To: <20230314103357.26010-1-lukasz.luba@arm.com>
The Energy Model (EM) support runtime modifications. Add description
with example driver code which updates EM.
Signed-off-by: Lukasz Luba <lukasz.luba@arm.com>
---
Documentation/power/energy-model.rst | 53 ++++++++++++++++++++++++++--
1 file changed, 51 insertions(+), 2 deletions(-)
diff --git a/Documentation/power/energy-model.rst b/Documentation/power/energy-model.rst
index 64c2462dc9a6..a6ceeeb72868 100644
--- a/Documentation/power/energy-model.rst
+++ b/Documentation/power/energy-model.rst
@@ -225,8 +225,11 @@ or in Section 3.4
:export:
-4. Example driver
------------------
+4. Examples
+-----------
+
+4.1 Example driver with EM registration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The CPUFreq framework supports dedicated callback for registering
the EM for a given CPU(s) 'policy' object: cpufreq_driver::register_em().
@@ -280,3 +283,49 @@ EM framework::
39 static struct cpufreq_driver foo_cpufreq_driver = {
40 .register_em = foo_cpufreq_register_em,
41 };
+
+
+4.2 Example driver with EM modification
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section provides a simple example of a thermal driver modifying the EM.
+The driver implements a foo_mod_power() function to be provided to the
+EM framework. The driver is woken up periodically to check the temperature
+and modify the EM data if needed::
+
+ -> drivers/thermal/foo_thermal.c
+
+ 01 static int foo_mod_power(struct device *dev, unsigned long freq,
+ 02 unsigned long *power, void *priv)
+ 03 {
+ 04 struct foo_context *ctx = priv;
+ 05
+ 06 /* Estimate power for the given frequency and temperature */
+ 07 *power = foo_estimate_power(dev, freq, ctx->temperature);
+ 08 if (*power >= EM_MAX_POWER);
+ 09 return -EINVAL;
+ 10
+ 11 return 0;
+ 12 }
+ 13
+ 14 /*
+ 15 * Function called periodically to check the temperature and
+ 16 * update the EM if needed
+ 17 */
+ 18 static void foo_thermal_em_update(struct foo_context *ctx)
+ 19 {
+ 20 struct em_data_callback em_cb = EM_UPDATE_CB(mod_power);
+ 21 struct cpufreq_policy *policy = ctx->policy;
+ 22 struct device *cpu_dev;
+ 23
+ 24 cpu_dev = get_cpu_device(cpumask_first(policy->cpus));
+ 25
+ 26 ctx->temperature = foo_get_temp(cpu_dev, ctx);
+ 27 if (ctx->temperature < FOO_EM_UPDATE_TEMP_THRESHOLD)
+ 28 return;
+ 29
+ 30 /* Update EM for the CPUs' performance domain */
+ 31 ret = em_dev_update_perf_domain(cpu_dev, &em_cb, ctx);
+ 32 if (ret)
+ 33 pr_warn("foo_thermal: EM update failed\n");
+ 34 }
--
2.17.1
next prev parent reply other threads:[~2023-03-14 10:43 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 ` [PATCH 14/17] Documentation: EM: Add a new section about the design Lukasz Luba
2023-03-14 10:33 ` [PATCH 15/17] Documentation: EM: Add a runtime modifiable EM design description Lukasz Luba
2023-03-14 10:33 ` Lukasz Luba [this message]
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-17-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®