summaryrefslogtreecommitdiff
path: root/Documentation/power/energy-model.rst
diff options
context:
space:
mode:
authorLukasz Luba <lukasz.luba@arm.com>2021-09-06 11:44:53 +0300
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>2021-09-07 22:17:28 +0300
commitd62aab8ff711dc3a4c07684ea33042347f79b630 (patch)
treeaef187ffb79e5498ee653292fc47fc861bbdf427 /Documentation/power/energy-model.rst
parentca67408ad57a5a67ad6801d792c40c010451bdef (diff)
downloadlinux-d62aab8ff711dc3a4c07684ea33042347f79b630.tar.xz
Documentation: power: include kernel-doc in Energy Model doc
Improve the existing documentation of the Energy Model and add kernel-doc comments. This extends an API description and helps better understanding the usage. Signed-off-by: Lukasz Luba <lukasz.luba@arm.com> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Diffstat (limited to 'Documentation/power/energy-model.rst')
-rw-r--r--Documentation/power/energy-model.rst15
1 files changed, 12 insertions, 3 deletions
diff --git a/Documentation/power/energy-model.rst b/Documentation/power/energy-model.rst
index 60ac091d3b0d..8a2788afe89b 100644
--- a/Documentation/power/energy-model.rst
+++ b/Documentation/power/energy-model.rst
@@ -101,8 +101,7 @@ 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, and kernel/power/energy_model.c for further documentation on this
-API.
+callback, or Section 2.4 for further documentation on this API
2.3 Accessing performance domains
@@ -123,7 +122,17 @@ em_cpu_energy() API. The estimation is performed assuming that the schedutil
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 include/linux/energy_model.h.
+More details about the above APIs can be found in ``<linux/energy_model.h>``
+or in Section 2.4
+
+
+2.4 Description details of this API
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. kernel-doc:: include/linux/energy_model.h
+ :internal:
+
+.. kernel-doc:: kernel/power/energy_model.c
+ :export:
3. Example driver