diff options
author | Tien Fong Chee | 2018-07-06 03:27:35 -0500 |
---|---|---|
committer | Tom Rini | 2018-09-28 19:22:33 -0500 |
commit | fc5ca3ab5422601775148e7f65b28aa205055279 (patch) | |
tree | d481ba3c9e03ac02a972099a8dd26b1be43feb3c /doc | |
parent | 45029758be16456189671b63137b41a5d3fe3d8d (diff) | |
download | u-boot-fc5ca3ab5422601775148e7f65b28aa205055279.tar.gz u-boot-fc5ca3ab5422601775148e7f65b28aa205055279.tar.xz u-boot-fc5ca3ab5422601775148e7f65b28aa205055279.zip |
doc: dtbinding: Add file system firmware loader binding document
Add a document to describe file system firmware loader binding
information.
Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/device-tree-bindings/chosen.txt | 21 | ||||
-rw-r--r-- | doc/device-tree-bindings/misc/fs_loader.txt | 48 |
2 files changed, 69 insertions, 0 deletions
diff --git a/doc/device-tree-bindings/chosen.txt b/doc/device-tree-bindings/chosen.txt index da7b4e6c45..86c533ad6d 100644 --- a/doc/device-tree-bindings/chosen.txt +++ b/doc/device-tree-bindings/chosen.txt | |||
@@ -83,3 +83,24 @@ of where said later stage was booted from. | |||
83 | 83 | ||
84 | You should not define this property yourself in the device-tree, as it | 84 | You should not define this property yourself in the device-tree, as it |
85 | may be overwritten without warning. | 85 | may be overwritten without warning. |
86 | |||
87 | firmware-loader property | ||
88 | ------------------------ | ||
89 | Multiple file system firmware loader nodes could be defined in device trees for | ||
90 | multiple storage type and their default partition, then a property | ||
91 | "firmware-loader" can be used to pass default firmware loader | ||
92 | node(default storage type) to the firmware loader driver. | ||
93 | |||
94 | Example | ||
95 | ------- | ||
96 | / { | ||
97 | chosen { | ||
98 | firmware-loader = &fs_loader0; | ||
99 | }; | ||
100 | |||
101 | fs_loader0: fs-loader@0 { | ||
102 | u-boot,dm-pre-reloc; | ||
103 | compatible = "u-boot,fs-loader"; | ||
104 | phandlepart = <&mmc 1>; | ||
105 | }; | ||
106 | }; | ||
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 0000000000..884fbf47c0 --- /dev/null +++ b/doc/device-tree-bindings/misc/fs_loader.txt | |||
@@ -0,0 +1,48 @@ | |||
1 | * File system firmware loader | ||
2 | |||
3 | Required properties: | ||
4 | -------------------- | ||
5 | |||
6 | - compatible: should contain "u-boot,fs-loader" | ||
7 | - phandlepart: which block storage device and partition the image loading from, | ||
8 | this property is required for mmc, usb and sata. This is unsigned | ||
9 | 32-bit array. For example phandlepart=<&mmc_0 1>, meaning use | ||
10 | that MMC0 node pointer, partition 1. | ||
11 | - mdtpart: which partition of ubi the image loading from, this property is | ||
12 | required for ubi and mounting. | ||
13 | - ubivol: which volume of ubi the image loading from, this property is required | ||
14 | for ubi and mounting. | ||
15 | |||
16 | Example of storage device and partition search set for mmc, usb, sata and | ||
17 | ubi in device tree source as shown in below: | ||
18 | |||
19 | Example of storage type and device partition search set for mmc, usb, | ||
20 | sata and ubi as shown in below: | ||
21 | Example for mmc: | ||
22 | fs_loader0: fs-loader@0 { | ||
23 | u-boot,dm-pre-reloc; | ||
24 | compatible = "u-boot,fs-loader"; | ||
25 | phandlepart = <&mmc_0 1>; | ||
26 | }; | ||
27 | |||
28 | Example for usb: | ||
29 | fs_loader1: fs-loader@1 { | ||
30 | u-boot,dm-pre-reloc; | ||
31 | compatible = "u-boot,fs-loader"; | ||
32 | phandlepart = <&usb0 1>; | ||
33 | }; | ||
34 | |||
35 | Example for sata: | ||
36 | fs_loader2: fs-loader@2 { | ||
37 | u-boot,dm-pre-reloc; | ||
38 | compatible = "u-boot,fs-loader"; | ||
39 | phandlepart = <&sata0 1>; | ||
40 | }; | ||
41 | |||
42 | Example for ubi: | ||
43 | fs_loader3: fs-loader@3 { | ||
44 | u-boot,dm-pre-reloc; | ||
45 | compatible = "u-boot,fs-loader"; | ||
46 | mtdpart = "UBI", | ||
47 | ubivol = "ubi0"; | ||
48 | }; | ||