[v2,2/2] cmd: Add dtimg command

Message ID 20180419205137.29182-2-semen.protsenko@linaro.org
State Superseded
Headers show
Series
  • [v2,1/2] common: Add support for Android DT image
Related show

Commit Message

Sam Protsenko April 19, 2018, 8:51 p.m.
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.

Signed-off-by: Sam Protsenko <semen.protsenko@linaro.org>
---
 cmd/Kconfig     |   8 +++
 cmd/Makefile    |   1 +
 cmd/dtimg.c     | 142 ++++++++++++++++++++++++++++++++++++++++++++++++
 common/Makefile |   4 ++
 4 files changed, 155 insertions(+)
 create mode 100644 cmd/dtimg.c

Comments

Alex Deymo May 8, 2018, 3:25 p.m. | #1
Le jeu. 19 avr. 2018 à 22:52, Sam Protsenko <semen.protsenko@linaro.org> a
écrit :

> 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.
>
> Signed-off-by: Sam Protsenko <semen.protsenko@linaro.org>
> ---
>  cmd/Kconfig     |   8 +++
>  cmd/Makefile    |   1 +
>  cmd/dtimg.c     | 142 ++++++++++++++++++++++++++++++++++++++++++++++++
>  common/Makefile |   4 ++
>  4 files changed, 155 insertions(+)
>  create mode 100644 cmd/dtimg.c
>
> diff --git a/cmd/Kconfig b/cmd/Kconfig
> index bc1d2f31c0..68f3cc7b48 100644
> --- a/cmd/Kconfig
> +++ b/cmd/Kconfig
> @@ -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
> diff --git a/cmd/Makefile b/cmd/Makefile
> index c4269ac8ac..1cc2e74e9e 100644
> --- a/cmd/Makefile
> +++ b/cmd/Makefile
> @@ -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
> diff --git a/cmd/dtimg.c b/cmd/dtimg.c
> new file mode 100644
> index 0000000000..5295a341ad
> --- /dev/null
> +++ b/cmd/dtimg.c
> @@ -0,0 +1,142 @@
> +/*
> + * (C) Copyright 2018 Linaro Ltd.
> + * Sam Protsenko <semen.protsenko@linaro.org>
> + *
> + * 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)
> +{
> +       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))
> +               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_tbl_t *cp;
> +
> +       cp = find_cmd_tbl(argv[1], cmd_dtimg_sub,
> ARRAY_SIZE(cmd_dtimg_sub));
> +
> +       /* Strip off leading 'dtimg' command argument */
> +       argc--;
> +       argv++;
> +
> +       if (!cp || argc > cp->maxargs)
> +               return CMD_RET_USAGE;
> +       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"


> +       "    - 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"
> +);
> diff --git a/common/Makefile b/common/Makefile
> index 7011dada99..6ef55d0d7a 100644
> --- a/common/Makefile
> +++ b/common/Makefile
> @@ -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
> --
> 2.17.0
>

You would likely need review from a maintainer, but otherwise this looks
fine (just one nit)
Reviewed-by: Alex Deymo <deymo@google.com>

Patch

diff --git a/cmd/Kconfig b/cmd/Kconfig
index bc1d2f31c0..68f3cc7b48 100644
--- a/cmd/Kconfig
+++ b/cmd/Kconfig
@@ -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
diff --git a/cmd/Makefile b/cmd/Makefile
index c4269ac8ac..1cc2e74e9e 100644
--- a/cmd/Makefile
+++ b/cmd/Makefile
@@ -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
diff --git a/cmd/dtimg.c b/cmd/dtimg.c
new file mode 100644
index 0000000000..5295a341ad
--- /dev/null
+++ b/cmd/dtimg.c
@@ -0,0 +1,142 @@ 
+/*
+ * (C) Copyright 2018 Linaro Ltd.
+ * Sam Protsenko <semen.protsenko@linaro.org>
+ *
+ * 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)
+{
+	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))
+		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_tbl_t *cp;
+
+	cp = find_cmd_tbl(argv[1], cmd_dtimg_sub, ARRAY_SIZE(cmd_dtimg_sub));
+
+	/* Strip off leading 'dtimg' command argument */
+	argc--;
+	argv++;
+
+	if (!cp || argc > cp->maxargs)
+		return CMD_RET_USAGE;
+	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"
+	"    - 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"
+);
diff --git a/common/Makefile b/common/Makefile
index 7011dada99..6ef55d0d7a 100644
--- a/common/Makefile
+++ b/common/Makefile
@@ -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