diff mbox series

[U-Boot,2/7] doc: FIT image: fix incorrect examples of DT node unit address

Message ID 20171204020513.18708-3-andre.przywara@arm.com
State Accepted
Commit b8790ebeec13c882979dc986947397738d9f38aa
Delegated to: Simon Glass
Headers show
Series Fix incorrect usage of the (FIT) DT node unit address | expand

Commit Message

Andre Przywara Dec. 4, 2017, 2:05 a.m. UTC
The DT spec demands a unit-address of a node name to match the "reg"
property in that node. Newer dtc versions will throw warnings if this is
not the case.
Fix all occurences in the FIT image example files where this was not
observed, to not give bad examples to the reader.

Signed-off-by: Andre Przywara <andre.przywara@arm.com>
---
 doc/uImage.FIT/kernel.its               | 28 ++++++++---------
 doc/uImage.FIT/kernel_fdt.its           | 20 ++++++------
 doc/uImage.FIT/multi-with-fpga.its      | 28 ++++++++---------
 doc/uImage.FIT/multi-with-loadables.its | 40 ++++++++++++------------
 doc/uImage.FIT/multi.its                | 54 ++++++++++++++++-----------------
 doc/uImage.FIT/multi_spl.its            | 14 ++++-----
 doc/uImage.FIT/sign-configs.its         | 18 +++++------
 doc/uImage.FIT/sign-images.its          | 16 +++++-----
 doc/uImage.FIT/update3.its              | 12 ++++----
 doc/uImage.FIT/update_uboot.its         |  4 +--
 10 files changed, 117 insertions(+), 117 deletions(-)

Comments

Simon Glass Dec. 19, 2017, 4:24 a.m. UTC | #1
On 3 December 2017 at 19:05, Andre Przywara <andre.przywara@arm.com> wrote:
> The DT spec demands a unit-address of a node name to match the "reg"
> property in that node. Newer dtc versions will throw warnings if this is
> not the case.
> Fix all occurences in the FIT image example files where this was not
> observed, to not give bad examples to the reader.
>
> Signed-off-by: Andre Przywara <andre.przywara@arm.com>
> ---
>  doc/uImage.FIT/kernel.its               | 28 ++++++++---------
>  doc/uImage.FIT/kernel_fdt.its           | 20 ++++++------
>  doc/uImage.FIT/multi-with-fpga.its      | 28 ++++++++---------
>  doc/uImage.FIT/multi-with-loadables.its | 40 ++++++++++++------------
>  doc/uImage.FIT/multi.its                | 54 ++++++++++++++++-----------------
>  doc/uImage.FIT/multi_spl.its            | 14 ++++-----
>  doc/uImage.FIT/sign-configs.its         | 18 +++++------
>  doc/uImage.FIT/sign-images.its          | 16 +++++-----
>  doc/uImage.FIT/update3.its              | 12 ++++----
>  doc/uImage.FIT/update_uboot.its         |  4 +--
>  10 files changed, 117 insertions(+), 117 deletions(-)

Reviewed-by: Simon Glass <sjg@chromium.org>
Simon Glass Dec. 19, 2017, 1:18 p.m. UTC | #2
On 18 December 2017 at 21:24, Simon Glass <sjg@chromium.org> wrote:
> On 3 December 2017 at 19:05, Andre Przywara <andre.przywara@arm.com> wrote:
>> The DT spec demands a unit-address of a node name to match the "reg"
>> property in that node. Newer dtc versions will throw warnings if this is
>> not the case.
>> Fix all occurences in the FIT image example files where this was not
>> observed, to not give bad examples to the reader.
>>
>> Signed-off-by: Andre Przywara <andre.przywara@arm.com>
>> ---
>>  doc/uImage.FIT/kernel.its               | 28 ++++++++---------
>>  doc/uImage.FIT/kernel_fdt.its           | 20 ++++++------
>>  doc/uImage.FIT/multi-with-fpga.its      | 28 ++++++++---------
>>  doc/uImage.FIT/multi-with-loadables.its | 40 ++++++++++++------------
>>  doc/uImage.FIT/multi.its                | 54 ++++++++++++++++-----------------
>>  doc/uImage.FIT/multi_spl.its            | 14 ++++-----
>>  doc/uImage.FIT/sign-configs.its         | 18 +++++------
>>  doc/uImage.FIT/sign-images.its          | 16 +++++-----
>>  doc/uImage.FIT/update3.its              | 12 ++++----
>>  doc/uImage.FIT/update_uboot.its         |  4 +--
>>  10 files changed, 117 insertions(+), 117 deletions(-)
>
> Reviewed-by: Simon Glass <sjg@chromium.org>

Applied to u-boot-dm, thanks!
diff mbox series

Patch

diff --git a/doc/uImage.FIT/kernel.its b/doc/uImage.FIT/kernel.its
index 0aaf47e6c6..77ddf622de 100644
--- a/doc/uImage.FIT/kernel.its
+++ b/doc/uImage.FIT/kernel.its
@@ -9,7 +9,7 @@ 
 	#address-cells = <1>;
 
 	images {
-		kernel@1 {
+		kernel {
 			description = "Vanilla Linux kernel";
 			data = /incbin/("./vmlinux.bin.gz");
 			type = "kernel";
@@ -18,20 +18,20 @@ 
 			compression = "gzip";
 			load = <00000000>;
 			entry = <00000000>;
-			hash@1 {
+			hash-1 {
 				algo = "crc32";
 			};
-			hash@2 {
+			hash-2 {
 				algo = "sha1";
 			};
 		};
 	};
 
 	configurations {
-		default = "config@1";
-		config@1 {
+		default = "config-1";
+		config-1 {
 			description = "Boot Linux kernel";
-			kernel = "kernel@1";
+			kernel = "kernel";
 		};
 	};
 };
@@ -47,7 +47,7 @@  For x86 a setup node is also required: see x86-fit-boot.txt.
 	#address-cells = <1>;
 
 	images {
-		kernel@1 {
+		kernel {
 			description = "Vanilla Linux kernel";
 			data = /incbin/("./image.bin.lzo");
 			type = "kernel";
@@ -56,12 +56,12 @@  For x86 a setup node is also required: see x86-fit-boot.txt.
 			compression = "lzo";
 			load = <0x01000000>;
 			entry = <0x00000000>;
-			hash@2 {
+			hash-2 {
 				algo = "sha1";
 			};
 		};
 
-		setup@1 {
+		setup {
 			description = "Linux setup.bin";
 			data = /incbin/("./setup.bin");
 			type = "x86_setup";
@@ -70,18 +70,18 @@  For x86 a setup node is also required: see x86-fit-boot.txt.
 			compression = "none";
 			load = <0x00090000>;
 			entry = <0x00090000>;
-			hash@2 {
+			hash-2 {
 				algo = "sha1";
 			};
 		};
 	};
 
 	configurations {
-		default = "config@1";
-		config@1 {
+		default = "config-1";
+		config-1 {
 			description = "Boot Linux kernel";
-			kernel = "kernel@1";
-			setup = "setup@1";
+			kernel = "kernel";
+			setup = "setup";
 		};
 	};
 };
diff --git a/doc/uImage.FIT/kernel_fdt.its b/doc/uImage.FIT/kernel_fdt.its
index 7c521486ef..000d85b8e0 100644
--- a/doc/uImage.FIT/kernel_fdt.its
+++ b/doc/uImage.FIT/kernel_fdt.its
@@ -9,7 +9,7 @@ 
 	#address-cells = <1>;
 
 	images {
-		kernel@1 {
+		kernel {
 			description = "Vanilla Linux kernel";
 			data = /incbin/("./vmlinux.bin.gz");
 			type = "kernel";
@@ -18,34 +18,34 @@ 
 			compression = "gzip";
 			load = <00000000>;
 			entry = <00000000>;
-			hash@1 {
+			hash-1 {
 				algo = "crc32";
 			};
-			hash@2 {
+			hash-2 {
 				algo = "sha1";
 			};
 		};
-		fdt@1 {
+		fdt-1 {
 			description = "Flattened Device Tree blob";
 			data = /incbin/("./target.dtb");
 			type = "flat_dt";
 			arch = "ppc";
 			compression = "none";
-			hash@1 {
+			hash-1 {
 				algo = "crc32";
 			};
-			hash@2 {
+			hash-2 {
 				algo = "sha1";
 			};
 		};
 	};
 
 	configurations {
-		default = "conf@1";
-		conf@1 {
+		default = "conf-1";
+		conf-1 {
 			description = "Boot Linux kernel with FDT blob";
-			kernel = "kernel@1";
-			fdt = "fdt@1";
+			kernel = "kernel";
+			fdt = "fdt-1";
 		};
 	};
 };
diff --git a/doc/uImage.FIT/multi-with-fpga.its b/doc/uImage.FIT/multi-with-fpga.its
index 0cdb31fe91..47ee5760c4 100644
--- a/doc/uImage.FIT/multi-with-fpga.its
+++ b/doc/uImage.FIT/multi-with-fpga.its
@@ -10,31 +10,31 @@ 
 	#address-cells = <1>;
 
 	images {
-		fdt@1 {
+		fdt-1 {
 			description = "zc706";
 			data = /incbin/("/tftpboot/devicetree.dtb");
 			type = "flat_dt";
 			arch = "arm";
 			compression = "none";
 			load = <0x10000000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
 		};
 
-		fpga@1 {
+		fpga {
 			description = "FPGA";
 			data = /incbin/("/tftpboot/download.bit");
 			type = "fpga";
 			arch = "arm";
 			compression = "none";
 			load = <0x30000000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
 		};
 
-		linux_kernel@1 {
+		linux_kernel {
 			description = "Linux";
 			data = /incbin/("/tftpboot/zImage");
 			type = "kernel";
@@ -43,25 +43,25 @@ 
 			compression = "none";
 			load = <0x8000>;
 			entry = <0x8000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
 		};
 	};
 
 	configurations {
-		default = "config@2";
-		config@1 {
+		default = "config-2";
+		config-1 {
 			description = "Linux";
-			kernel = "linux_kernel@1";
-			fdt = "fdt@1";
+			kernel = "linux_kernel";
+			fdt = "fdt-1";
 		};
 
-		config@2 {
+		config-2 {
 			description = "Linux with fpga";
-			kernel = "linux_kernel@1";
-			fdt = "fdt@1";
-			fpga = "fpga@1";
+			kernel = "linux_kernel";
+			fdt = "fdt-1";
+			fpga = "fpga";
 		};
 	};
 };
diff --git a/doc/uImage.FIT/multi-with-loadables.its b/doc/uImage.FIT/multi-with-loadables.its
index a8545d245c..4d4909f832 100644
--- a/doc/uImage.FIT/multi-with-loadables.its
+++ b/doc/uImage.FIT/multi-with-loadables.its
@@ -10,7 +10,7 @@ 
 	#address-cells = <1>;
 
 	images {
-		xen_kernel@1 {
+		xen_kernel {
 			description = "xen binary";
 			data = /incbin/("./xen");
 			type = "kernel";
@@ -19,36 +19,36 @@ 
 			compression = "none";
 			load = <0xa0000000>;
 			entry = <0xa0000000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
 		};
 
-		fdt@1 {
+		fdt-1 {
 			description = "xexpress-ca15 tree blob";
 			data = /incbin/("./vexpress-v2p-ca15-tc1.dtb");
 			type = "flat_dt";
 			arch = "arm";
 			compression = "none";
 			load = <0xb0000000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
 		};
 
-		fdt@2 {
+		fdt-2 {
 			description = "xexpress-ca15 tree blob";
 			data = /incbin/("./vexpress-v2p-ca15-tc1.dtb");
 			type = "flat_dt";
 			arch = "arm";
 			compression = "none";
 			load = <0xb0400000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
 		};
 
-		linux_kernel@1 {
+		linux_kernel {
 			description = "Linux Image";
 			data = /incbin/("./Image");
 			type = "kernel";
@@ -57,33 +57,33 @@ 
 			compression = "none";
 			load = <0xa0000000>;
 			entry = <0xa0000000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
 		};
 	};
 
 	configurations {
-		default = "config@2";
+		default = "config-2";
 
-		config@1 {
+		config-1 {
 			description = "Just plain Linux";
-			kernel = "linux_kernel@1";
-			fdt = "fdt@1";
+			kernel = "linux_kernel";
+			fdt = "fdt-1";
 		};
 
-		config@2 {
+		config-2 {
 			description = "Xen one loadable";
-			kernel = "xen_kernel@1";
-			fdt = "fdt@1";
-			loadables = "linux_kernel@1";
+			kernel = "xen_kernel";
+			fdt = "fdt-1";
+			loadables = "linux_kernel";
 		};
 
-		config@3 {
+		config-3 {
 			description = "Xen two loadables";
-			kernel = "xen_kernel@1";
-			fdt = "fdt@1";
-			loadables = "linux_kernel@1", "fdt@2";
+			kernel = "xen_kernel";
+			fdt = "fdt-1";
+			loadables = "linux_kernel", "fdt-2";
 		};
 	};
 };
diff --git a/doc/uImage.FIT/multi.its b/doc/uImage.FIT/multi.its
index 37369ecc82..26c8dad6a2 100644
--- a/doc/uImage.FIT/multi.its
+++ b/doc/uImage.FIT/multi.its
@@ -9,7 +9,7 @@ 
 	#address-cells = <1>;
 
 	images {
-		kernel@1 {
+		kernel-1 {
 			description = "vanilla-2.6.23";
 			data = /incbin/("./vmlinux.bin.gz");
 			type = "kernel";
@@ -18,15 +18,15 @@ 
 			compression = "gzip";
 			load = <00000000>;
 			entry = <00000000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
-			hash@2 {
+			hash-2 {
 				algo = "sha1";
 			};
 		};
 
-		kernel@2 {
+		kernel-2 {
 			description = "2.6.23-denx";
 			data = /incbin/("./2.6.23-denx.bin.gz");
 			type = "kernel";
@@ -35,12 +35,12 @@ 
 			compression = "gzip";
 			load = <00000000>;
 			entry = <00000000>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};
 
-		kernel@3 {
+		kernel-3 {
 			description = "2.4.25-denx";
 			data = /incbin/("./2.4.25-denx.bin.gz");
 			type = "kernel";
@@ -49,12 +49,12 @@ 
 			compression = "gzip";
 			load = <00000000>;
 			entry = <00000000>;
-			hash@1 {
+			hash-1 {
 				algo = "md5";
 			};
 		};
 
-		ramdisk@1 {
+		ramdisk-1 {
 			description = "eldk-4.2-ramdisk";
 			data = /incbin/("./eldk-4.2-ramdisk");
 			type = "ramdisk";
@@ -63,12 +63,12 @@ 
 			compression = "gzip";
 			load = <00000000>;
 			entry = <00000000>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};
 
-		ramdisk@2 {
+		ramdisk-2 {
 			description = "eldk-3.1-ramdisk";
 			data = /incbin/("./eldk-3.1-ramdisk");
 			type = "ramdisk";
@@ -77,30 +77,30 @@ 
 			compression = "gzip";
 			load = <00000000>;
 			entry = <00000000>;
-			hash@1 {
+			hash-1 {
 				algo = "crc32";
 			};
 		};
 
-		fdt@1 {
+		fdt-1 {
 			description = "tqm5200-fdt";
 			data = /incbin/("./tqm5200.dtb");
 			type = "flat_dt";
 			arch = "ppc";
 			compression = "none";
-			hash@1 {
+			hash-1 {
 				algo = "crc32";
 			};
 		};
 
-		fdt@2 {
+		fdt-2 {
 			description = "tqm5200s-fdt";
 			data = /incbin/("./tqm5200s.dtb");
 			type = "flat_dt";
 			arch = "ppc";
 			compression = "none";
 			load = <00700000>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};
@@ -108,26 +108,26 @@ 
 	};
 
 	configurations {
-		default = "config@1";
+		default = "config-1";
 
-		config@1 {
+		config-1 {
 			description = "tqm5200 vanilla-2.6.23 configuration";
-			kernel = "kernel@1";
-			ramdisk = "ramdisk@1";
-			fdt = "fdt@1";
+			kernel = "kernel-1";
+			ramdisk = "ramdisk-1";
+			fdt = "fdt-1";
 		};
 
-		config@2 {
+		config-2 {
 			description = "tqm5200s denx-2.6.23 configuration";
-			kernel = "kernel@2";
-			ramdisk = "ramdisk@1";
-			fdt = "fdt@2";
+			kernel = "kernel-2";
+			ramdisk = "ramdisk-1";
+			fdt = "fdt-2";
 		};
 
-		config@3 {
+		config-3 {
 			description = "tqm5200s denx-2.4.25 configuration";
-			kernel = "kernel@3";
-			ramdisk = "ramdisk@2";
+			kernel = "kernel-3";
+			ramdisk = "ramdisk-2";
 		};
 	};
 };
diff --git a/doc/uImage.FIT/multi_spl.its b/doc/uImage.FIT/multi_spl.its
index d43563d87a..5942199744 100644
--- a/doc/uImage.FIT/multi_spl.its
+++ b/doc/uImage.FIT/multi_spl.its
@@ -45,7 +45,7 @@ 
 			load = <0x40000>;
 		};
 
-		fdt@1 {
+		fdt-1 {
 			description = "Pine64+ DT";
 			type = "flat_dt";
 			compression = "none";
@@ -53,7 +53,7 @@ 
 			arch = "arm64";
 		};
 
-		fdt@2 {
+		fdt-2 {
 			description = "Pine64 DT";
 			type = "flat_dt";
 			compression = "none";
@@ -79,18 +79,18 @@ 
 	};
 
 	configurations {
-		default = "config@1";
+		default = "config-1";
 
-		config@1 {
+		config-1 {
 			description = "sun50i-a64-pine64-plus";
 			loadables = "uboot", "atf", "kernel", "initrd";
-			fdt = "fdt@1";
+			fdt = "fdt-1";
 		};
 
-		config@2 {
+		config-2 {
 			description = "sun50i-a64-pine64";
 			loadables = "uboot", "atf", "mgmt-firmware";
-			fdt = "fdt@2";
+			fdt = "fdt-2";
 		};
 	};
 };
diff --git a/doc/uImage.FIT/sign-configs.its b/doc/uImage.FIT/sign-configs.its
index 3c17f040de..9e992c1988 100644
--- a/doc/uImage.FIT/sign-configs.its
+++ b/doc/uImage.FIT/sign-configs.its
@@ -5,7 +5,7 @@ 
 	#address-cells = <1>;
 
 	images {
-		kernel@1 {
+		kernel {
 			data = /incbin/("test-kernel.bin");
 			type = "kernel_noload";
 			arch = "sandbox";
@@ -14,28 +14,28 @@ 
 			load = <0x4>;
 			entry = <0x8>;
 			kernel-version = <1>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};
-		fdt@1 {
+		fdt-1 {
 			description = "snow";
 			data = /incbin/("sandbox-kernel.dtb");
 			type = "flat_dt";
 			arch = "sandbox";
 			compression = "none";
 			fdt-version = <1>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};
 	};
 	configurations {
-		default = "conf@1";
-		conf@1 {
-			kernel = "kernel@1";
-			fdt = "fdt@1";
-			signature@1 {
+		default = "conf-1";
+		conf-1 {
+			kernel = "kernel";
+			fdt = "fdt-1";
+			signature {
 				algo = "sha1,rsa2048";
 				key-name-hint = "dev";
 				sign-images = "fdt", "kernel";
diff --git a/doc/uImage.FIT/sign-images.its b/doc/uImage.FIT/sign-images.its
index f69326a39b..18c759e9e6 100644
--- a/doc/uImage.FIT/sign-images.its
+++ b/doc/uImage.FIT/sign-images.its
@@ -5,7 +5,7 @@ 
 	#address-cells = <1>;
 
 	images {
-		kernel@1 {
+		kernel {
 			data = /incbin/("test-kernel.bin");
 			type = "kernel_noload";
 			arch = "sandbox";
@@ -14,29 +14,29 @@ 
 			load = <0x4>;
 			entry = <0x8>;
 			kernel-version = <1>;
-			signature@1 {
+			signature {
 				algo = "sha1,rsa2048";
 				key-name-hint = "dev";
 			};
 		};
-		fdt@1 {
+		fdt-1 {
 			description = "snow";
 			data = /incbin/("sandbox-kernel.dtb");
 			type = "flat_dt";
 			arch = "sandbox";
 			compression = "none";
 			fdt-version = <1>;
-			signature@1 {
+			signature {
 				algo = "sha1,rsa2048";
 				key-name-hint = "dev";
 			};
 		};
 	};
 	configurations {
-		default = "conf@1";
-		conf@1 {
-			kernel = "kernel@1";
-			fdt = "fdt@1";
+		default = "conf-1";
+		conf-1 {
+			kernel = "kernel";
+			fdt = "fdt-1";
 		};
 	};
 };
diff --git a/doc/uImage.FIT/update3.its b/doc/uImage.FIT/update3.its
index a6eaef691e..0659f20002 100644
--- a/doc/uImage.FIT/update3.its
+++ b/doc/uImage.FIT/update3.its
@@ -9,34 +9,34 @@ 
 	#address-cells = <1>;
 
 	images {
-		update@1 {
+		update-1 {
 			description = "Linux kernel binary";
 			data = /incbin/("./vmlinux.bin.gz");
 			compression = "none";
 			type = "firmware";
 			load = <FF700000>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};
-		update@2 {
+		update-2 {
 			description = "Ramdisk image";
 			data = /incbin/("./ramdisk_image.gz");
 			compression = "none";
 			type = "firmware";
 			load = <FF8E0000>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};
 
-		update@3 {
+		update-3 {
 			description = "FDT blob";
 			data = /incbin/("./blob.fdt");
 			compression = "none";
 			type = "firmware";
 			load = <FFAC0000>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};
diff --git a/doc/uImage.FIT/update_uboot.its b/doc/uImage.FIT/update_uboot.its
index 846723e2d6..c2ac2663e6 100644
--- a/doc/uImage.FIT/update_uboot.its
+++ b/doc/uImage.FIT/update_uboot.its
@@ -10,13 +10,13 @@ 
 	#address-cells = <1>;
 
 	images {
-		update@1 {
+		update-1 {
 			description = "U-Boot binary";
 			data = /incbin/("./u-boot.bin");
 			compression = "none";
 			type = "firmware";
 			load = <FFFC0000>;
-			hash@1 {
+			hash-1 {
 				algo = "sha1";
 			};
 		};