xref: /freebsd/share/man/man4/acpi_rapidstart.4 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\" Copyright (c) 2013 Takanori Watanabe
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd May 8, 2013
26.Dt ACPI_RAPIDSTART 4
27.Os
28.Sh NAME
29.Nm acpi_rapidstart
30.Nd "Intel rapid start technology ACPI driver"
31.Sh SYNOPSIS
32To compile this driver into the kernel,
33place the following line in your
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device acpi_rapidstart"
37.Ed
38.Pp
39Alternatively, to load the driver as a
40module at boot time, place the following line in
41.Xr loader.conf 5 :
42.Bd -literal -offset indent
43acpi_rapidstart_load="YES"
44.Ed
45.Sh DESCRIPTION
46The
47.Nm
48driver provides support for Intel Rapid Start technology ACPI device interface.
49Note that this is only for the ACPI device interface.
50This has _CID PNP0C02 so it should be loaded at boot time to avoid attaching
51to the acpi_sysresource driver.
52.Sh SYSCTLS
53The following
54.Xr sysctl 8
55nodes are currently implemented:
56.Bl -tag -width indent
57.It Va dev.acpi_rapidstart.0.ffs
58Rapid start flag.
59It is a bitwise OR of the following:
60.Pp
61.Bl -tag -width indent-two -compact
62.It Li 1
63Enter Fast Flash Standby in RTC wake.
64.It Li 2
65Enter Fast Flash Standby in Critical Battery Wake enable
66.El
67.It Va dev.acpi_rapidstart.0.ftv
68Fast Flash Standby timer value in minutes.
69.El
70.Sh SEE ALSO
71.Xr acpi 4 ,
72.Xr sysctl 8
73.Sh HISTORY
74The
75.Nm
76driver first appeared in
77.Fx 10.0 .
78.Sh AUTHORS
79The
80.Nm
81driver was written by
82.An Takanori Watanabe Aq Mt takawata@FreeBSD.org .
83