diff options
| author | Armin Wolf <W_Armin@gmx.de> | 2023-04-25 00:29:39 +0200 |
|---|---|---|
| committer | Hans de Goede <hdegoede@redhat.com> | 2023-05-09 11:54:42 +0200 |
| commit | bf4f93c4ca4b6f41e81e83131cf9458d27cf62ee (patch) | |
| tree | f0036524fbe1ab3d1e7392abc997e0f8db1b6807 /Documentation/wmi | |
| parent | e8f8b448c168d7f2f93c9586cf789dee5d61182d (diff) | |
| download | linux-bf4f93c4ca4b6f41e81e83131cf9458d27cf62ee.tar.gz linux-bf4f93c4ca4b6f41e81e83131cf9458d27cf62ee.tar.bz2 linux-bf4f93c4ca4b6f41e81e83131cf9458d27cf62ee.zip | |
platform/x86: wmi: Add device specific documentation
Add a place for device-specific documentation of WMI drivers.
The first entry is documentation for the wmi-bmof driver, with
additional documentation being expected to follow.
Signed-off-by: Armin Wolf <W_Armin@gmx.de>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230424222939.208137-5-W_Armin@gmx.de
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Diffstat (limited to 'Documentation/wmi')
| -rw-r--r-- | Documentation/wmi/devices/index.rst | 22 | ||||
| -rw-r--r-- | Documentation/wmi/devices/wmi-bmof.rst | 25 | ||||
| -rw-r--r-- | Documentation/wmi/index.rst | 1 |
3 files changed, 48 insertions, 0 deletions
diff --git a/Documentation/wmi/devices/index.rst b/Documentation/wmi/devices/index.rst new file mode 100644 index 000000000000..c08735a9d7df --- /dev/null +++ b/Documentation/wmi/devices/index.rst @@ -0,0 +1,22 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +============================= +Driver-specific Documentation +============================= + +This section provides information about various devices supported by +the Linux kernel, their protocols and driver details. + +.. toctree:: + :maxdepth: 1 + :numbered: + :glob: + + * + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` diff --git a/Documentation/wmi/devices/wmi-bmof.rst b/Documentation/wmi/devices/wmi-bmof.rst new file mode 100644 index 000000000000..ca1ee9a29be3 --- /dev/null +++ b/Documentation/wmi/devices/wmi-bmof.rst @@ -0,0 +1,25 @@ +.. SPDX-License-Identifier: GPL-2.0-only + +============================== +WMI embedded Binary MOF driver +============================== + +Introduction +============ + +Many machines embed WMI Binary MOF (Managed Object Format) metadata used to +describe the details of their ACPI WMI interfaces. The data can be decoded +with tools like `bmfdec <https://github.com/pali/bmfdec>`_ to obtain a +human readable WMI interface description, which is useful for developing +new WMI drivers. + +The Binary MOF data can be retrieved from the ``bmof`` sysfs attribute of the +associated WMI device. Please note that multiple WMI devices containing Binary +MOF data can exist on a given system. + +WMI interface +============= + +The Binary MOF WMI device is identified by the WMI GUID ``05901221-D566-11D1-B2F0-00A0C9062910``. +The Binary MOF can be obtained by doing a WMI data block query. The result is +then returned as an ACPI buffer with a variable size. diff --git a/Documentation/wmi/index.rst b/Documentation/wmi/index.rst index b29933a86380..537cff188e14 100644 --- a/Documentation/wmi/index.rst +++ b/Documentation/wmi/index.rst @@ -8,6 +8,7 @@ WMI Subsystem :maxdepth: 1 acpi-interface + devices/index .. only:: subproject and html |