xref: /freebsd/share/man/man4/man4.powerpc/smu.4 (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1.\"-
2.\" Copyright (c) 2010 Nathan Whitehorn <nwhitehorn@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
18.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
23.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24.\" POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd February 22, 2010
29.Dt SMU 4
30.Os
31.Sh NAME
32.Nm smu
33.Nd Apple System Management Unit Driver
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device smu"
40.Ed
41.Sh DESCRIPTION
42The
43.Nm
44driver provides support for the System Management Unit (SMU) found in many
45Apple G5 systems.
46This includes most Power Macintosh G5 and all iMac G5 systems.
47.Pp
48The Apple SMU controller provides software power management and thermal
49control functionality, and is responsible for managing system cooling
50devices.
51.Sh HARDWARE
52Chips supported by the
53.Nm
54driver include:
55.Pp
56.Bl -bullet -compact
57.It
58Apple System Management Unit
59.El
60.Sh THERMAL MANAGEMENT
61The
62.Nm
63driver provides basic automatic thermal management.
64Without a userspace daemon providing more advanced control, the driver will
65attempt to maintain system temperatures in a conservative range through
66coarse-grained control of system cooling devices (see below).
67Automatic kernel-level thermal control will take over if more than 3
68seconds elapses between userspace cooling setting adjustments.
69.Sh SYSCTL VARIABLES
70The
71.Nm
72driver provides power management services and thermal readout through a
73sysctl interface.
74The following sysctls can be used to control the power management behavior
75and to examine current system power and thermal conditions.
76.Bl -tag -width indent
77.It Va dev.smu.%d.server_mode
78Restart after power failure behavior (1 causes system to reboot after power
79cut, 0 causes system to remain off).
80.It Va dev.smu.%d.target_temp
81Target system temperature, in degrees Celsius.
82The
83.Nm
84driver will attempt to adjust fans to maintain the temperature of the
85warmest component in the system at or below this level.
86.It Va dev.smu.%d.critical_temp
87System critical temperature, in degrees Celsius.
88If any component in the system exceeds this temperature, the machine
89will be shut down within 500 ms.
90.It Va dev.smu.%d.fans.%s.minrpm
91Minimum allowed speed for this fan.
92.It Va dev.smu.%d.fans.%s.maxrpm
93Maximum allowed speed for this fan.
94.It Va dev.smu.%d.fans.%s.rpm
95Current speed for this fan.
96The fan speed can be adjusted by changing this sysctl.
97If more than 3 seconds elapses between fan speed adjustments, the kernel will
98resume automatic control of the fan.
99.It Va dev.smu.%d.sensors.%s
100Current reading from this sensor.
101Four sensor types are supported.
102Temperature sensors are in units of degrees Celsius, current sensors in
103milliamps, voltage sensors in millivolts, and power sensors in milliwatts.
104.El
105.Sh LED INTERFACE
106The
107.Nm
108driver provides an
109.Xr led 4
110annunciator interface at
111.Pa /dev/led/sleepled .
112.Sh SEE ALSO
113.Xr acpi 4 ,
114.Xr led 4 ,
115.Xr pmu 4
116.Sh HISTORY
117The
118.Nm
119device driver appeared in
120.Fx 8.0 .
121.Sh AUTHORS
122.An -nosplit
123The
124.Nm
125driver was written by
126.An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org .
127