From: Marco Felsch <m.felsch@pengutronix.de>
To: barebox@lists.infradead.org
Subject: [PATCH 26/26] Documentation: boards: imx: add FlexSPI sub-section
Date: Tue, 10 Oct 2023 16:33:14 +0200 [thread overview]
Message-ID: <20231010143314.2031253-27-m.felsch@pengutronix.de> (raw)
In-Reply-To: <20231010143314.2031253-1-m.felsch@pengutronix.de>
Document the FlexSPI image and boot feature to make it easier for users
to enable the support. Also document the image layout since it became
more complex with FlexSPI and HAB, so a detailed overview is very
helpful.
Signed-off-by: Marco Felsch <m.felsch@pengutronix.de>
---
Documentation/boards/imx.rst | 77 ++++++++++++++++++++++++++++++++++++
1 file changed, 77 insertions(+)
diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
index a8f014dd1b91..1b34c12cf4c6 100644
--- a/Documentation/boards/imx.rst
+++ b/Documentation/boards/imx.rst
@@ -394,6 +394,83 @@ with only the image name as argument:
scripts/imx/imx-usb-loader images/barebox-freescale-imx51-babbage.img
+FlexSPI Boot
+^^^^^^^^^^^^
+
+FlexSPI boot is currently supported on: i.MX8MM, i.MX8MN and i.MX8MP.
+
+To generate FlexSPI/QSPI image(s) the board flash header file must specify:
+``flexspi_ivtofs`` and ``flexspi_fcfbofs``.
+
+It is recommended to do this via the ``include/mach/imx/flexspi-imx8m*-cfg.h``
+header files due to HAB boot. In this case ``CONFIG_SPI_NXP_FLEXSPI`` must be
+enabled too
+
+.. code-block:: none
+
+ #include <mach/imx/flexspi-imx8mp-cfg.h>
+
+There are two different headers, one for the i.MX8MM and one for the i.MX8MP/N.
+It's important to use the correct one because the BootROM expects the IVT and
+flash configuration block (FCB) on different offsets.
+
+Barebox doesn't generate a separate FlexSPI image instead the same image used
+for SD/MMC/USB is extended to support FlexSPI boot. This is done by adding a 2nd
+IVT header and the required FCB at the required boot offsets.
+
+The FlexSPI boot(-image) also supports `High Assurance Boot`_ if enabled. A fully
+featured image with FlexSPI and HAB support for an i.MX8MM looks like::
+
+ 0x0 +------------------------------------------+
+ | Barebox Header |
+ header_gap +------------------------------------------+
+ | FlexSPI Flash Configuration Block (FCFB) |
+ header_gap + 0x400 +------------------------------------------+ ---
+ | i.MX MMC/SD/USB IVT Header | |
+ | Boot Data +--. |
+ | CSF Pointer +--|--. |
+ header_gap + 0x1000 +------------------------------------------+ | | --- |
+ | i.MX FlexSPI IVT Header | | | | | Signed Area
+ | Boot Data +--+ | | | MMC/SD/
+ | CSF Pointer +--|--|--. | Signed Area | USB
+ header_gap + 0x2000 +------------------------------------------+ | | | | FlexSPI |
+ | Barebox Prebootloader (PBL) |<-´ | | | |
+ | Piggydata Hash (SHA256) | | | | |
+ +------------------------------------------+ | | --- ---
+ | Command Sequence File (CSF) Slot-0 |<----´ |
+ +------------------------------------------+ |
+ | Command Sequence File (CSF) Slot-1 |<-------´
+ +------------------------------------------+ ---
+ | Piggydata (Main Barebox Binary) | | Hashed Area
+ +------------------------------------------+ ---
+
+For i.MX8MP/N devices the image does differ slightly due to different offsets::
+
+ 0x0 +------------------------------------------+
+ | Barebox Header |
+ header_gap +------------------------------------------+ ---
+ | i.MX MMC/SD/USB IVT Header | |
+ | Boot Data +--. |
+ | CSF Pointer +--|--. |
+ header_gap + 0x400 +------------------------------------------+ | | |
+ | FlexSPI Flash Configuration Block (FCFB) | | | | Signed Area
+ header_gap + 0x1000 +------------------------------------------+ | | --- | MMC/SD/
+ | i.MX FlexSPI IVT Header | | | | | USB
+ | Boot Data +--+ | | |
+ | CSF Pointer +--|--|--. | Signed Area |
+ header_gap + 0x2000 +------------------------------------------+ | | | | FlexSPI |
+ | Barebox Prebootloader (PBL) |<-´ | | | |
+ | Piggydata Hash (SHA256) | | | | |
+ +------------------------------------------+ | | --- ---
+ | Command Sequence File (CSF) Slot-0 |<----´ |
+ +------------------------------------------+ |
+ | Command Sequence File (CSF) Slot-1 |<-------´
+ +------------------------------------------+ ---
+ | Piggydata (Main Barebox Binary) | | Hashed Area
+ +------------------------------------------+ ---
+
+At the moment ``header_gap`` is always 32K for all supported devices.
+
External Boot Mode
------------------
--
2.39.2
prev parent reply other threads:[~2023-10-10 14:35 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-10 14:32 [PATCH 00/26] i.MX8M HAB Fixes Marco Felsch
2023-10-10 14:32 ` [PATCH 01/26] kbuild: clean start*_*.{p,ps}imximg files Marco Felsch
2023-10-10 14:32 ` [PATCH 02/26] i.MX: HABv4: fix event status comparison Marco Felsch
2023-10-10 14:32 ` [PATCH 03/26] i.MX: HABv4: fix i.MX8MQ device lockdown Marco Felsch
2023-10-10 18:35 ` [PATCH] fixup! " Ahmad Fatoum
2023-10-11 5:00 ` Marco Felsch
2023-10-10 14:32 ` [PATCH 04/26] i.MX: HAB: remove unused init() hook Marco Felsch
2023-10-10 14:32 ` [PATCH 05/26] i.MX: HABv4: extend support to i.MX8M SoCs Marco Felsch
2023-10-10 14:32 ` [PATCH 06/26] i.MX: HABv4: retrieve HAB ROM version for i.MX8M Marco Felsch
2023-10-10 14:32 ` [PATCH 07/26] ARM: i.MX: allow HAB for i.MX8M family Marco Felsch
2023-10-10 14:32 ` [PATCH 08/26] ARM: i.MX: introduce build_imx8m_habv4img Marco Felsch
2023-10-10 14:32 ` [PATCH 09/26] ARM: i.MX: convert i.MX8M to helper Marco Felsch
2023-10-10 14:32 ` [PATCH 10/26] ARM: boards: i.MX8M: add HAB image support Marco Felsch
2023-10-10 14:32 ` [PATCH 11/26] ARM: i.MX8M: add flexspi-imx8m{m,p}-cfg.h header Marco Felsch
2023-10-13 6:27 ` Sascha Hauer
2023-10-16 5:44 ` Marco Felsch
2023-10-10 14:33 ` [PATCH 12/26] ARM: boards: i.MX8M: make use of new " Marco Felsch
2023-10-10 14:33 ` [PATCH 13/26] ARM: lds: introduce HAB_CSF_LEN define for the hab_csf section Marco Felsch
2023-10-10 14:33 ` [PATCH 14/26] ARM: lds: add support for a 2nd CSF area Marco Felsch
2023-10-13 6:37 ` Sascha Hauer
2023-10-16 5:45 ` Marco Felsch
2023-10-10 14:33 ` [PATCH 15/26] scripts: imx: force flexspi and hab option order Marco Felsch
2023-10-10 14:33 ` [PATCH 16/26] scripts: imx: move flexspi_image() into header Marco Felsch
2023-10-10 14:33 ` [PATCH 17/26] scripts: imx: fix i.MX8M CSF header placement Marco Felsch
2023-10-10 14:33 ` [PATCH 18/26] scripts: imx: add imx8m_get_offset_size helper Marco Felsch
2023-10-10 14:33 ` [PATCH 19/26] scripts: imx-image: header_v2: add CSF slots Marco Felsch
2023-10-10 14:33 ` [PATCH 20/26] scripts: imx-image: hab_sign: refactor function Marco Felsch
2023-10-10 14:33 ` [PATCH 21/26] scripts: imx: add helper to write CSF Blocks command Marco Felsch
2023-10-13 7:28 ` Sascha Hauer
2023-10-16 5:50 ` Marco Felsch
2023-10-16 7:44 ` Marco Felsch
2023-10-16 8:19 ` Sascha Hauer
2023-10-17 14:58 ` Marco Felsch
2023-10-10 14:33 ` [PATCH 22/26] scripts: imx: fix HAB for FlexSPI boot Marco Felsch
2023-10-10 14:33 ` [PATCH 23/26] scripts: imx-image: add missing close() Marco Felsch
2023-10-10 14:33 ` [PATCH 24/26] scripts: imx-image: add support for CST_EXTRA_CMDLINE_OPTIONS Marco Felsch
2023-10-10 14:33 ` [PATCH 25/26] Documentation: boards: imx: replace i.MX8MQ with i.MX8M Marco Felsch
2023-10-10 14:33 ` Marco Felsch [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231010143314.2031253-27-m.felsch@pengutronix.de \
--to=m.felsch@pengutronix.de \
--cc=barebox@lists.infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox