linux-toradex.git/Documentation/driver-api/firmware, branch v5.5-rc7

docs: Fix a misdirected kerneldoc directive

2019-05-24T20:31:50+00:00

The stratix10 service layer documentation tried to include a kerneldoc
comments for a nonexistent struct; leading to a "no structured comments
found" message.  Switch it to stratix10_svc_command_config_type, which
appears at that spot in the sequence and was not included.

Signed-off-by: Jonathan Corbet

Documentation: driver-api: add stratix10 service layer

2018-11-26T19:15:07+00:00

Add Intel Stratix10 service layer driver document

Signed-off-by: Richard Gong 
Signed-off-by: Alan Tull 
Signed-off-by: Greg Kroah-Hartman

Documentation: update firmware loader fallback reference

2018-07-07T15:45:25+00:00

The firmware loader has a fallback mechanism, and it now has some proper
kdoc, but we forgot to update the Documentation to use the new kdoc. Fix
that.

Signed-off-by: Luis R. Rodriguez 
Signed-off-by: Greg Kroah-Hartman

Documentation: clarify firmware_class provenance and why we can't rename the module

2018-05-14T14:46:10+00:00

Clarify the provenance of the firmware loader firmware_class module name
and why we cannot rename the module in the future.

Reviewed-by: Mauro Carvalho Chehab 
Reviewed-by: Kees Cook 
Signed-off-by: Luis R. Rodriguez 
Signed-off-by: Greg Kroah-Hartman

Documentation: fix few typos and clarifications for the firmware loader

2018-05-14T14:44:41+00:00

Fix a few typos, and clarify a few sentences.

Reviewed-by: Kees Cook 
Signed-off-by: Luis R. Rodriguez 
Signed-off-by: Greg Kroah-Hartman

firmware: add firmware_request_nowarn() - load firmware without warnings

2018-05-14T14:44:41+00:00

Currently the firmware loader only exposes one silent path for querying
optional firmware, and that is firmware_request_direct(). This function
also disables the sysfs fallback mechanism, which might not always be the
desired behaviour [0].

This patch introduces a variations of request_firmware() that enable the
caller to disable the undesired warning messages but enables the sysfs
fallback mechanism. This is equivalent to adding FW_OPT_NO_WARN to the
old behaviour.

[0]: https://git.kernel.org/linus/c0cc00f250e1

Signed-off-by: Andres Rodriguez 
Reviewed-by: Kees Cook 
Acked-by: Luis R. Rodriguez 
[mcgrof: used the old API calls as the full rename is not done yet, and
 add the caller for when FW_LOADER is disabled, enhance documentation ]
Signed-off-by: Luis R. Rodriguez 
Signed-off-by: Greg Kroah-Hartman

firmware: some documentation fixes

2018-04-25T16:37:20+00:00

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

Signed-off-by: Andres Rodriguez 
Signed-off-by: Greg Kroah-Hartman

firmware: Fix firmware documentation for recent file renames

2018-04-23T11:03:26+00:00

firmware_class.c was split into several files under
drivers/base/firmware_loader. The new main.c has the functions which
/request_firmware.rst references.

Acked-by: Luis R. Rodriguez 
Signed-off-by: Hans de Goede 
Tested-by: Randy Dunlap 
Signed-off-by: Greg Kroah-Hartman

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

2018-03-22T17:33:26+00:00

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: Luis R. Rodriguez 
Signed-off-by: Greg Kroah-Hartman

rename: _request_firmware_load() fw_load_sysfs_fallback()

2018-03-20T08:28:47+00:00

This reflects much clearer what is being done.
While at it, kdoc'ify it.

Signed-off-by: Luis R. Rodriguez 
Signed-off-by: Greg Kroah-Hartman