xref: /freebsd/share/man/man4/acpi_wmi.4 (revision 349cc55c9796c4596a5b9904cd3281af295f878f)
1.\" Copyright (c) 2009 Michael Gmelin
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
12.\"
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
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd September 5, 2019
28.Dt ACPI_WMI 4
29.Os
30.Sh NAME
31.Nm acpi_wmi
32.Nd "ACPI to WMI mapping driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following line in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device acpi_wmi"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45acpi_wmi_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver provides an interface for vendor specific WMI implementations
51(e.g. HP and Acer laptops).
52It creates /dev/wmistat%d, which can be read to get
53information about GUIDs found in the system.
54.Sh FILES
55.Bl -tag -width /dev/wmistat%d -compact
56.It Pa /dev/wmistat%d
57WMI status device.
58.El
59.Sh SYSCTLS
60The following sysctl node is currently implemented:
61.Bl -tag
62.It Va dev.acpi_wmi.%d.bmof
63Managed Object Format (MOF) blob.
64You can obtain human readable output by bmf2mof in bmfdec tool.
65(https://github.com/pali/bmfdec)
66.El
67.Sh EXAMPLES
68.Bd -literal
69# cat /dev/wmistat0
70GUID                                  INST EXPE METH STR EVENT OID
71{5FB7F034-2C63-45E9-BE91-3D44E2C707E4}   1 NO   WMAA NO  NO    AA
72{95F24279-4D7B-4334-9387-ACCDC67EF61C}   1 NO   NO   NO  0x80+ -
73{2B814318-4BE8-4707-9D84-A190A859B5D0}   1 NO   NO   NO  0xA0  -
74{05901221-D566-11D1-B2F0-00A0C9062910}   1 NO   NO   NO  NO    AB
75{1F4C91EB-DC5C-460B-951D-C7CB9B4B8D5E}   1 NO   WMBA NO  NO    BA
76{2D114B49-2DFB-4130-B8FE-4A3C09E75133}  57 NO   NO   NO  NO    BC
77{988D08E3-68F4-4C35-AF3E-6A1B8106F83C}  20 NO   NO   NO  NO    BD
78{14EA9746-CE1F-4098-A0E0-7045CB4DA745}   1 NO   NO   NO  NO    BE
79{322F2028-0F84-4901-988E-015176049E2D}   2 NO   NO   NO  NO    BF
80{8232DE3D-663D-4327-A8F4-E293ADB9BF05}   0 NO   NO   NO  NO    BG
81{8F1F6436-9F42-42C8-BADC-0E9424F20C9A}   0 NO   NO   NO  NO    BH
82{8F1F6435-9F42-42C8-BADC-0E9424F20C9A}   0 NO   NO   NO  NO    BI
83# sysctl -b dev.acpi_wmi.0.bmof |bmf2mof
84[abstract]
85class Lenovo_BIOSElement {
86};
87
88[WMI, Dynamic, Provider("WMIProv"), WmiExpense(1), Description("Bios Setting"),
89GUID("{51F5230E-9677-46cd-A1CF-C0B23EE34DB7}"), Locale("MS\\0x409")]
90class Lenovo_BiosSetting : Lenovo_BiosElement {
91  [key, read] String InstanceName;
92    [read] Boolean Active;
93      [WmiDataId(1), Description("BIOS setting")] String CurrentSetting;
94      };
95   ...
96
97.Ed
98.Sh SEE ALSO
99.Xr acpi 4
100.Sh HISTORY
101The
102.Nm
103device driver first appeared in
104.Fx 8.0 .
105.Sh AUTHORS
106.An -nosplit
107The
108.Nm
109driver was written by
110.An Michael Gmelin Aq Mt freebsd@grem.de .
111.Pp
112Work has been inspired by the Linux acpi-wmi driver written by Carlos Corbacho.
113.Pp
114See http://www.microsoft.com/whdc/system/pnppwr/wmi/wmi-acpi.mspx for
115the specification of ACPI-WMI.
116.Pp
117MOF part has been inspired by the Linux wmi-bmof driver
118written by Andy Lutomirski.
119.Pp
120This manual page was written by
121.An Michael Gmelin Aq Mt freebsd@grem.de .
122