xref: /freebsd/share/man/man4/acpi_toshiba.4 (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
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.Dd February 8, 2010
27.Dt ACPI_TOSHIBA 4
28.Os
29.Sh NAME
30.Nm acpi_toshiba
31.Nd Toshiba HCI interface
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following line in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device acpi_toshiba"
38.Ed
39.Pp
40Alternatively, to load the driver as a
41module at boot time, place the following line in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44acpi_toshiba_load="YES"
45.Ed
46.Sh DESCRIPTION
47HCI is Toshiba's
48.Em "Hardware Control Interface"
49which is somewhat uniform across their models.
50The
51.Nm
52driver allows the user to manipulate HCI-controlled hardware using a number of
53.Xr sysctl 8
54variables.
55.Sh SYSCTL VARIABLES
56The following sysctls are currently implemented:
57.Bl -tag -width indent
58.It Va hw.acpi.toshiba.force_fan
59Causes active cooling to be forcibly enabled
60.Pq Ql 1
61or disabled
62.Pq Ql 0
63regardless of the current temperature.
64.It Va hw.acpi.toshiba.video_output
65Sets the active display to use according to a bitwise OR of the following:
66.Pp
67.Bl -tag -width indent -compact
68.It Li 0
69No display
70.It Li 1
71LCD
72.It Li 2
73CRT
74.It Li 4
75TV-Out
76.El
77.Pp
78Only some systems (i.e., the Libretto L5) support video switching via
79this hardware-specific driver.
80Use the
81.Xr acpi_video 4
82driver for generic video output support.
83.It Va hw.acpi.toshiba.lcd_brightness
84Makes the LCD backlight brighter or dimmer (higher values are brighter).
85.It Va hw.acpi.toshiba.lcd_backlight
86Turns the LCD backlight on and off.
87.It Va hw.acpi.toshiba.cpu_speed
88Sets the CPU speed to the specified speed.
89This provides functionality similar to the
90.Va hw.acpi.cpu.throttle_state
91variable.
92Higher sysctl values mean lower CPU speeds.
93.El
94.Pp
95Defaults for these variables can be set in
96.Xr sysctl.conf 5 ,
97which is parsed at boot-time.
98.Sh LOADER TUNABLES
99The
100.Va hw.acpi.toshiba.enable_fn_keys
101tunable enables or disables the function keys on the keyboard.
102Function keys are enabled by default.
103.Pp
104This behaviour can be changed at the
105.Xr loader 8
106prompt or in
107.Xr loader.conf 5 .
108.Sh SEE ALSO
109.Xr acpi 4 ,
110.Xr acpi_video 4 ,
111.Xr loader.conf 5 ,
112.Xr sysctl.conf 5 ,
113.Xr sysctl 8
114.Sh HISTORY
115The
116.Nm
117driver first appeared in
118.Fx 5.1 .
119.Sh AUTHORS
120.An -nosplit
121The
122.Nm
123driver was written by
124.An Hiroyuki Aizu Aq Mt aizu@navi.org .
125This manual page was written by
126.An Philip Paeps Aq Mt philip@FreeBSD.org .
127