diff options
| author | Luis R. Rodriguez <mcgrof@kernel.org> | 2016-12-16 03:10:36 -0800 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2017-01-11 09:42:59 +0100 |
| commit | 113ccc38378b6f0b24c0993040c6044e35163a51 (patch) | |
| tree | 2a1fbd9a1ad5144dc316834ccf52505a84191cb3 /Documentation/driver-api/firmware/core.rst | |
| parent | 880444e214cfd293a2e8cc4bd3505f7ffa6ce33a (diff) | |
| download | linux-113ccc38378b6f0b24c0993040c6044e35163a51.tar.gz linux-113ccc38378b6f0b24c0993040c6044e35163a51.tar.xz | |
firmware: revamp firmware documentation
Understanding this code is getting out of control without any
notes. Give the firmware_class driver a much needed documentation love,
and while at it convert it to the new sphinx documentation format.
v2: typos and small fixes
Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/driver-api/firmware/core.rst')
| -rw-r--r-- | Documentation/driver-api/firmware/core.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/Documentation/driver-api/firmware/core.rst b/Documentation/driver-api/firmware/core.rst new file mode 100644 index 000000000000..1d1688cbc078 --- /dev/null +++ b/Documentation/driver-api/firmware/core.rst @@ -0,0 +1,16 @@ +========================== +Firmware API core features +========================== + +The firmware API has a rich set of core features available. This section +documents these features. + +.. toctree:: + + fw_search_path + built-in-fw + firmware_cache + direct-fs-lookup + fallback-mechanisms + lookup-order + |