doc/driver-model/fs_firmware_loader.txt

3 # SPDX-License-Identifier:    GPL-2.0
8 This is file system firmware loader for U-Boot framework, which has very close
9 to some Linux Firmware API. For the details of Linux Firmware API, you can refer
10 to https://01.org/linuxgraphics/gfx-docs/drm/driver-api/firmware/index.html.
12 File system firmware loader can be used to load whatever(firmware, image,
13 and binary) from the storage device in file system format into target location
17 To enable firmware loader, CONFIG_FS_LOADER need to be set at
20 Firmware Loader API core features
21 ---------------------------------
23 Firmware storage device described in device tree source
24 -------------------------------------------------------
26 	firmware loading from to the firmware loader driver, those data could be
27 	defined in fs-loader node as shown in below:
30 	fs_loader0: fs-loader@0 {
31 		u-boot,dm-pre-reloc;
32 		compatible = "u-boot,fs-loader";
42 	fs_loader1: fs-loader@1 {
43 		u-boot,dm-pre-reloc;
44 		compatible = "u-boot,fs-loader";
57 	However, this driver is also designed to support U-boot environment
59 	through the U-boot environment variable during run time.
61 	"storage_interface" - Storage interface, it can be "mmc", "usb", "sata"
63 	"fw_dev_part" - Block device number and its partition, it can be "0:1".
64 	"fw_ubi_mtdpart" - UBI device mtd partition, it can be "UBI".
65 	"fw_ubi_volume" - UBI volume, it can be "ubi0".
70 	at run time through U-boot console and saving the setting as default
74 File system firmware Loader API
75 -------------------------------
80 --------------------------------------------------------------------
81 Load firmware into a previously allocated buffer
89 	name of firmware file
92 	address of buffer to load firmware into
102 	-ve when error
105 	The firmware is loaded directly into the buffer pointed to by buf
107 Example of creating firmware loader instance and calling