The branch main has been updated by imp:
URL:
https://cgit.FreeBSD.org/src/commit/?id=954ac4049852cc1cf6d6074d9247b67f02b84b12
commit 954ac4049852cc1cf6d6074d9247b67f02b84b12
Author: Alexander Ziaee <zi...@freebsd.org>
AuthorDate: 2024-10-17 05:24:50 +0000
Commit: Warner Losh <i...@freebsd.org>
CommitDate: 2025-06-13 01:21:44 +0000
acpi_wmi.4: fall cleaning
+ add descriptions to existing examples
+ github repo url in sysctls => port named in example using it
+ reword MOF description for consistency with external docs
+ restore standard link, move to STANDARDS
+ grammar and markup nits + tag SPDX
MFC after: 3 days
Reviewed by: imp
Pull Request: https://github.com/freebsd/freebsd-src/pull/1477
Closes: https://github.com/freebsd/freebsd-src/pull/1477
---
share/man/man4/acpi_wmi.4 | 61 ++++++++++++++++++++++++++++-------------------
1 file changed, 37 insertions(+), 24 deletions(-)
diff --git a/share/man/man4/acpi_wmi.4 b/share/man/man4/acpi_wmi.4
index 9ad14ed7892a..e5c5517ba4ac 100644
--- a/share/man/man4/acpi_wmi.4
+++ b/share/man/man4/acpi_wmi.4
@@ -1,3 +1,6 @@
+.\"-
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.\" Copyright (c) 2009 Michael Gmelin
.\" All rights reserved.
.\"
@@ -22,47 +25,45 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd September 5, 2019
+.Dd June 12, 2025
.Dt ACPI_WMI 4
.Os
.Sh NAME
.Nm acpi_wmi
-.Nd "ACPI to WMI mapping driver"
+.Nd ACPI to WMI mapping driver
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following line in your
kernel configuration file:
-.Bd -ragged -offset indent
-.Cd "device acpi_wmi"
-.Ed
+.Pp
+.Dl Cd "device acpi_wmi"
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
-.Bd -literal -offset indent
-acpi_wmi_load="YES"
-.Ed
+.Pp
+.Dl acpi_wmi_load="YES"
.Sh DESCRIPTION
The
.Nm
driver provides an interface for vendor specific WMI implementations
-(e.g. HP and Acer laptops).
-It creates /dev/wmistat%d, which can be read to get
-information about GUIDs found in the system.
+.Pq e.g. HP and Acer laptops .
+It creates
+.Pa /dev/wmistat%d ,
+which can be read to get information about GUIDs found in the system.
.Sh FILES
.Bl -tag -width /dev/wmistat%d -compact
.It Pa /dev/wmistat%d
-WMI status device.
+WMI status devices.
.El
.Sh SYSCTLS
The following sysctl node is currently implemented:
-.Bl -tag
+.Bl -tag -width "dev.acpi_wmi.%d.bmof"
.It Va dev.acpi_wmi.%d.bmof
-Managed Object Format (MOF) blob.
-You can obtain human readable output by bmf2mof in bmfdec tool.
-(https://github.com/pali/bmfdec)
+binary Managed Object Format (MOF) buffer
.El
.Sh EXAMPLES
+Read GUIDs from the first WMI interface found in the system:
.Bd -literal
# cat /dev/wmistat0
GUID INST EXPE METH STR EVENT OID
@@ -78,7 +79,14 @@ GUID INST EXPE METH STR
EVENT OID
{8232DE3D-663D-4327-A8F4-E293ADB9BF05} 0 NO NO NO NO BG
{8F1F6436-9F42-42C8-BADC-0E9424F20C9A} 0 NO NO NO NO BH
{8F1F6435-9F42-42C8-BADC-0E9424F20C9A} 0 NO NO NO NO BI
-# sysctl -b dev.acpi_wmi.0.bmof |bmf2mof
+.Ed
+.Pp
+Read first WMI interface description with
+.Sy bmf2mof
+from
+.Pa ports/converters/bmfdec :
+.Bd -literal
+# sysctl -b dev.acpi_wmi.0.bmof | bmf2mof
[abstract]
class Lenovo_BIOSElement {
};
@@ -91,10 +99,15 @@ class Lenovo_BiosSetting : Lenovo_BiosElement {
[WmiDataId(1), Description("BIOS setting")] String CurrentSetting;
};
...
-
.Ed
.Sh SEE ALSO
.Xr acpi 4
+.Sh STANDARDS
+.Rs
+.%T Windows Instrumentation: WMI and ACPI
+.%I Microsoft Corporation
+.%U https://github.com/microsoft/Windows-driver-samples/tree/main/wmi/wmiacpi
+.Re
.Sh HISTORY
The
.Nm
@@ -107,13 +120,13 @@ The
driver was written by
.An Michael Gmelin Aq Mt free...@grem.de .
.Pp
-Work has been inspired by the Linux acpi-wmi driver written by Carlos Corbacho.
-.Pp
-See http://www.microsoft.com/whdc/system/pnppwr/wmi/wmi-acpi.mspx for
-the specification of ACPI-WMI.
+Work inspired by the Linux
+.Sy acpi-wmi
+driver written by Carlos Corbacho.
.Pp
-MOF part has been inspired by the Linux wmi-bmof driver
-written by Andy Lutomirski.
+MOF handling inspired by the Linux
+.Sy wmi-bmof
+driver written by Andy Lutomirski.
.Pp
This manual page was written by
.An Michael Gmelin Aq Mt free...@grem.de .
