summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api
diff options
context:
space:
mode:
authorLuis R. Rodriguez <mcgrof@kernel.org>2017-05-02 01:31:05 -0700
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2017-06-03 19:15:49 +0900
commit81f95076281fdd3bc382e004ba1bce8e82fccbce (patch)
tree59cf64e1d454e740af39a4f397ee44c8f822b389 /Documentation/driver-api
parenta669f04ab4b4d7e5a7ac8250f0b688a07e10b04c (diff)
downloadop-kernel-dev-81f95076281fdd3bc382e004ba1bce8e82fccbce.zip
op-kernel-dev-81f95076281fdd3bc382e004ba1bce8e82fccbce.tar.gz
firmware: add sanity check on shutdown/suspend
The firmware API should not be used after we go to suspend and after we reboot/halt. The suspend/resume case is a bit complex, so this documents that so things are clearer. We want to know about users of the API in incorrect places so that their callers are corrected, so this also adds a warn for those cases. Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/driver-api')
-rw-r--r--Documentation/driver-api/firmware/request_firmware.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/driver-api/firmware/request_firmware.rst b/Documentation/driver-api/firmware/request_firmware.rst
index cc0aea8..1c2c496 100644
--- a/Documentation/driver-api/firmware/request_firmware.rst
+++ b/Documentation/driver-api/firmware/request_firmware.rst
@@ -44,6 +44,17 @@ request_firmware_nowait
.. kernel-doc:: drivers/base/firmware_class.c
:functions: request_firmware_nowait
+Considerations for suspend and resume
+=====================================
+
+During suspend and resume only the built-in firmware and the firmware cache
+elements of the firmware API can be used. This is managed by fw_pm_notify().
+
+fw_pm_notify
+------------
+.. kernel-doc:: drivers/base/firmware_class.c
+ :functions: fw_pm_notify
+
request firmware API expected driver use
========================================
OpenPOWER on IntegriCloud