1
0
Fork 0

firmware: some documentation fixes

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

Signed-off-by: Andres Rodriguez <andresx7@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Andres Rodriguez 2018-04-25 12:25:39 -04:00 committed by Greg Kroah-Hartman
parent 0183df0baf
commit b93815d0f3
3 changed files with 6 additions and 6 deletions

View file

@ -50,11 +50,11 @@ Special optimizations on reboot
Some devices have an optimization in place to enable the firmware to be Some devices have an optimization in place to enable the firmware to be
retained during system reboot. When such optimizations are used the driver retained during system reboot. When such optimizations are used the driver
author must ensure the firmware is still available on resume from suspend, 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 this can be done with firmware_request_cache() instead of requesting for the
firmare to be loaded. firmware to be loaded.
firmware_request_cache() firmware_request_cache()
----------------------- ------------------------
.. kernel-doc:: drivers/base/firmware_loader/main.c .. kernel-doc:: drivers/base/firmware_loader/main.c
:functions: firmware_request_cache :functions: firmware_request_cache

View file

@ -537,8 +537,8 @@ exit:
} }
/** /**
* fw_load_sysfs_fallback - load a firmware via the syfs fallback mechanism * fw_load_sysfs_fallback - load a firmware via the sysfs fallback mechanism
* @fw_sysfs: firmware syfs information for the firmware to load * @fw_sysfs: firmware sysfs information for the firmware to load
* @opt_flags: flags of options, FW_OPT_* * @opt_flags: flags of options, FW_OPT_*
* @timeout: timeout to wait for the load * @timeout: timeout to wait for the load
* *

View file

@ -6,7 +6,7 @@
#include <linux/device.h> #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. * Helps describe and fine tune the fallback mechanism.
* *