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