[U-Boot] [PATCH v3 2/3] doc: dtbinding: Add file system firmware loader binding document

tien.fong.chee at intel.com
2018-06-25T13:28:57Z

From: Tien Fong Chee <tien.fong.chee@intel.com>

Add a document to describe file system firmware loader binding
information.

Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
---
doc/device-tree-bindings/chosen.txt | 22 ++++++++++++
doc/device-tree-bindings/misc/fs_loader.txt | 52 +++++++++++++++++++++++++++++
2 files changed, 74 insertions(+)
create mode 100644 doc/device-tree-bindings/misc/fs_loader.txt

diff --git a/doc/device-tree-bindings/chosen.txt b/doc/device-tree-bindings/chosen.txt
index c96b8f7..738673c 100644
--- a/doc/device-tree-bindings/chosen.txt
+++ b/doc/device-tree-bindings/chosen.txt
@@ -73,3 +73,25 @@ Example
u-boot,spl-boot-order = "same-as-spl", &sdmmc, "/sdhci at fe330000";
};
};
+
+firmware-loader property
+------------------------
+Multiple file system firmware loader nodes could be defined in device trees for
+multiple storage type and their default partition, then a property
+"firmware-loader" can be used to pass default firmware loader
+node(default storage type) to the firmware loader driver.
+
+Example
+-------
+/ {
+ chosen {
+ firmware-loader = &fs_loader0;
+ };
+
+ fs_loader0: fs_loader at 0 {
+ u-boot,dm-pre-reloc;
+ compatible = "fs_loader";
+ storage_device = "mmc";
+ devpart = "0:1";
+ };
+};
diff --git a/doc/device-tree-bindings/misc/fs_loader.txt b/doc/device-tree-bindings/misc/fs_loader.txt
new file mode 100644
index 0000000..78bea66
--- /dev/null
+++ b/doc/device-tree-bindings/misc/fs_loader.txt
@@ -0,0 +1,52 @@
+* File system firmware loader
+
+Required properties:
+--------------------
+
+- compatible: should contain "fs_loader"
+- storage_device: which storage device loading from, could be:
+ - mmc, usb, sata, and ubi.
+- devpart: which storage device and partition the image loading from,
+ this property is required for mmc, usb and sata.
+- mdtpart: which partition of ubi the image loading from, this property is
+ required for ubi.
+- ubivol: which volume of ubi the image loading from, this proprety is required
+ for ubi.
+
+Example of storage device and partition search set for mmc, usb, sata and
+ubi in device tree source as shown in below:
+
+ Example of storage type and device partition search set for mmc, usb,
+ sata and ubi as shown in below:
+ Example for mmc:
+ fs_loader0: fs_loader at 0 {
+ u-boot,dm-pre-reloc;
+ compatible = "fs_loader";
+ storage_device = "mmc";
+ devpart = "0:1";
+ };
+
+ Example for usb:
+ fs_loader1: fs_loader at 1 {
+ u-boot,dm-pre-reloc;
+ compatible = "fs_loader";
+ storage_device = "usb";
+ devpart = "0:1";
+ };
+
+ Example for sata:
+ fs_loader2: fs_loader at 2 {
+ u-boot,dm-pre-reloc;
+ compatible = "fs_loader";
+ storage_device = "sata";
+ devpart = "0:1";
+ };
+
+ Example for ubi:
+ fs_loader3: fs_loader at 3 {
+ u-boot,dm-pre-reloc;
+ compatible = "fs_loader";
+ storage_device = "ubi";
+ mtdpart = "UBI",
+ ubivol = "ubi0";
+ };
--
2.2.0