summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorBastian Krause <bst@pengutronix.de>2019-06-04 18:53:07 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2019-06-07 08:38:49 +0200
commitc5328f17b48b0778c90220b26b808a96413f5e91 (patch)
tree3b7f8a542bb761e7583cb342be20ca7f094e3204 /Documentation
parent3f3b1ac7a9fc62d47516ba8ac6170616b537b397 (diff)
downloadbarebox-c5328f17b48b0778c90220b26b808a96413f5e91.tar.gz
barebox-c5328f17b48b0778c90220b26b808a96413f5e91.tar.xz
doc: boards: imx: document image creation
Signed-off-by: Bastian Krause <bst@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/boards/imx.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
index 27d0123c87..abd9c76151 100644
--- a/Documentation/boards/imx.rst
+++ b/Documentation/boards/imx.rst
@@ -31,6 +31,21 @@ the i.MX images are generated with the ``scripts/imx/imx-image`` tool.
Normally it's not necessary to call this tool manually, it is executed
automatically at the end of the build process.
+Required entries for an i.MX image in ``images/Makefile.imx`` are for example:
+
+.. code-block:: none
+
+ pblb-$(CONFIG_MACH_MYBOARD) += start_imx6dl_myboard
+ CFG_start_imx6dl_myboard.pblb.imximg = $(board)/myboard/flash-header-imx6dl-myboard.imxcfg
+ FILE_barebox-imx6dl-myboard.img = start_imx6dl_myboard.pblb.imximg
+ image-$(CONFIG_MACH_MYBOARD) += barebox-imx6dl-myboard.img
+
+The first line defines the entry function of the pre-bootloader.
+This function must be defined in the board's ``lowlevel.c``.
+The second line describes the flash header to be used for the image, which is
+then compiled into an imximg file.
+The prebootloader is then added to the final barebox image.
+
The images generated by the build process can be directly written to an
SD card: