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: src/share/man/man4/acpi_thermal.4,v 1.6 2004/02/03 04:18:55 njl Exp $
  26 .\" $DragonFly: src/share/man/man4/acpi_thermal.4,v 1.3 2008/10/03 10:33:49 swildner Exp $
  27 .\"
  28 .Dd October 3, 2008
  29 .Dt ACPI_THERMAL 4
  30 .Os
  31 .Sh NAME
  32 .Nm acpi_thermal
  33 .Nd ACPI thermal management subsystem
  34 .Sh SYNOPSIS
  35 .Cd "device acpi"
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 driver provides the thermal management features of the ACPI module.
  40 This driver has a
  41 .Xr sysctl 8
  42 interface and a
  43 .Xr devd 8
  44 notification interface.
  45 The sysctls export properties of each ACPI thermal zone object.
  46 .Pp
  47 There can be multiple thermal zones in a system.
  48 For example, each CPU and the enclosure could all be separate thermal
  49 zones, each with its own setpoints and cooling devices.
  50 Thermal zones are numbered sequentially in the order they appear in
  51 the AML.
  52 .Pp
  53 The
  54 .Nm
  55 driver also activates the active cooling system according to
  56 each thermal zone's setpoints.
  57 .Sh SYSCTLS
  58 .Bl -tag -width indent
  59 .It Va hw.acpi.thermal.tz%d.active
  60 Current active cooling system state.
  61 If this is non-negative, the appropriate _AC%d object is running.
  62 Set this value to the desired active cooling level to force
  63 the corresponding fan object to the appropriate level.
  64 .It Va hw.acpi.thermal.tz%d.thermal_flags
  65 Current thermal zone status.
  66 These are bit-masked values.
  67 .It Va hw.acpi.thermal.tz%d.temperature
  68 Current temperature for this zone.
  69 .It Va hw.acpi.thermal.tz%d._PSV
  70 Temperature to start passive cooling by throttling down CPU, etc.
  71 .It Va hw.acpi.thermal.tz%d._HOT
  72 Temperature to start critical suspend to disk (S4).
  73 .It Va hw.acpi.thermal.tz%d._CRT
  74 Temperature to start critical shutdown (S5).
  75 .It Va hw.acpi.thermal.tz%d._ACx
  76 Temperatures at which to switch to the corresponding active cooling
  77 level.
  78 For instance, values of
  79 .Qq Li "3200 3100"
  80 mean to switch on _AC0 at 320.0K
  81 and _AC1 at 310.0K.
  82 The lower the _ACx value, the higher the cooling power.
  83 .El
  84 .Pp
  85 All temperatures are represented in tenths of a Kelvin.
  86 For example, 300.0K is represented by the integer 3000.
  87 To convert to units of Centigrade,
  88 the formula is
  89 .Li "(x - 2731.5) / 10" .
  90 .Sh NOTIFIES
  91 Notifies are passed to userland via
  92 .Xr devd 8 .
  93 See
  94 .Pa /etc/devd.conf
  95 and
  96 .Xr devd.conf 5
  97 for examples.
  98 The
  99 .Nm
 100 driver sends events with the following attributes:
 101 .Pp
 102 .Bl -tag -width "subsystem" -compact
 103 .It system
 104 .Li ACPI
 105 .It subsystem
 106 .Li Thermal
 107 .It type
 108 The fully qualified thermal zone object path as in the ASL.
 109 .It notify
 110 An integer designating the event:
 111 .Pp
 112 .Bl -tag -width indent -compact
 113 .It Li 0x80
 114 Current temperature has changed.
 115 .It Li 0x81
 116 One or more trip points (_ACx, _PSV) have changed.
 117 .It Li 0x82
 118 One or more device lists (_ALx, _PSL, _TZD) have changed.
 119 .It Li 0xcc
 120 Non-standard notify that the system will shutdown if the temperature
 121 stays above _CRT or _HOT for one more poll cycle.
 122 .El
 123 .El
 124 .Sh SEE ALSO
 125 .Xr acpi 4 ,
 126 .Xr acpidump 8
 127 .Sh AUTHORS
 128 .An -nosplit
 129 .An Michael Smith
 130 .Pp
 131 This manual page was written by
 132 .An Takanori Watanabe .