Skip to contentSkip to conversation

common: Add support for Android DT image

PATCH Superseded Sam Protsenko 3 participants 9 messages Apr 19, 2018 – May 28, 2018

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/2 common: Add support for Android DT image

Android documentation recommends new image format for storing DTB/DTBO
files: [1]. To support that format, two things should be done:

1. Add dt_table.h file from Android (BSD-3 relicensed version): [2]. This header defines structures and constants that we need to work with that DT image format.

Changes:
- re-licensed from Apache to BSD-3
- removed functions declarations
- change the coding style to kernel (make checkpatch happy)

2. Add helper functions for Android DTB/DTBO format. In image-android-dt.* files you can find helper functions to work with Android DT image format, such us routines for:
- printing the dump of image structure
- getting the address and size of desired dtb/dtbo file

[1] https://source.android.com/devices/architecture/dto/partitions
[2] https://android.googlesource.com/platform/system/libufdt/+/58a7582180f477032cd6c74f8d9afad0038e74c3/utils/src/dt_table.h

---
 common/image-android-dt.c  | 157 +++++++++++++++++++++++++++++++++++++
 include/dt_table.h         |  46 +++++++++++
 include/image-android-dt.h |  21 +++++
 3 files changed, 224 insertions(+)
 create mode 100644 common/image-android-dt.c
 create mode 100644 include/dt_table.h
 create mode 100644 include/image-android-dt.h
common/image-android-dt.c new file +157 -0
new file mode 100644
index 0000000000..9b7683faab
@@ -0,0 +1,157 @@
+/*
+ * (C) Copyright 2018 Linaro Ltd.
+ * Sam Protsenko <[email protected]>
+ *
+ * SPDX-License-Identifier:	GPL-2.0+
+ */
+
+#include <image-android-dt.h>
+#include <dt_table.h>
+#include <common.h>
+#include <linux/libfdt.h>
+#include <mapmem.h>
+
+/**
+ * Check if image header is correct.
+ *
+ * @param hdr_addr Start address of DT image
+ * @return true if header is correct or false if header is incorrect
+ */
+bool android_dt_check_header(ulong hdr_addr)
+{
+	const struct dt_table_header *hdr;
+	u32 magic;
+
+	hdr = map_sysmem(hdr_addr, sizeof(*hdr));
+	magic = fdt32_to_cpu(hdr->magic);
+	unmap_sysmem(hdr);
+
+	return magic == DT_TABLE_MAGIC;
+}
+
+/**
+ * Get the address of FDT (dtb or dtbo) in memory by its index in image.
+ *
+ * @param hdr_addr Start address of DT image
+ * @param index Index of desired FDT in image (starting from 0)
+ * @param[out] addr If not NULL, will contain address to specified FDT
+ * @param[out] size If not NULL, will contain size of specified FDT
+ *
+ * @return true on success or false on error
+ */
+bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr,
+				 u32 *size)
+{
+	const struct dt_table_header *hdr;
+	const struct dt_table_entry *e;
+	u32 entry_count, entries_offset, entry_size;
+	ulong e_addr;
+	u32 dt_offset, dt_size;
+
+	hdr = map_sysmem(hdr_addr, sizeof(*hdr));
+	entry_count = fdt32_to_cpu(hdr->dt_entry_count);
+	entries_offset = fdt32_to_cpu(hdr->dt_entries_offset);
+	entry_size = fdt32_to_cpu(hdr->dt_entry_size);
+	unmap_sysmem(hdr);
+
+	if (index > entry_count) {
+		printf("Error: index > dt_entry_count (%u > %u)\n", index,
+		       entry_count);
+		return false;
+	}
+
+	e_addr = hdr_addr + entries_offset + index * entry_size;
+	e = map_sysmem(e_addr, sizeof(*e));
+	dt_offset = fdt32_to_cpu(e->dt_offset);
+	dt_size = fdt32_to_cpu(e->dt_size);
+	unmap_sysmem(e);
+
+	if (addr)
+		*addr = hdr_addr + dt_offset;
+	if (size)
+		*size = dt_size;
+
+	return true;
+}
+
+#if !defined(CONFIG_SPL_BUILD)
+static void android_dt_print_fdt_info(const struct fdt_header *fdt)
+{
+	u32 fdt_size;
+	int root_node_off;
+	const char *compatible = NULL;
+
+	fdt_size = fdt_totalsize(fdt);
+	root_node_off = fdt_path_offset(fdt, "/");
+	if (root_node_off < 0) {
+		printf("Error: Root node not found\n");
+	} else {
+		compatible = fdt_getprop(fdt, root_node_off, "compatible",
+					 NULL);
+	}
+
+	printf("           (FDT)size = %d\n", fdt_size);
+	printf("     (FDT)compatible = %s\n",
+	       compatible ? compatible : "(unknown)");
+}
+
+/**
+ * Print information about DT image structure.
+ *
+ * @param hdr_addr Start address of DT image
+ */
+void android_dt_print_contents(ulong hdr_addr)
+{
+	const struct dt_table_header *hdr;
+	u32 entry_count, entries_offset, entry_size;
+	u32 i;
+
+	hdr = map_sysmem(hdr_addr, sizeof(*hdr));
+	entry_count = fdt32_to_cpu(hdr->dt_entry_count);
+	entries_offset = fdt32_to_cpu(hdr->dt_entries_offset);
+	entry_size = fdt32_to_cpu(hdr->dt_entry_size);
+
+	/* Print image header info */
+	printf("dt_table_header:\n");
+	printf("               magic = %08x\n", fdt32_to_cpu(hdr->magic));
+	printf("          total_size = %d\n", fdt32_to_cpu(hdr->total_size));
+	printf("         header_size = %d\n", fdt32_to_cpu(hdr->header_size));
+	printf("       dt_entry_size = %d\n", entry_size);
+	printf("      dt_entry_count = %d\n", entry_count);
+	printf("   dt_entries_offset = %d\n", entries_offset);
+	printf("           page_size = %d\n", fdt32_to_cpu(hdr->page_size));
+	printf("         reserved[0] = %08x\n", fdt32_to_cpu(hdr->reserved[0]));
+
+	unmap_sysmem(hdr);
+
+	/* Print image entries info */
+	for (i = 0; i < entry_count; ++i) {
+		const ulong e_addr = hdr_addr + entries_offset + i * entry_size;
+		const struct dt_table_entry *e;
+		const struct fdt_header *fdt;
+		u32 dt_offset, dt_size;
+		u32 j;
+
+		e = map_sysmem(e_addr, sizeof(*e));
+		dt_offset = fdt32_to_cpu(e->dt_offset);
+		dt_size = fdt32_to_cpu(e->dt_size);
+
+		printf("dt_table_entry[%d]:\n", i);
+		printf("             dt_size = %d\n", dt_size);
+		printf("           dt_offset = %d\n", dt_offset);
+		printf("                  id = %08x\n", fdt32_to_cpu(e->id));
+		printf("                 rev = %08x\n", fdt32_to_cpu(e->rev));
+		for (j = 0; j < 4; ++j) {
+			printf("           custom[%d] = %08x\n", j,
+			       fdt32_to_cpu(e->custom[j]));
+		}
+
+		unmap_sysmem(e);
+
+		/* Print FDT info for this entry */
+		fdt = map_sysmem(hdr_addr + dt_offset, sizeof(*fdt));
+		android_dt_print_fdt_info(fdt);
+		unmap_sysmem(fdt);
+	}
+}
+#endif
include/dt_table.h new file +46 -0

46 lines not on this page · raw message

include/image-android-dt.h new file +21 -0
new file mode 100644
index 0000000000..08b810d461
@@ -0,0 +1,21 @@
+/*
+ * (C) Copyright 2018 Linaro Ltd.
+ * Sam Protsenko <[email protected]>
+ *
+ * SPDX-License-Identifier:	GPL-2.0+
+ */
+
+#ifndef IMAGE_ANDROID_DT_H
+#define IMAGE_ANDROID_DT_H
+
+#include <linux/types.h>
+
+bool android_dt_check_header(ulong hdr_addr);
+bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr,
+				 u32 *size);
+
+#if !defined(CONFIG_SPL_BUILD)
+void android_dt_print_contents(ulong hdr_addr);
+#endif
+
+#endif /* IMAGE_ANDROID_DT_H */
Signature · 1 line
2.17.0
#1 lore raw

PATCH v2 2/2 cmd: Add dtimg command

dtimg command allows user to work with Android DTB/DTBO image format. Such as, getting the address of desired DTB/DTBO file, printing the dump of the image in U-Boot shell, etc.

This command is needed to provide Android boot with new Android DT image format further.

---
 cmd/Kconfig     |   8 +++
 cmd/Makefile    |   1 +
 cmd/dtimg.c     | 142 ++++++++++++++++++++++++++++++++++++++++++++++++
 common/Makefile |   4 ++
 4 files changed, 155 insertions(+)
 create mode 100644 cmd/dtimg.c
cmd/Kconfig +8 -0
index bc1d2f31c0..68f3cc7b48 100644
@@ -256,6 +256,14 @@ config CMD_BOOTMENU
 	help
 	  Add an ANSI terminal boot menu command.
 
+config CMD_DTIMG
+	bool "dtimg"
+	help
+	  Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
+	  image into RAM, dump image structure information, etc. Those dtb/dtbo
+	  files should be merged in one dtb further, which needs to be passed to
+	  the kernel, as part of a boot process.
+
 config CMD_ELF
 	bool "bootelf, bootvx"
 	default y
cmd/Makefile +1 -0
index c4269ac8ac..1cc2e74e9e 100644
@@ -43,6 +43,7 @@ ifdef CONFIG_POST
 obj-$(CONFIG_CMD_DIAG) += diag.o
 endif
 obj-$(CONFIG_CMD_DISPLAY) += display.o
+obj-$(CONFIG_CMD_DTIMG) += dtimg.o
 obj-$(CONFIG_CMD_ECHO) += echo.o
 obj-$(CONFIG_ENV_IS_IN_EEPROM) += eeprom.o
 obj-$(CONFIG_CMD_EEPROM) += eeprom.o
cmd/dtimg.c new file +142 -0

142 lines not on this page · raw message

common/Makefile +4 -0
index 7011dada99..6ef55d0d7a 100644
@@ -111,6 +111,10 @@ obj-$(CONFIG_IO_TRACE) += iotrace.o
 obj-y += memsize.o
 obj-y += stdio.o
 
+ifdef CONFIG_CMD_DTIMG
+obj-y += image-android-dt.o
+endif
+
 ifndef CONFIG_SPL_BUILD
 # This option is not just y/n - it can have a numeric value
 ifdef CONFIG_FASTBOOT_FLASH
Signature · 1 line
2.17.0
#2 lore raw

PATCH v2 2/2 cmd: Add dtimg command

Le jeu. 19 avr. 2018 à 22:52, Sam Protsenko <[email protected]> a écrit :

Quoted 180 lines

dtimg command allows user to work with Android DTB/DTBO image format. Such as, getting the address of desired DTB/DTBO file, printing the dump of the image in U-Boot shell, etc.

This command is needed to provide Android boot with new Android DT image format further.

---
 cmd/Kconfig     |   8 +++
 cmd/Makefile    |   1 +
 cmd/dtimg.c     | 142 ++++++++++++++++++++++++++++++++++++++++++++++++
 common/Makefile |   4 ++
 4 files changed, 155 insertions(+)
 create mode 100644 cmd/dtimg.c
cmd/Kconfig +4 -0
index bc1d2f31c0..68f3cc7b48 100644
@@ -256,6 +256,14 @@ config CMD_BOOTMENU
        help
          Add an ANSI terminal boot menu command.
 
+config CMD_DTIMG
+       bool "dtimg"
+       help
+         Android DTB/DTBO image manipulation commands. Read dtb/dtbo

files from
+ image into RAM, dump image structure information, etc. Those
dtb/dtbo
+ files should be merged in one dtb further, which needs to be
passed to

cmd/Kconfig +2 -0
+         the kernel, as part of a boot process.
+
 config CMD_ELF
        bool "bootelf, bootvx"
        default y
cmd/Makefile +1 -0
index c4269ac8ac..1cc2e74e9e 100644
@@ -43,6 +43,7 @@ ifdef CONFIG_POST
 obj-$(CONFIG_CMD_DIAG) += diag.o
 endif
 obj-$(CONFIG_CMD_DISPLAY) += display.o
+obj-$(CONFIG_CMD_DTIMG) += dtimg.o
 obj-$(CONFIG_CMD_ECHO) += echo.o
 obj-$(CONFIG_ENV_IS_IN_EEPROM) += eeprom.o
 obj-$(CONFIG_CMD_EEPROM) += eeprom.o
cmd/dtimg.c new file +41 -0
new file mode 100644
index 0000000000..5295a341ad
@@ -0,0 +1,142 @@
+/*
+ * (C) Copyright 2018 Linaro Ltd.
+ * Sam Protsenko <[email protected]>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <image-android-dt.h>
+#include <common.h>
+
+enum cmd_dtimg_info {
+       CMD_DTIMG_START = 0,
+       CMD_DTIMG_SIZE,
+};
+
+static int do_dtimg_dump(cmd_tbl_t *cmdtp, int flag, int argc,
+                        char * const argv[])
+{
+       char *endp;
+       ulong hdr_addr;
+
+       if (argc != 2)
+               return CMD_RET_USAGE;
+
+       hdr_addr = simple_strtoul(argv[1], &endp, 16);
+       if (*endp != '\0') {
+               printf("Error: Wrong image address\n");
+               return CMD_RET_FAILURE;
+       }
+
+       if (!android_dt_check_header(hdr_addr)) {
+               printf("Error: DT image header is incorrect\n");
+               return CMD_RET_FAILURE;
+       }
+
+       android_dt_print_contents(hdr_addr);
+
+       return CMD_RET_SUCCESS;
+}
+
+static int dtimg_get_fdt(int argc, char * const argv[], enum

cmd_dtimg_info cmd)

cmd/dtimg.c new file +29 -0
+{
+       ulong hdr_addr;
+       u32 index;
+       char *endp;
+       ulong fdt_addr;
+       u32 fdt_size;
+       char buf[65];
+
+       if (argc != 4)
+               return CMD_RET_USAGE;
+
+       hdr_addr = simple_strtoul(argv[1], &endp, 16);
+       if (*endp != '\0') {
+               printf("Error: Wrong image address\n");
+               return CMD_RET_FAILURE;
+       }
+
+       if (!android_dt_check_header(hdr_addr)) {
+               printf("Error: DT image header is incorrect\n");
+               return CMD_RET_FAILURE;
+       }
+
+       index = simple_strtoul(argv[2], &endp, 0);
+       if (*endp != '\0') {
+               printf("Error: Wrong index\n");
+               return CMD_RET_FAILURE;
+       }
+
+       if (!android_dt_get_fdt_by_index(hdr_addr, index, &fdt_addr,

&fdt_size))

cmd/dtimg.c new file +38 -0
+               return CMD_RET_FAILURE;
+
+       switch (cmd) {
+       case CMD_DTIMG_START:
+               snprintf(buf, sizeof(buf), "%lx", fdt_addr);
+               break;
+       case CMD_DTIMG_SIZE:
+               snprintf(buf, sizeof(buf), "%x", fdt_size);
+               break;
+       default:
+               printf("Error: Unknown cmd_dtimg_info value: %d\n", cmd);
+               return CMD_RET_FAILURE;
+       }
+
+       env_set(argv[3], buf);
+
+       return CMD_RET_SUCCESS;
+}
+
+static int do_dtimg_start(cmd_tbl_t *cmdtp, int flag, int argc,
+                         char * const argv[])
+{
+       return dtimg_get_fdt(argc, argv, CMD_DTIMG_START);
+}
+
+static int do_dtimg_size(cmd_tbl_t *cmdtp, int flag, int argc,
+                        char * const argv[])
+{
+       return dtimg_get_fdt(argc, argv, CMD_DTIMG_SIZE);
+}
+
+static cmd_tbl_t cmd_dtimg_sub[] = {
+       U_BOOT_CMD_MKENT(dump, 2, 0, do_dtimg_dump, "", ""),
+       U_BOOT_CMD_MKENT(start, 4, 0, do_dtimg_start, "", ""),
+       U_BOOT_CMD_MKENT(size, 4, 0, do_dtimg_size, "", ""),
+};
+
+static int do_dtimg(cmd_tbl_t *cmdtp, int flag, int argc, char * const

argv[])

cmd/dtimg.c new file +4 -0
+{
+       cmd_tbl_t *cp;
+
+       cp = find_cmd_tbl(argv[1], cmd_dtimg_sub,

ARRAY_SIZE(cmd_dtimg_sub));

cmd/dtimg.c new file +7 -0
+
+       /* Strip off leading 'dtimg' command argument */
+       argc--;
+       argv++;
+
+       if (!cp || argc > cp->maxargs)
+               return CMD_RET_USAGE;

cmd/dtimg.c line 129

Quoted 10 lines
cmd/dtimg.c new file +10 -0
+       if (flag == CMD_FLAG_REPEAT && !cp->repeatable)
+               return CMD_RET_SUCCESS;
+
+       return cp->cmd(cmdtp, flag, argc, argv);
+}
+
+U_BOOT_CMD(
+       dtimg, CONFIG_SYS_MAXARGS, 0, do_dtimg,
+       "manipulate dtb/dtbo Android image",
+       "dump <addr>\n"

"dtimg dump <addr>\n"

Quoted 29 lines
cmd/dtimg.c new file +13 -0
+       "    - parse specified image and print its structure info\n"
+       "      <addr>: image address in RAM, in hex\n"
+       "dtimg start <addr> <index> <varname>\n"
+       "    - get address (hex) of FDT in the image, by index\n"
+       "      <addr>: image address in RAM, in hex\n"
+       "      <index>: index of desired FDT in the image\n"
+       "      <varname>: name of variable where to store address of FDT\n"
+       "dtimg size <addr> <index> <varname>\n"
+       "    - get size (hex, bytes) of FDT in the image, by index\n"
+       "      <addr>: image address in RAM, in hex\n"
+       "      <index>: index of desired FDT in the image\n"
+       "      <varname>: name of variable where to store size of FDT"
+);
common/Makefile +4 -1
index 7011dada99..6ef55d0d7a 100644
@@ -111,6 +111,10 @@ obj-$(CONFIG_IO_TRACE) += iotrace.o
 obj-y += memsize.o
 obj-y += stdio.o
 
+ifdef CONFIG_CMD_DTIMG
+obj-y += image-android-dt.o
+endif
+
 ifndef CONFIG_SPL_BUILD
 # This option is not just y/n - it can have a numeric value
 ifdef CONFIG_FASTBOOT_FLASH
--
Quoted 2 lines

2.17.0

You would likely need review from a maintainer, but otherwise this looks fine (just one nit)

#3 lore raw

PATCH v2 1/2 common: Add support for Android DT image

In reply to Sam Protsenko

Le jeu. 19 avr. 2018 à 22:52, Sam Protsenko <[email protected]> a écrit :

Quoted 10 lines

Android documentation recommends new image format for storing DTB/DTBO
files: [1]. To support that format, two things should be done:

1. Add dt_table.h file from Android (BSD-3 relicensed version): [2]. This header defines structures and constants that we need to work with that DT image format.

Changes:
- re-licensed from Apache to BSD-3

I'm not familiar with how you handle these re-licensing so I can't say anything about that.

Quoted 2 lines

- removed functions declarations

You also removed DT_TABLE_DEFAULT_VERSION but left DT_TABLE_DEFAULT_PAGE_SIZE, was that intentional?

- change the coding style to kernel (make checkpatch happy)

Quoted 79 lines

2. Add helper functions for Android DTB/DTBO format. In image-android-dt.* files you can find helper functions to work with Android DT image format, such us routines for:
- printing the dump of image structure
- getting the address and size of desired dtb/dtbo file

[1] https://source.android.com/devices/architecture/dto/partitions
[2]
https://android.googlesource.com/platform/system/libufdt/+/58a7582180f477032cd6c74f8d9afad0038e74c3/utils/src/dt_table.h

---
 common/image-android-dt.c  | 157 +++++++++++++++++++++++++++++++++++++
 include/dt_table.h         |  46 +++++++++++
 include/image-android-dt.h |  21 +++++
 3 files changed, 224 insertions(+)
 create mode 100644 common/image-android-dt.c
 create mode 100644 include/dt_table.h
 create mode 100644 include/image-android-dt.h
common/image-android-dt.c new file +51 -0
new file mode 100644
index 0000000000..9b7683faab
@@ -0,0 +1,157 @@
+/*
+ * (C) Copyright 2018 Linaro Ltd.
+ * Sam Protsenko <[email protected]>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#include <image-android-dt.h>
+#include <dt_table.h>
+#include <common.h>
+#include <linux/libfdt.h>
+#include <mapmem.h>
+
+/**
+ * Check if image header is correct.
+ *
+ * @param hdr_addr Start address of DT image
+ * @return true if header is correct or false if header is incorrect
+ */
+bool android_dt_check_header(ulong hdr_addr)
+{
+       const struct dt_table_header *hdr;
+       u32 magic;
+
+       hdr = map_sysmem(hdr_addr, sizeof(*hdr));
+       magic = fdt32_to_cpu(hdr->magic);
+       unmap_sysmem(hdr);
+
+       return magic == DT_TABLE_MAGIC;
+}
+
+/**
+ * Get the address of FDT (dtb or dtbo) in memory by its index in image.
+ *
+ * @param hdr_addr Start address of DT image
+ * @param index Index of desired FDT in image (starting from 0)
+ * @param[out] addr If not NULL, will contain address to specified FDT
+ * @param[out] size If not NULL, will contain size of specified FDT
+ *
+ * @return true on success or false on error
+ */
+bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr,
+                                u32 *size)
+{
+       const struct dt_table_header *hdr;
+       const struct dt_table_entry *e;
+       u32 entry_count, entries_offset, entry_size;
+       ulong e_addr;
+       u32 dt_offset, dt_size;
+
+       hdr = map_sysmem(hdr_addr, sizeof(*hdr));

common/image-android-dt.c line 61

Quoted 10 lines
common/image-android-dt.c new file +10 -0
+       entry_count = fdt32_to_cpu(hdr->dt_entry_count);
+       entries_offset = fdt32_to_cpu(hdr->dt_entries_offset);
+       entry_size = fdt32_to_cpu(hdr->dt_entry_size);
+       unmap_sysmem(hdr);
+
+       if (index > entry_count) {
+               printf("Error: index > dt_entry_count (%u > %u)\n", index,
+                      entry_count);
+               return false;
+       }

This function assumes the image is valid in several places, but here you could also check that the relative offset you are going to load falls within the the fdt32_to_cpu(hdr->total_size).

+

Quoted 184 lines
common/image-android-dt.c new file +55 -0
+       e_addr = hdr_addr + entries_offset + index * entry_size;
+       e = map_sysmem(e_addr, sizeof(*e));
+       dt_offset = fdt32_to_cpu(e->dt_offset);
+       dt_size = fdt32_to_cpu(e->dt_size);
+       unmap_sysmem(e);
+
+       if (addr)
+               *addr = hdr_addr + dt_offset;
+       if (size)
+               *size = dt_size;
+
+       return true;
+}
+
+#if !defined(CONFIG_SPL_BUILD)
+static void android_dt_print_fdt_info(const struct fdt_header *fdt)
+{
+       u32 fdt_size;
+       int root_node_off;
+       const char *compatible = NULL;
+
+       fdt_size = fdt_totalsize(fdt);
+       root_node_off = fdt_path_offset(fdt, "/");
+       if (root_node_off < 0) {
+               printf("Error: Root node not found\n");
+       } else {
+               compatible = fdt_getprop(fdt, root_node_off, "compatible",
+                                        NULL);
+       }
+
+       printf("           (FDT)size = %d\n", fdt_size);
+       printf("     (FDT)compatible = %s\n",
+              compatible ? compatible : "(unknown)");
+}
+
+/**
+ * Print information about DT image structure.
+ *
+ * @param hdr_addr Start address of DT image
+ */
+void android_dt_print_contents(ulong hdr_addr)
+{
+       const struct dt_table_header *hdr;
+       u32 entry_count, entries_offset, entry_size;
+       u32 i;
+
+       hdr = map_sysmem(hdr_addr, sizeof(*hdr));
+       entry_count = fdt32_to_cpu(hdr->dt_entry_count);
+       entries_offset = fdt32_to_cpu(hdr->dt_entries_offset);
+       entry_size = fdt32_to_cpu(hdr->dt_entry_size);
+
+       /* Print image header info */
+       printf("dt_table_header:\n");
+       printf("               magic = %08x\n", fdt32_to_cpu(hdr->magic));
+       printf("          total_size = %d\n",

fdt32_to_cpu(hdr->total_size));
+ printf(" header_size = %d\n",
fdt32_to_cpu(hdr->header_size));

common/image-android-dt.c new file +4 -0
+       printf("       dt_entry_size = %d\n", entry_size);
+       printf("      dt_entry_count = %d\n", entry_count);
+       printf("   dt_entries_offset = %d\n", entries_offset);
+       printf("           page_size = %d\n",

fdt32_to_cpu(hdr->page_size));
+ printf(" reserved[0] = %08x\n",
fdt32_to_cpu(hdr->reserved[0]));

common/image-android-dt.c new file +6 -0
+
+       unmap_sysmem(hdr);
+
+       /* Print image entries info */
+       for (i = 0; i < entry_count; ++i) {
+               const ulong e_addr = hdr_addr + entries_offset + i *

entry_size;

common/image-android-dt.c new file +13 -0
+               const struct dt_table_entry *e;
+               const struct fdt_header *fdt;
+               u32 dt_offset, dt_size;
+               u32 j;
+
+               e = map_sysmem(e_addr, sizeof(*e));
+               dt_offset = fdt32_to_cpu(e->dt_offset);
+               dt_size = fdt32_to_cpu(e->dt_size);
+
+               printf("dt_table_entry[%d]:\n", i);
+               printf("             dt_size = %d\n", dt_size);
+               printf("           dt_offset = %d\n", dt_offset);
+               printf("                  id = %08x\n",

fdt32_to_cpu(e->id));
+ printf(" rev = %08x\n",
fdt32_to_cpu(e->rev));

common/image-android-dt.c new file +14 -0
+               for (j = 0; j < 4; ++j) {
+                       printf("           custom[%d] = %08x\n", j,
+                              fdt32_to_cpu(e->custom[j]));
+               }
+
+               unmap_sysmem(e);
+
+               /* Print FDT info for this entry */
+               fdt = map_sysmem(hdr_addr + dt_offset, sizeof(*fdt));
+               android_dt_print_fdt_info(fdt);
+               unmap_sysmem(fdt);
+       }
+}
+#endif
include/dt_table.h new file +21 -0
new file mode 100644
index 0000000000..19cbbeab2a
@@ -0,0 +1,46 @@
+/*
+ * This is from the Android Project,
+ * Repository: https://android.googlesource.com/platform/system/libufdt
+ * File: utils/src/dt_table.h
+ * Commit: 58a7582180f477032cd6c74f8d9afad0038e74c3
+ * Copyright (C) 2017 The Android Open Source Project
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+#ifndef DT_TABLE_H
+#define DT_TABLE_H
+
+#include <linux/types.h>
+
+#define DT_TABLE_MAGIC                 0xd7b7ab1e
+#define DT_TABLE_DEFAULT_PAGE_SIZE     2048
+
+struct dt_table_header {
+       u32 magic;              /* DT_TABLE_MAGIC */
+       u32 total_size;         /* includes dt_table_header + all

dt_table_entry

include/dt_table.h new file +9 -0
+                                * and all dtb/dtbo
+                                */
+       u32 header_size;        /* sizeof(dt_table_header) */
+
+       u32 dt_entry_size;      /* sizeof(dt_table_entry) */
+       u32 dt_entry_count;     /* number of dt_table_entry */
+       u32 dt_entries_offset;  /* offset to the first dt_table_entry
+                                * from head of dt_table_header.
+                                * The value will be equal to header_size

if

include/dt_table.h new file +16 -0
+                                * no padding is appended
+                                */
+       u32 page_size;          /* flash page size we assume */
+       u32 reserved[1];        /* must be zero */
+};
+
+struct dt_table_entry {
+       u32 dt_size;
+       u32 dt_offset;          /* offset from head of dt_table_header */
+
+       u32 id;                 /* optional, must be zero if unused */
+       u32 rev;                /* optional, must be zero if unused */
+       u32 custom[4];          /* optional, must be zero if unused */
+};
+
+#endif
include/image-android-dt.h new file +21 -1
new file mode 100644
index 0000000000..08b810d461
@@ -0,0 +1,21 @@
+/*
+ * (C) Copyright 2018 Linaro Ltd.
+ * Sam Protsenko <[email protected]>
+ *
+ * SPDX-License-Identifier:    GPL-2.0+
+ */
+
+#ifndef IMAGE_ANDROID_DT_H
+#define IMAGE_ANDROID_DT_H
+
+#include <linux/types.h>
+
+bool android_dt_check_header(ulong hdr_addr);
+bool android_dt_get_fdt_by_index(ulong hdr_addr, u32 index, ulong *addr,
+                                u32 *size);
+
+#if !defined(CONFIG_SPL_BUILD)
+void android_dt_print_contents(ulong hdr_addr);
+#endif
+
+#endif /* IMAGE_ANDROID_DT_H */
--
Quoted 2 lines

2.17.0

I haven't test this. Again, you probably want some maintainer to take a look too.

Regards,
Alex

#4 lore raw

PATCH v2 1/2 common: Add support for Android DT image

In reply to Sam Protsenko
Quoted 18 lines · Sam Protsenko

Android documentation recommends new image format for storing DTB/DTBO
files: [1]. To support that format, two things should be done:

1. Add dt_table.h file from Android (BSD-3 relicensed version): [2]. This header defines structures and constants that we need to work with that DT image format.

Changes:
- re-licensed from Apache to BSD-3
- removed functions declarations
- change the coding style to kernel (make checkpatch happy)

2. Add helper functions for Android DTB/DTBO format. In image-android-dt.* files you can find helper functions to work with Android DT image format, such us routines for:
- printing the dump of image structure
- getting the address and size of desired dtb/dtbo file

Quoted 4 lines

[1] https://source.android.com/devices/architecture/dto/partitions
[2] https://android.googlesource.com/platform/system/libufdt/+/58a7582180f477032cd6c74f8d9afad0038e74c3/utils/src/dt_table.h

Why is it OK to change the license on the code? AFAICT someone can't just relicense Apache to BSD-3. What happened for include/android_image.h was that Google relicensed the Android code in question to BSD-2 (which in turn allows us in GPL projects). Thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180516/8668a9e4/attachment.sig>
#5 lore raw

PATCH v2 1/2 common: Add support for Android DT image

Quoted 23 lines · Tom Rini
Quoted 21 lines · Sam Protsenko

Android documentation recommends new image format for storing DTB/DTBO
files: [1]. To support that format, two things should be done:

1. Add dt_table.h file from Android (BSD-3 relicensed version): [2]. This header defines structures and constants that we need to work with that DT image format.

Changes:
- re-licensed from Apache to BSD-3
- removed functions declarations
- change the coding style to kernel (make checkpatch happy)

2. Add helper functions for Android DTB/DTBO format. In image-android-dt.* files you can find helper functions to work with Android DT image format, such us routines for:
- printing the dump of image structure
- getting the address and size of desired dtb/dtbo file

[1] https://source.android.com/devices/architecture/dto/partitions
[2] https://android.googlesource.com/platform/system/libufdt/+/58a7582180f477032cd6c74f8d9afad0038e74c3/utils/src/dt_table.h

Quoted 7 lines
Quoted 1 line

Why is it OK to change the license on the code? AFAICT someone can't just relicense Apache to BSD-3. What happened for include/android_image.h was that Google relicensed the Android code in question to BSD-2 (which in turn allows us in GPL projects). Thanks!

Ok, I will try to ask Google to do the same for the header I used. Do you know what exactly should be done? Do they need to publish relicensed file somewhere, or exactly in Android, or we just need a confirmation from their side? Also, which license is preferable for us?

Thanks.

Quoted 2 lines

--
Tom

#6 lore raw

PATCH v2 1/2 common: Add support for Android DT image

Quoted 31 lines · Sam Protsenko
Quoted 23 lines · Tom Rini
Quoted 21 lines · Sam Protsenko

Android documentation recommends new image format for storing DTB/DTBO
files: [1]. To support that format, two things should be done:

1. Add dt_table.h file from Android (BSD-3 relicensed version): [2]. This header defines structures and constants that we need to work with that DT image format.

Changes:
- re-licensed from Apache to BSD-3
- removed functions declarations
- change the coding style to kernel (make checkpatch happy)

2. Add helper functions for Android DTB/DTBO format. In image-android-dt.* files you can find helper functions to work with Android DT image format, such us routines for:
- printing the dump of image structure
- getting the address and size of desired dtb/dtbo file

[1] https://source.android.com/devices/architecture/dto/partitions
[2] https://android.googlesource.com/platform/system/libufdt/+/58a7582180f477032cd6c74f8d9afad0038e74c3/utils/src/dt_table.h

Quoted 6 lines
Quoted 1 line

Why is it OK to change the license on the code? AFAICT someone can't just relicense Apache to BSD-3. What happened for include/android_image.h was that Google relicensed the Android code in question to BSD-2 (which in turn allows us in GPL projects). Thanks!

Quoted 5 lines

Ok, I will try to ask Google to do the same for the header I used. Do you know what exactly should be done? Do they need to publish relicensed file somewhere, or exactly in Android, or we just need a confirmation from their side? Also, which license is preferable for us?

I believe Alex helped us last time, and it was done, iirc, by someone from Google submitting the file with the license we need and a Signed-off-by from their google.com address.

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180524/4fabd8d5/attachment.sig>
#7 lore raw

PATCH v2 1/2 common: Add support for Android DT image

Hi,
I checked with our team and the include/dt_table.h import as BSD-3 here is fine with us. Would you like me to send a patch with just this header file or just Signed-off-by this whole patch?
Thanks,
deymo@

Quoted 46 lines · Tom Rini
Quoted 15 lines · Sam Protsenko
Quoted 14 lines · Tom Rini
Quoted 12 lines · Sam Protsenko

Android documentation recommends new image format for storing DTB/DTBO
files: [1]. To support that format, two things should be done:

1. Add dt_table.h file from Android (BSD-3 relicensed version): [2]. This header defines structures and constants that we need to work with that DT image format.

Changes:
- re-licensed from Apache to BSD-3
- removed functions declarations
- change the coding style to kernel (make checkpatch happy)

Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

2. Add helper functions for Android DTB/DTBO format. In image-android-dt.* files you can find helper functions to work with Android DT image format, such us routines for:
- printing the dump of image structure
- getting the address and size of desired dtb/dtbo file

[1] https://source.android.com/devices/architecture/dto/partitions
[2]

https://android.googlesource.com/platform/system/libufdt/+/58a7582180f477032cd6c74f8d9afad0038e74c3/utils/src/dt_table.h

Quoted 8 lines
Quoted 7 lines
Quoted 2 lines

Why is it OK to change the license on the code? AFAICT someone can't just relicense Apache to BSD-3. What happened for include/android_image.h was that Google relicensed the Android code in question to BSD-2 (which in turn allows us in GPL projects). Thanks!

Quoted 5 lines

Ok, I will try to ask Google to do the same for the header I used. Do you know what exactly should be done? Do they need to publish relicensed file somewhere, or exactly in Android, or we just need a confirmation from their side? Also, which license is preferable for us?

I believe Alex helped us last time, and it was done, iirc, by someone from Google submitting the file with the license we need and a Signed-off-by from their google.com address.

--
Tom

#8 lore raw

PATCH v2 1/2 common: Add support for Android DT image

Quoted 6 lines · Alex Deymo

Hi,
I checked with our team and the include/dt_table.h import as BSD-3 here is fine with us. Would you like me to send a patch with just this header file or just Signed-off-by this whole patch?
Thanks,
deymo@

Thanks and please submit a stand-alone patch for just the header.

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180528/f7a8ce3e/attachment.sig>