docs: cpufreq: Frequencies are in Hz, not kHz

Commit Message

Doug Anderson Feb. 1, 2023, 6:11 p.m. UTC

Though the documentation for the cpufreq files has always specified
that the frequencies are in kHz, they simply aren't. For as long as I
can remember looking at these files they've always been in straight
Hz. Fix the docs.

Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2")
Cc: Rafael J. Wysocki <[e-mail]>
Signed-off-by: Douglas Anderson <[e-mail]>
---
NOTE: git blame shows that this has been wrong since before the kernel
switched to git. I've tagged the first git commit as Fixes, but we
could easily just drop the Fixes tag if that's a better way to go.

 Documentation/admin-guide/pm/cpufreq.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

Comments

Doug Anderson Feb. 1, 2023, 6:41 p.m. UTC | #1

Hi,

On Wed, Feb 1, 2023 at 10:11 AM Douglas Anderson <[e-mail]> wrote:
>
> Though the documentation for the cpufreq files has always specified
> that the frequencies are in kHz, they simply aren't. For as long as I
> can remember looking at these files they've always been in straight
> Hz. Fix the docs.
>
> Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2")
> Cc: Rafael J. Wysocki <[e-mail]>
> Signed-off-by: Douglas Anderson <[e-mail]>
> ---
> NOTE: git blame shows that this has been wrong since before the kernel
> switched to git. I've tagged the first git commit as Fixes, but we
> could easily just drop the Fixes tag if that's a better way to go.
>
>  Documentation/admin-guide/pm/cpufreq.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)

Ugh. Please ignore this patch. Somehow I read these numbers many times
and convinced myself that it was Hz enough to actually post a patch.
...but then someone corrected me and pointed out that I'm utterly and
completely wrong. Sorry for the noise.

-Doug

Patch

diff --git a/Documentation/admin-guide/pm/cpufreq.rst b/Documentation/admin-guide/pm/cpufreq.rst
index 6adb7988e0eb..eb46c5983a0a 100644
--- a/Documentation/admin-guide/pm/cpufreq.rst
+++ b/Documentation/admin-guide/pm/cpufreq.rst
@@ -242,7 +242,7 @@  are the following:
 
 ``cpuinfo_cur_freq``
 	Current frequency of the CPUs belonging to this policy as obtained from
-	the hardware (in KHz).
+	the hardware (in Hz).
 
 	This is expected to be the frequency the hardware actually runs at.
 	If that frequency cannot be determined, this attribute should not
@@ -250,11 +250,11 @@  are the following:
 
 ``cpuinfo_max_freq``
 	Maximum possible operating frequency the CPUs belonging to this policy
-	can run at (in kHz).
+	can run at (in Hz).
 
 ``cpuinfo_min_freq``
 	Minimum possible operating frequency the CPUs belonging to this policy
-	can run at (in kHz).
+	can run at (in Hz).
 
 ``cpuinfo_transition_latency``
 	The time it takes to switch the CPUs belonging to this policy from one
@@ -278,7 +278,7 @@  are the following:
 	listed by this attribute.]
 
 ``scaling_cur_freq``
-	Current frequency of all of the CPUs belonging to this policy (in kHz).
+	Current frequency of all of the CPUs belonging to this policy (in Hz).
 
 	In the majority of cases, this is the frequency of the last P-state
 	requested by the scaling driver from the hardware using the scaling
@@ -308,7 +308,7 @@  are the following:
 
 ``scaling_max_freq``
 	Maximum frequency the CPUs belonging to this policy are allowed to be
-	running at (in kHz).
+	running at (in Hz).
 
 	This attribute is read-write and writing a string representing an
 	integer to it will cause a new limit to be set (it must not be lower
@@ -316,7 +316,7 @@  are the following:
 
 ``scaling_min_freq``
 	Minimum frequency the CPUs belonging to this policy are allowed to be
-	running at (in kHz).
+	running at (in Hz).
 
 	This attribute is read-write and writing a string representing a
 	non-negative integer to it will cause a new limit to be set (it must not
@@ -326,7 +326,7 @@  are the following:
 	This attribute is functional only if the `userspace`_ scaling governor
 	is attached to the given policy.
 
-	It returns the last frequency requested by the governor (in kHz) or can
+	It returns the last frequency requested by the governor (in Hz) or can
 	be written to in order to set a new frequency for the policy.