share/man/man4/corepower.4

   1 .\"-
   2 .\" Copyright (c) 2015 Imre Vadász
   3 .\" 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 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd August 12, 2015
  27 .Dt COREPOWER 4
  28 .Os
  29 .Sh NAME
  30 .Nm corepower
  31 .Nd device driver for Intel Core on-die power usage estimation
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following line in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device corepower"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a
  41 module at boot time, place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 corepower_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 driver provides support for Intel's on-die power usage estimation, that is
  50 provided in Sandy Bridge and newer Core and Xeon CPUs, and in Atom CPUs
  51 of the Silvermont and newer architectures.
  52 The values are exposed through the
  53 .Dv HW_SENSORS
  54 .Xr sysctl 3
  55 tree.
  56 For example:
  57 .Bd -literal -offset indent
  58 % sysctl hw.sensors
  59 hw.sensors.cpu_node0.power0: 0.84 W (node0 Package Power)
  60 hw.sensors.cpu_node0.power1: 0.73 W (node0 DRAM Power)
  61 hw.sensors.cpu_node0.power2: 0.02 W (node0 Cores Power)
  62 hw.sensors.cpu_node0.power3: 0.00 W (node0 Graphics Power)
  63 .Ed
  64 .Pp
  65 Both the
  66 .Dq Cores Power
  67 and the
  68 .Dq Graphics Power
  69 values are included in the
  70 .Dq Package Power
  71 value, which estimates the total power usage of the CPU package.
  72 .Sh SEE ALSO
  73 .Xr systat 1 ,
  74 .Xr sysctl 3 ,
  75 .Xr devctl 4 ,
  76 .Xr devd 8 ,
  77 .Xr sensorsd 8 ,
  78 .Xr sysctl 8
  79 .Sh HISTORY
  80 The
  81 .Nm
  82 driver first appeared in
  83 .Dx 4.3 .
  84 .Sh AUTHORS
  85 .An -nosplit
  86 The
  87 .Nm
  88 driver was written by
  89 .An Imre Vadasz Aq Mt imre@vdsz.com .
  90 .Sh BUGS
  91 For some Xeon and Core-i CPUs this driver might incorrectly assume that the
  92 MSR_PP1_ENERGY_STATUS MSR for measuring power usage of the integrated GPU is
  93 available.