diff options
author | Dale Rahn <drahn@cvs.openbsd.org> | 2001-10-09 00:01:57 +0000 |
---|---|---|
committer | Dale Rahn <drahn@cvs.openbsd.org> | 2001-10-09 00:01:57 +0000 |
commit | 422c788552ab1e9903be18e60c42db14d56be3fc (patch) | |
tree | 0ca5c6e34377ce43950a15d7edd844352753dd67 | |
parent | 865bcb21f2191314a5b16b0da5865304db28d22d (diff) |
Add manpage for apm driver on macppc. This version is copied from
i386 with some minor changes, and several NOT YET SUPPORTED statements.
ok miod (we can improve it in the tree later).
-rw-r--r-- | share/man/man4/man4.macppc/Makefile | 6 | ||||
-rw-r--r-- | share/man/man4/man4.macppc/apm.4 | 287 |
2 files changed, 290 insertions, 3 deletions
diff --git a/share/man/man4/man4.macppc/Makefile b/share/man/man4/man4.macppc/Makefile index dbc0d0348b0..af328fa65a6 100644 --- a/share/man/man4/man4.macppc/Makefile +++ b/share/man/man4/man4.macppc/Makefile @@ -1,9 +1,9 @@ -# $OpenBSD: Makefile,v 1.3 2001/10/03 04:32:37 drahn Exp $ +# $OpenBSD: Makefile,v 1.4 2001/10/09 00:01:56 drahn Exp $ # from: @(#)Makefile 5.1 (Berkeley) 2/12/91 # Id: Makefile,v 1.4 1995/12/14 05:41:38 deraadt Exp $ -MAN= abtn.4 adb.4 aed.4 akbd.4 ams.4 autoconf.4 awacs.4 bm.4 gm.4 intro.4 mem.4 -MAN+=zs.4 +MAN= abtn.4 adb.4 aed.4 akbd.4 ams.4 apm.4 autoconf.4 awacs.4 bm.4 gm.4 +MAN+= intro.4 mem.4 zs.4 MLINKS= zs.4 zsc.4 zs.4 zstty.4 MANSUBDIR=macppc diff --git a/share/man/man4/man4.macppc/apm.4 b/share/man/man4/man4.macppc/apm.4 new file mode 100644 index 00000000000..c644a4c2fd2 --- /dev/null +++ b/share/man/man4/man4.macppc/apm.4 @@ -0,0 +1,287 @@ +.\" $OpenBSD: apm.4,v 1.1 2001/10/09 00:01:56 drahn Exp $ +.\" +.\" Copyright (c) 1998 Marco S. Hyman +.\" +.\" Permission to copy all or part of this material for any purpose is +.\" granted provided that the above copyright notice and this paragraph +.\" are duplicated in all copies. THIS SOFTWARE IS PROVIDED ``AS IS'' +.\" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT +.\" LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE. +.\" +.Dd July 17, 1998 +.Dt APM 4 macppc +.Os +.Sh NAME +.Nm apm +.Nd advanced power management device interface +.Sh SYNOPSIS +.Cd apm0 at adb0 +.Sh DESCRIPTION +The +.Nm +driver provides an interface which simulates the Advanced Power Management +.Pq Tn APM +.Tn BIOS +functions. +The bios functions are translated into the appropriate PowerManager requests. +Currently only battery level, AC connection, and charging status is available +from the apm device. +Suspend/resume and other power events are +not supported +.Em NOT YET SUPPORTED . +.Pp +Configuration options: +.Pp +.Bl -tag -width DIAGNOSTIC -compact -offset indent +.It Dv APMDEBUG +Enable various driver status messages. +.It Dv DIAGNOSTIC +Enable debugging messages. +.It Dv DEBUG +Enable other debugging messages. +.El +.Pp +The +.Nm +driver implements the following +.Xr ioctl 2 +calls. +They are defined in +.Aq Pa machine/apmvar.h . +.Pp +.Bl -tag -width Ds +.It Dv APM_IOC_REJECT +.Em Not implemented . DO NOT USE . +.It Dv APM_IOC_STANDBY +.Em NOT YET SUPPORTED on macppc +.Pq Li "no parameters" +Request +.Dq standby +mode. +.It Dv APM_IOC_SUSPEND +.Em NOT YET SUPPORTED on macppc +.Pq Li "no parameters" +Request +.Dq suspend +mode. +.It Dv APM_IOC_GETPOWER +.Pq Li "struct apm_power_info" +Request the current power state. +The argument structure is as follows: +.Bd -literal -offset indent +struct apm_power_info { + u_char battery_state; + u_char ac_state; + u_char battery_life; + u_char spare1; + u_int minutes_left; + u_int spare2[6]; +}; +.Ed +.Pp +The following values are defined for +.Va battery_state : +.Bl -tag -width Ds +.It Dv APM_BATT_HIGH +Battery has a high state of charge. +.It Dv APM_BATT_LOW +Battery has a low state of charge. +.It Dv APM_BATT_CRITICAL +Battery has a critical state of charge. +.It Dv APM_BATT_CHARGING +Battery is not high, low, or critical and is currently charging. +.It Dv APM_BATT_UNKNOWN +Can not read the current battery state. +.It Dv APM_BATTERY_ABSENT +No battery installed. +.El +.Pp +The following values are defined for +.Va ac_state : +.Bl -tag -width Ds +.It Dv APM_AC_OFF +External power not detected. +.It Dv APM_AC_ON +External power detected. +.It Dv APM_AC_BACKUP +Backup power in use. +.It Dv APM_AC_UNKNOWN +External power state unknown. +.El +.Pp +The +.Va battery_life +value contains the estimated percentage of battery life available. +100% indicates a full charge. +.Pp +The +.Va minutes_left +value contains the estimated number of minutes of battery life +remaining. +.It Dv APM_IOC_NEXTEVENT +.Em NOT YET SUPPORTED on macppc +.Pq Li "struct apm_event_info" +The +.Tn APM +driver stores up to +.Dv APM_NEVENTS +events. +This was defined as 16 at the time this documentation was written. +If the event list is full when a new event is detected the new event is lost. +.Dv APM_IOC_NEXTEVENT +ioctl returns the next event on the list or +.Er EAGAIN +if the event list is empty. +The format of the returned event is: +.Bd -literal -offset indent +struct apm_event_info { + u_int type; + u_int index; + u_int spare[8]; +}; +.Ed +where +.Va index +is a sequential count of events that can be used to check if any +events were lost and +.Va type +is one of: +.Bl -tag -width Ds -offset indent -compact +.It Dv APM_STANDBY_REQ +.It Dv APM_SUSPEND_REQ +.It Dv APM_NORMAL_RESUME +.It Dv APM_CRIT_RESUME +.It Dv APM_BATTERY_LOW +.It Dv APM_POWER_CHANGE +.It Dv APM_UPDATE_TIME +.It Dv APM_CRIT_SUSPEND_REQ +.It Dv APM_USER_STANDBY_REQ +.It Dv APM_USER_SUSPEND_REQ +.It Dv APM_SYS_STANDBY_RESUME +.El +.It Dv APM_IOC_DEV_CTL +.Em NOT YET SUPPORTED on macppc +.Pq Li "struct apm_ctl" +Allows an application to directly set the +.Tm APM +operating mode. +The argument structure is as follows: +.Bd -literal -offset indent +struct apm_ctl { + u_int dev; + u_int mode; +}; +.Ed +.Pp +.Va dev +indicates the device, typically +.Dv APM_DEV_ALLDEVS . +.Pp +.Va mode +indicates the desired operating mode. +Possible values are +.Bl -tag -compact -offset indent +.It Dv APM_SYS_READY +.It Dv APM_SYS_STANDBY +.It Dv APM_SYS_SUSPEND +.It Dv APM_SYS_OFF +.It Dv APM_LASTREQ_INPROG +.It Dv APM_LASTREQ_REJECTED +.El +.It Dv APM_IOC_PRN_CTL +.Em NOT YET SUPPORTED on macppc +.Pq Li "int" +This +.Xr ioctl 2 +controls message output by the +.Tn APM +driver when a power change event is detected. +The integer parameter is one of: +.Bl -tag -width Ds +.It Dv APM_PRINT_ON +All power change events result in a message. +This is the normal operating mode for the driver. +.It Dv APM_PRINT_OFF +Power change event messages are suppressed. +.It Dv APM_PRINT_PCT +Power change event messages are suppressed unless the estimated +battery life percentage changes. +.El +.Pp +However, in no case will power status messages be displayed until the +battery life goes below the percentage in the +.Xr sysctl 8 +state variable +.Dv machdep.apmwarn . +Setting +.Dv machdep.apmwarn +to zero disables all warnings regardless of the +.Dv APM_IOC_PRN_CTL +setting. +.El +.Pp +.Em NOT YET SUPPORTED on macppc: +As noted above, the operation of the +.Tn APM +driver can be modified using the +.Dv machdep.apmwarn +.Xr sysctl 8 +variable. +Another driver modifier is the +.Dv machdep.apmhalt +variable. +When +.Dv machdep.apmhalt +is set to 1 the +.Tn APM +power down code is modified in a way necessary for correct operation on +some systems, mainly +.Tn IBM +laptops. +If your system does not power down when given the command +.Li "halt -p" +try setting +.Dv machdep.apmhalt +to 1 using +.Xr sysctl 8 . +The variable can be set at boot time in +.Xr sysctl.conf 5 . +.Sh FILES +.Bl -tag -width /dev/apmctl -compat +.It Pa /dev/apm +.Tn APM +data device. +May only be opened read-only. +May be opened by multiple concurrent users. +.It Pa /dev/apmctl +.Tn APM +control device. +May be opened read-write or write-only. +May only be opened by one user at a time. +An attempt to open the file when in use will fail, returning +.Er EBUSY . +.El +.Sh SEE ALSO +.Xr sysctl.conf 5 , +.Xr apm 8 , +.Xr apmd 8 , +.Xr halt 8 , +.Xr sysctl 8 +.\" .Pp +.\" http://developer.intel.com/ial/powermgm/apmv12.pdf +.Sh HISTORY +The +.Nm +driver source code contains these copyrights: +.Pp +.Bl -item -compact +.It +.Li Copyright (c) 1995 John T. Kohl. All rights reserved. +.It +.Li Copyright (C) 1994 by HOSOKAWA Tatsumi <hosokawa@mt.cs.keio.ac.jp> +.El +.Pp +\&...and has been hacked on by many others since. +.Sh BUGS +Sleep modes and power events are supported. |