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