1 .\" Copyright (c) 2009 Michael Gmelin
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: src/share/man/man4/acpi_hp.4,v 1.4 2009/07/03 21:12:37 rpaulo Exp $
32 .Nd "ACPI extras driver for HP laptops"
34 To compile this driver into the kernel,
35 place the following line in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
41 Alternatively, to load the driver as a
42 module at boot time, place the following line in
44 .Bd -literal -offset indent
50 driver provides support for ACPI-controlled features found on HP laptops
51 that use a WMI enabled BIOS (e.g. HP Compaq 8510p and 6510p).
53 The main purpose of this driver is to provide an interface,
59 through which applications can determine and change the status of
60 various laptop components and BIOS settings.
62 .Ss Xr devd 8 Ss Events
63 Devd events received by
65 provide the following information:
67 .Bl -tag -width "subsystem" -offset indent -compact
73 The source of the event in the ACPI namespace.
74 The value depends on the model.
76 Event code (see below).
81 .Bl -tag -width "0xc0" -offset indent -compact
83 WLAN on air status changed to 0 (not on air)
85 WLAN on air status changed to 1 (on air)
87 Bluetooth on air status changed to 0 (not on air)
89 Bluetooth on air status changed to 1 (on air)
91 WWAN on air status changed to 0 (not on air)
93 WWAN on air status changed to 1 (on air)
95 .Ss Xr devfs 8 Ss Device
96 You can read /dev/hpcmi to see your current BIOS settings.
97 The detail level can be adjusted by setting the sysctl
101 The following sysctls are currently implemented:
103 .Bl -tag -width indent
104 .It Va dev.acpi_hp.0.wlan_enabled
105 Toggle WLAN chip activity.
106 .It Va dev.acpi_hp.0.wlan_radio
108 WLAN radio status (controlled by hardware switch)
109 .It Va dev.acpi_hp.0.wlan_on_air
111 WLAN on air (chip enabled, hardware switch enabled + enabled in BIOS)
112 .It Va dev.acpi_hp.0.wlan_enabled_if_radio_on
113 If set to 1, the WLAN chip will be enabled if the radio is turned on
114 .It Va dev.acpi_hp.0.wlan_disable_if_radio_off
115 If set to 1, the WLAN chip will be disabled if the radio is turned off
118 .Bl -tag -width indent
119 .It Va dev.acpi_hp.0.bt_enabled
120 Toggle Bluetooth chip activity.
121 .It Va dev.acpi_hp.0.bt_radio
123 Bluetooth radio status (controlled by hardware switch)
124 .It Va dev.acpi_hp.0.bt_on_air
126 Bluetooth on air (chip enabled, hardware switch enabled + enabled in BIOS)
127 .It Va dev.acpi_hp.0.bt_enabled_if_radio_on
128 If set to 1, the Bluetooth chip will be enabled if the radio is turned on
129 .It Va dev.acpi_hp.0.bt_disable_if_radio_off
130 If set to 1, the Bluetooth chip will be disabled if the radio is turned off
133 .Bl -tag -width indent
134 .It Va dev.acpi_hp.0.wwan_enabled
135 Toggle WWAN chip activity.
136 .It Va dev.acpi_hp.0.wwan_radio
138 WWAN radio status (controlled by hardware switch)
139 .It Va dev.acpi_hp.0.wwan_on_air
141 WWAN on air (chip enabled, hardware switch enabled + enabled in BIOS)
142 .It Va dev.acpi_hp.0.wwan_enabled_if_radio_on
143 If set to 1, the WWAN chip will be enabled if the radio is turned on
144 .It Va dev.acpi_hp.0.wwan_disable_if_radio_off
145 If set to 1, the WWAN chip will be disabled if the radio is turned off
148 .Bl -tag -width indent
149 .It Va dev.acpi_hp.0.als_enabled
150 Toggle ambient light sensor (ALS)
151 .It Va dev.acpi_hp.0.display
153 Display status (bitmask)
154 .It Va dev.acpi_hp.0.hdd_temperature
157 .It Va dev.acpi_hp.0.is_docked
159 Docking station status (1 if docked)
160 .It Va dev.acpi_hp.0.cmi_detail
161 Bitmask to control detail level in /dev/hpcmi output (values can be ORed).
162 .Bl -tag -width "0x01" -offset indent -compact
164 Show path component of BIOS setting
166 Show a list of valid options for the BIOS setting
168 Show additional flags of BIOS setting (ReadOnly etc.)
170 Query highest BIOS entry instance.
171 This is broken on many HP models and therefore disabled by default.
173 .It Va dev.acpi_hp.0.verbose
178 Defaults for these sysctls can be set in
183 driver has been reported to support the following hardware:
192 It should work on most HP laptops that feature a WMI enabled BIOS.
194 .Bl -tag -width ".Pa /dev/hpcmi"
196 Interface to read BIOS settings
199 The following can be added to
201 in order disable the LAN interface when WLAN on air and reenable if it's
203 .Bd -literal -offset indent
205 match "system" "ACPI";
206 match "subsystem" "HP";
207 match "notify" "0xc0";
208 action "ifconfig em0 up";
212 match "system" "ACPI";
213 match "subsystem" "HP";
214 match "notify" "0xc1";
215 action "ifconfig em0 down";
219 Enable the ambient light sensor:
220 .Bd -literal -offset indent
221 sysctl dev.acpi_hp.0.als_enabled=1
225 .Bd -literal -offset indent
226 sysctl dev.acpi_hp.0.bt_enabled=1
230 .Bd -literal -offset indent
235 Parallel Port Disable
236 Flash Media Reader Disable
237 USB Ports including Express Card slot Enable
240 Express Card Slot Disable
244 Set maximum detail level for /dev/hpcmi output:
245 .Bd -literal -offset indent
246 sysctl dev.acpi_hp.0.cmi_detail=7
259 device driver was ported from
267 driver was written by
268 .An Michael Gmelin Aq freebsd@grem.de
270 It has been inspired by hp-wmi driver, which implements a subset of these
271 features (hotkeys) on Linux.
273 .Bl -tag -width indent
274 .It HP CMI whitepaper:
275 http://h20331.www2.hp.com/Hpsub/downloads/cmi_whitepaper.pdf
276 .It wmi-hp for Linux:
277 http://www.kernel.org
279 http://www.microsoft.com/whdc/system/pnppwr/wmi/wmi-acpi.mspx
282 This manual page was written by
283 .An Michael Gmelin Aq freebsd@grem.de
285 This driver is experimental and has only been tested on CURRENT i386 on an
286 HP Compaq 8510p which featured all supported wireless devices (WWAN/BT/WLAN).
287 Expect undefined results when operating on different hardware.
289 Loading the driver is slow. Reading from /dev/hpcmi is even slower.
291 Additional features like HP specific sensor readings or writing BIOS
292 settings are not supported.