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
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,
58 through which applications can determine and change the status of
59 various laptop components and BIOS settings.
62 Devd events received by
64 provide the following information:
66 .Bl -tag -width "subsystem" -offset indent -compact
72 The source of the event in the ACPI namespace.
73 The value depends on the model.
75 Event code (see below).
80 .Bl -tag -width "0xc0" -offset indent -compact
82 WLAN on air status changed to 0 (not on air)
84 WLAN on air status changed to 1 (on air)
86 Bluetooth on air status changed to 0 (not on air)
88 Bluetooth on air status changed to 1 (on air)
90 WWAN on air status changed to 0 (not on air)
92 WWAN on air status changed to 1 (on air)
95 You can read /dev/hpcmi to see your current BIOS settings.
96 The detail level can be adjusted by setting the sysctl
100 The following sysctls are currently implemented:
102 .Bl -tag -width indent
103 .It Va dev.acpi_hp.0.wlan_enabled
104 Toggle WLAN chip activity.
105 .It Va dev.acpi_hp.0.wlan_radio
107 WLAN radio status (controlled by hardware switch)
108 .It Va dev.acpi_hp.0.wlan_on_air
110 WLAN on air (chip enabled, hardware switch enabled + enabled in BIOS)
111 .It Va dev.acpi_hp.0.wlan_enabled_if_radio_on
112 If set to 1, the WLAN chip will be enabled if the radio is turned on
113 .It Va dev.acpi_hp.0.wlan_disable_if_radio_off
114 If set to 1, the WLAN chip will be disabled if the radio is turned off
117 .Bl -tag -width indent
118 .It Va dev.acpi_hp.0.bt_enabled
119 Toggle Bluetooth chip activity.
120 .It Va dev.acpi_hp.0.bt_radio
122 Bluetooth radio status (controlled by hardware switch)
123 .It Va dev.acpi_hp.0.bt_on_air
125 Bluetooth on air (chip enabled, hardware switch enabled + enabled in BIOS)
126 .It Va dev.acpi_hp.0.bt_enabled_if_radio_on
127 If set to 1, the Bluetooth chip will be enabled if the radio is turned on
128 .It Va dev.acpi_hp.0.bt_disable_if_radio_off
129 If set to 1, the Bluetooth chip will be disabled if the radio is turned off
132 .Bl -tag -width indent
133 .It Va dev.acpi_hp.0.wwan_enabled
134 Toggle WWAN chip activity.
135 .It Va dev.acpi_hp.0.wwan_radio
137 WWAN radio status (controlled by hardware switch)
138 .It Va dev.acpi_hp.0.wwan_on_air
140 WWAN on air (chip enabled, hardware switch enabled + enabled in BIOS)
141 .It Va dev.acpi_hp.0.wwan_enabled_if_radio_on
142 If set to 1, the WWAN chip will be enabled if the radio is turned on
143 .It Va dev.acpi_hp.0.wwan_disable_if_radio_off
144 If set to 1, the WWAN chip will be disabled if the radio is turned off
147 .Bl -tag -width indent
148 .It Va dev.acpi_hp.0.als_enabled
149 Toggle ambient light sensor (ALS)
150 .It Va dev.acpi_hp.0.display
152 Display status (bitmask)
153 .It Va dev.acpi_hp.0.hdd_temperature
156 .It Va dev.acpi_hp.0.is_docked
158 Docking station status (1 if docked)
159 .It Va dev.acpi_hp.0.cmi_detail
160 Bitmask to control detail level in /dev/hpcmi output (values can be ORed).
161 .Bl -tag -width "0x01" -offset indent -compact
163 Show path component of BIOS setting
165 Show a list of valid options for the BIOS setting
167 Show additional flags of BIOS setting (ReadOnly etc.)
169 Query highest BIOS entry instance.
170 This is broken on many HP models and therefore disabled by default.
172 .It Va dev.acpi_hp.0.verbose
177 Defaults for these sysctls can be set in
182 driver has been reported to support the following hardware:
191 It should work on most HP laptops that feature a WMI enabled BIOS.
193 .Bl -tag -width ".Pa /dev/hpcmi"
195 Interface to read BIOS settings
198 The following can be added to
200 in order disable the LAN interface when WLAN on air and reenable if it is not:
201 .Bd -literal -offset indent
203 match "system" "ACPI";
204 match "subsystem" "HP";
205 match "notify" "0xc0";
206 action "ifconfig em0 up";
210 match "system" "ACPI";
211 match "subsystem" "HP";
212 match "notify" "0xc1";
213 action "ifconfig em0 down";
217 Enable the ambient light sensor:
218 .Bd -literal -offset indent
219 sysctl dev.acpi_hp.0.als_enabled=1
223 .Bd -literal -offset indent
224 sysctl dev.acpi_hp.0.bt_enabled=1
228 .Bd -literal -offset indent
233 Parallel Port Disable
234 Flash Media Reader Disable
235 USB Ports including Express Card slot Enable
238 Express Card Slot Disable
242 Set maximum detail level for /dev/hpcmi output:
243 .Bd -literal -offset indent
244 sysctl dev.acpi_hp.0.cmi_detail=7
256 device driver first appeared in
262 driver was written by
263 .An Michael Gmelin Aq freebsd@grem.de .
265 It has been inspired by hp-wmi driver, which implements a subset of these
266 features (hotkeys) on Linux.
267 .Bl -tag -width indent
268 .It HP CMI whitepaper:
269 http://h20331.www2.hp.com/Hpsub/downloads/cmi_whitepaper.pdf
270 .It wmi-hp for Linux:
271 http://www.kernel.org
273 http://www.microsoft.com/whdc/system/pnppwr/wmi/wmi-acpi.mspx
276 This manual page was written by
277 .An Michael Gmelin Aq freebsd@grem.de .
279 This driver is experimental and has only been tested on i386 on an
280 HP Compaq 8510p which featured all supported wireless devices (WWAN/BT/WLAN).
281 Expect undefined results when operating on different hardware.
283 Loading the driver is slow.
288 Additional features like HP specific sensor readings or writing BIOS
289 settings are not supported.