linux-kernel - [PATCH v2 0/4] platform/x86: wmi: Add subsystem documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 25 Apr 2023 00:29:35 +0200
From:   Armin Wolf <W_Armin@....de>
To:     hdegoede@...hat.com, markgross@...nel.org, rdunlap@...radead.org
Cc:     corbet@....net, linux-doc@...r.kernel.org,
        platform-driver-x86@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: [PATCH v2 0/4] platform/x86: wmi: Add subsystem documentation

Currently, there is no recent documentation available for writing WMI
drivers using the modern bus-based interface. This leads to developers
using the deprecated GUID-based interface when developing new drivers,
causing issues with notification handling when multiple WMI devices sharing
the same notification ID are present. There is also no way for WMI
drivers to add device specific documentation at the moment.
Add documentation for the WMI subsystem to solve those issues. The
device specific documentation currently onyl include documentation for
the wmi-bmof driver, but more is expected to follow.
---
Changes in v2:
- spelling fixes
- tell readers that MOF means Managed Object Format
- 80-cloumn limit

Armin Wolf (4):
  platform/x86: wmi: Add kernel doc comments
  platform/x86: wmi: Mark GUID-based WMI interface as deprecated
  platform/x86: wmi: Add documentation
  platform/x86: wmi: Add device specific documentation

 .../ABI/stable/sysfs-platform-wmi-bmof        |  7 ++
 Documentation/driver-api/index.rst            |  1 +
 Documentation/driver-api/wmi.rst              | 21 ++++
 Documentation/subsystem-apis.rst              |  1 +
 Documentation/wmi/acpi-interface.rst          | 96 +++++++++++++++++++
 Documentation/wmi/devices/index.rst           | 22 +++++
 Documentation/wmi/devices/wmi-bmof.rst        | 25 +++++
 Documentation/wmi/index.rst                   | 19 ++++
 MAINTAINERS                                   |  9 ++
 drivers/platform/x86/Kconfig                  |  4 +-
 drivers/platform/x86/wmi.c                    | 63 +++++++++---
 include/linux/wmi.h                           | 41 +++++++-
 12 files changed, 289 insertions(+), 20 deletions(-)
 create mode 100644 Documentation/ABI/stable/sysfs-platform-wmi-bmof
 create mode 100644 Documentation/driver-api/wmi.rst
 create mode 100644 Documentation/wmi/acpi-interface.rst
 create mode 100644 Documentation/wmi/devices/index.rst
 create mode 100644 Documentation/wmi/devices/wmi-bmof.rst
 create mode 100644 Documentation/wmi/index.rst

--
2.30.2