[PATCH 0/4] platform/x86: wmi: Add subsystem documentation

From: Armin Wolf
Date: Thu Apr 20 2023 - 19:32:46 EST


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.

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 | 19 ++++
Documentation/subsystem-apis.rst | 1 +
Documentation/wmi/acpi-interface.rst | 86 +++++++++++++++++++
Documentation/wmi/devices/index.rst | 22 +++++
Documentation/wmi/devices/wmi-bmof.rst | 22 +++++
Documentation/wmi/index.rst | 19 ++++
MAINTAINERS | 9 ++
drivers/platform/x86/wmi.c | 63 ++++++++++----
include/linux/wmi.h | 41 ++++++++-
11 files changed, 272 insertions(+), 18 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