freebsd-skq/share/man/man4/acpi_thermal.4

.\" Copyright (c) 2003 Takanori Watanabe.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd December 27, 2003
.Dt ACPI_THERMAL 4
.Os
.Sh NAME
.Nm acpi_thermal
.Nd ACPI thermal management subsystem
.Sh SYNOPSIS
.Cd "device acpi"
.Sh DESCRIPTION
The
.Nm
driver provides the thermal management features of the ACPI module.
This driver has a
.Xr sysctl 8
interface and a
.Xr devd 8
notification interface.
The sysctls export properties of each ACPI thermal zone object.
.Pp
There can be multiple thermal zones in a system.
For example, each CPU and the enclosure could all be separate thermal
zones, each with its own setpoints and cooling devices.
Thermal zones are numbered sequentially in the order they appear in
the AML.
.Pp
The
.Nm
driver also activates the active cooling system according to
each thermal zone's setpoints.
.Sh SYSCTL VARIABLES
.Bl -tag -width indent
.It Va hw.acpi.thermal.tz%d.active
Current active cooling system state.
If this is non-negative, the appropriate _AC%d object is running.
Set this value to the desired active cooling level to force
the corresponding fan object to the appropriate level.
.It Va hw.acpi.thermal.tz%d.thermal_flags
Current thermal zone status.
These are bit-masked values.
.It Va hw.acpi.thermal.tz%d.temperature
Current temperature for this zone.
.It Va hw.acpi.thermal.tz%d._PSV
Temperature to start passive cooling by throttling down CPU, etc.
.It Va hw.acpi.thermal.tz%d._HOT
Temperature to start critical suspend to disk (S4).
.It Va hw.acpi.thermal.tz%d._CRT
Temperature to start critical shutdown (S5).
.It Va hw.acpi.thermal.tz%d._ACx
Temperatures at which to switch to the corresponding active cooling
level.
For instance, values of
.Qq Li "3200 3100"
mean to switch on _AC0 at 320.0K
and _AC1 at 310.0K.
The lower the _ACx value, the higher the cooling power.
.El
.Pp
All temperatures are represented in tenths of a Kelvin.
For example, 300.0K is represented by the integer 3000.
To convert to units of Centigrade,
the formula is
.Li "(x - 2731.5) / 10" .
.Sh NOTIFIES
Notifies are passed to userland via
.Xr devd 8 .
See
.Pa /etc/devd.conf
and
.Xr devd.conf 5
for examples.
The
.Nm
driver sends events with the following attributes:
.Pp
.Bl -tag -width "subsystem" -compact
.It system
.Li ACPI
.It subsystem
.Li Thermal
.It type
The fully qualified thermal zone object path as in the ASL.
.It notify
An integer designating the event:
.Pp
.Bl -tag -width indent -compact
.It Li 0x80
Current temperature has changed.
.It Li 0x81
One or more trip points (_ACx, _PSV) have changed.
.It Li 0x82
One or more device lists (_ALx, _PSL, _TZD) have changed.
.It Li 0xcc
Non-standard notify that the system will shutdown if the temperature
stays above _CRT or _HOT for one more poll cycle.
.El
.El
.Sh SEE ALSO
.Xr acpi 4 ,
.Xr acpidump 8
.Sh AUTHORS
.An -nosplit
.An Michael Smith
.Pp
This manual page was written by
.An Takanori Watanabe .
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.\" Copyright (c) 2003 Takanori Watanabe.`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.Dd December 27, 2003`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.Dt ACPI_THERMAL 4`
			`.Os`
			`.Sh NAME`
			`.Nm acpi_thermal`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`.Nd ACPI thermal management subsystem`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.Sh SYNOPSIS`
			`.Cd "device acpi"`
			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`driver provides the thermal management features of the ACPI module.`
			`This driver has a`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.Xr sysctl 8`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`interface and a`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.Xr devd 8`
			`notification interface.`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`The sysctls export properties of each ACPI thermal zone object.`
			`.Pp`
			`There can be multiple thermal zones in a system.`
			`For example, each CPU and the enclosure could all be separate thermal`
			`zones, each with its own setpoints and cooling devices.`
			`Thermal zones are numbered sequentially in the order they appear in`
			`the AML.`
			`.Pp`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`The`
			`.Nm`
Some mdoc(7) polishing. 2004-01-01 21:04:44 +00:00			`driver also activates the active cooling system according to`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`each thermal zone's setpoints.`
Fix typos and use consistent section names in manual pages: s/SYSCTLS/SYSCTL VARIABLES/ s/TUNABLES/LOADER TUNABLES/ s/CAVEAT/CAVEATS/ s/DESCIPTION/DESCRIPTION/ Reviewed by: ru MFC after: 3 days 2005-07-15 17:35:26 +00:00			`.Sh SYSCTL VARIABLES`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.Bl -tag -width indent`
			`.It Va hw.acpi.thermal.tz%d.active`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`Current active cooling system state.`
			`If this is non-negative, the appropriate _AC%d object is running.`
			`Set this value to the desired active cooling level to force`
			`the corresponding fan object to the appropriate level.`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.It Va hw.acpi.thermal.tz%d.thermal_flags`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`Current thermal zone status.`
			`These are bit-masked values.`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.It Va hw.acpi.thermal.tz%d.temperature`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`Current temperature for this zone.`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.It Va hw.acpi.thermal.tz%d._PSV`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`Temperature to start passive cooling by throttling down CPU, etc.`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.It Va hw.acpi.thermal.tz%d._HOT`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`Temperature to start critical suspend to disk (S4).`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.It Va hw.acpi.thermal.tz%d._CRT`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`Temperature to start critical shutdown (S5).`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.It Va hw.acpi.thermal.tz%d._ACx`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`Temperatures at which to switch to the corresponding active cooling`
			`level.`
Some mdoc(7) polishing. 2004-01-01 21:04:44 +00:00			`For instance, values of`
			`.Qq Li "3200 3100"`
			`mean to switch on _AC0 at 320.0K`
Correct _ACx description. This is for a computer system, not for a furnace. 2004-01-01 04:28:13 +00:00			`and _AC1 at 310.0K.`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`The lower the _ACx value, the higher the cooling power.`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.El`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.Pp`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`All temperatures are represented in tenths of a Kelvin.`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`For example, 300.0K is represented by the integer 3000.`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`To convert to units of Centigrade,`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`the formula is`
			`.Li "(x - 2731.5) / 10" .`
			`.Sh NOTIFIES`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`Notifies are passed to userland via`
			`.Xr devd 8 .`
			`See`
			`.Pa /etc/devd.conf`
			`and`
			`.Xr devd.conf 5`
			`for examples.`
			`The`
			`.Nm`
			`driver sends events with the following attributes:`
			`.Pp`
Some mdoc(7) polishing. 2004-01-01 21:04:44 +00:00			`.Bl -tag -width "subsystem" -compact`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`.It system`
Some mdoc(7) polishing. 2004-01-01 21:04:44 +00:00			`.Li ACPI`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`.It subsystem`
Some mdoc(7) polishing. 2004-01-01 21:04:44 +00:00			`.Li Thermal`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`.It type`
			`The fully qualified thermal zone object path as in the ASL.`
			`.It notify`
Some mdoc(7) polishing. 2004-01-01 21:04:44 +00:00			`An integer designating the event:`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.Pp`
			`.Bl -tag -width indent -compact`
			`.It Li 0x80`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`Current temperature has changed.`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.It Li 0x81`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`One or more trip points (_ACx, _PSV) have changed.`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.It Li 0x82`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`One or more device lists (_ALx, _PSL, _TZD) have changed.`
Notify the user (at kern.emerg) that the system will be shutting down if it is still above the critical temperature on the next poll cycle. This is a 10 second advance notice by default. Document the private (non-standard) notify we will be using with devd(8). 2004-02-03 04:18:56 +00:00			`.It Li 0xcc`
			`Non-standard notify that the system will shutdown if the temperature`
			`stays above _CRT or _HOT for one more poll cycle.`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.El`
Some mdoc(7) polishing. 2004-01-01 21:04:44 +00:00			`.El`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.Sh SEE ALSO`
Add to the acpi_thermal man page, especially the notifies section. 2003-12-31 19:12:52 +00:00			`.Xr acpi 4 ,`
			`.Xr acpidump 8`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.Sh AUTHORS`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.An -nosplit`
Add acpi_thermal manual page, because I asked about the unit of thermal zone-related value too freqently. Come on, mdoc police. 2003-12-27 16:25:11 +00:00			`.An Michael Smith`
			`.Pp`
			`This manual page was written by`
Somebody called mdoc(7) janitor. A bit of wordsmithing from a native speaker is still necessary. 2003-12-28 12:56:01 +00:00			`.An Takanori Watanabe .`