share/man/man4/acpi_thermal.4

   1 .\" Copyright (c) 2003 Takanori Watanabe.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 27, 2003
  28 .Dt ACPI_THERMAL 4
  29 .Os
  30 .Sh NAME
  31 .Nm acpi_thermal
  32 .Nd ACPI thermal management subsystem
  33 .Sh SYNOPSIS
  34 .Cd "device acpi"
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 driver provides the thermal management features of the ACPI module.
  39 This driver has a
  40 .Xr sysctl 8
  41 interface and a
  42 .Xr devd 8
  43 notification interface.
  44 The sysctls export properties of each ACPI thermal zone object.
  45 .Pp
  46 There can be multiple thermal zones in a system.
  47 For example, each CPU and the enclosure could all be separate thermal
  48 zones, each with its own setpoints and cooling devices.
  49 Thermal zones are numbered sequentially in the order they appear in
  50 the AML.
  51 .Pp
  52 The
  53 .Nm
  54 driver also activates the active cooling system according to
  55 each thermal zone's setpoints.
  56 .Sh SYSCTL VARIABLES
  57 .Bl -tag -width indent
  58 .It Va hw.acpi.thermal.tz%d.active
  59 Current active cooling system state.
  60 If this is non-negative, the appropriate _AC%d object is running.
  61 Set this value to the desired active cooling level to force
  62 the corresponding fan object to the appropriate level.
  63 .It Va hw.acpi.thermal.tz%d.passive_cooling
  64 If set to 1, passive cooling is enabled.
  65 It does cooling without fans using
  66 .Xr cpufreq 4
  67 as the mechanism for controlling CPU speed.
  68 Default is enabled for tz0 where it is available.
  69 .It Va hw.acpi.thermal.tz%d.thermal_flags
  70 Current thermal zone status.
  71 These are bit-masked values.
  72 .It Va hw.acpi.thermal.tz%d.temperature
  73 Current temperature for this zone.
  74 .It Va hw.acpi.thermal.tz%d._PSV
  75 Temperature to start passive cooling by throttling down CPU, etc.
  76 .It Va hw.acpi.thermal.tz%d._HOT
  77 Temperature to start critical suspend to disk (S4).
  78 .It Va hw.acpi.thermal.tz%d._CRT
  79 Temperature to start critical shutdown (S5).
  80 .It Va hw.acpi.thermal.tz%d._ACx
  81 Temperatures at which to switch to the corresponding active cooling
  82 level.
  83 For instance, values of
  84 .Qq Li "3200 3100"
  85 mean to switch on _AC0 at 320.0K
  86 and _AC1 at 310.0K.
  87 The lower the _ACx value, the higher the cooling power.
  88 .El
  89 .Pp
  90 All temperatures are represented in tenths of a Kelvin.
  91 For example, 300.0K is represented by the integer 3000.
  92 To convert to units of Centigrade,
  93 the formula is
  94 .Li "(x - 2731.5) / 10" .
  95 .Sh NOTIFIES
  96 Notifies are passed to userland via
  97 .Xr devd 8 .
  98 See
  99 .Pa /etc/devd.conf
 100 and
 101 .Xr devd.conf 5
 102 for examples.
 103 The
 104 .Nm
 105 driver sends events with the following attributes:
 106 .Pp
 107 .Bl -tag -width "subsystem" -compact
 108 .It system
 109 .Li ACPI
 110 .It subsystem
 111 .Li Thermal
 112 .It type
 113 The fully qualified thermal zone object path as in the ASL.
 114 .It notify
 115 An integer designating the event:
 116 .Pp
 117 .Bl -tag -width indent -compact
 118 .It Li 0x80
 119 Current temperature has changed.
 120 .It Li 0x81
 121 One or more trip points (_ACx, _PSV) have changed.
 122 .It Li 0x82
 123 One or more device lists (_ALx, _PSL, _TZD) have changed.
 124 .It Li 0xcc
 125 Non-standard notify that the system will shutdown if the temperature
 126 stays above _CRT or _HOT for one more poll cycle.
 127 .El
 128 .El
 129 .Sh SEE ALSO
 130 .Xr acpi 4 ,
 131 .Xr cpufreq 4 ,
 132 .Xr acpidump 8
 133 .Sh AUTHORS
 134 .An -nosplit
 135 .An Michael Smith
 136 .Pp
 137 This manual page was written by
 138 .An Takanori Watanabe .