| Message ID | 20230420233226.14561-1-W_Armin@gmx.de |
|---|---|
| Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org>
Delivered-To: ouuuleilei@gmail.com
Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp691201vqo;
Thu, 20 Apr 2023 16:37:18 -0700 (PDT)
X-Google-Smtp-Source:
AKy350YJxAJZi+d3tO/zDzyt9wVkUWExcN8TyISY5W3Qw/27i2ydNcltUuyK3l8DR0TlZLbtmCDc
X-Received: by 2002:a05:6a20:ad8b:b0:ef:d7e5:d3a3 with SMTP id
dd11-20020a056a20ad8b00b000efd7e5d3a3mr3826010pzb.9.1682033838215;
Thu, 20 Apr 2023 16:37:18 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; t=1682033838; cv=none;
d=google.com; s=arc-20160816;
b=N0wxheFvERW5gKn2TwTf13qIrKMo2OmqV/+BZubjjND1AD+B/WA6G+Tx4OMIemGkQ8
Je+6ZqaTRPEt+rXMg/APAZZkov8X7pP1sXUHuU4IK4LhsSi7wyoE7aR7Ae5N2gIKb/Hg
mDPqxVLlsUAsGXvucnGhVJY6d+Y+4OPmy/OYl32ABhspF5xUUcsmrBbSBlxwvKos3GLQ
KMr9TX6SNo3HQ/ao/yRTQx+k2BflKUC7wY00lpl6j7DIt04uAbjQrK9876CuRYcgdx0m
64fp855q9yACP4beqYwms/6nl9AiOAYP/qaGdGsju+f7W7dtvYncZk4rP5JZTkiVloNs
2EZQ==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
s=arc-20160816;
h=list-id:precedence:ui-outboundreport:content-transfer-encoding
:mime-version:message-id:date:subject:cc:to:from:dkim-signature;
bh=4AUA2NWfjPhGFm/cxaMQYdhIuylmqKfFZOgm6Y9g01A=;
b=pRc/JRLV79F+JxWKwyVZBULeWz29fn2pty2CGFehT3Y5WSha+NgPF/Jd2BE96UBnxC
HO1P11CS0Ew3boSKi8hONaSoe6UsUiGlqbchdC//LmfxHwPBqrYd8qltakz6ODO3ZHKN
lFyT2hhHkukUAA/sjA5d80hNtbBcozDedG0xn5Jq7HsyQdW7tHIjJ+6aBd60gt+IZ90Y
9Lp+jTbxtPofZTQMSNxNzrBkjArejrZIuH/HkqpweYD86oewObZ6/63x0lXYeoAmitgh
jRQrk7MkzKNHyWaDZgyR8KvRCe/znz7csZaCDDLRT24IFT7UEEeogMNpbcpG5yOFYlOA
62fQ==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@gmx.de header.s=s31663417 header.b=rzPvR6LV;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gmx.de
Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20])
by mx.google.com with ESMTP id
mg21-20020a17090b371500b002467eaf62d8si2896097pjb.157.2023.04.20.16.37.05;
Thu, 20 Apr 2023 16:37:18 -0700 (PDT)
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;
Authentication-Results: mx.google.com;
dkim=pass header.i=@gmx.de header.s=s31663417 header.b=rzPvR6LV;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gmx.de
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
id S232643AbjDTXcn (ORCPT <rfc822;cjcooper78@gmail.com> + 99 others);
Thu, 20 Apr 2023 19:32:43 -0400
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59870 "EHLO
lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
with ESMTP id S229839AbjDTXcl (ORCPT
<rfc822;linux-kernel@vger.kernel.org>);
Thu, 20 Apr 2023 19:32:41 -0400
Received: from mout.gmx.net (mout.gmx.net [212.227.15.18])
by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 64279172A;
Thu, 20 Apr 2023 16:32:40 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.de; s=s31663417;
t=1682033549; i=w_armin@gmx.de;
bh=NGlN7WhKpCXC32UorWAt3fK4hRHpP3AFfPfRXp8ykXk=;
h=X-UI-Sender-Class:From:To:Cc:Subject:Date;
b=rzPvR6LVsGc7av6bFcK6y4RpNJz5+JHjZnhmT5+o8xg9i30zl/Be7M9it45Sat+MA
r9RAEAEbYNsBqtAZYt4q91szzdSeMUSyS6ngxqtosizg5PizGfDXhEvYBmNIVYYZbR
8O7I8Y+R5QNZ7TDDBfwDiNi9Jdg2MgRlyR0EirBsOjaaH6ZsZJJakvXZI+o4IvIPy9
F7bCCpr+3lTpO4WaCFE0ec1aRl0t2Xg5Ps5bfwkO957FkaXVSm4DsN3EBNh33GMGOX
cm/ceC/JRNKS26xh/eIByTVbcboYecXudz29mtIu1ufnSkgvHhIvLqBkja/p96uOOK
rDknXJ6XlYmwA==
X-UI-Sender-Class: 724b4f7f-cbec-4199-ad4e-598c01a50d3a
Received: from esprimo-mx.users.agdsn.de ([141.30.226.129]) by mail.gmx.net
(mrgmx004 [212.227.17.190]) with ESMTPSA (Nemesis) id
1MC34h-1q1UfY1hIj-00CNlD; Fri, 21 Apr 2023 01:32:29 +0200
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
Message-Id: <20230420233226.14561-1-W_Armin@gmx.de>
X-Mailer: git-send-email 2.30.2
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
X-Provags-ID: V03:K1:VosZo3WIQjkYCBzzJ6OwPTI8whtbxtKrvTXnqoF79ThWaP/+Yo5
OHewk3zzr1J4/T+8rfBDT8jZGvOmpyRVMxk2AdJzK2l3dlDakB8N+tjO/T7wRB3tHHxA+Au
mUaic5TJ9c3R0qmvkVGHypY+/yvyCwVebCX+ncdEi/iAD5xhTt7kuMl7yznI4RxpXChyVBc
oLFa7UWXup+mJKdV6Ku+Q==
UI-OutboundReport: notjunk:1;M01:P0:qEjxGZMQOQs=;mmH3Zu9IknHgqH+NfH/F7iwTmjC
O7YipxZZmRiAK235ISk2+jLTkKURfNUD+P6FzaqbVtvzU1rIjO09/rFTGhjei8/wwlih73P/B
v6aTE9WAect+yBLLfRhl0dVzERaco0YBGEJUgXhyNQhY1vAsVxd6tRwwH0fbAt1Z6ab5BFAx/
ne7pTYmLqvJ4jLs3FbK/1beEyMpXKVuLs1zAI24ksIhdteSsOuMxZEQZSBLdmt03kGOp29UXg
cqJoP1fsf/92ovoPTfj3ecyqRtA6rH1PgDLJD5clnBv2RqnTfpMNGuW/+G3eKBRjJC8dDjIqo
qXxtK/REi+qMTI5XqixYzRzPLCXCiouOwqZdpZjT6lJoNvqvN7oiOnazNmHaHYB+0ufmHzQGK
95vQWEXjuDdbZtyHh4aem3hP7OA/dINN2854kEpdgO0TzeDUNeHO7QilkeqQJn8/qrzUdg9xB
OrIAvXIi3lCrlWiXP6NGOFylLdDjqooz97gHVNbEhI4470B4ufFLPWJvhrGdvGKGcedolkbDC
m8nblw6RFHDToKYhQtWPCHnTBJ/z5qWSyinuHkza1yiaZXB7pRXqsw11S6gBsBhpghLzqoGBh
JVW8RVoyjauMUKmHuaipDTf7o4ns+6+STv4uxspDXo3B7HeW/Yum5Dmw7CXGj+LzD/IbDaQLy
pNHfI0maimK4SabNzCJR23dacYeNGZAqP9jVhxRxJZER0WumVqIepTDgl4rXWjRfhkrTspxYM
VBnJGj0N0SP4pxeO0pwkWpKm2I34VYIYqS8jGmmQrqwsFDsfjFpaE7wD6lQA08Qu2HDAAHXBP
+iNTuqD+WmK9QITpypspj1q9Bz2/MEo7iIVOqwVMUdYbe6+NabkYheSOMVCXOuampU1cBB5V8
82uMW44n9v7SPKGwBe2u+hw5ynWIVTq6CS/ScW2t/Aampd/o3MFOHEBkzGTeQqOYi6yhOrXK0
KMgbuAXVjJ6/jOKXCM4bdj94cQo=
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,
RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE
autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?=
X-GMAIL-THRID: =?utf-8?q?1763740314262107164?=
X-GMAIL-MSGID: =?utf-8?q?1763740314262107164?=
|
| Series |
platform/x86: wmi: Add subsystem documentation
|
|
Message
Armin Wolf
April 20, 2023, 11:32 p.m. UTC
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