2016-12-16 19:10:36 +08:00
|
|
|
====================
|
|
|
|
|
request_firmware API
|
|
|
|
|
====================
|
|
|
|
|
|
|
|
|
|
You would typically load firmware and then load it into your device somehow.
|
|
|
|
|
The typical firmware work flow is reflected below::
|
|
|
|
|
|
|
|
|
|
if(request_firmware(&fw_entry, $FIRMWARE, device) == 0)
|
|
|
|
|
copy_fw_to_device(fw_entry->data, fw_entry->size);
|
|
|
|
|
release_firmware(fw_entry);
|
|
|
|
|
|
|
|
|
|
Synchronous firmware requests
|
|
|
|
|
=============================
|
|
|
|
|
|
|
|
|
|
Synchronous firmware requests will wait until the firmware is found or until
|
|
|
|
|
an error is returned.
|
|
|
|
|
|
|
|
|
|
request_firmware
|
|
|
|
|
----------------
|
2018-04-09 00:06:21 +08:00
|
|
|
.. kernel-doc:: drivers/base/firmware_loader/main.c
|
2016-12-16 19:10:36 +08:00
|
|
|
:functions: request_firmware
|
|
|
|
|
|
2018-05-11 04:08:45 +08:00
|
|
|
firmware_request_nowarn
|
|
|
|
|
-----------------------
|
|
|
|
|
.. kernel-doc:: drivers/base/firmware_loader/main.c
|
|
|
|
|
:functions: firmware_request_nowarn
|
|
|
|
|
|
2020-01-16 00:35:48 +08:00
|
|
|
firmware_request_platform
|
|
|
|
|
-------------------------
|
|
|
|
|
.. kernel-doc:: drivers/base/firmware_loader/main.c
|
|
|
|
|
:functions: firmware_request_platform
|
|
|
|
|
|
2016-12-16 19:10:36 +08:00
|
|
|
request_firmware_direct
|
|
|
|
|
-----------------------
|
2018-04-09 00:06:21 +08:00
|
|
|
.. kernel-doc:: drivers/base/firmware_loader/main.c
|
2016-12-16 19:10:36 +08:00
|
|
|
:functions: request_firmware_direct
|
|
|
|
|
|
|
|
|
|
request_firmware_into_buf
|
|
|
|
|
-------------------------
|
2018-04-09 00:06:21 +08:00
|
|
|
.. kernel-doc:: drivers/base/firmware_loader/main.c
|
2016-12-16 19:10:36 +08:00
|
|
|
:functions: request_firmware_into_buf
|
|
|
|
|
|
|
|
|
|
Asynchronous firmware requests
|
|
|
|
|
==============================
|
|
|
|
|
|
|
|
|
|
Asynchronous firmware requests allow driver code to not have to wait
|
|
|
|
|
until the firmware or an error is returned. Function callbacks are
|
|
|
|
|
provided so that when the firmware or an error is found the driver is
|
|
|
|
|
informed through the callback. request_firmware_nowait() cannot be called
|
|
|
|
|
in atomic contexts.
|
|
|
|
|
|
|
|
|
|
request_firmware_nowait
|
|
|
|
|
-----------------------
|
2018-04-09 00:06:21 +08:00
|
|
|
.. kernel-doc:: drivers/base/firmware_loader/main.c
|
2016-12-16 19:10:36 +08:00
|
|
|
:functions: request_firmware_nowait
|
|
|
|
|
|
2018-03-22 06:34:29 +08:00
|
|
|
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,
|
2018-04-26 00:25:39 +08:00
|
|
|
this can be done with firmware_request_cache() instead of requesting for the
|
|
|
|
|
firmware to be loaded.
|
2018-03-22 06:34:29 +08:00
|
|
|
|
|
|
|
|
firmware_request_cache()
|
2018-04-26 00:25:39 +08:00
|
|
|
------------------------
|
2018-04-09 00:06:21 +08:00
|
|
|
.. kernel-doc:: drivers/base/firmware_loader/main.c
|
2018-03-22 06:34:29 +08:00
|
|
|
:functions: firmware_request_cache
|
|
|
|
|
|
2016-12-16 19:10:36 +08:00
|
|
|
request firmware API expected driver use
|
|
|
|
|
========================================
|
|
|
|
|
|
|
|
|
|
Once an API call returns you process the firmware and then release the
|
|
|
|
|
firmware. For example if you used request_firmware() and it returns,
|
|
|
|
|
the driver has the firmware image accessible in fw_entry->{data,size}.
|
|
|
|
|
If something went wrong request_firmware() returns non-zero and fw_entry
|
|
|
|
|
is set to NULL. Once your driver is done with processing the firmware it
|
2020-07-04 11:44:50 +08:00
|
|
|
can call release_firmware(fw_entry) to release the firmware image
|
2016-12-16 19:10:36 +08:00
|
|
|
and any related resource.
|
