Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

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 <mchehab+samsung@kernel.org>
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>

authored by

Luis R. Rodriguez and committed by
Greg Kroah-Hartman
f0a46297 0b92d3f6

+6 -3
+6 -3
Documentation/driver-api/firmware/fallback-mechanisms.rst
··· 72 72 associating the device used to make the request as the device's parent. 73 73 The sysfs directory's file attributes are defined and controlled through 74 74 the new device's class (firmware_class) and group (fw_dev_attr_groups). 75 - This is actually where the original firmware_class.c file name comes from, 76 - as originally the only firmware loading mechanism available was the 77 - mechanism we now use as a fallback mechanism. 75 + This is actually where the original firmware_class module name came from, 76 + given that originally the only firmware loading mechanism available was the 77 + mechanism we now use as a fallback mechanism, which registers a struct class 78 + firmware_class. Because the attributes exposed are part of the module name, the 79 + module name firmware_class cannot be renamed in the future, to ensure backward 80 + compatibility with old userspace. 78 81 79 82 To load firmware using the sysfs interface we expose a loading indicator, 80 83 and a file upload firmware into: