diff options
author | Michael Knudsen <mk@cvs.openbsd.org> | 2007-01-10 16:14:37 +0000 |
---|---|---|
committer | Michael Knudsen <mk@cvs.openbsd.org> | 2007-01-10 16:14:37 +0000 |
commit | d8fb8781553f62dd2c2fcf1aa82538fce026141c (patch) | |
tree | c797516fb76e66c89b44f4e87c8b77d993ca53b6 | |
parent | 9f177629927c4e4c0e31c5f26e568aa7f613af16 (diff) |
As requested by deraadt, split acpi(4) up into individual driver pages.
While doing this, improve and add the text of some manuals. Some of
these are simply revived versions of the pages back from when they were
individual pages.
Input and ok from jmc.
Note: When we wrote these pages, people submitted new pages to jmc and
I. At some point during this, we decided to merge all pages into acpi(4)
(which is now being undone), and I lost track of who sent what. Thus,
if you think you should be the copyright owner of any of these files,
get back to me in private.
-rw-r--r-- | share/man/man4/acpi.4 | 135 | ||||
-rw-r--r-- | share/man/man4/acpiac.4 | 54 | ||||
-rw-r--r-- | share/man/man4/acpibat.4 | 58 | ||||
-rw-r--r-- | share/man/man4/acpibtn.4 | 46 | ||||
-rw-r--r-- | share/man/man4/acpiec.4 | 54 | ||||
-rw-r--r-- | share/man/man4/acpihpet.4 | 46 | ||||
-rw-r--r-- | share/man/man4/acpitimer.4 | 46 | ||||
-rw-r--r-- | share/man/man4/acpitz.4 | 55 |
8 files changed, 366 insertions, 128 deletions
diff --git a/share/man/man4/acpi.4 b/share/man/man4/acpi.4 index 1047114bed2..e761bec8258 100644 --- a/share/man/man4/acpi.4 +++ b/share/man/man4/acpi.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: acpi.4,v 1.16 2006/12/25 01:06:45 mk Exp $ +.\" $OpenBSD: acpi.4,v 1.17 2007/01/10 16:14:36 mk Exp $ .\" .\" Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org> .\" @@ -18,24 +18,10 @@ .Dt ACPI 4 .Os .Sh NAME -.Nm acpi , -.Nm acpiac , -.Nm acpibat , -.Nm acpibtn , -.Nm acpiec , -.Nm acpihpet , -.Nm acpitimer , -.Nm acpitz +.Nm acpi .Nd Advanced Configuration and Power Interface .Sh SYNOPSIS .Cd "acpi0 at mainbus?" -.Cd "acpiac* at acpi?" -.Cd "acpibat* at acpi?" -.Cd "acpibtn* at acpi?" -.Cd "acpiec* at acpi?" -.Cd "acpihpet* at acpi?" -.Cd "acpitimer* at acpi?" -.Cd "acpitz* at acpi?" .Pp .Cd "option ACPIVERBOSE" .Cd "option ACPI_ENABLE" @@ -46,71 +32,6 @@ driver provides basic support for ACPI including loading ACPI tables from the firmware, parsing and interpreting AML code, event handling, suspending and powering off, and attaching device drivers. .Pp -The -.Nm acpiac -driver supports ACPI AC Adapters. -Information about AC power source status (connected or disconnected) is -available through this driver. -AC power source status is updated every 10 seconds or, -if the implementation supports it, -via an event. -.Pp -The -.Nm acpibat -driver supports the ACPI Control Method Battery interface between the -battery and the host. -Information about the battery, such as capacity, recharge rate, voltage, -and serial number, is available through this driver. -Battery status is updated every 10 seconds or, -if the implementation supports it, -via an event. -.Pp -The -.Nm acpibtn -driver is used to power down the system safely when the user presses -an ACPI power button -.Pq usually the main system power button . -.Pp -The -.Nm acpiec -driver supports ACPI Embedded Controllers. -It provides embedded controller access for other ACPI devices. -On many systems -which have an -.Nm acpiec -device, other ACPI devices such as -.Nm acpiac , -.Nm acpibat , -and -.Nm acpitz -implicitly depend on the -.Nm acpiec -device. -.Pp -The -.Nm acpihpet -driver provides support for the high precision event timer to be used -as a timecounter for the -.Xr tc_init 9 -framework. -.Pp -The -.Nm acpitimer -driver allows access to a power management timer through the ACPI. -The timer is used as a timecounter for the -.Xr tc_init 9 -framework. -.Pp -The -.Nm acpitz -driver supports ACPI Thermal Zones. -Temperature information is available through this driver as a sensor -which is updated every 10 seconds or, if the implementation supports it, -via an event. -If the temperature exceeds the -.Sq critical -temperature threshold, the system will be shut down and powered off. -.Pp If the configuration option .Dq Dv ACPIVERBOSE is set, information about all detected ACPI devices will be displayed @@ -124,60 +45,18 @@ driver will take control of ACPI from the firmware (BIOS). WARNING: this may cause an overheating on some machines since .Nm doesn't provide any thermal or cooling control. -.Pp -Some devices, such as -.Nm acpiac , -provide hardware information via sensors -that can be monitored using -.Xr sysctl 8 -or -.Xr sensorsd 8 . .Sh SEE ALSO -.Xr intro 4 , -.Xr sensorsd 8 , -.Xr sysctl 8 , -.Xr tc_init 9 +.Xr intro 4 .Sh HISTORY The -.Nm acpi , -.Nm acpiac , -.Nm acpibat , -.Nm acpiec , -.Nm acpihpet , -.Nm acpitimer , -and -.Nm acpitz -drivers first appeared in +.Nm +driver first appeared in .Ox 3.8 . .Sh AUTHORS .An -nosplit The -.Nm acpi , -.Nm acpihpet , -and -.Nm acpitimer -drivers were written by +.Nm +driver was written by .An Thorsten Lockert Aq tholo@sigmasoft.com and .An Jordan Hargrave Aq jordan@openbsd.org . -.Pp -The -.Nm acpiac , -.Nm acpibat , -and -.Nm acpibtn -drivers were written by -.An Marco Peereboom Aq marco@openbsd.org . -.Pp -The -.Nm acpiec -and -.Nm acpitz -drivers were written by -.An Can Erkin Acar Aq canacar@openbsd.org . -.Sh BUGS -Some systems do not propagate battery insertion up to the driver or -will not report valid information unless there is a state change to the -battery. -.Pp -Smart Battery Specification-based batteries are not supported. diff --git a/share/man/man4/acpiac.4 b/share/man/man4/acpiac.4 new file mode 100644 index 00000000000..8e7072a8a09 --- /dev/null +++ b/share/man/man4/acpiac.4 @@ -0,0 +1,54 @@ +.\" $OpenBSD: acpiac.4,v 1.1 2007/01/10 16:14:36 mk Exp $ +.\" +.\" Copyright (c) 2007 Michael Knudsen <mk@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd January 8, 2007 +.Dt ACPIAC 4 +.Os +.Sh NAME +.Nm acpiac +.Nd ACPI AC Adapters +.Sh SYNOPSIS +.Cd "acpiac* at acpi?" +.Sh DESCRIPTION +The +.Nm +driver supports ACPI AC Adapters. +Information about AC power source status (connected or disconnected) is +available through this driver as a sensor. +AC power source status is updated every 10 seconds or, +if the implementation supports it, +via an event when a change happens. +The sensors provided by +.Nm +can be monitored using +.Xr sysctl 8 +or +.Xr sensorsd 8 . +.Sh SEE ALSO +.Xr intro 4 , +.Xr sensorsd 8 , +.Xr sysctl 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 3.8 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Marco Peereboom Aq marco@openbsd.org . diff --git a/share/man/man4/acpibat.4 b/share/man/man4/acpibat.4 new file mode 100644 index 00000000000..99802bcbc3c --- /dev/null +++ b/share/man/man4/acpibat.4 @@ -0,0 +1,58 @@ +.\" $OpenBSD: acpibat.4,v 1.4 2007/01/10 16:14:36 mk Exp $ +.\" +.\" Copyright (c) 2006 Dmitri Alenitchev <dmitri@wave.net.ru> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd August 29, 2006 +.Dt ACPIBAT 4 +.Os +.Sh NAME +.Nm acpibat +.Nd ACPI Control Method Battery +.Sh SYNOPSIS +.Cd "acpibat* at acpi?" +.Sh DESCRIPTION +The +.Nm +driver supports the ACPI Control Method Battery interface between the +battery and the host. +Information about the battery, such as capacity, recharge rate, voltage, +and serial number, is available through this driver. +Battery status is updated through an event triggered when a battery +changes state (such as starting to charge) and, as a failsafe if the +system does not support passing such events, every 10 seconds. +Battery status can be monitored using +.Xr sysctl 8 +or +.Xr sensorsd 8 . +.Sh SEE ALSO +.Xr acpi 4 , +.Xr intro 4 , +.Xr sensorsd 8 , +.Xr sysctl 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 3.8 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Marco Peereboom Aq marco@openbsd.org . +.Sh BUGS +Some systems do not propagate battery insertion up to the driver. +.Pp +Smart Battery Specification-based batteries are not supported. diff --git a/share/man/man4/acpibtn.4 b/share/man/man4/acpibtn.4 new file mode 100644 index 00000000000..1e3bb259ad2 --- /dev/null +++ b/share/man/man4/acpibtn.4 @@ -0,0 +1,46 @@ +.\" $OpenBSD: acpibtn.4,v 1.1 2007/01/10 16:14:36 mk Exp $ +.\" +.\" Copyright (c) 2006 Michael Knudsen <mk@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd December 24, 2006 +.Dt ACPIBTN 4 +.Os +.Sh NAME +.Nm acpibtn +.Nd ACPI Buttons +.Sh SYNOPSIS +.Cd "acpibtn* at acpi?" +.Sh DESCRIPTION +The +.Nm +driver is used to handle the event triggered when the user presses an ACPI +button. +Currently, the only event handled is the press of a power button which +causes the system to perform a regular system shutdown and power off the +machine. +.Sh SEE ALSO +.Xr acpi 4 , +.Xr intro 4 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 3.9 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Marco Peereboom Aq marco@openbsd.org . diff --git a/share/man/man4/acpiec.4 b/share/man/man4/acpiec.4 new file mode 100644 index 00000000000..a232533fd37 --- /dev/null +++ b/share/man/man4/acpiec.4 @@ -0,0 +1,54 @@ +.\" $OpenBSD: acpiec.4,v 1.1 2007/01/10 16:14:36 mk Exp $ +.\" +.\" Copyright (c) 2006 Michael Knudsen <mk@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd December 24, 2006 +.Dt ACPIEC 4 +.Os +.Sh NAME +.Nm acpiec +.Nd ACPI Embedded Controllers +.Sh SYNOPSIS +.Cd "acpiec* at acpi?" +.Sh DESCRIPTION +The +.Nm +driver supports ACPI Embedded Controllers. +It provides embedded controller access for other ACPI devices. +On many systems +which have an +.Nm +device, other ACPI devices such as +.Xr acpiac 4 , +.Xr acpibat 4 , +and +.Xr acpitz 4 +implicitly depend on the +.Nm +device. +.Sh SEE ALSO +.Xr acpi 4 , +.Xr intro 4 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 3.8 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Can Erkin Acar Aq canacar@openbsd.org . diff --git a/share/man/man4/acpihpet.4 b/share/man/man4/acpihpet.4 new file mode 100644 index 00000000000..2b252979d1b --- /dev/null +++ b/share/man/man4/acpihpet.4 @@ -0,0 +1,46 @@ +.\" $OpenBSD: acpihpet.4,v 1.3 2007/01/10 16:14:36 mk Exp $ +.\" +.\" Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd January 7, 2006 +.Dt ACPIHPET 4 +.Os +.Sh NAME +.Nm acpihpet +.Nd ACPI High Precision Event Timer +.Sh SYNOPSIS +.Cd "acpihpet* at acpi?" +.Sh DESCRIPTION +The +.Nm +driver provides support for the high precision event timer to be used +as a timecounter for the +.Xr tc_init 9 +framework. +.Sh SEE ALSO +.Xr acpi 4 , +.Xr intro 4 , +.Xr tc_init 9 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 3.8 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Thorsten Lockert Aq tholo@sigmasoft.com . diff --git a/share/man/man4/acpitimer.4 b/share/man/man4/acpitimer.4 new file mode 100644 index 00000000000..2820acc08e9 --- /dev/null +++ b/share/man/man4/acpitimer.4 @@ -0,0 +1,46 @@ +.\" $OpenBSD: acpitimer.4,v 1.4 2007/01/10 16:14:36 mk Exp $ +.\" +.\" Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd January 7, 2006 +.Dt ACPITIMER 4 +.Os +.Sh NAME +.Nm acpitimer +.Nd ACPI power management timer +.Sh SYNOPSIS +.Cd "acpitimer* at acpi?" +.Sh DESCRIPTION +The +.Nm +driver allows access to a power management timer through the ACPI. +The timer is used as a timecounter for the +.Xr tc_init 9 +framework. +.Sh SEE ALSO +.Xr acpi 4 , +.Xr intro 4 , +.Xr tc_init 9 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 3.8 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Thorsten Lockert Aq tholo@sigmasoft.com . diff --git a/share/man/man4/acpitz.4 b/share/man/man4/acpitz.4 new file mode 100644 index 00000000000..597ba276d7f --- /dev/null +++ b/share/man/man4/acpitz.4 @@ -0,0 +1,55 @@ +.\" $OpenBSD: acpitz.4,v 1.1 2007/01/10 16:14:36 mk Exp $ +.\" +.\" Copyright (c) 2007 Michael Knudsen <mk@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd January 7, 2007 +.Dt ACPITZ 4 +.Os +.Sh NAME +.Nm acpitz +.Nd ACPI Thermal Zones +.Sh SYNOPSIS +.Cd "acpitz* at acpi?" +.Sh DESCRIPTION +The +.Nm +driver supports ACPI Thermal Zones. +Temperature information is available through this driver as a sensor +which is updated every 10 seconds or, if the implementation supports it, +via an event. +If the temperature exceeds the +.Sq critical +temperature threshold, the system will be shut down and powered off. +The sensor provided by +.Nm +can be monitored using +.Xr sysctl 8 +or +.Xr sensorsd 8 . +.Sh SEE ALSO +.Xr intro 4 , +.Xr sensorsd 8 , +.Xr sysctl 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 3.8 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Can Erkin Acar Aq canacar@openbsd.org . |