[CPUFREQ] update Doc for cpuinfo_cur_freq and scaling_cur_freq
Naga Chumbalkar [Mon, 29 Jun 2009 19:53:41 +0000 (19:53 +0000)]
I think the way "cpuinfo_cur_info" and "scaling_cur_info" are defined under
./Documentation/cpu-freq/user-guide.txt can be enhanced. Currently, they are
both defined the same way: "Current speed/frequency" of the CPU, in KHz".

Below is a patch that distinguishes one from the other.

Regards,
- naga -

-----------------------------------------
Update description for "cpuinfo_cur_freq" and "scaling_cur_freq".

Some of the wording is drawn from comments found in
./drivers/cpufreq/cpufreq.c: cpufreq_out_of_sync():

 *      @old_freq: CPU frequency the kernel thinks the CPU runs at
 *      @new_freq: CPU frequency the CPU actually runs at

Signed-off-by: Naga Chumbalkar <nagananda.chumbalkar@hp.com>
Signed-off-by: Dave Jones <davej@redhat.com>

Documentation/cpu-freq/user-guide.txt

index 5d5f5fa..2a5b850 100644 (file)
@@ -176,7 +176,9 @@ scaling_governor,           and by "echoing" the name of another
                                work on some specific architectures or
                                processors.
 
-cpuinfo_cur_freq :             Current speed of the CPU, in KHz.
+cpuinfo_cur_freq :             Current frequency of the CPU as obtained from
+                               the hardware, in KHz. This is the frequency
+                               the CPU actually runs at.
 
 scaling_available_frequencies : List of available frequencies, in KHz.
 
@@ -196,7 +198,10 @@ related_cpus :                     List of CPUs that need some sort of frequency
 
 scaling_driver :               Hardware driver for cpufreq.
 
-scaling_cur_freq :             Current frequency of the CPU, in KHz.
+scaling_cur_freq :             Current frequency of the CPU as determined by
+                               the governor and cpufreq core, in KHz. This is
+                               the frequency the kernel thinks the CPU runs
+                               at.
 
 If you have selected the "userspace" governor which allows you to
 set the CPU operating frequency to a specific value, you can read out