Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Armin Wolf <W_Armin@gmx.de>
To:     hdegoede@redhat.com, markgross@kernel.org, rdunlap@infradead.org
Cc:     corbet@lwn.net, linux-doc@vger.kernel.org,
        platform-driver-x86@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 0/4] platform/x86: wmi: Add subsystem documentation
Date:   Tue, 25 Apr 2023 00:29:35 +0200
Message-Id: <20230424222939.208137-1-W_Armin@gmx.de>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
UI-OutboundReport: notjunk:1;M01:P0:kHRGcxxyzKQ=;sqSHSbGA6xtxoyjd+PfqCGBglyG
 dzM64Jz/SJhm8EJ4HVU2GJwKcjy8qOMU3Prumt9MbCbHpapIIqWqarZBj1X2EJFr8wKiumUGe
 ttHiakBza/1wdK5xc+arz1Z38Wp3QlnFC2iDBgwX7nrP3TVvApD7TIcumIzq5u+GG75JQNMxX
 aV4XJDOBcjgV0XEB94gK9/bIZXsO161XUSb2pmz+NjIRGkxH7bHLs3WOPnX124yuGg2jZvFZC
 13jZ1/K2U9u4/DzBja/N3TgcWPLr6BFLXqJ00espIlTi+bYgNawjzEgpMNeBzvEB3Drw5NLw7
 DPVarZx63CL84t+maKFJowhvrBPXAr2TVeeWMA4mIRQvwa9lMwggZj6HCYVXf0u2mMMPR67TU
 HN8jTy0IYac4wNwFpBYSPhekchefAIEuHARLqFt5wQb5Ak0iVB9Qhhdjws46ENbonYkg5MMbh
 ustNHTUsTyxsOGbYFTskFleUz5JBuvddakblXpLfu1cHkACKaLYK7vADt3xtoKBXkDexu2mml
 Qz7lAhXzbqDAsxjdGo/IYnwlFQLyNLREXKTUm/Z54VxAMyRFkz9M957+3mLFOxUEniGKdL8OX
 B8F1Q2vZiaf6/DE5DO3iohRfbQahOEUFOk3QEZR/vM4hCYV5H76eQ02zD6GQKS6CsLayR3DTq
 4lMW+nmKCYMbVc71Zny/2inYGpLXkFx0KDZh8bMvWBFy4kGtrKjOtJWI64YBxIbscrsohqa0b
 Fy+rruVUb4MeK30/wkGXOF9/9uM+vmIjq34k0jMz6o/Sg05z4r7d6FnMyMK2G54jviyc3in7g
 iMBtUiqmto6j0X6H+CMnwKkiGEjRzMo/q6LyRoBc6SkhwbW3ccY6D92ama2/Ec1v6d5zNWZIR
 Htrz1L7OrYjfcZYqWRXSLcyshEh/C6iXF2rwuQ2vZLoSoDv2IsIUfCOju+mz63Mz7SgyzGim4
 uRk7mjK8/CDTFz+c4gwAP4K9NLc=
Precedence: bulk

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 sharin=
g
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.
=2D--
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

=2D-
2.30.2