Skip to content

Commit

Permalink
Documentation: fix few typos and clarifications for the firmware loader
Browse files Browse the repository at this point in the history
Fix a few typos, and clarify a few sentences.

Reviewed-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
  • Loading branch information
Luis R. Rodriguez authored and Greg Kroah-Hartman committed May 14, 2018
1 parent 1bc4d68 commit 4fde24d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions Documentation/driver-api/firmware/fallback-mechanisms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ and a file upload firmware into:
* /sys/$DEVPATH/data

To upload firmware you will echo 1 onto the loading file to indicate
you are loading firmware. You then cat the firmware into the data file,
you are loading firmware. You then write the firmware into the data file,
and you notify the kernel the firmware is ready by echo'ing 0 onto
the loading file.

Expand Down Expand Up @@ -136,7 +136,8 @@ by kobject uevents. This is specially exacerbated due to the fact that most
distributions today disable CONFIG_FW_LOADER_USER_HELPER_FALLBACK.

Refer to do_firmware_uevent() for details of the kobject event variables
setup. Variables passwdd with a kobject add event:
setup. The variables currently passed to userspace with a "kobject add"
event are:

* FIRMWARE=firmware name
* TIMEOUT=timeout value
Expand Down
4 changes: 2 additions & 2 deletions Documentation/driver-api/firmware/firmware_cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Some implementation details about the firmware cache setup:
* If an asynchronous call is used the firmware cache is only set up for a
device if if the second argument (uevent) to request_firmware_nowait() is
true. When uevent is true it requests that a kobject uevent be sent to
userspace for the firmware request. For details refer to the Fackback
mechanism documented below.
userspace for the firmware request through the sysfs fallback mechanism
if the firmware file is not found.

* If the firmware cache is determined to be needed as per the above two
criteria the firmware cache is setup by adding a devres entry for the
Expand Down

0 comments on commit 4fde24d

Please sign in to comment.