xref: /dflybsd-src/share/man/man4/corepower.4 (revision e8516a5ef522bd91c87118266b1a407611909eea)
1309b1170SImre Vadász.\"-
2309b1170SImre Vadász.\" Copyright (c) 2015 Imre Vadász
3309b1170SImre Vadász.\" All rights reserved.
4309b1170SImre Vadász.\"
5309b1170SImre Vadász.\" Redistribution and use in source and binary forms, with or without
6309b1170SImre Vadász.\" modification, are permitted provided that the following conditions
7309b1170SImre Vadász.\" are met:
8309b1170SImre Vadász.\" 1. Redistributions of source code must retain the above copyright
9309b1170SImre Vadász.\"    notice, this list of conditions and the following disclaimer.
10309b1170SImre Vadász.\" 2. Redistributions in binary form must reproduce the above copyright
11309b1170SImre Vadász.\"    notice, this list of conditions and the following disclaimer in the
12309b1170SImre Vadász.\"    documentation and/or other materials provided with the distribution.
13309b1170SImre Vadász.\"
14309b1170SImre Vadász.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15309b1170SImre Vadász.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16309b1170SImre Vadász.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17309b1170SImre Vadász.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18309b1170SImre Vadász.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19309b1170SImre Vadász.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20309b1170SImre Vadász.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21309b1170SImre Vadász.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22309b1170SImre Vadász.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23309b1170SImre Vadász.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24309b1170SImre Vadász.\" SUCH DAMAGE.
25309b1170SImre Vadász.\"
26309b1170SImre Vadász.Dd August 12, 2015
27309b1170SImre Vadász.Dt COREPOWER 4
28309b1170SImre Vadász.Os
29309b1170SImre Vadász.Sh NAME
30309b1170SImre Vadász.Nm corepower
31309b1170SImre Vadász.Nd device driver for Intel Core on-die power usage estimation
32309b1170SImre Vadász.Sh SYNOPSIS
33309b1170SImre VadászTo compile this driver into the kernel,
34309b1170SImre Vadászplace the following line in your
35309b1170SImre Vadászkernel configuration file:
36309b1170SImre Vadász.Bd -ragged -offset indent
37309b1170SImre Vadász.Cd "device corepower"
38309b1170SImre Vadász.Ed
39309b1170SImre Vadász.Pp
40309b1170SImre VadászAlternatively, to load the driver as a
41309b1170SImre Vadászmodule at boot time, place the following line in
42309b1170SImre Vadász.Xr loader.conf 5 :
43309b1170SImre Vadász.Bd -literal -offset indent
44309b1170SImre Vadászcorepower_load="YES"
45309b1170SImre Vadász.Ed
46309b1170SImre Vadász.Sh DESCRIPTION
47309b1170SImre VadászThe
48309b1170SImre Vadász.Nm
49309b1170SImre Vadászdriver provides support for Intel's on-die power usage estimation, that is
50309b1170SImre Vadászprovided in Sandy Bridge and newer Core and Xeon CPUs, and in Atom CPUs
51309b1170SImre Vadászof the Silvermont and newer architectures.
52309b1170SImre VadászThe values are exposed through the
53309b1170SImre Vadász.Dv HW_SENSORS
54309b1170SImre Vadász.Xr sysctl 3
55309b1170SImre Vadásztree.
56309b1170SImre VadászFor example:
57309b1170SImre Vadász.Bd -literal -offset indent
58309b1170SImre Vadász% sysctl hw.sensors
59309b1170SImre Vadászhw.sensors.cpu_node0.power0: 0.84 W (node0 Package Power)
60309b1170SImre Vadászhw.sensors.cpu_node0.power1: 0.73 W (node0 DRAM Power)
61309b1170SImre Vadászhw.sensors.cpu_node0.power2: 0.02 W (node0 Cores Power)
62309b1170SImre Vadászhw.sensors.cpu_node0.power3: 0.00 W (node0 Graphics Power)
63*e8516a5eSImre Vadász.Ed
64*e8516a5eSImre Vadász.Pp
65*e8516a5eSImre VadászBoth the
66*e8516a5eSImre Vadász.Dq Cores Power
67*e8516a5eSImre Vadászand the
68*e8516a5eSImre Vadász.Dq Graphics Power
69*e8516a5eSImre Vadászvalues are included in the
70*e8516a5eSImre Vadász.Dq Package Power
71*e8516a5eSImre Vadászvalue, which estimates the total power usage of the CPU package.
72309b1170SImre Vadász.Sh SEE ALSO
73309b1170SImre Vadász.Xr systat 1 ,
74309b1170SImre Vadász.Xr sysctl 3 ,
75309b1170SImre Vadász.Xr devctl 4 ,
76309b1170SImre Vadász.Xr devd 8 ,
77309b1170SImre Vadász.Xr sensorsd 8 ,
78309b1170SImre Vadász.Xr sysctl 8
79309b1170SImre Vadász.Sh HISTORY
80309b1170SImre VadászThe
81309b1170SImre Vadász.Nm
82309b1170SImre Vadászdriver first appeared in
83309b1170SImre Vadász.Dx 4.3 .
84309b1170SImre Vadász.Sh AUTHORS
85309b1170SImre Vadász.An -nosplit
86309b1170SImre VadászThe
87309b1170SImre Vadász.Nm
88309b1170SImre Vadászdriver was written by
89309b1170SImre Vadász.An Imre Vadasz Aq Mt imre@vdsz.com .
90309b1170SImre Vadász.Sh BUGS
91309b1170SImre VadászFor some Xeon and Core-i CPUs this driver might incorrectly assume that the
92309b1170SImre VadászMSR_PP1_ENERGY_STATUS MSR for measuring power usage of the integrated GPU is
93309b1170SImre Vadászavailable.
94