share/man/man4/acpitz.4

   1 .\" $NetBSD: acpitz.4,v 1.8 2008/09/11 21:53:12 reed Exp $
   2 .\"
   3 .\" Copyright (c) 2003, 2004 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25 .\" POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .Dd November 9, 2008
  28 .Dt ACPITZ 4
  29 .Os
  30 .Sh NAME
  31 .Nm acpitz
  32 .Nd ACPI Thermal Zone
  33 .Sh SYNOPSIS
  34 .Cd "acpitz* at acpi?"
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 driver supports ACPI Thermal Zones.
  39 .Pp
  40 The temperature can be monitored by the
  41 .Xr envsys 4
  42 API or the
  43 .Xr envstat 8
  44 command.
  45 .Sh EVENTS
  46 The
  47 .Nm
  48 driver knows about the active cooling levels, the current
  49 temperatures, and critical, hot, and passive temperature thresholds
  50 (as supported by the hardware).
  51 The driver is able to send events to
  52 .Xr powerd 8
  53 when the sensor's state has changed.
  54 When a Thermal Zone is critical, a
  55 .Em critical-over
  56 event will be sent or if the Thermal Zone is hot, a
  57 .Em warning-over
  58 event will be sent to the
  59 .Pa /etc/powerd/scripts/sensor_temperature
  60 script.
  61 .Pp
  62 The critical temperature is the threshold for system shutdown.
  63 Depending on the hardware, the mainboard will take down the system
  64 instantly and no event will have a chance to be sent.
  65 .\" The hot temperature is the temperature threshold for S4 sleep.
  66 .\" S4 is only supported on small subset of machines and is not known to work.
  67 The passive temperature is the passive cooling temperature threshold.
  68 Passive cooling means the Thermal Zone hardware
  69 doesn't have any software control.
  70 On capable hardware, active cooling can power on and off fans, for example.
  71 .Sh SEE ALSO
  72 .Xr acpi 4 ,
  73 .Xr envsys 4 ,
  74 .Xr envstat 8 ,
  75 .Xr powerd 8
  76 .Sh HISTORY
  77 The
  78 .Nm
  79 driver
  80 appeared in
  81 .Nx 2.0 .
  82 .Sh BUGS
  83 Any policy control such as fan control is not implemented.