xref: /freebsd/share/man/man4/man4.powerpc/pmu.4 (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
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. This includes late G3 laptops, all G4 machines, early G5
47desktops and all G5 XServes.
48.Ed
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
54.Pp
55Chips supported by the
56.Nm
57driver include:
58.Pp
59.Bl -bullet -compact
60.It
61Apple KeyLargo PMU
62.It
63Apple K2-KeyLargo PMU
64.El
65.Pp
66.Sh SYSCTL VARIABLES
67The
68.Nm
69driver provides power management services in addition to an
70.Xr adb 4
71interface. The following sysctls can be used to control the
72power management behavior and to examine current system power and
73thermal conditions.
74.Bl -tag -width indent
75.It Va dev.pmu.%d.server_mode
76Restart after power failure behavior (1 causes system to reboot after power
77cut, 0 causes system to remain off).
78.It Va dev.pmu.%d.batteries.%d.present
79Indicates whether the relevant battery is inserted.
80.It Va dev.pmu.%d.batteries.%d.charging
81Indicates whether the battery is currently charging.
82.It Va dev.pmu.%d.batteries.%d.charge
83The current battery charge, in milliamp hours.
84.It Va dev.pmu.%d.batteries.%d.maxcharge
85The battery's self-reported maximum charge, in milliamp hours.
86.It Va dev.pmu.%d.batteries.%d.rate
87The current into the battery, in milliamps. While 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.Sh SEE ALSO
96.Xr adb 4 ,
97.Xr acpi 4
98.Sh HISTORY
99The
100.Nm
101device driver appeared in
102.Nx 4.0 ,
103and then in
104.Fx 8.0 .
105.Sh AUTHORS
106.An -nosplit
107The
108.Nm
109driver was written by
110.An Michael Lorenz
111.Aq macallan@NetBSD.org
112and ported to FreeBSD by
113.An Nathan Whitehorn
114.Aq nwhitehorn@freebsd.org .
115