PM: EM: fix kernel-doc comments
Fix the kernel-doc comments for the improved Energy Model documentation. Signed-off-by: Lukasz Luba <lukasz.luba@arm.com> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
This commit is contained in:
parent
5cbba60596
commit
ca67408ad5
|
@ -11,7 +11,7 @@
|
||||||
#include <linux/types.h>
|
#include <linux/types.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* em_perf_state - Performance state of a performance domain
|
* struct em_perf_state - Performance state of a performance domain
|
||||||
* @frequency: The frequency in KHz, for consistency with CPUFreq
|
* @frequency: The frequency in KHz, for consistency with CPUFreq
|
||||||
* @power: The power consumed at this level (by 1 CPU or by a registered
|
* @power: The power consumed at this level (by 1 CPU or by a registered
|
||||||
* device). It can be a total power: static and dynamic.
|
* device). It can be a total power: static and dynamic.
|
||||||
|
@ -25,7 +25,7 @@ struct em_perf_state {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* em_perf_domain - Performance domain
|
* struct em_perf_domain - Performance domain
|
||||||
* @table: List of performance states, in ascending order
|
* @table: List of performance states, in ascending order
|
||||||
* @nr_perf_states: Number of performance states
|
* @nr_perf_states: Number of performance states
|
||||||
* @milliwatts: Flag indicating the power values are in milli-Watts
|
* @milliwatts: Flag indicating the power values are in milli-Watts
|
||||||
|
@ -103,12 +103,12 @@ void em_dev_unregister_perf_domain(struct device *dev);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* em_cpu_energy() - Estimates the energy consumed by the CPUs of a
|
* em_cpu_energy() - Estimates the energy consumed by the CPUs of a
|
||||||
performance domain
|
* performance domain
|
||||||
* @pd : performance domain for which energy has to be estimated
|
* @pd : performance domain for which energy has to be estimated
|
||||||
* @max_util : highest utilization among CPUs of the domain
|
* @max_util : highest utilization among CPUs of the domain
|
||||||
* @sum_util : sum of the utilization of all CPUs in the domain
|
* @sum_util : sum of the utilization of all CPUs in the domain
|
||||||
* @allowed_cpu_cap : maximum allowed CPU capacity for the @pd, which
|
* @allowed_cpu_cap : maximum allowed CPU capacity for the @pd, which
|
||||||
might reflect reduced frequency (due to thermal)
|
* might reflect reduced frequency (due to thermal)
|
||||||
*
|
*
|
||||||
* This function must be used only for CPU devices. There is no validation,
|
* This function must be used only for CPU devices. There is no validation,
|
||||||
* i.e. if the EM is a CPU type and has cpumask allocated. It is called from
|
* i.e. if the EM is a CPU type and has cpumask allocated. It is called from
|
||||||
|
|
Loading…
Reference in New Issue