xref: /freebsd/share/man/man4/man4.powerpc/pmu.4 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1.\"-
2.\" Copyright (c) 2008 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 December 6, 2008
29.Dt PMU 4
30.Os
31.Sh NAME
32.Nm pmu
33.Nd Apple PMU99 Power Management 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 adb"
40.Cd "device pmu"
41.Ed
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for the Power Management Unit (PMU) found in Apple
46Core99 hardware.
47This includes late G3 laptops, all G4 machines, early G5
48desktops and all G5 XServes.
49.Pp
50The Apple PMU controller is a multi-purpose ASIC that provides power
51management and thermal control, as well as an ADB bus for the internal
52keyboard and mouse on laptops.
53.Sh HARDWARE
54Chips supported by the
55.Nm
56driver include:
57.Pp
58.Bl -bullet -compact
59.It
60Apple KeyLargo PMU
61.It
62Apple K2-KeyLargo PMU
63.El
64.Sh SYSCTL VARIABLES
65The
66.Nm
67driver provides power management services in addition to an
68.Xr adb 4
69interface.
70The following sysctls can be used to control the
71power management behavior and to examine current system power and
72thermal conditions.
73.Bl -tag -width indent
74.It Va dev.pmu.%d.server_mode
75Restart after power failure behavior (1 causes system to reboot after power
76cut, 0 causes system to remain off).
77.It Va dev.pmu.%d.batteries.%d.present
78Indicates whether the relevant battery is inserted.
79.It Va dev.pmu.%d.batteries.%d.charging
80Indicates whether the battery is currently charging.
81.It Va dev.pmu.%d.batteries.%d.charge
82The current battery charge, in milliamp hours.
83.It Va dev.pmu.%d.batteries.%d.maxcharge
84The battery's self-reported maximum charge, in milliamp hours.
85.It Va dev.pmu.%d.batteries.%d.rate
86The current into the battery, in milliamps.
87While the battery is discharging,
88this will be negative.
89.It Va dev.pmu.%d.batteries.%d.voltage
90Battery voltage, in millivolts.
91.It Va dev.pmu.%d.batteries.%d.time
92Estimated time until full battery charge (or discharge), in minutes.
93.It Va dev.pmu.%d.batteries.%d.life
94Current fraction of the battery's maximum charge, in percent.
95.El
96.Sh SEE ALSO
97.Xr acpi 4 ,
98.Xr adb 4 ,
99.Xr led 4
100.Sh HISTORY
101The
102.Nm
103device driver appeared in
104.Nx 4.0 ,
105and then in
106.Fx 8.0 .
107.Sh AUTHORS
108.An -nosplit
109The
110.Nm
111driver was written by
112.An Michael Lorenz Aq Mt macallan@NetBSD.org
113and ported to
114.Fx
115by
116.An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org .
117