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
Cc:     corbet@lwn.net, linux-doc@vger.kernel.org,
        platform-driver-x86@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 2/4] platform/x86: wmi: Mark GUID-based WMI interface as deprecated
Date:   Fri, 21 Apr 2023 01:32:24 +0200
Message-Id: <20230420233226.14561-3-W_Armin@gmx.de>
In-Reply-To: <20230420233226.14561-1-W_Armin@gmx.de>
References: <20230420233226.14561-1-W_Armin@gmx.de>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
UI-OutboundReport: notjunk:1;M01:P0:RXLP46U4J1w=;7sV2VB/mGCtehhbbtZGn6u/bpZB
 t2MXkbH+SeKrLEFhQQOnBHLHhgxokCerpiHsVA/nVnpRtxvn3/eDRcD2QNKbK9IylMUdTco1d
 lhxfcfQet5dbWKJT8F/FB8p0cyFtXt+oMPqXZ+0J+bP+yiaU32iKv+Fgqsrh1WFqF5ygTp9pw
 QcoGJC6L15EKqDR9TZFVDjDNvmqpAI9xBD5whtc8F8HjJ81MsxHFA9sfRx8XgmOUewiKE6jwo
 /VofFt2T5DfJNqJVsb0Gr8ZWqW9c+/2TAWWqid5e7X28VEjK5POx8adrpFecHZXpLCV7aOYuS
 OfKfX5JB3yW86UK191Ymb24OJAuvasjaeeO+CX6GdZEe8vstoMnWikoYYjzVKGA5iVFL1SXS5
 EN2K4b86YGqFLaDIwuZlywaTspP6bedWG8zPcKXeqxpVo9h5KuI3cZ7T4sqQLwS/M9zFfBhJz
 Bos+S1dYnupyVzHRnbpItGUCCdAKsc7Fa1QfC7iajLfsQizTvS/Y8k2msy8QsSshm1lKmbdxX
 N5ZtPW5rnfR91/XYgq5UIXwUOnruVS93lCreoT0eyrLOaL9InjvBeHqn068iPfb7kjmtsdVGp
 yISmA7KiaiXQ/GxQaoTVlDWuSsRbZRIsEsPAFNuOCQ4rJOcmm4cITKiHV9MV4qaIACDtyucyO
 mrSS2LmxrePUEEMQ9jcQta7U9Zbk8KGQWG+G1KyB5WxOFS8j5Wf038twQ/0IN3yXTFX5dHcHF
 4HgFxiknS5SdaY8ZJ7UAemW2XsYQKtUBpn6wdJFaez7O7iDP72a54IsypfxnkMOuQrBF4FcMP
 zz9UsSRHC1gpKynDKZ1UTZDH84V0czT3+9npeMm9MJCva/2d4mv8lQJ0fKfgX4O0dA1sfqbFb
 i95iMat9+cDY9Hn5H9XBS1Yj7tmgD2IUDmQXuUlVId3znyIqC8mh6kIrMedYDQFKzTVdSf9zl
 MZRnnFMkAQH+WlpaqGTz6SsB13Y=
Precedence: bulk

The WMI driver core supports a more mordern bus-based interface for
interacting with WMI devices. The older GUID-based interface depends
on each WMI GUID and notification id being unique on a given system,
which turned out is not the case.
Mark the older interface as deprecated since new WMI drivers should
use the bus-based interface to avoid this issues.

Signed-off-by: Armin Wolf <W_Armin@gmx.de>
=2D--
 drivers/platform/x86/wmi.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/drivers/platform/x86/wmi.c b/drivers/platform/x86/wmi.c
index e4b41dca70c7..ae654487718e 100644
=2D-- a/drivers/platform/x86/wmi.c
+++ b/drivers/platform/x86/wmi.c
@@ -264,7 +264,7 @@ int set_required_buffer_size(struct wmi_device *wdev, =
u64 length)
 EXPORT_SYMBOL_GPL(set_required_buffer_size);

 /**
- * wmi_evaluate_method - Evaluate a WMI method
+ * wmi_evaluate_method - Evaluate a WMI method (deprecated)
  * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417=
f2f49ba
  * @instance: Instance index
  * @method_id: Method ID to call
@@ -457,7 +457,7 @@ union acpi_object *wmidev_block_query(struct wmi_devic=
e *wdev, u8 instance)
 EXPORT_SYMBOL_GPL(wmidev_block_query);

 /**
- * wmi_set_block - Write to a WMI block
+ * wmi_set_block - Write to a WMI block (deprecated)
  * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417=
f2f49ba
  * @instance: Instance index
  * @in: Buffer containing new values for the data block
@@ -568,7 +568,7 @@ static void wmi_notify_debug(u32 value, void *context)
 }

 /**
- * wmi_install_notify_handler - Register handler for WMI events
+ * wmi_install_notify_handler - Register handler for WMI events (deprecat=
ed)
  * @guid: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
  * @handler: Function to handle notifications
  * @data: Data to be returned to handler when event is fired
@@ -614,7 +614,7 @@ acpi_status wmi_install_notify_handler(const char *gui=
d,
 EXPORT_SYMBOL_GPL(wmi_install_notify_handler);

 /**
- * wmi_remove_notify_handler - Unregister handler for WMI events
+ * wmi_remove_notify_handler - Unregister handler for WMI events (depreca=
ted)
  * @guid: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
  *
  * Unregister handler for events sent to the ACPI-WMI mapper device.
@@ -661,7 +661,7 @@ acpi_status wmi_remove_notify_handler(const char *guid=
)
 EXPORT_SYMBOL_GPL(wmi_remove_notify_handler);

 /**
- * wmi_get_event_data - Get WMI data associated with an event
+ * wmi_get_event_data - Get WMI data associated with an event (deprecated=
)
  *
  * @event: Event to find
  * @out: Buffer to hold event data
@@ -700,7 +700,7 @@ bool wmi_has_guid(const char *guid_string)
 EXPORT_SYMBOL_GPL(wmi_has_guid);

 /**
- * wmi_get_acpi_device_uid() - Get _UID name of ACPI device that defines =
GUID
+ * wmi_get_acpi_device_uid() - Get _UID name of ACPI device that defines =
GUID (deprecated)
  * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417=
f2f49ba
  *
  * Find the _UID of ACPI device associated with this WMI GUID.
=2D-
2.30.2