History

sched: Document arch_scale_*_capacity()

Rather that hide their purpose in some dark, damp corner of Documentation/, add some documentation to the default implementations.

Valentin Schneider committed 6 years ago

Commit f4470cd1 parent fcd7c9c2 files · +20 −0Browse files

Unified · Split

2 files
  1. include/linux/sched/topology.h +10 −0
  2. kernel/sched/sched.h +10 −0
include/linux/sched/topology.h+10−0
@@ -217,6 +217,16 @@ static inline bool cpus_share_cache(int this_cpu, int that_cpu) · 216 unmodified lines
217217 #endif /* !CONFIG_SMP */
218218
219219 #ifndef arch_scale_cpu_capacity
220+/**
221+ * arch_scale_cpu_capacity - get the capacity scale factor of a given CPU.
222+ * @cpu: the CPU in question.
223+ *
224+ * Return: the CPU scale factor normalized against SCHED_CAPACITY_SCALE, i.e.
225+ *
226+ * max_perf(cpu)
227+ * ----------------------------- * SCHED_CAPACITY_SCALE
228+ * max(max_perf(c) : c \in CPUs)
229+ */
220230 static __always_inline
221231 unsigned long arch_scale_cpu_capacity(int cpu)
222232 {
kernel/sched/sched.h+10−0
@@ -2049,6 +2049,16 @@ void arch_scale_freq_tick(void) · 2048 unmodified lines
20492049 #endif
20502050
20512051 #ifndef arch_scale_freq_capacity
2052+/**
2053+ * arch_scale_freq_capacity - get the frequency scale factor of a given CPU.
2054+ * @cpu: the CPU in question.
2055+ *
2056+ * Return: the frequency scale factor normalized against SCHED_CAPACITY_SCALE, i.e.
2057+ *
2058+ * f_curr
2059+ * ------ * SCHED_CAPACITY_SCALE
2060+ * f_max
2061+ */
20522062 static __always_inline
20532063 unsigned long arch_scale_freq_capacity(int cpu)
20542064 {