Improve frequency scaling-related manual pages
[dragonfly.git] / share / man / man4 / est.4
1 .\"
2 .\" Copyright (c) 2007
3 .\"     The DragonFly Project.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\"    contributors may be used to endorse or promote products derived
17 .\"    from this software without specific, prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .Dd October 10, 2014
33 .Dt EST 4
34 .Os
35 .Sh NAME
36 .Nm est
37 .Nd Enhanced SpeedStep Technology support
38 .Sh SYNOPSIS
39 To compile this driver into the kernel, place the following line in your
40 kernel configuration file:
41 .Bd -ragged -offset indent
42 .Cd "options CPU_ENABLE_EST"
43 .Ed
44 .Pp
45 To load this driver as a module at boot time, place the following line in
46 .Xr loader.conf 5 :
47 .Bd -literal -offset indent
48 est_load="YES"
49 .Ed
50 .Sh DESCRIPTION
51 The
52 .Nm
53 driver provides support for the
54 .Tn Enhanced SpeedStep Technology
55 present in some CPUs.
56 Please note that
57 .Xr powerd 8
58 should be preferred if it is working properly on your system.
59 .Pp
60 If the CPU is supported
61 .Nm
62 creates the following variables in the
63 .Va machdep.est
64 branch of the
65 .Xr sysctl 3
66 MIB.
67 .Bl -tag -width ".Va frequency.available" -offset indent
68 .It Va frequency.available
69 The list of frequencies supported by
70 .Nm
71 for the CPU (read only).
72 .It Va frequency.current
73 The current CPU frequency (read only).
74 .It Va frequency.target
75 The target CPU frequency (read/write).
76 .El
77 .Pp
78 An associated userland daemon which is part of the
79 .Xr pkgsrc 7
80 collection
81 .Pa ( sysutils/estd )
82 can be used to dynamically set the CPU frequency depending on utilization.
83 .Sh SEE ALSO
84 .Xr powernow 4 ,
85 .Xr powerd 8
86 .Sh HISTORY
87 The
88 .Nm
89 driver first appeared in
90 .Dx 1.5 .