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

Message ID 1526462501-9586-3-git-send-email-tien.fong.chee@intel.com
State Superseded
Delegated to: Tom Rini
Headers show
Series
  • Generic file system firmware loader DM
Related show

Commit Message

Chee, Tien Fong May 16, 2018, 9:21 a.m.
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/misc/fs_loader.txt |   48 +++++++++++++++++++++++++++
 1 files changed, 48 insertions(+), 0 deletions(-)
 create mode 100644 doc/device-tree-bindings/misc/fs_loader.txt

Patch

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..4b3bb62
--- /dev/null
+++ b/doc/device-tree-bindings/misc/fs_loader.txt
@@ -0,0 +1,48 @@ 
+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 default storage device partition search set for mmc, usb, sata and
+ubi in device tree source as shown in below:
+
+Example for mmc:
+fs_loader {
+	u-boot,dm-pre-reloc;
+	compatible = "fs_loader";
+	storage_device = "mmc";
+	devpart = "0:1";
+};
+
+Example for usb:
+fs_loader {
+	u-boot,dm-pre-reloc;
+	compatible = "fs_loader";
+	storage_device = "usb";
+	devpart = "0:1";
+};
+
+Example for sata:
+fs_loader {
+	u-boot,dm-pre-reloc;
+	compatible = "fs_loader";
+	storage_device = "sata";
+	devpart = "0:1";
+};
+
+Example for ubi:
+fs_loader {
+	u-boot,dm-pre-reloc;
+	compatible = "fs_loader";
+	storage_device = "ubi";
+	mtdpart = "UBI",
+	ubivol = "ubi0";
+};