From: Armin Wolf <W_Armin@gmx.de>
To: hdegoede@redhat.com, markgross@kernel.org
Cc: corbet@lwn.net, linux-doc@vger.kernel.org,
platform-driver-x86@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH 0/4] platform/x86: wmi: Add subsystem documentation
Date: Fri, 21 Apr 2023 01:32:22 +0200 [thread overview]
Message-ID: <20230420233226.14561-1-W_Armin@gmx.de> (raw)
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
next reply other threads:[~2023-04-20 23:32 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-20 23:32 Armin Wolf [this message]
2023-04-20 23:32 ` [PATCH 1/4] platform/x86: wmi: Add kernel doc comments Armin Wolf
2023-04-22 2:54 ` Randy Dunlap
2023-04-24 21:20 ` Armin Wolf
2023-04-24 21:30 ` Randy Dunlap
2023-04-20 23:32 ` [PATCH 2/4] platform/x86: wmi: Mark GUID-based WMI interface as deprecated Armin Wolf
2023-04-20 23:32 ` [PATCH 3/4] platform/x86: wmi: Add documentation Armin Wolf
2023-04-22 2:43 ` Randy Dunlap
2023-04-20 23:32 ` [PATCH 4/4] platform/x86: wmi: Add device specific documentation Armin Wolf
2023-04-22 2:28 ` Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230420233226.14561-1-W_Armin@gmx.de \
--to=w_armin@gmx.de \
--cc=corbet@lwn.net \
--cc=hdegoede@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markgross@kernel.org \
--cc=platform-driver-x86@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®