[PATCH 0/5] firmware: doc revamp

Luis R. Rodriguez
2016-12-13T03:08:36Z

Greg,

here's a few simple changes for documentation revamp and a few
simple fixes for the firmware test script. I'm pretty sure this is
too late for the next release so I am happy with this getting queued in
until the merge window closes, posting now to iron out kinks once
the merge window closes.

I'll soon also post the extensible firmware API as per feedback, much of
which was just name change preferences and also a huge clarification on
roadmap on fallback mechanisms. The documentation should help iron out
tons of kinks I think folks have on this front, but more on all this later
once those patches get posted.

You may notice I've dropped the SmPL patches which complain on use of the
API on init and probe -- although valid the context was off given the only
valid use case was if you don't use initramfs, and that's a corner case.
Fortunatley Daniel Wagner and Tom Gundersen have come up with some ideas
that should help correct these issues, so I've dropped that grammar patch.

Luis R. Rodriguez (5):
selftests: firmware: only modprobe if driver is missing
selftests: firmware: send expected errors to /dev/null
firmware: revamp firmware documentation
firmware: add SmPL report for custom fallback mechanism
firmware: add DECLARE_FW_CUSTOM_FALLBACK() annotation

Documentation/driver-api/firmware/built-in-fw.rst | 36 ++++
Documentation/driver-api/firmware/core.rst | 16 ++
.../driver-api/firmware/direct-fs-lookup.rst | 30 +++
.../driver-api/firmware/fallback-mechanisms.rst | 215 +++++++++++++++++++++
.../driver-api/firmware/firmware_cache.rst | 51 +++++
.../driver-api/firmware/fw_search_path.rst | 26 +++
Documentation/driver-api/firmware/index.rst | 16 ++
Documentation/driver-api/firmware/introduction.rst | 27 +++
Documentation/driver-api/firmware/lookup-order.rst | 18 ++
.../driver-api/firmware/request_firmware.rst | 56 ++++++
Documentation/driver-api/index.rst | 1 +
Documentation/firmware_class/README | 128 ------------
drivers/firmware/dell_rbu.c | 1 +
drivers/leds/leds-lp55xx-common.c | 1 +
include/linux/firmware.h | 7 +
.../api/request_firmware-custom-fallback.cocci | 44 +++++
tools/testing/selftests/firmware/fw_filesystem.sh | 25 ++-
17 files changed, 565 insertions(+), 133 deletions(-)
create mode 100644 Documentation/driver-api/firmware/built-in-fw.rst
create mode 100644 Documentation/driver-api/firmware/core.rst
create mode 100644 Documentation/driver-api/firmware/direct-fs-lookup.rst
create mode 100644 Documentation/driver-api/firmware/fallback-mechanisms.rst
create mode 100644 Documentation/driver-api/firmware/firmware_cache.rst
create mode 100644 Documentation/driver-api/firmware/fw_search_path.rst
create mode 100644 Documentation/driver-api/firmware/index.rst
create mode 100644 Documentation/driver-api/firmware/introduction.rst
create mode 100644 Documentation/driver-api/firmware/lookup-order.rst
create mode 100644 Documentation/driver-api/firmware/request_firmware.rst
delete mode 100644 Documentation/firmware_class/README
create mode 100644 scripts/coccinelle/api/request_firmware-custom-fallback.cocci

--
2.10.1