xref: /dragonfly/share/man/man4/acpi_panasonic.4 (revision 63e03116)
1.\"
2.\" Copyright (c) 2004 OGAWA Takaya <t-ogawa@triaez.kaisei.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/acpi_panasonic.4,v 1.2 2009/09/17 13:12:24 brueffer Exp $
27.\"
28.Dd November 11, 2009
29.Dt ACPI_PANASONIC 4
30.Os
31.Sh NAME
32.Nm acpi_panasonic
33.Nd "ACPI hotkey driver for Panasonic laptops"
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following line in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device acpi_panasonic"
40.Ed
41.Pp
42Alternatively, to load the driver as a
43module at boot time, place the following line in
44.Xr loader.conf 5 :
45.Bd -literal -offset indent
46acpi_panasonic_load="YES"
47.Ed
48.Sh DESCRIPTION
49The
50.Nm
51driver enables such hotkey facilities of various Panasonic laptops as
52changing LCD brightness, controlling mixer volumes, entering sleep or
53suspended state and so on.
54On the following models it is reported to work: Let's note (or
55Toughbook, outside Japan) CF-R1N, CF-R2A and CF-R3.
56It may also work on other models as well.
57.Pp
58The driver consists of three functionalities.
59The first is to detect hotkey events and take corresponding actions,
60which include changing LCD luminance and speaker mute state.
61The second role is to notify occurrences of the event by way of
62.Xr devctl 4
63and eventually to
64.Xr devd 8 .
65The third and last is to provide a way to adjust LCD brightness and
66sound mute state via
67.Xr sysctl 8 .
68.Ss Hotkeys
69There are 9 hotkeys available on the supported hardware:
70.Pp
71.Bl -tag -compact -offset indent -width ".Sy Fn+F10"
72.It Sy Fn+F1
73Make LCD backlight darker.
74.It Sy Fn+F2
75Make LCD backlight brighter.
76.It Sy Fn+F3
77Switch video output between LCD and CRT.
78Not supported by the
79.Nm
80driver.
81.It Sy Fn+F4
82Toggle muting the speaker.
83.It Sy Fn+F5
84Turn the mixer volume down.
85.It Sy Fn+F6
86Turn the mixer volume up.
87.It Sy Fn+F7
88Enter suspend-to-RAM state.
89.It Sy Fn+F9
90Show battery status.
91.It Sy Fn+F10
92Enter suspend-to-disk state.
93.El
94.Pp
95Actions are automatically taken within the driver for
96.Sy Fn+F1 , Fn+F2
97and
98.Sy Fn+F4 .
99For the other events such as
100mixer control and showing battery status,
101.Xr devd 8
102should take the role as described below.
103.Ss Eo
104.Xr devd 8
105Events
106.Ec
107When notified to
108.Xr devd 8 ,
109the hotkey event provides the following information:
110.Pp
111.Bl -tag -compact -offset indent -width "subsystem"
112.It system
113.Qq Li ACPI
114.It subsystem
115.Qq Li Panasonic
116.It type
117The source of the event in ACPI namespace.
118The value depends on the model but typically
119.Qq Li \e_SB_.HKEY .
120.It notify
121Event code (see below).
122.El
123.Pp
124Event codes to be generated are assigned as follows:
125.Bl -tag -offset indent -width "0x01-0x07, 0x09, 0x1a"
126.It 0x81-0x86, 0x89
127.Sy Fn+F<n>
128pressed.
1290x81 corresponds to
130.Sy Fn+F1 ,
1310x82 corresponds to
132.Sy Fn+F2 ,
133and so on.
134.It 0x01-0x07, 0x09, 0x1a
135.Sy Fn+F<n>
136released.
1370x01 corresponds to
138.Sy Fn+F1 ,
1390x02 corresponds to
140.Sy Fn+F2 ,
141and so on.
142.El
143.Sh SYSCTL VARIABLES
144The following MIBs are available:
145.Bl -tag -width indent
146.It Va hw.acpi.panasonic.lcd_brightness_max
147The maximum level of brightness.
148The value is read only and
149automatically set according to hardware model.
150.It Va hw.acpi.panasonic.lcd_brightness_min
151The minimum level of brightness.
152The value is read only and
153automatically set according to hardware model.
154.It Va hw.acpi.panasonic.lcd_brightness
155Current brightness level of the LCD (read-write).
156The value ranges from
157.Va hw.acpi.panasonic.lcd_brightness_min
158to
159.Va hw.acpi.panasonic.lcd_brightness_max .
160.It Va hw.acpi.panasonic.sound_mute
161A read-write boolean flag to control whether to mute the speaker.
162The value 1 means to mute and 0 not.
163.El
164.Sh SEE ALSO
165.Xr acpi 4 ,
166.Xr devd.conf 5 ,
167.Xr devd 8 ,
168.Xr sysctl 8
169.Sh HISTORY
170The
171.Nm
172driver first appeared in
173.Fx 5.3 .
174It was then ported to
175.Dx 2.5 .
176.Sh AUTHORS
177.An -nosplit
178The
179.Nm
180driver and this manual page were written by
181.An OGAWA Takaya Aq Mt t-ogawa@triaez.kaisei.org
182and
183.An TAKAHASHI Yoshihiro Aq Mt nyan@FreeBSD.org .
184