add a minimal genimage support
Subsystems (2)
cover add a minimal genimage support
This patchset adds a minimal support for genimage config files, to ease the generation of custom complete target images.
The first patch explains the convenience of this host tool, and adds the mechanism to wrap and call genimage against optional config file(s).
The second patch uses the Raspberry Pi as an example for genimage. This shows how Buildroot can be used to create a fully functional SD card image with a persistent rootfs, without the need to mount any partition.
Vivien Didelot (2):
Makefile: add target-genimage boards/raspberrypi: add a sample genimage config
Makefile | 17 +++++++++++++++-- board/raspberrypi/genimage/persistent.cfg | 29 +++++++++++++++++++++++++++++ board/raspberrypi/readme.txt | 9 +++++++-- configs/raspberrypi_defconfig | 4 ++++ system/Config.in | 22 ++++++++++++++++++++++ 5 files changed, 77 insertions(+), 4 deletions(-) create mode 100644 board/raspberrypi/genimage/persistent.cfg
Signature · 1 line
2.3.0
RFC 1/2 Makefile: add target-genimage
genimage is a convenient host tool which eases the generation of images and partition layout by providing simple configuration files.
This patch adds a new BR2_ROOTFS_GENIMAGE_CFG menuconfig entry, which is a space-separated list of config files. Indeed, you may want to split images in different files, or put them all together in the same file.
BR2_ROOTFS_GENIMAGE_HOST_DEPENDENCIES is meant to auto-select the packages that genimage may use, such as mkdosfs or mcopy (which copies files from/to unmounted vfat images).
The rational behind adding this to Buildroot is that genimage requires an overhead configuration to use it, like temporary directories, host dependencies, and images path, that Buildroot is all aware of. This minimal addition is optional and allows the user not to write the same post-image script to wrap the genimage call.
Finally, the new "target-genimage" make target is called before target-post-image so that the post-image script can still clean intermediate generated images and do whatever with the very final image.
--- Makefile | 17 +++++++++++++++-- system/Config.in | 22 ++++++++++++++++++++++ 2 files changed, 37 insertions(+), 2 deletions(-)
Makefile +15 -2
@@ -434,7 +434,7 @@ world: target-post-image .PHONY: all world toolchain dirs clean distclean source outputmakefile \ legal-info legal-info-prepare legal-info-clean printvars \ - target-finalize target-post-image \ + target-finalize target-genimage target-post-image \ $(TARGETS) $(TARGETS_ROOTFS) \ $(TARGETS_DIRCLEAN) $(TARGETS_SOURCE) $(TARGETS_LEGAL_INFO) \ $(BUILD_DIR) $(STAGING_DIR) $(TARGET_DIR) \
@@ -621,7 +621,20 @@ endif $(call MESSAGE,"Executing post-build script $(s)"); \ $(EXTRA_ENV) $(s) $(TARGET_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep)) -target-post-image: $(TARGETS_ROOTFS) target-finalize +target-genimage: $(TARGETS_ROOTFS) target-finalize + @$(foreach cfg, $(call qstrip,$(BR2_ROOTFS_GENIMAGE_CFG)), \ + $(call MESSAGE,"Executing genimage with config $(cfg)"); \ + T=$$(mktemp -d $(BUILD_DIR)/.genimage.XXXXXXXXXX); \ + mkdir -p $$T/{root,tmp}; \ + $(EXTRA_ENV) output/host/usr/bin/genimage \ + --rootpath $$T/root \ + --tmppath $$T/tmp \ + --inputpath output/images/ \ + --outputpath output/images/ \ + --config $(cfg); \ + rm -rf $$T$(sep)) + +target-post-image: target-genimage @$(foreach s, $(call qstrip,$(BR2_ROOTFS_POST_IMAGE_SCRIPT)), \ $(call MESSAGE,"Executing post-image script $(s)"); \ $(EXTRA_ENV) $(s) $(BINARIES_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep))
system/Config.in +22 -0
@@ -421,6 +421,28 @@ config BR2_ROOTFS_POST_BUILD_SCRIPT argument. Make sure the exit code of those scripts are 0, otherwise make will stop after calling them. +config BR2_ROOTFS_GENIMAGE_CFG + string "genimage config files to prepare custom images" + default "" + help + Specify a space-separated list of configuration files for genimage to be + run after the build has finished and after Buildroot has packed the files + into selected filesystem images. + + This can for example be used to generate a card image with an vfat + partition containing some boot files, and an ext4 rootfs. + + genimage is executed from the main Buildroot source directory, with input + and output paths configured to output/images. + +config BR2_ROOTFS_GENIMAGE_HOST_DEPENDENCIES + bool "genimage host dependencies" + default y + depends on BR2_ROOTFS_GENIMAGE_CFG != "" + select BR2_PACKAGE_HOST_GENIMAGE + select BR2_PACKAGE_HOST_DOSFSTOOLS + select BR2_PACKAGE_HOST_MTOOLS + config BR2_ROOTFS_POST_IMAGE_SCRIPT string "Custom scripts to run after creating filesystem images" default ""
Signature · 1 line
2.3.0
RFC 1/2 Makefile: add target-genimage
Vivean,
A couple nitpicks ...
Quoted 7 lines · Vivien Didelot
genimage is a convenient host tool which eases the generation of images and partition layout by providing simple configuration files.
This patch adds a new
BR2_ROOTFS_GENIMAGE_CFGmenuconfig entry, which is a space-separated list of config files. Indeed, you may want to split images in different files, or put them all together in the same file.
Quoted 5 lines
BR2_ROOTFS_GENIMAGE_HOST_DEPENDENCIESis meant to auto-select the packages that genimage may use, such as mkdosfs or mcopy (which copies files from/to unmounted vfat images).The rational behind adding this to Buildroot is that genimage requires
spelling: "rationale".
Quoted 35 lines
an overhead configuration to use it, like temporary directories, host dependencies, and images path, that Buildroot is all aware of. This minimal addition is optional and allows the user not to write the same post-image script to wrap the genimage call.
Finally, the new "target-genimage" make target is called before target-post-image so that the post-image script can still clean intermediate generated images and do whatever with the very final image.
Signed-off-by Vivien Didelot <[email protected]>--- Makefile | 17 +++++++++++++++-- system/Config.in | 22 ++++++++++++++++++++++ 2 files changed, 37 insertions(+), 2 deletions(-)Makefile +3
-2@@ -434,7 +434,7 @@ world: target-post-image .PHONY: all world toolchain dirs clean distclean source outputmakefile \ legal-info legal-info-prepare legal-info-clean printvars \ - target-finalize target-post-image \ + target-finalize target-genimage target-post-image \ $(TARGETS) $(TARGETS_ROOTFS) \ $(TARGETS_DIRCLEAN) $(TARGETS_SOURCE) $(TARGETS_LEGAL_INFO) \ $(BUILD_DIR) $(STAGING_DIR) $(TARGET_DIR) \@@ -621,7 +621,20 @@ endif $(call MESSAGE,"Executing post-build script $(s)"); \ $(EXTRA_ENV) $(s) $(TARGET_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep)) -target-post-image: $(TARGETS_ROOTFS) target-finalize +target-genimage: $(TARGETS_ROOTFS) target-finalize + @$(foreach cfg, $(call qstrip,$(BR2_ROOTFS_GENIMAGE_CFG)), \
Makefile endif · line 635
Quoted 10 lines
Makefile +10
-0+ $(call MESSAGE,"Executing genimage with config $(cfg)"); \ + T=$$(mktemp -d $(BUILD_DIR)/.genimage.XXXXXXXXXX); \ + mkdir -p $$T/{root,tmp}; \ + $(EXTRA_ENV) output/host/usr/bin/genimage \ + --rootpath $$T/root \ + --tmppath $$T/tmp \ + --inputpath output/images/ \ + --outputpath output/images/ \ + --config $(cfg); \ + rm -rf $$T$(sep))
I don't think the final $(sep) is needed, since this the last line of a makefile target, as opposed to, say. a template.
Danomi -
Quoted 45 lines
Makefile +2
-0+ +target-post-image: target-genimage @$(foreach s, $(call qstrip,$(BR2_ROOTFS_POST_IMAGE_SCRIPT)), \ $(call MESSAGE,"Executing post-image script $(s)"); \ $(EXTRA_ENV) $(s) $(BINARIES_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep))system/Config.in +22
-1@@ -421,6 +421,28 @@ config BR2_ROOTFS_POST_BUILD_SCRIPT argument. Make sure the exit code of those scripts are 0, otherwise make will stop after calling them. +config BR2_ROOTFS_GENIMAGE_CFG + string "genimage config files to prepare custom images" + default "" + help + Specify a space-separated list of configuration files for genimage to be + run after the build has finished and after Buildroot has packed the files + into selected filesystem images. + + This can for example be used to generate a card image with an vfat + partition containing some boot files, and an ext4 rootfs. + + genimage is executed from the main Buildroot source directory, with input + and output paths configured to output/images. + +config BR2_ROOTFS_GENIMAGE_HOST_DEPENDENCIES + bool "genimage host dependencies" + default y + depends on BR2_ROOTFS_GENIMAGE_CFG != "" + select BR2_PACKAGE_HOST_GENIMAGE + select BR2_PACKAGE_HOST_DOSFSTOOLS + select BR2_PACKAGE_HOST_MTOOLS + config BR2_ROOTFS_POST_IMAGE_SCRIPT string "Custom scripts to run after creating filesystem images" default "" --2.3.0
_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot
RFC 1/2 Makefile: add target-genimage
Hi Danomi,
Quoted 1 line
A couple nitpicks ...
[...]
Quoted 4 lines
Quoted 2 lines
The rational behind adding this to Buildroot is that genimage requires
spelling: "rationale".
Thanks.
[...]
Quoted 28 lines
Quoted 28 lines
Makefile +1
-1@@ -434,7 +434,7 @@ world: target-post-image .PHONY: all world toolchain dirs clean distclean source outputmakefile \ legal-info legal-info-prepare legal-info-clean printvars \ - target-finalize target-post-image \ + target-finalize target-genimage target-post-image \ $(TARGETS) $(TARGETS_ROOTFS) \ $(TARGETS_DIRCLEAN) $(TARGETS_SOURCE) $(TARGETS_LEGAL_INFO)\ $(BUILD_DIR) $(STAGING_DIR) $(TARGET_DIR) \Makefile +7
-1@@ -621,7 +621,20 @@ endif $(call MESSAGE,"Executing post-build script $(s)"); \ $(EXTRA_ENV) $(s) $(TARGET_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep)) -target-post-image: $(TARGETS_ROOTFS) target-finalize +target-genimage: $(TARGETS_ROOTFS) target-finalize + @$(foreach cfg, $(call qstrip,$(BR2_ROOTFS_GENIMAGE_CFG)), \ + $(call MESSAGE,"Executing genimage with config $(cfg)"); \ + T=$$(mktemp -d $(BUILD_DIR)/.genimage.XXXXXXXXXX); \ + mkdir -p $$T/{root,tmp}; \ + $(EXTRA_ENV) output/host/usr/bin/genimage \ + --rootpath $$T/root \
Quoted 8 lines
Makefile endif · line 635
Quoted 5 lines
Makefile +5
-0+ --tmppath $$T/tmp \ + --inputpath output/images/ \ + --outputpath output/images/ \ + --config $(cfg); \ + rm -rf $$T$(sep))I don't think the final $(sep) is needed, since this the last line of a makefile target, as opposed to, say. a template.
Are you sure? I'm not sure either but I tried to follow the other foreach statements.
Thanks for the nitpicks. Other than that, an feedback on the overall RFC?
Regards,
Vivien
RFC 1/2 Makefile: add target-genimage
Vivien,
Quoted 52 lines · Vivien Didelot
Hi Danomi,
Quoted 1 line
A couple nitpicks ...
[...]
Quoted 4 lines
Quoted 2 lines
The rational behind adding this to Buildroot is that genimage requires
spelling: "rationale".
Thanks.
[...]
Quoted 28 lines
Quoted 28 lines
Makefile +1
-1@@ -434,7 +434,7 @@ world: target-post-image .PHONY: all world toolchain dirs clean distclean source outputmakefile \ legal-info legal-info-prepare legal-info-clean printvars \ - target-finalize target-post-image \ + target-finalize target-genimage target-post-image \ $(TARGETS) $(TARGETS_ROOTFS) \ $(TARGETS_DIRCLEAN) $(TARGETS_SOURCE) $(TARGETS_LEGAL_INFO)\ $(BUILD_DIR) $(STAGING_DIR) $(TARGET_DIR) \Makefile +7
-1@@ -621,7 +621,20 @@ endif $(call MESSAGE,"Executing post-build script $(s)"); \ $(EXTRA_ENV) $(s) $(TARGET_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep)) -target-post-image: $(TARGETS_ROOTFS) target-finalize +target-genimage: $(TARGETS_ROOTFS) target-finalize + @$(foreach cfg, $(call qstrip,$(BR2_ROOTFS_GENIMAGE_CFG)), \ + $(call MESSAGE,"Executing genimage with config $(cfg)"); \ + T=$$(mktemp -d $(BUILD_DIR)/.genimage.XXXXXXXXXX); \ + mkdir -p $$T/{root,tmp}; \ + $(EXTRA_ENV) output/host/usr/bin/genimage \ + --rootpath $$T/root \Quoted 8 lines
Makefile endif · line 635
Quoted 5 lines
Makefile +5
-0+ --tmppath $$T/tmp \ + --inputpath output/images/ \ + --outputpath output/images/ \ + --config $(cfg); \ + rm -rf $$T$(sep))I don't think the final $(sep) is needed, since this the last line of a makefile target, as opposed to, say. a template.
Quoted 2 lines
Are you sure? I'm not sure either but I tried to follow the other foreach statements.
Ah, so sorry, I missed the fact that it was a foreach. Comment retracted!
Quoted 1 line
Thanks for the nitpicks. Other than that, an feedback on the overall RFC?
Sorry, I haven't actually tried it.
Danomi -
Quoted 2 lines
Regards,
Vivien
RFC 1/2 Makefile: add target-genimage
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Dear Vivien,
looks good so far, and it fits well into my workflow, thanks for your contribution.
Unfortunately the out-of tree build is broken with this version, please see inline in your patch my comment.
I would propose to resend this patch with the fixed typos and the fix for the out-of-tree build.
Quoted 33 lines · Danomi Manchego
Vivien,
Quoted 29 lines · Vivien Didelot
Hi Danomi,
Quoted 1 line
A couple nitpicks ...
[...]
Quoted 4 lines
Quoted 2 lines
The rational behind adding this to Buildroot is that genimage requires
spelling: "rationale".
Thanks.
[...]
Quoted 14 lines
Quoted 14 lines
--- a/Makefile +++ b/Makefile @@ -434,7 +434,7 @@ world:
target-post-image.PHONY: all world toolchain dirs clean distclean source outputmakefile \ legal-info legal-info-prepare
legal-info-clean printvars \ - target-finalize
target-post-image \ + target-finalize target-genimage
target-post-image \ $(TARGETS) $(TARGETS_ROOTFS) \
$(TARGETS_DIRCLEAN) $(TARGETS_SOURCE) $(TARGETS_LEGAL_INFO) \ $(BUILD_DIR) $(STAGING_DIR) $(TARGET_DIR) \ @@ -621,7 +621,20 @@ endif $(call MESSAGE,"Executing post-build script $(s)"); \ $(EXTRA_ENV) $(s) $(TARGET_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep))
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
(quoted diff) +1
-1-target-post-image: $(TARGETS_ROOTFS) target-finalize +target-genimage: $(TARGETS_ROOTFS) target-finalize +@$(foreach cfg, $(call qstrip,$(BR2_ROOTFS_GENIMAGE_CFG)), \
+ $(call MESSAGE,"Executing genimage with config
$(cfg)"); \ + T=$$(mktemp -d
$(BUILD_DIR)/.genimage.XXXXXXXXXX); \ + mkdir -p
$$T/{root,tmp}; \ + $(EXTRA_ENV)
output/host/usr/bin/genimage \
should be $(HOST_DIR)/output/host/
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
+ --rootpath $$T/root \ + --tmppath $$T/tmp
\ + --inputpath output/images/ \ +
--outputpath output/images/ \
both of the paths should be $(BINARIES_DIR)
Quoted 17 lines
Quoted 7 lines
Quoted 4 lines
Quoted 1 line
+ --config $(cfg); \ + rm -rf $$T$(sep))
I don't think the final $(sep) is needed, since this the last line of a makefile target, as opposed to, say. a template.
Are you sure? I'm not sure either but I tried to follow the other foreach statements.
Ah, so sorry, I missed the fact that it was a foreach. Comment retracted!
Quoted 2 lines
Thanks for the nitpicks. Other than that, an feedback on the overall RFC?
Sorry, I haven't actually tried it.
Quoted 8 lines
Danomi -
Quoted 1 line
Regards, Vivien
_______________________________________________ buildroot mailing list buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot
- --
Bests,
Zoltan Gyarmati
IRC freenode: zgyarmati
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1
iQEcBAEBAgAGBQJU7ah2AAoJEAGmEeeR8iVhZ38H/0ZX29k/tKM3zjy05jwAGEcE OM0ySLjhIH+8843/CaNBszDXhG7kIxvfpFfX6ugGnmPJ2NAWu3ajnqk9oYHYkDyN gJJ7cN7aKo1RzVz64idZNY4ZyOxWyJVAK8vuLroQMOZO2h3Ztepf577UsfayfE82 ThIY4tmAgwbIrdoWeC6R6YGtlMgIMpyzEtQe4FGqNYhMT29XMhyvAJfGt0Ep+EMR o7FKZrBWMr+G+mX2M6QuFTPcAcY5hffqRUccOOp1pS5ciVSeOVkr2yUnlMpS5CNQ 8gCBAXjd2k/bWBpkdnn09xltVZQlOg1NysC4f7S1vqqFRrF9dfGv22Viz/I7yqA= =kvfn
-----END PGP SIGNATURE-----
RFC 2/2 boards/raspberrypi: add a sample genimage config
In reply to Vivien DidelotThis patch adds a "persistent.cfg" genimage config file for the Raspberry Pi, to use with a persistent rootfs. The final generated "sdcard.img" image is ready to use and contains the setup explained in the board readme.txt file: a bootable vfat partition with the rpi-firmware files, and an ext4 rootfs partition.
The defconfig and readme file have been slightly changed to add the generation of the rootfs.ext4 filesystem.
--- board/raspberrypi/genimage/persistent.cfg | 29 +++++++++++++++++++++++++++++ board/raspberrypi/readme.txt | 9 +++++++-- configs/raspberrypi_defconfig | 4 ++++ 3 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 board/raspberrypi/genimage/persistent.cfg
board/raspberrypi/genimage/persistent.cfg new file +29 -0
@@ -0,0 +1,29 @@ +image boot.vfat { + vfat { + files = { + "rpi-firmware/bootcode.bin", + "rpi-firmware/config.txt", + "rpi-firmware/fixup.dat", + "rpi-firmware/start.elf", + "zImage" + } + } + size = 10M +} + +image sdcard.img { + hdimage { + } + + partition boot { + partition-type = 0xC + bootable = "true" + image = "boot.vfat" + } + + partition rootfs { + partition-type = 0x83 + image = "rootfs.ext4" + size = 512M + } +}
board/raspberrypi/readme.txt +7 -2
@@ -11,6 +11,9 @@ Buildroot, you have to choose whether you will use: Also, a good source of information is http://elinux.org/R-Pi_Hub +Note: Buildroot already prepared an "sdcard.img" image for a persistent +rootfs, but this document explains how to do it manually. + How to build it ===============
@@ -56,6 +59,7 @@ After building, you should obtain this tree: output/images/ +-- rootfs.tar [0] + +-- rootfs.ext4 [0] +-- rpi-firmware/ | +-- bcm2708-rpi-b.dtb [1] | +-- bcm2708-rpi-b-plus.dtb [1]
@@ -65,8 +69,9 @@ After building, you should obtain this tree: | `-- start.elf `-- zImage -[0] Note for Volatile: rootfs.tar will only be there if you kept - "tar the root filesystem" option selected in "Filesystem images". +[0] Note for Volatile: rootfs.tar and rootfs.ext4 will only be there if + you kept "tar the root filesystem" and "ext2/3/4 root filesystem" + options selected in "Filesystem images". [1] The DTBs (Device Tree Blobs) will only be present if you setup Buildroot to install the DTBs from the rpi-firmware package, and
configs/raspberrypi_defconfig +4 -0
@@ -20,3 +20,7 @@ BR2_LINUX_KERNEL_CUSTOM_REPO_VERSION="c256eb9968c8997dce47350d2075e42f1b3991d3" BR2_LINUX_KERNEL_USE_DEFCONFIG=y BR2_LINUX_KERNEL_DEFCONFIG="bcmrpi_quick" BR2_LINUX_KERNEL_ZIMAGE=y + +BR2_TARGET_ROOTFS_EXT2=y +BR2_TARGET_ROOTFS_EXT2_4=y +BR2_ROOTFS_GENIMAGE_CFG="board/raspberrypi/genimage/persistent.cfg"
Signature · 1 line
2.3.0