share/man/man4/est.4

   1 .\"
   2 .\" Copyright (c) 2012 Sean Bruno <sbruno@freebsd.org>
   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 .\" $FreeBSD$
  27 .\"
  28 .Dd October 18, 2012
  29 .Dt EST 4
  30 .Os
  31 .Sh NAME
  32 .Nm est
  33 .Nd Enhanced Speedstep Technology
  34 .Sh SYNOPSIS
  35 To compile this capability into your kernel
  36 place the following line in your kernel
  37 configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device cpufreq"
  40 .Ed
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 interface provides support for the Intel Enhanced Speedstep Technology.
  45 .Pp
  46 Note that
  47 .Nm
  48 capabilities are automatically loaded by the
  49 .Xr cpufreq 4
  50 driver.
  51 .Sh LOADER TUNABLES
  52 The
  53 .Nm
  54 interface is intended to allow
  55 .Xr cpufreq 4
  56 to access and implement Intel Enhanced SpeedStep Technology via
  57 .Xr acpi 4
  58 and the acpi_perf interface accessors.
  59 If the default settings are not optimal, the following sysctls can be
  60 used to modify or monitor
  61 .Nm
  62 behavior.
  63 .Bl -tag -width indent
  64 .It hw.est.msr_info
  65 Attempt to infer information from direct probing of the msr.
  66 Should only be used in diagnostic cases.
  67 .Pq default 0
  68 .It hw.est.strict
  69 Validate frequency requested is accepted by the cpu when set.
  70 It appears that this will only work on single core cpus.
  71 .Pq default 0
  72 .El
  73 .Sh SYSCTL VARIABLES
  74 The following
  75 .Xr sysctl 8
  76 values are available
  77 .Bl -tag -width indent
  78 .It Va dev.est.%d.\%desc
  79 Description of support, almost always Enhanced SpeedStep Frequency Control.
  80 .It dev.est.0.%desc: Enhanced SpeedStep Frequency Control
  81 .It Va dev.est.%d.\%driver
  82 Driver in use, always est.
  83 .It dev.est.0.%driver: est
  84 .It Va dev.est.%d.\%parent
  85 .It dev.est.0.%parent: cpu0
  86 The cpu that is exposing these frequencies.
  87 For example
  88 .Va cpu0 .
  89 .It Va dev.est.%d.freq_settings .
  90 The valid frequencies that are allowed by this CPU and their step values.
  91 .It dev.est.0.freq_settings: 2201/45000 2200/45000 2000/39581 1900/37387
  92 1800/34806 1700/32703 1600/30227 1500/28212 1400/25828 1300/23900 1200/21613
  93 1100/19775 1000/17582 900/15437 800/13723
  94 .Pp
  95 .El
  96 .Sh DIAGNOSTICS
  97 .Bl -diag
  98 .It "est%d: <Enhanced SpeedStep Frequency Control> on cpu%d"
  99 .Pp
 100 Indicates normal startup of this interface.
 101 .It "est: CPU supports Enhanced Speedstep, but is not recognized."
 102 .It "est: cpu_vendor GenuineIntel, msr 471c471c0600471c"
 103 .It "device_attach: est%d attach returned 6"
 104 .Pp
 105 Indicates all attempts to attach to this interface have failed.
 106 This usually indicates an improper BIOS setting restricting O/S
 107 control of the CPU speeds.
 108 Consult your BIOS documentation for more details.
 109 .El
 110 .Sh COMPATIBILITY
 111 .Nm
 112 is only found on supported Intel CPUs.
 113 .Sh SEE ALSO
 114 .Xr cpufreq 4
 115 .Rs
 116 .%T "Intel 64 and IA-32 Architectures Software Developer Manuals"
 117 .%U "http://www.intel.com/content/www/us/en/processors/architectures-software-developer-manuals.html"
 118 .Re
 119 .Sh AUTHORS
 120 This manual page was written by
 121 .An Sean Bruno Aq sbruno@FreeBSD.org .