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

Commit 5d42c96e authored by Luis R. Rodriguez's avatar Luis R. Rodriguez Committed by Greg Kroah-Hartman
Browse files

firmware: add firmware_request_cache() to help with cache on reboot 



Some devices have an optimization in place to enable the firmware to
be retaineed during a system reboot, so after reboot the device can skip
requesting and loading the firmware. This can save up to 1s in load
time. The mt7601u 802.11 device happens to be such a device.

When these devices retain the firmware on a reboot and then suspend
they can miss looking for the firmware on resume. To help with this we
need a way to cache the firmware when such an optimization has taken
place.

Signed-off-by: default avatarLuis R. Rodriguez <mcgrof@kernel.org>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent c6263a48

Documentation/driver-api/firmware/request_firmware.rst

+14 −0
Original line number Diff line number Diff line
@@ -44,6 +44,20 @@ request_firmware_nowait 
.. kernel-doc:: drivers/base/firmware_class.c

   :functions: request_firmware_nowait



Special optimizations on reboot

===============================



Some devices have an optimization in place to enable the firmware to be

retained during system reboot. When such optimizations are used the driver

author must ensure the firmware is still available on resume from suspend,

this can be done with firmware_request_cache() insted of requesting for the

firmare to be loaded.



firmware_request_cache()

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

.. kernel-doc:: drivers/base/firmware_class.c

   :functions: firmware_request_cache



request firmware API expected driver use

========================================

drivers/base/firmware_loader/main.c

+24 −0
Original line number Diff line number Diff line
@@ -656,6 +656,30 @@ int request_firmware_direct(const struct firmware **firmware_p, 
}

EXPORT_SYMBOL_GPL(request_firmware_direct);



/**

 * firmware_request_cache: - cache firmware for suspend so resume can use it

 * @name: name of firmware file

 * @device: device for which firmware should be cached for

 *

 * There are some devices with an optimization that enables the device to not

 * require loading firmware on system reboot. This optimization may still

 * require the firmware present on resume from suspend. This routine can be

 * used to ensure the firmware is present on resume from suspend in these

 * situations. This helper is not compatible with drivers which use

 * request_firmware_into_buf() or request_firmware_nowait() with no uevent set.

 **/

int firmware_request_cache(struct device *device, const char *name)

{

	int ret;



	mutex_lock(&fw_lock);

	ret = fw_add_devm_name(device, name);

	mutex_unlock(&fw_lock);



	return ret;

}

EXPORT_SYMBOL_GPL(firmware_request_cache);



/**

 * request_firmware_into_buf - load firmware into a previously allocated buffer

 * @firmware_p: pointer to firmware image

include/linux/firmware.h

+3 −0
Original line number Diff line number Diff line
@@ -85,4 +85,7 @@ static inline int request_firmware_into_buf(const struct firmware **firmware_p, 
}



#endif



int firmware_request_cache(struct device *device, const char *name);



#endif