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

Commit b93815d0 authored by Andres Rodriguez's avatar Andres Rodriguez Committed by Greg Kroah-Hartman
Browse files

firmware: some documentation fixes 



Including:
 - Fixup outdated kernel-doc paths
 - Slightly too short title underline
 - Some typos

Signed-off-by: default avatarAndres Rodriguez <andresx7@gmail.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 0183df0b

Documentation/driver-api/firmware/request_firmware.rst

+3 −3
Original line number Diff line number Diff line
@@ -50,11 +50,11 @@ 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.

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

firmware to be loaded.



firmware_request_cache()

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

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

.. kernel-doc:: drivers/base/firmware_loader/main.c

   :functions: firmware_request_cache

drivers/base/firmware_loader/fallback.c

+2 −2
Original line number Diff line number Diff line
@@ -537,8 +537,8 @@ fw_create_instance(struct firmware *firmware, const char *fw_name, 
}



/**

 * fw_load_sysfs_fallback - load a firmware via the syfs fallback mechanism

 * @fw_sysfs: firmware syfs information for the firmware to load

 * fw_load_sysfs_fallback - load a firmware via the sysfs fallback mechanism

 * @fw_sysfs: firmware sysfs information for the firmware to load

 * @opt_flags: flags of options, FW_OPT_*

 * @timeout: timeout to wait for the load

 *

drivers/base/firmware_loader/fallback.h

+1 −1
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@ 
#include <linux/device.h>



/**

 * struct firmware_fallback_config - firmware fallback configuratioon settings

 * struct firmware_fallback_config - firmware fallback configuration settings

 *

 * Helps describe and fine tune the fallback mechanism.

 *