Unverified Commit 8d5316c6 authored by Armin Wolf's avatar Armin Wolf Committed by Ilpo Järvinen
Browse files

platform/x86: wmi: Update documentation regarding the GUID-based API 



Warn WMI driver developers to not use GUID-based and non-GUID-based
functions for querying WMI data blocks and handling WMI events
simultaneously on the same device, as this will corrupt the WMI device
state and might thus lead to erratic behaviour.

Signed-off-by: default avatarArmin Wolf <W_Armin@gmx.de>
Link: https://lore.kernel.org/r/20250216193251.866125-9-W_Armin@gmx.de


Reviewed-by: default avatarIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: default avatarIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
parent 08c9f402

Documentation/wmi/driver-development-guide.rst

+4 −0
Original line number Diff line number Diff line
@@ -96,6 +96,10 @@ on a given machine. 
Because of this, WMI drivers should use the state container design pattern as described in

Documentation/driver-api/driver-model/design-patterns.rst.



.. warning:: Using both GUID-based and non-GUID-based functions for querying WMI data blocks and

             handling WMI events simultaneously on the same device is guaranteed to corrupt the

             WMI device state and might lead to erratic behaviour.



WMI method drivers

------------------