Skip to content

Commit 8d5316c

Browse files
Wer-Wolfij-intel
authored andcommitted
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: Armin Wolf <[email protected]> Link: https://lore.kernel.org/r/[email protected] Reviewed-by: Ilpo Järvinen <[email protected]> Signed-off-by: Ilpo Järvinen <[email protected]>
1 parent 08c9f40 commit 8d5316c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Documentation/wmi/driver-development-guide.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ on a given machine.
9696
Because of this, WMI drivers should use the state container design pattern as described in
9797
Documentation/driver-api/driver-model/design-patterns.rst.
9898

99+
.. warning:: Using both GUID-based and non-GUID-based functions for querying WMI data blocks and
100+
handling WMI events simultaneously on the same device is guaranteed to corrupt the
101+
WMI device state and might lead to erratic behaviour.
102+
99103
WMI method drivers
100104
------------------
101105

0 commit comments

Comments
 (0)