xref: /freebsd/share/man/man4/acpi_panasonic.4 (revision 2f02600abfddfc4e9f20dd384a2e729b451e16bd)
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$
27.\"
28.Dd February 25, 2012
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 -width 10n -compact -offset indent
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 Xr devd 8 Ss Events
104When notified to
105.Xr devd 8 ,
106the hotkey event provides the following information:
107.Pp
108.Bl -tag -width 10n -compact -offset indent
109.It system
110.Qq Li ACPI
111.It subsystem
112.Qq Li Panasonic
113.It type
114The source of the event in ACPI namespace.
115The value depends on the model but typically
116.Qq Li \e_SB_.HKEY .
117.It notify
118Event code (see below).
119.El
120.Pp
121Event codes to be generated are assigned as follows:
122.Bl -tag -width 10n -offset indent
123.It 0x81-0x86, 0x89
124.Sy Fn+F<n>
125pressed.
1260x81 corresponds to
127.Sy Fn+F1 ,
1280x82 corresponds to
129.Sy Fn+F2 ,
130and so on.
131.It 0x01-0x07, 0x09, 0x1a
132.Sy Fn+F<n>
133released.
1340x01 corresponds to
135.Sy Fn+F1 ,
1360x02 corresponds to
137.Sy Fn+F2 ,
138and so on.
139.El
140.Sh SYSCTL VARIABLES
141The following MIBs are available:
142.Bl -tag -width indent
143.It Va hw.acpi.panasonic.lcd_brightness_max
144The maximum level of brightness.
145The value is read only and
146automatically set according to hardware model.
147.It Va hw.acpi.panasonic.lcd_brightness_min
148The minimum level of brightness.
149The value is read only and
150automatically set according to hardware model.
151.It Va hw.acpi.panasonic.lcd_brightness
152Current brightness level of the LCD (read-write).
153The value ranges from
154.Va hw.acpi.panasonic.lcd_brightness_min
155to
156.Va hw.acpi.panasonic.lcd_brightness_max .
157.It Va hw.acpi.panasonic.sound_mute
158A read-write boolean flag to control whether to mute the speaker.
159The value 1 means to mute and 0 not.
160.El
161.Sh SEE ALSO
162.Xr acpi 4 ,
163.Xr devd.conf 5 ,
164.Xr devd 8 ,
165.Xr sysctl 8
166.Sh HISTORY
167The
168.Nm
169driver first appeared in
170.Fx 5.3 .
171.Sh AUTHORS
172.An -nosplit
173The
174.Nm
175driver and this manual page were written by
176.An OGAWA Takaya Aq t\-ogawa@triaez.kaisei.org
177and
178.An TAKAHASHI Yoshihiro Aq nyan@FreeBSD.org .
179