share/man/man4/acpi_rapidstart.4

   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 .\" $FreeBSD$
  26 .\"
  27 .Dd May 8, 2013
  28 .Dt ACPI_RAPIDSTART 4
  29 .Os
  30 .Sh NAME
  31 .Nm acpi_rapidstart
  32 .Nd "Intel rapid start technology ACPI driver"
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following line in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device acpi_rapidstart"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 acpi_rapidstart_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 driver provides support for Intel Rapid Start technology ACPI device interface.
  51 Note that this is only for the ACPI device interface.
  52 This has _CID PNP0C02 so it should be loaded at boot time to avoid attaching
  53 to the acpi_sysresource driver.
  54 .Sh SYSCTLS
  55 The following
  56 .Xr sysctl 8
  57 nodes are currently implemented:
  58 .Bl -tag -width indent
  59 .It Va dev.acpi_rapidstart.0.ffs
  60 Rapid start flag.
  61 It is a bitwise OR of the following:
  62 .Pp
  63 .Bl -tag -width indent-two -compact
  64 .It Li 1
  65 Enter Fast Flash Standby in RTC wake.
  66 .It Li 2
  67 Enter Fast Flash Standby in Critical Battery Wake enable
  68 .El
  69 .It Va dev.acpi_rapidstart.0.ftv
  70 Fast Flash Standby timer value in minutes.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr acpi 4 ,
  74 .Xr sysctl 8
  75 .Sh HISTORY
  76 The
  77 .Nm
  78 driver first appeared in
  79 .Fx 10.0 .
  80 .Sh AUTHORS
  81 The
  82 .Nm
  83 driver was written by
  84 .An Takanori Watanabe Aq takawata@FreeBSD.org .