Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6a927857 authored by Ming Lei's avatar Ming Lei Committed by Greg Kroah-Hartman
Browse files

firmware loader: document firmware cache mechanism



This patch documents the firmware cache mechanism so that
users of request_firmware() know that it can be called
safely inside device's suspend and resume callback, and
the device's firmware needn't be cached any more by individual
driver itself to deal with firmware loss during system resume.

Signed-off-by: default avatarMing Lei <ming.lei@canonical.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 27602842
Loading
Loading
Loading
Loading
+7 −0
Original line number Diff line number Diff line
@@ -119,3 +119,10 @@
   on the setup, so I think that the choice on what firmware to make
   persistent should be left to userspace.

 about firmware cache:
 --------------------
 After firmware cache mechanism is introduced during system sleep,
 request_firmware can be called safely inside device's suspend and
 resume callback, and callers need't cache the firmware by
 themselves any more for dealing with firmware loss during system
 resume.
+3 −0
Original line number Diff line number Diff line
@@ -988,6 +988,9 @@ static int _request_firmware_load(struct firmware_priv *fw_priv, bool uevent,
 *      firmware image for this or any other device.
 *
 *	Caller must hold the reference count of @device.
 *
 *	The function can be called safely inside device's suspend and
 *	resume callback.
 **/
int
request_firmware(const struct firmware **firmware_p, const char *name,