xref: /freebsd/share/man/man4/acpi_wmi.4 (revision 328110da2661a8841f12000b99fea27ceacdd5b2)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2009 Michael Gmelin
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd June 12, 2025
29.Dt ACPI_WMI 4
30.Os
31.Sh NAME
32.Nm acpi_wmi
33.Nd ACPI to WMI mapping driver
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following line in your
37kernel configuration file:
38.Pp
39.Dl Cd "device acpi_wmi"
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Pp
45.Dl acpi_wmi_load="YES"
46.Sh DESCRIPTION
47The
48.Nm
49driver provides an interface for vendor specific WMI implementations
50.Pq e.g. HP and Acer laptops .
51It creates
52.Pa /dev/wmistat%d ,
53which can be read to get information 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 devices.
58.El
59.Sh SYSCTLS
60The following sysctl node is currently implemented:
61.Bl -tag -width "dev.acpi_wmi.%d.bmof"
62.It Va dev.acpi_wmi.%d.bmof
63binary Managed Object Format (MOF) buffer
64.El
65.Sh EXAMPLES
66Read GUIDs from the first WMI interface found in the system:
67.Bd -literal
68# cat /dev/wmistat0
69GUID                                  INST EXPE METH STR EVENT OID
70{5FB7F034-2C63-45E9-BE91-3D44E2C707E4}   1 NO   WMAA NO  NO    AA
71{95F24279-4D7B-4334-9387-ACCDC67EF61C}   1 NO   NO   NO  0x80+ -
72{2B814318-4BE8-4707-9D84-A190A859B5D0}   1 NO   NO   NO  0xA0  -
73{05901221-D566-11D1-B2F0-00A0C9062910}   1 NO   NO   NO  NO    AB
74{1F4C91EB-DC5C-460B-951D-C7CB9B4B8D5E}   1 NO   WMBA NO  NO    BA
75{2D114B49-2DFB-4130-B8FE-4A3C09E75133}  57 NO   NO   NO  NO    BC
76{988D08E3-68F4-4C35-AF3E-6A1B8106F83C}  20 NO   NO   NO  NO    BD
77{14EA9746-CE1F-4098-A0E0-7045CB4DA745}   1 NO   NO   NO  NO    BE
78{322F2028-0F84-4901-988E-015176049E2D}   2 NO   NO   NO  NO    BF
79{8232DE3D-663D-4327-A8F4-E293ADB9BF05}   0 NO   NO   NO  NO    BG
80{8F1F6436-9F42-42C8-BADC-0E9424F20C9A}   0 NO   NO   NO  NO    BH
81{8F1F6435-9F42-42C8-BADC-0E9424F20C9A}   0 NO   NO   NO  NO    BI
82.Ed
83.Pp
84Read first WMI interface description with
85.Sy bmf2mof
86from
87.Pa ports/converters/bmfdec :
88.Bd -literal
89# sysctl -b dev.acpi_wmi.0.bmof | bmf2mof
90[abstract]
91class Lenovo_BIOSElement {
92};
93
94[WMI, Dynamic, Provider("WMIProv"), WmiExpense(1), Description("Bios Setting"),
95GUID("{51F5230E-9677-46cd-A1CF-C0B23EE34DB7}"), Locale("MS\\0x409")]
96class Lenovo_BiosSetting : Lenovo_BiosElement {
97  [key, read] String InstanceName;
98    [read] Boolean Active;
99      [WmiDataId(1), Description("BIOS setting")] String CurrentSetting;
100      };
101   ...
102.Ed
103.Sh SEE ALSO
104.Xr acpi 4
105.Sh STANDARDS
106.Rs
107.%T Windows Instrumentation: WMI and ACPI
108.%I Microsoft Corporation
109.%U https://github.com/microsoft/Windows-driver-samples/tree/main/wmi/wmiacpi
110.Re
111.Sh HISTORY
112The
113.Nm
114device driver first appeared in
115.Fx 8.0 .
116.Sh AUTHORS
117.An -nosplit
118The
119.Nm
120driver was written by
121.An Michael Gmelin Aq Mt freebsd@grem.de .
122.Pp
123Work inspired by the Linux
124.Sy acpi-wmi
125driver written by Carlos Corbacho.
126.Pp
127MOF handling inspired by the Linux
128.Sy wmi-bmof
129driver written by Andy Lutomirski.
130.Pp
131This manual page was written by
132.An Michael Gmelin Aq Mt freebsd@grem.de .
133