share/man/man4/acpi_toshiba.4

   1 .\"
   2 .\" Copyright (c) 2003 Philip Paeps <philip@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man4/man4.i386/acpi_toshiba.4,v 1.7.8.1 2009/04/15 03:14:26 kensmith Exp $
  27 .\"
  28 .Dd November 11, 2009
  29 .Dt ACPI_TOSHIBA 4
  30 .Os
  31 .Sh NAME
  32 .Nm acpi_toshiba
  33 .Nd Toshiba HCI interface
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following line in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device acpi_toshiba"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 acpi_toshiba_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 HCI is Toshiba's
  50 .Em "Hardware Control Interface"
  51 which is somewhat uniform across their models.
  52 The
  53 .Nm
  54 driver allows the user to manipulate HCI-controlled hardware using a number of
  55 .Xr sysctl 8
  56 variables.
  57 .Sh SYSCTL VARIABLES
  58 The following sysctls are currently implemented:
  59 .Bl -tag -width indent
  60 .It Va hw.acpi.toshiba.force_fan
  61 Causes active cooling to be forcibly enabled
  62 .Pq Ql 1
  63 or disabled
  64 .Pq Ql 0
  65 regardless of the current temperature.
  66 .It Va hw.acpi.toshiba.video_output
  67 Sets the active display to use according to a bitwise OR of the following:
  68 .Pp
  69 .Bl -tag -width indent -compact
  70 .It Li 0
  71 No display
  72 .It Li 1
  73 LCD
  74 .It Li 2
  75 CRT
  76 .It Li 4
  77 TV-Out
  78 .El
  79 .Pp
  80 Only some systems (i.e., the Libretto L5) support video switching via
  81 this hardware-specific driver.
  82 Use the
  83 .Xr acpi_video 4
  84 driver for generic video output support.
  85 .It Va hw.acpi.toshiba.lcd_brightness
  86 Makes the LCD backlight brighter or dimmer (higher values are brighter).
  87 .It Va hw.acpi.toshiba.lcd_backlight
  88 Turns the LCD backlight on and off.
  89 .It Va hw.acpi.toshiba.cpu_speed
  90 Sets the CPU speed to the specified speed.
  91 This provides functionality similar to the
  92 .Va hw.acpi.cpu.throttle_state
  93 variable.
  94 Higher sysctl values mean lower CPU speeds.
  95 .El
  96 .Pp
  97 Defaults for these variables can be set in
  98 .Xr sysctl.conf 5 ,
  99 which is parsed at boot-time.
 100 .Sh LOADER TUNABLES
 101 The
 102 .Va hw.acpi.toshiba.enable_fn_keys
 103 tunable enables or disables the function keys on the keyboard.
 104 Function keys are enabled by default.
 105 .Pp
 106 This behaviour can be changed at the
 107 .Xr loader 8
 108 prompt or in
 109 .Xr loader.conf 5 .
 110 .Sh SEE ALSO
 111 .Xr acpi 4 ,
 112 .Xr acpi_video 4 ,
 113 .Xr loader.conf 5 ,
 114 .Xr sysctl.conf 5 ,
 115 .Xr sysctl 8
 116 .Sh HISTORY
 117 The
 118 .Nm
 119 driver first appeared in
 120 .Fx 5.1 .
 121 .Sh AUTHORS
 122 .An -nosplit
 123 The
 124 .Nm
 125 driver was written by
 126 .An Hiroyuki Aizu Aq aizu@navi.org .
 127 This manual page was written by
 128 .An Philip Paeps Aq philip@FreeBSD.org .