Commit | Line | Data |
---|---|---|
68fb0c66 YT |
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 | .\" | |
2f5aa587 | 25 | .\" $FreeBSD: src/share/man/man4/acpi_thermal.4,v 1.11.8.1 2009/04/15 03:14:26 kensmith Exp $ |
68fb0c66 | 26 | .\" |
2f5aa587 | 27 | .Dd November 11, 2009 |
68fb0c66 YT |
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 | |
06627c8a SW |
41 | interface and a |
42 | .Xr devd 8 | |
43 | notification interface. | |
68fb0c66 YT |
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. | |
2f5aa587 | 56 | .Sh SYSCTL VARIABLES |
68fb0c66 | 57 | .Bl -tag -width indent |
2f5aa587 SW |
58 | .It Va hw.acpi.thermal.min_runtime |
59 | Number of seconds to continue active cooling once started. | |
60 | A new active cooling level will not be selected until this interval expires. | |
61 | .It Va hw.acpi.thermal.polling_rate | |
62 | Number of seconds between polling the current temperature. | |
63 | .It Va hw.acpi.thermal.user_override | |
64 | If set to 1, allow user override of various setpoints (below). | |
65 | The original values for these settings are obtained from the BIOS and | |
66 | system overheating and possible damage could occur if changed. | |
67 | Default is 0 (no override). | |
68fb0c66 YT |
68 | .It Va hw.acpi.thermal.tz%d.active |
69 | Current active cooling system state. | |
70 | If this is non-negative, the appropriate _AC%d object is running. | |
71 | Set this value to the desired active cooling level to force | |
72 | the corresponding fan object to the appropriate level. | |
2f5aa587 SW |
73 | .It Va hw.acpi.thermal.tz%d.passive_cooling |
74 | If set to 1, passive cooling is enabled. | |
507a4eeb SW |
75 | .\"It does cooling without fans using |
76 | .\".Xr cpufreq 4 | |
77 | .\"as the mechanism for controlling CPU speed. | |
2f5aa587 | 78 | Default is enabled for tz0 where it is available. |
68fb0c66 YT |
79 | .It Va hw.acpi.thermal.tz%d.thermal_flags |
80 | Current thermal zone status. | |
81 | These are bit-masked values. | |
82 | .It Va hw.acpi.thermal.tz%d.temperature | |
83 | Current temperature for this zone. | |
84 | .It Va hw.acpi.thermal.tz%d._PSV | |
85 | Temperature to start passive cooling by throttling down CPU, etc. | |
2f5aa587 | 86 | This value can be overridden by the user. |
68fb0c66 YT |
87 | .It Va hw.acpi.thermal.tz%d._HOT |
88 | Temperature to start critical suspend to disk (S4). | |
2f5aa587 | 89 | This value can be overridden by the user. |
68fb0c66 YT |
90 | .It Va hw.acpi.thermal.tz%d._CRT |
91 | Temperature to start critical shutdown (S5). | |
2f5aa587 | 92 | This value can be overridden by the user. |
68fb0c66 YT |
93 | .It Va hw.acpi.thermal.tz%d._ACx |
94 | Temperatures at which to switch to the corresponding active cooling | |
95 | level. | |
68fb0c66 YT |
96 | The lower the _ACx value, the higher the cooling power. |
97 | .El | |
98 | .Pp | |
2f5aa587 SW |
99 | All temperatures are printed in Celsius. |
100 | Values can be set in Celsius (by providing a trailing | |
101 | .Qq C ) | |
102 | or Kelvin (by leaving off any trailing letter). | |
103 | When setting a value by | |
104 | .Xr sysctl 8 , | |
105 | do not specify a trailing decimal (i.e., 90C instead of 90.0C). | |
06627c8a SW |
106 | .Sh NOTIFIES |
107 | Notifies are passed to userland via | |
108 | .Xr devd 8 . | |
109 | See | |
110 | .Pa /etc/devd.conf | |
111 | and | |
112 | .Xr devd.conf 5 | |
113 | for examples. | |
114 | The | |
115 | .Nm | |
116 | driver sends events with the following attributes: | |
117 | .Pp | |
118 | .Bl -tag -width "subsystem" -compact | |
119 | .It system | |
120 | .Li ACPI | |
121 | .It subsystem | |
122 | .Li Thermal | |
123 | .It type | |
124 | The fully qualified thermal zone object path as in the ASL. | |
125 | .It notify | |
126 | An integer designating the event: | |
127 | .Pp | |
128 | .Bl -tag -width indent -compact | |
129 | .It Li 0x80 | |
130 | Current temperature has changed. | |
131 | .It Li 0x81 | |
132 | One or more trip points (_ACx, _PSV) have changed. | |
133 | .It Li 0x82 | |
134 | One or more device lists (_ALx, _PSL, _TZD) have changed. | |
135 | .It Li 0xcc | |
136 | Non-standard notify that the system will shutdown if the temperature | |
137 | stays above _CRT or _HOT for one more poll cycle. | |
138 | .El | |
139 | .El | |
68fb0c66 YT |
140 | .Sh SEE ALSO |
141 | .Xr acpi 4 , | |
2f5aa587 | 142 | .\".Xr cpufreq 4 , |
68fb0c66 YT |
143 | .Xr acpidump 8 |
144 | .Sh AUTHORS | |
145 | .An -nosplit | |
146 | .An Michael Smith | |
147 | .Pp | |
148 | This manual page was written by | |
149 | .An Takanori Watanabe . |