Merge branch 'master' of git://git.denx.de/u-boot-socfpga
[oweals/u-boot.git] / doc / device-tree-bindings / misc / fs_loader.txt
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         };