[ptxdist] [PATCH v2 1/3] kernel: add make target for the installed device trees

[ptxdist] [PATCH v2 1/3] kernel: add make target for the installed device trees

[Roland Hieber]

This makes it easy to depend on the kernel.targetinstall stage by
depending on one of the .dtb's that it installs into the image dir, e.g.
when building a custom recipe for a FIT image. As a nice side-effect,
you can simply call "ptxdist image <board.dtb>" to build the device
tree.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
PATCH v2:
 * change ifneq syntax

PATCH v1: https://lore.ptxdist.org/ptxdist/20230822121234.2040303-1-rhi@pengutronix.de
---
 rules/kernel.make | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/rules/kernel.make b/rules/kernel.make
index e70af54e6137..a12838bd78ea 100644
--- a/rules/kernel.make
+++ b/rules/kernel.make
@@ -281,6 +281,10 @@ endif
 # Target-Install
 # ----------------------------------------------------------------------------
 
+ifneq ($(KERNEL_DTB_FILES),)
+$(addprefix $(IMAGEDIR)/,$(KERNEL_DTB_FILES)): $(STATEDIR)/kernel.targetinstall
+endif
+
 $(STATEDIR)/kernel.targetinstall:
 	@$(call targetinfo)
 
-- 
2.39.2

[ptxdist] [PATCH v2 2/3] templates: add template for custom FIT images

[Roland Hieber]

Signed-off-by: Roland Hieber <rhi@pengutronix.de>

---
PATCH v2: no change
PATCH v1: https://lore.ptxdist.org/ptxdist/20230822121234.2040303-2-rhi@pengutronix.de
---
 rules/templates/template-image-fit-in   |  8 ++++++
 rules/templates/template-image-fit-make | 34 +++++++++++++++++++++++++
 scripts/lib/ptxd_lib_template.sh        | 25 ++++++++++++++++++
 3 files changed, 67 insertions(+)
 create mode 100644 rules/templates/template-image-fit-in
 create mode 100644 rules/templates/template-image-fit-make

diff --git a/rules/templates/template-image-fit-in b/rules/templates/template-image-fit-in
new file mode 100644
index 000000000000..ac5606dd0d89
--- /dev/null
+++ b/rules/templates/template-image-fit-in
@@ -0,0 +1,8 @@
+## SECTION=image
+
+config IMAGE_@PACKAGE@
+	tristate
+	@select_CODE_SIGNING@# TODO: select kernel and initrd image
+	prompt "Generate images/@package@.fit"
+	help
+	  FIXME
diff --git a/rules/templates/template-image-fit-make b/rules/templates/template-image-fit-make
new file mode 100644
index 000000000000..265b7e6350c7
--- /dev/null
+++ b/rules/templates/template-image-fit-make
@@ -0,0 +1,34 @@
+# -*-makefile-*-
+#
+# Copyright (C) @YEAR@ by @AUTHOR@
+#
+# For further information about the PTXdist project and license conditions
+# see the README file.
+#
+
+#
+# We provide this package
+#
+IMAGE_PACKAGES-$(PTXCONF_IMAGE_@PACKAGE@) += image-@package@
+
+#
+# Paths and names
+#
+IMAGE_@PACKAGE@			:= image-@package@
+IMAGE_@PACKAGE@_DIR		:= $(BUILDDIR)/$(IMAGE_@PACKAGE@)
+IMAGE_@PACKAGE@_IMAGE		:= $(IMAGEDIR)/@package@.fit
+IMAGE_@PACKAGE@_VERSION		:=
+IMAGE_@PACKAGE@_KERNEL		= # TODO: $(IMAGEDIR)/linuximage
+IMAGE_@PACKAGE@_DTB		= # TODO: $(IMAGEDIR)/your-board.dtb
+IMAGE_@PACKAGE@_INITRAMFS	= # optional: $(IMAGEDIR)/your-initramfs
+@CODE_SIGNING_VARS@
+# ----------------------------------------------------------------------------
+# Image
+# ----------------------------------------------------------------------------
+
+$(IMAGE_@PACKAGE@_IMAGE): $(IMAGE_@PACKAGE@_KERNEL) $(IMAGE_@PACKAGE@_INITRAMFS) $(IMAGE_@PACKAGE@_DTB)
+	@$(call targetinfo)
+	@$(call world/image-fit, IMAGE_@PACKAGE@)
+	@$(call finish)
+
+# vim: syntax=make
diff --git a/scripts/lib/ptxd_lib_template.sh b/scripts/lib/ptxd_lib_template.sh
index 30cc48d6c9b0..f8f188e148ac 100644
--- a/scripts/lib/ptxd_lib_template.sh
+++ b/scripts/lib/ptxd_lib_template.sh
@@ -598,6 +598,31 @@ export -f ptxd_template_new_image_tgz
 ptxd_template_help_list[${#ptxd_template_help_list[@]}]="image-tgz"
 ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create package for a tgz image"
 
+ptxd_template_new_image_fit() {
+    export class="image-"
+    ptxd_template_read_name &&
+    ptxd_template_read_author &&
+    ptxd_template_read "sign FIT image? (y/N)" SIGN
+    case "$SIGN" in
+	y*|Y*)
+	    export select_CODE_SIGNING="select CODE_SIGNING
+	"
+	    export CODE_SIGNING_VARS="
+IMAGE_@PACKAGE@_SIGN_ROLE	:= # TODO: role name of the code signing provider, passed to cs_get_uri
+IMAGE_@PACKAGE@_KEY_NAME_HINT	:= # TODO: key-name-hint property in the signature node of the FIT image
+"
+	;;
+	*)
+	    export select_CODE_SIGNING=""
+	    export CODE_SIGNING_VARS=""
+	;;
+    esac
+    ptxd_template_write_platform_rules
+}
+export -f ptxd_template_new_image_fit
+ptxd_template_help_list[${#ptxd_template_help_list[@]}]="image-fit"
+ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create package for a FIT image"
+
 ptxd_template_new_image_genimage() {
     export class="image-"
     ptxd_template_read_name &&
-- 
2.39.2

[ptxdist] [PATCH v2] fixup! templates: add template for custom FIT images

[Roland Hieber]

'mkimage' is needed to build the FIT image, select the correct host
package to make it available.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 rules/templates/template-image-fit-in | 1 +
 1 file changed, 1 insertion(+)

diff --git a/rules/templates/template-image-fit-in b/rules/templates/template-image-fit-in
index ac5606dd0d89..6319cdeac32b 100644
--- a/rules/templates/template-image-fit-in
+++ b/rules/templates/template-image-fit-in
@@ -2,6 +2,7 @@
 
 config IMAGE_@PACKAGE@
 	tristate
+	select HOST_U_BOOT_TOOLS
 	@select_CODE_SIGNING@# TODO: select kernel and initrd image
 	prompt "Generate images/@package@.fit"
 	help
-- 
2.39.2

Re: [ptxdist] [PATCH v2 2/3] templates: add template for custom FIT images

[Michael Olbrich]

On Thu, Aug 31, 2023 at 12:44:24PM +0200, Roland Hieber wrote:
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> 
> ---
> PATCH v2: no change
> PATCH v1: https://lore.ptxdist.org/ptxdist/20230822121234.2040303-2-rhi@pengutronix.de
> ---
>  rules/templates/template-image-fit-in   |  8 ++++++
>  rules/templates/template-image-fit-make | 34 +++++++++++++++++++++++++
>  scripts/lib/ptxd_lib_template.sh        | 25 ++++++++++++++++++
>  3 files changed, 67 insertions(+)
>  create mode 100644 rules/templates/template-image-fit-in
>  create mode 100644 rules/templates/template-image-fit-make
> 
> diff --git a/rules/templates/template-image-fit-in b/rules/templates/template-image-fit-in
> new file mode 100644
> index 000000000000..ac5606dd0d89
> --- /dev/null
> +++ b/rules/templates/template-image-fit-in
> @@ -0,0 +1,8 @@
> +## SECTION=image
> +
> +config IMAGE_@PACKAGE@
> +	tristate
> +	@select_CODE_SIGNING@# TODO: select kernel and initrd image

Nobody ever replaces those comments with something useful.
Just select the regular kernel here so we have a working default.

> +	prompt "Generate images/@package@.fit"
> +	help
> +	  FIXME
> diff --git a/rules/templates/template-image-fit-make b/rules/templates/template-image-fit-make
> new file mode 100644
> index 000000000000..265b7e6350c7
> --- /dev/null
> +++ b/rules/templates/template-image-fit-make
> @@ -0,0 +1,34 @@
> +# -*-makefile-*-
> +#
> +# Copyright (C) @YEAR@ by @AUTHOR@
> +#
> +# For further information about the PTXdist project and license conditions
> +# see the README file.
> +#
> +
> +#
> +# We provide this package
> +#
> +IMAGE_PACKAGES-$(PTXCONF_IMAGE_@PACKAGE@) += image-@package@
> +
> +#
> +# Paths and names
> +#
> +IMAGE_@PACKAGE@			:= image-@package@
> +IMAGE_@PACKAGE@_DIR		:= $(BUILDDIR)/$(IMAGE_@PACKAGE@)
> +IMAGE_@PACKAGE@_IMAGE		:= $(IMAGEDIR)/@package@.fit
> +IMAGE_@PACKAGE@_VERSION		:=
> +IMAGE_@PACKAGE@_KERNEL		= # TODO: $(IMAGEDIR)/linuximage

IMAGE_@PACKAGE@_KERNEL		 = $(IMAGEDIR)/linuximage

Note the space to align the '='.

> +IMAGE_@PACKAGE@_DTB		= # TODO: $(IMAGEDIR)/your-board.dtb


IMAGE_@PACKAGE@_DTB		 = $(addprefix $(IMAGEDIR)/,$(KERNEL_DTB_FILES))

> +IMAGE_@PACKAGE@_INITRAMFS	= # optional: $(IMAGEDIR)/your-initramfs

# IMAGE_@PACKAGE@_INITRAMFS	 = $(IMAGEDIR)/your-initramfs

I think.

> +@CODE_SIGNING_VARS@
> +# ----------------------------------------------------------------------------
> +# Image
> +# ----------------------------------------------------------------------------
> +
> +$(IMAGE_@PACKAGE@_IMAGE): $(IMAGE_@PACKAGE@_KERNEL) $(IMAGE_@PACKAGE@_INITRAMFS) $(IMAGE_@PACKAGE@_DTB)

No dependencies here. This should be covered by selecting the relevant
packages.

> +	@$(call targetinfo)
> +	@$(call world/image-fit, IMAGE_@PACKAGE@)
> +	@$(call finish)
> +
> +# vim: syntax=make
> diff --git a/scripts/lib/ptxd_lib_template.sh b/scripts/lib/ptxd_lib_template.sh
> index 30cc48d6c9b0..f8f188e148ac 100644
> --- a/scripts/lib/ptxd_lib_template.sh
> +++ b/scripts/lib/ptxd_lib_template.sh
> @@ -598,6 +598,31 @@ export -f ptxd_template_new_image_tgz
>  ptxd_template_help_list[${#ptxd_template_help_list[@]}]="image-tgz"
>  ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create package for a tgz image"
>  
> +ptxd_template_new_image_fit() {
> +    export class="image-"
> +    ptxd_template_read_name &&
> +    ptxd_template_read_author &&
> +    ptxd_template_read "sign FIT image? (y/N)" SIGN
> +    case "$SIGN" in
> +	y*|Y*)
> +	    export select_CODE_SIGNING="select CODE_SIGNING
> +	"
> +	    export CODE_SIGNING_VARS="
> +IMAGE_@PACKAGE@_SIGN_ROLE	:= # TODO: role name of the code signing provider, passed to cs_get_uri
> +IMAGE_@PACKAGE@_KEY_NAME_HINT	:= # TODO: key-name-hint property in the signature node of the FIT image

Ask for the two while building the template. Maybe with a useful default?

Michael

> +"
> +	;;
> +	*)
> +	    export select_CODE_SIGNING=""
> +	    export CODE_SIGNING_VARS=""
> +	;;
> +    esac
> +    ptxd_template_write_platform_rules
> +}
> +export -f ptxd_template_new_image_fit
> +ptxd_template_help_list[${#ptxd_template_help_list[@]}]="image-fit"
> +ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create package for a FIT image"
> +
>  ptxd_template_new_image_genimage() {
>      export class="image-"
>      ptxd_template_read_name &&
> -- 
> 2.39.2
> 
> 
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

Re: [ptxdist] [PATCH v2 2/3] templates: add template for custom FIT images

[Roland Hieber]

On Fri, Sep 01, 2023 at 08:48:40AM +0200, Michael Olbrich wrote:
> On Thu, Aug 31, 2023 at 12:44:24PM +0200, Roland Hieber wrote:
> > Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> > 
> > ---
> > PATCH v2: no change
> > PATCH v1: https://lore.ptxdist.org/ptxdist/20230822121234.2040303-2-rhi@pengutronix.de
> > ---
> >  rules/templates/template-image-fit-in   |  8 ++++++
> >  rules/templates/template-image-fit-make | 34 +++++++++++++++++++++++++
> >  scripts/lib/ptxd_lib_template.sh        | 25 ++++++++++++++++++
> >  3 files changed, 67 insertions(+)
> >  create mode 100644 rules/templates/template-image-fit-in
> >  create mode 100644 rules/templates/template-image-fit-make
> > 
> > diff --git a/rules/templates/template-image-fit-in b/rules/templates/template-image-fit-in
> > new file mode 100644
> > index 000000000000..ac5606dd0d89
> > --- /dev/null
> > +++ b/rules/templates/template-image-fit-in
> > @@ -0,0 +1,8 @@
> > +## SECTION=image
> > +
> > +config IMAGE_@PACKAGE@
> > +	tristate
> > +	@select_CODE_SIGNING@# TODO: select kernel and initrd image
> 
> Nobody ever replaces those comments with something useful.

Yes, I do :P

> Just select the regular kernel here so we have a working default.

OK.

 - Roland

> 
> > +	prompt "Generate images/@package@.fit"
> > +	help
> > +	  FIXME
> > diff --git a/rules/templates/template-image-fit-make b/rules/templates/template-image-fit-make
> > new file mode 100644
> > index 000000000000..265b7e6350c7
> > --- /dev/null
> > +++ b/rules/templates/template-image-fit-make
> > @@ -0,0 +1,34 @@
> > +# -*-makefile-*-
> > +#
> > +# Copyright (C) @YEAR@ by @AUTHOR@
> > +#
> > +# For further information about the PTXdist project and license conditions
> > +# see the README file.
> > +#
> > +
> > +#
> > +# We provide this package
> > +#
> > +IMAGE_PACKAGES-$(PTXCONF_IMAGE_@PACKAGE@) += image-@package@
> > +
> > +#
> > +# Paths and names
> > +#
> > +IMAGE_@PACKAGE@			:= image-@package@
> > +IMAGE_@PACKAGE@_DIR		:= $(BUILDDIR)/$(IMAGE_@PACKAGE@)
> > +IMAGE_@PACKAGE@_IMAGE		:= $(IMAGEDIR)/@package@.fit
> > +IMAGE_@PACKAGE@_VERSION		:=
> > +IMAGE_@PACKAGE@_KERNEL		= # TODO: $(IMAGEDIR)/linuximage
> 
> IMAGE_@PACKAGE@_KERNEL		 = $(IMAGEDIR)/linuximage
> 
> Note the space to align the '='.
> 
> > +IMAGE_@PACKAGE@_DTB		= # TODO: $(IMAGEDIR)/your-board.dtb
> 
> 
> IMAGE_@PACKAGE@_DTB		 = $(addprefix $(IMAGEDIR)/,$(KERNEL_DTB_FILES))
> 
> > +IMAGE_@PACKAGE@_INITRAMFS	= # optional: $(IMAGEDIR)/your-initramfs
> 
> # IMAGE_@PACKAGE@_INITRAMFS	 = $(IMAGEDIR)/your-initramfs
> 
> I think.
> 
> > +@CODE_SIGNING_VARS@
> > +# ----------------------------------------------------------------------------
> > +# Image
> > +# ----------------------------------------------------------------------------
> > +
> > +$(IMAGE_@PACKAGE@_IMAGE): $(IMAGE_@PACKAGE@_KERNEL) $(IMAGE_@PACKAGE@_INITRAMFS) $(IMAGE_@PACKAGE@_DTB)
> 
> No dependencies here. This should be covered by selecting the relevant
> packages.
> 
> > +	@$(call targetinfo)
> > +	@$(call world/image-fit, IMAGE_@PACKAGE@)
> > +	@$(call finish)
> > +
> > +# vim: syntax=make
> > diff --git a/scripts/lib/ptxd_lib_template.sh b/scripts/lib/ptxd_lib_template.sh
> > index 30cc48d6c9b0..f8f188e148ac 100644
> > --- a/scripts/lib/ptxd_lib_template.sh
> > +++ b/scripts/lib/ptxd_lib_template.sh
> > @@ -598,6 +598,31 @@ export -f ptxd_template_new_image_tgz
> >  ptxd_template_help_list[${#ptxd_template_help_list[@]}]="image-tgz"
> >  ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create package for a tgz image"
> >  
> > +ptxd_template_new_image_fit() {
> > +    export class="image-"
> > +    ptxd_template_read_name &&
> > +    ptxd_template_read_author &&
> > +    ptxd_template_read "sign FIT image? (y/N)" SIGN
> > +    case "$SIGN" in
> > +	y*|Y*)
> > +	    export select_CODE_SIGNING="select CODE_SIGNING
> > +	"
> > +	    export CODE_SIGNING_VARS="
> > +IMAGE_@PACKAGE@_SIGN_ROLE	:= # TODO: role name of the code signing provider, passed to cs_get_uri
> > +IMAGE_@PACKAGE@_KEY_NAME_HINT	:= # TODO: key-name-hint property in the signature node of the FIT image
> 
> Ask for the two while building the template. Maybe with a useful default?
> 
> Michael
> 
> > +"
> > +	;;
> > +	*)
> > +	    export select_CODE_SIGNING=""
> > +	    export CODE_SIGNING_VARS=""
> > +	;;
> > +    esac
> > +    ptxd_template_write_platform_rules
> > +}
> > +export -f ptxd_template_new_image_fit
> > +ptxd_template_help_list[${#ptxd_template_help_list[@]}]="image-fit"
> > +ptxd_template_help_list[${#ptxd_template_help_list[@]}]="create package for a FIT image"
> > +
> >  ptxd_template_new_image_genimage() {
> >      export class="image-"
> >      ptxd_template_read_name &&
> > -- 
> > 2.39.2
> > 
> > 
> > 
> 
> -- 
> Pengutronix e.K.                           |                             |
> Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
> 31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
> Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |
> 

-- 
Roland Hieber, Pengutronix e.K.          | r.hieber@pengutronix.de     |
Steuerwalder Str. 21                     | https://www.pengutronix.de/ |
31137 Hildesheim, Germany                | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686         | Fax:   +49-5121-206917-5555 |

[ptxdist] [PATCH v2 3/3] doc: ref_make_macros: document world/image-fit macro

[Roland Hieber]

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
PATCH v2: no change
PATCH v1: https://lore.ptxdist.org/ptxdist/20230822121234.2040303-3-rhi@pengutronix.de
---
 doc/ref_make_macros.rst | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/doc/ref_make_macros.rst b/doc/ref_make_macros.rst
index b8cfe9eff644..fe300c45757a 100644
--- a/doc/ref_make_macros.rst
+++ b/doc/ref_make_macros.rst
@@ -175,6 +175,44 @@ omitted.
 
 ``ptx/image-install-link`` creates a symlink in the image directory.
 
+.. _world_image_fit:
+
+world/image-fit
+~~~~~~~~~~~~~~~
+
+.. code-block:: none
+
+ @$(call world/image-fit, <PKG>)
+
+Build a FIT image containing a kernel, optionally an initial ramdisk, and one or
+multiple device trees. For each device tree, a configuration node is generated.
+
+.. note:: You can generate a template for a new FIT image recipe by
+   calling ``ptxdist newpackage image-fit``.
+
+The following variables are respected:
+
+``<PKG>_IMAGE``
+   The output file, usually something like ``$(IMAGEDIR)/pkg.fit``.
+
+``<PKG>_KERNEL``
+   The kernel image to package into the FIT image.
+
+``<PKG>_DTB``
+   One or more device trees that should be included in the FIT image.
+
+``<PKG>_INITRAMFS``
+   If the FIT image should contain an initial ramdisk, this variable determines
+   the initrd file name that is included. Otherwise it can be left empty.
+
+``<PKG>_SIGN_ROLE``
+   If the FIT image should be signed, this variable determines the role name
+   used for the signature. It is passed to :ref:`cs_get_uri`.
+
+``<PKG>_KEY_NAME_HINT``
+   If the FIT image should be signed, this variable determines the
+   *key-name-hint* property of the signature node.
+
 .. _install_copy:
 
 install_copy
-- 
2.39.2

Re: [ptxdist] [PATCH v2 1/3] kernel: add make target for the installed device trees

[Michael Olbrich]

On Thu, Aug 31, 2023 at 12:44:23PM +0200, Roland Hieber wrote:
> This makes it easy to depend on the kernel.targetinstall stage by
> depending on one of the .dtb's that it installs into the image dir, e.g.
> when building a custom recipe for a FIT image. As a nice side-effect,
> you can simply call "ptxdist image <board.dtb>" to build the device
> tree.

Add the same thing to the kernel template to make sure that behaves the
same way. Sorry, forgot about that when I reviewed the first version.

Michael

> 
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> ---
> PATCH v2:
>  * change ifneq syntax
> 
> PATCH v1: https://lore.ptxdist.org/ptxdist/20230822121234.2040303-1-rhi@pengutronix.de
> ---
>  rules/kernel.make | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/rules/kernel.make b/rules/kernel.make
> index e70af54e6137..a12838bd78ea 100644
> --- a/rules/kernel.make
> +++ b/rules/kernel.make
> @@ -281,6 +281,10 @@ endif
>  # Target-Install
>  # ----------------------------------------------------------------------------
>  
> +ifneq ($(KERNEL_DTB_FILES),)
> +$(addprefix $(IMAGEDIR)/,$(KERNEL_DTB_FILES)): $(STATEDIR)/kernel.targetinstall
> +endif
> +
>  $(STATEDIR)/kernel.targetinstall:
>  	@$(call targetinfo)
>  
> -- 
> 2.39.2
> 
> 
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |