1.\" LP (Laptop Package) 2.\" 3.\" Copyright (c) 1994 by HOSOKAWA, Tatsumi <hosokawa@mt.cs.keio.ac.jp> 4.\" 5.\" This software may be used, modified, copied, and distributed, in 6.\" both source and binary form provided that the above copyright and 7.\" these terms are retained. Under no circumstances is the author 8.\" responsible for the proper functioning of this software, nor does 9.\" the author assume any responsibility for damages incurred with its 10.\" use. 11.\" 12.\" $FreeBSD$ 13.\" 14.Dd November 1, 1994 15.Dt APM 4 i386 16.Os 17.Sh NAME 18.Nm apm 19.Nd APM BIOS interface 20.Sh SYNOPSIS 21.Cd device apm0 at nexus? 22.Sh DESCRIPTION 23.Nm apm 24is an interface to the Intel / Microsoft APM (Advanced Power Management) BIOS 25on laptop PCs. 26.Pp 27.Nm apm 28provides the following power management functions. 29.Bl -enum -offset indent 30.It 31When the system wakes up from suspended mode, 32.Nm apm 33adjusts the system clock to RTC. 34.It 35When the system wakes up from suspended mode, 36.Nm apm 37passes a message to 38.Xr syslogd 8 39comprising of system wakeup time and elapsed time during suspended mode. 40.It 41.Nm apm 42slows CPU clock when there are no system activities (runnable processes, 43interrupts, etc.). This function is available only on systems whose APM 44supports CPU idling. 45.It 46.Nm apm 47exports an application interface as a character device. Applications 48can control APM, or retrieve APM status information via this interface. 49.Nm apm 50exports the following interfaces. These symbols are defined in 51.Dq Pa /usr/include/machine/apm_bios.h. 52.Bl -tag -width 4n -offset indent 53.It Sy APMIO_SUSPEND 54Suspend system. 55.It Sy APMIO_GET 56Get power management information. 57.It Sy APMIO_ENABLE 58.It Sy APMIO_DISABLE 59Enable / Disable power management. 60.It Sy APMIO_HALTCPU 61.It Sy APMIO_NOTHALTCPU 62Control execution of HLT in the kernel context switch routine. 63.Pp 64Some APM implementations execute the HLT 65.Pq Halt CPU until an interrupt occurs 66instruction in the 67.Dq Pa Idle CPU 68call, while others do not. Thus enabling this may result in 69redundant HLT executions because 70.Dq Pa Idle CPU 71is called from the kernel context switch routine that inherently executes 72HLT. This may reduce peak system performance. 73.Pp 74Also the system hangs up if HLT instruction is disabled in the kernel 75context switch routine, and if the APM implementation of the machine 76does not execute HLT in 77.Dq Pa Idle CPU. 78On some implementations that do not support CPU clock slowdown, APM 79might not execute HLT. 80.Nm apm 81disables 82.Sy APMIO_NOTHALTCPU 83operation on such machines. 84.Pp 85The current version of 86.Nm apm 87does not call 88.Dq Pa Idle CPU 89from the kernel context switch routine if clock slowdown is not supported, 90and it executes HLT instruction by default. Therefore, there is 91no need to use these two operations in most cases. 92.El 93.Pp 94These interfaces are used by 95.Xr apm 8 . 96.It 97.Nm apm 98polls APM events and handles the following events. 99.Bl -column PMEV_POWERSTATECHANGEXXX "suspend system xxxxx" 100.It Sy "Name " "Action " "Description" 101.It Dv "PMEV_STANDBYREQ " No "suspend system " "standby request" 102.It Dv "PMEV_SUSPENDREQ " No "suspend system " "suspend request" 103.It Dv "PMEV_USERSUSPENDREQ " No "suspend system " "user suspend request" 104.It Dv "PMEV_CRITSUSPEND " No "suspend system " "critical suspend request" 105.It Dv "PMEV_NORMRESUME " No "resume system " "normal resume" 106.It Dv "PMEV_CRITRESUME " No "resume system " "critical resume" 107.It Dv "PMEV_STANDBYRESUME " No "resume system " "standby resume" 108.It Dv "PMEV_BATTERYLOW " No "notify message " "battery low" 109.It Dv "PMEV_UPDATETIME " No "adjust clock " "update time" 110.El 111.El 112.Sh BUGS 113WARNING! Many, if not most, of the implementations of APM-bios in laptops 114today are buggy. You may be putting your LCD-display and batteries at 115a risk by using this interface. (The reason this isn't a problem for 116MS-windows is that they use the real-mode interface.) If you see any 117weird behavior from your system with this code in use, unplug the 118power and batteries ASAP, if not immediately, and disable this code. 119.Pp 120We are very interested in getting this code working, so please send you 121observations of any anomalous behavior to us. 122.Pp 123When 124.Nm apm 125is active, calling the BIOS setup routine by using hot-keys, 126may cause serious trouble when resuming the system. 127BIOS setup programs should be called during bootstrap, or from DOS. 128.Pp 129Some APM implementations cannot handle events such as pushing the 130power button or closing the cover. On such implementations, the system 131.Ar must 132be suspended 133.Ar only 134by using 135.Xr apm 8 136or 137.Xr zzz 8 . 138.Pp 139Disk spin-down, LCD backlight control, and power on demand have not 140been supported on the current version. 141.Sh SEE ALSO 142.Xr apm 8 , 143.Xr zzz 8 144.Sh AUTHORS 145Tatsumi Hosokawa <hosokawa@jp.FreeBSD.org> 146