xref: /openbmc/linux/Documentation/ABI/testing/sysfs-class-firmware (revision 97730bbb242cde22b7140acd202ffd88823886c9)
1What: 		/sys/class/firmware/.../data
2Date:		July 2022
3KernelVersion:	5.19
4Contact:	Russ Weight <russell.h.weight@intel.com>
5Description:	The data sysfs file is used for firmware-fallback and for
6		firmware uploads. Cat a firmware image to this sysfs file
7		after you echo 1 to the loading sysfs file. When the firmware
8		image write is complete, echo 0 to the loading sysfs file. This
9		sequence will signal the completion of the firmware write and
10		signal the lower-level driver that the firmware data is
11		available.
12
13What: 		/sys/class/firmware/.../loading
14Date:		July 2022
15KernelVersion:	5.19
16Contact:	Russ Weight <russell.h.weight@intel.com>
17Description:	The loading sysfs file is used for both firmware-fallback and
18		for firmware uploads. Echo 1 onto the loading file to indicate
19		you are writing a firmware file to the data sysfs node. Echo
20		-1 onto this file to abort the data write or echo 0 onto this
21		file to indicate that the write is complete. For firmware
22		uploads, the zero value also triggers the transfer of the
23		firmware data to the lower-level device driver.
24
25What: 		/sys/class/firmware/.../timeout
26Date:		July 2022
27KernelVersion:	5.19
28Contact:	Russ Weight <russell.h.weight@intel.com>
29Description:	This file supports the timeout mechanism for firmware
30		fallback.  This file has no affect on firmware uploads. For
31		more information on timeouts please see the documentation
32		for firmware fallback.
33