Skip to contentSkip to conversation

binman: imx8mimage: Handle nxp,boot-from = "fspi"

PATCH Superseded Marek Vasut 3 participants 9 messages May 25 – Jun 3

Subsystems (2)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/3 binman: imx8mimage: Handle nxp,boot-from = "fspi"

Boot from FSPI requires additional 448 Byte long header, with U-Boot SPL starting at offset 0x1000. Currently, both i.MX8MM and i.MX8MN attempt to generate this header using fspi_conf_block with filename pointing at CONFIG_FSPI_CONF_FILE file. This does not work, for two reasons.

First, the CONFIG_FSPI_CONF_FILE is generated by mkimage -T imx8mimage and may not be available yet when the fspi_conf_block is evaluated. That leads to a race condition where highly parallel builds fail to find the CONFIG_FSPI_CONF_FILE, which is usually called fspi_header.bin, on first build attempt.

Second, binman gets confused and patches incorrect offset of DDR PHY firmware blobs into U-Boot SPL, the offset is incremented by exactly 0x1000 which is the size of fspi_conf_block.

Fix both problems at once, make imx8mimage handle the generated FSPI header and prepend it in front of the imx8mimage processed data. This way, the race condition is solved, because the data generated by the imx8mimage are surely combined only after mkimage -T imx8mimage ran. The binman offset calculation is also solved, because there is no fspi_conf_block node in the DT anymore.

---
Cc: "NXP i.MX U-Boot Team" <[email protected]>
Cc: Adam Ford <[email protected]>
Cc: Alexander Koch <[email protected]>
Cc: Fabio Estevam <[email protected]>
Cc: Peng Fan <[email protected]>
Cc: Simon Glass <[email protected]>
Cc: Tom Rini <[email protected]>
Cc: [email protected]
---
V2: - Move test into vendor/nxp_imx8m_fspi.dts
- Fix up path handling in both etype and test

---
 tools/binman/etype/nxp_imx8mimage.py        | 11 ++++++++++-
 tools/binman/ftest.py                       |  9 +++++++++
 tools/binman/test/vendor/nxp_imx8m_fspi.dts | 18 ++++++++++++++++++
 3 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100644 tools/binman/test/vendor/nxp_imx8m_fspi.dts
tools/binman/etype/nxp_imx8mimage.py +10 -1
index 8ad177b3b65..008d2f914db 100644
@@ -7,6 +7,8 @@
 # configuration file and input data.
 #
 
+import os
+
 from collections import OrderedDict
 
 from binman.entry import Entry
@@ -33,6 +35,7 @@ class Entry_nxp_imx8mimage(Entry_mkimage):
     def ReadNode(self):
         super().ReadNode()
         self.boot_from = fdt_util.GetString(self._node, 'nxp,boot-from')
+        self.fspi_header = fdt_util.GetString(self._node, 'nxp,fspi-header-filename')
         self.loader_address = fdt_util.GetInt(self._node, 'nxp,loader-address')
         self.rom_version = fdt_util.GetInt(self._node, 'nxp,rom-version')
         self.ReadEntries()
@@ -52,7 +55,13 @@ class Entry_nxp_imx8mimage(Entry_mkimage):
         args = ['-d', input_fname, '-n', cfg_fname, '-T', 'imx8mimage',
                 output_fname]
         if self.mkimage.run_cmd(*args) is not None:
-            return tools.read_file(output_fname)
+            outdata = tools.read_file(output_fname)
+            if self.boot_from == 'fspi' and self.fspi_header:
+                spidata = tools.read_file(os.path.join(tools.get_output_dir(), self.fspi_header))
+                if len(spidata) < 0x1000:
+                    spidata += tools.get_bytes(0, 0x1000 - len(spidata))
+                outdata = spidata + outdata
+            return outdata
         else:
             # Bintool is missing; just use the input data as the output
             self.record_missing_bintool(self.mkimage)
tools/binman/ftest.py +9 -0
index 9a3811c1732..d85ecffdc21 100644
@@ -8099,6 +8099,15 @@ fdt         fdtmap                Extract the devicetree blob from the fdtmap
             result = cst.fetch(bintool.FETCH_BUILD)
             self.assertEqual(('cst', None), result)
 
+    def testNxpImx8MFSPI(self):
+        """Test that binman can produce an iMX8m FSPI image"""
+        testdir = tempfile.mkdtemp(prefix='binman.')
+        image_path = os.path.join(testdir, 'fspi_header.bin')
+        with open(image_path, 'w') as f:
+            f.write(bytes([0x87]).decode('latin1') * 448)
+        with terminal.capture():
+            self._DoTestFile('vendor/nxp_imx8m_fspi.dts', output_dir=testdir)
+
     def testNxpHeaderDdrfw(self):
         """Test that binman can add a header to DDR PHY firmware images"""
         data = self._DoReadFile('vendor/nxp_ddrfw_imx95.dts')
tools/binman/test/vendor/nxp_imx8m_fspi.dts new file +18 -0
new file mode 100644
index 00000000000..6b04eca757c
@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: GPL-2.0+
+
+/dts-v1/;
+
+/ {
+	#address-cells = <1>;
+	#size-cells = <1>;
+
+	binman {
+		nxp-imx8mimage {
+			args;	/* TODO: Needed by mkimage etype superclass */
+			nxp,boot-from = "fspi";
+			nxp,fspi-header-filename = "fspi_header.bin";
+			nxp,rom-version = <2>;
+			nxp,loader-address = <0x10>;
+		};
+	};
+};
Signature · 1 line
2.53.0
#1 lore raw

PATCH v2 2/3 arm64: dts: imx8mm: Generate FSPI header using binman imx8mimage

The binman imx8mimage now correctly handles generated fspi_header.bin in its imx8mimage etype. Make use of this, remove fspi_conf_block in favor of generated fspi_header.bin, and configure imx8mimage accordingly.

---
Cc: "NXP i.MX U-Boot Team" <[email protected]>
Cc: Adam Ford <[email protected]>
Cc: Alexander Koch <[email protected]>
Cc: Fabio Estevam <[email protected]>
Cc: Peng Fan <[email protected]>
Cc: Simon Glass <[email protected]>
Cc: Tom Rini <[email protected]>
Cc: [email protected]
---
V2: No change

---
 arch/arm/dts/imx8mm-u-boot.dtsi | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)
arch/arm/dts/imx8mm-u-boot.dtsi +5 -8
index d891e8062fe..ab135fc8a47 100644
@@ -50,14 +50,6 @@
 	section {
 		pad-byte = <0x00>;
 
-#ifdef CONFIG_FSPI_CONF_HEADER
-		fspi_conf_block {
-			filename = CONFIG_FSPI_CONF_FILE;
-			type = "blob-ext";
-			size = <0x1000>;
-		};
-#endif
-
 #ifdef CONFIG_IMX_HAB
 		nxp-imx8mcst@0 {
 			filename = "u-boot-spl-mkimage.signed.bin";
@@ -68,7 +60,12 @@
 
 			binman_imx_spl: nxp-imx8mimage {
 				filename = "u-boot-spl-mkimage.bin";
+#ifdef CONFIG_FSPI_CONF_HEADER
+				nxp,boot-from = "fspi";
+				nxp,fspi-header-filename = CONFIG_FSPI_CONF_FILE;
+#else
 				nxp,boot-from = "sd";
+#endif
 				nxp,rom-version = <1>;
 				nxp,loader-address = <CONFIG_SPL_TEXT_BASE>;
 				args;	/* Needed by mkimage etype superclass */
Signature · 1 line
2.53.0
Reviewed-by on v2 2/3
#2 lore raw

Re: [PATCH v2 2/3] arm64: dts: imx8mm: Generate FSPI header using binman imx8mimage

Quoted 10 lines · Marek Vasut

arm64: dts: imx8mm: Generate FSPI header using binman imx8mimage

The binman imx8mimage now correctly handles generated fspi_header.bin in its imx8mimage etype. Make use of this, remove fspi_conf_block in favor of generated fspi_header.bin, and configure imx8mimage accordingly.

arch/arm/dts/imx8mm-u-boot.dtsi | 13 +++++--------

 1 file changed, 5 insertions(+), 8 deletions(-)
#3 lore raw

PATCH v2 3/3 arm64: dts: imx8mn: Generate FSPI header using binman imx8mimage

In reply to Marek Vasut

The binman imx8mimage now correctly handles generated fspi_header.bin in its imx8mimage etype. Make use of this, remove fspi_conf_block in favor of generated fspi_header.bin, and configure imx8mimage accordingly.

---
Cc: "NXP i.MX U-Boot Team" <[email protected]>
Cc: Adam Ford <[email protected]>
Cc: Alexander Koch <[email protected]>
Cc: Fabio Estevam <[email protected]>
Cc: Peng Fan <[email protected]>
Cc: Simon Glass <[email protected]>
Cc: Tom Rini <[email protected]>
Cc: [email protected]
---
V2: No change

---
 arch/arm/dts/imx8mn-u-boot.dtsi | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)
arch/arm/dts/imx8mn-u-boot.dtsi +5 -8
index 29eecd6d70d..8993605af3c 100644
@@ -104,14 +104,6 @@
 	section {
 		pad-byte = <0x00>;
 
-#ifdef CONFIG_FSPI_CONF_HEADER
-		fspi_conf_block {
-			filename = CONFIG_FSPI_CONF_FILE;
-			type = "blob-ext";
-			offset = <0x400>;
-		};
-#endif
-
 #ifdef CONFIG_IMX_HAB
 		nxp-imx8mcst@0 {
 			filename = "u-boot-spl-mkimage.signed.bin";
@@ -122,7 +114,12 @@
 
 			binman_imx_spl: nxp-imx8mimage {
 				filename = "u-boot-spl-mkimage.bin";
+#ifdef CONFIG_FSPI_CONF_HEADER
+				nxp,boot-from = "fspi";
+				nxp,fspi-header-filename = CONFIG_FSPI_CONF_FILE;
+#else
 				nxp,boot-from = "sd";
+#endif
 				nxp,rom-version = <2>;
 				nxp,loader-address = <CONFIG_SPL_TEXT_BASE>;
 				args;	/* Needed by mkimage etype superclass */
Signature · 1 line
2.53.0
Reviewed-by on v2 3/3
#4 lore raw

Re: [PATCH v2 3/3] arm64: dts: imx8mn: Generate FSPI header using binman imx8mimage

Quoted 10 lines · Marek Vasut

arm64: dts: imx8mn: Generate FSPI header using binman imx8mimage

The binman imx8mimage now correctly handles generated fspi_header.bin in its imx8mimage etype. Make use of this, remove fspi_conf_block in favor of generated fspi_header.bin, and configure imx8mimage accordingly.

arch/arm/dts/imx8mn-u-boot.dtsi | 13 +++++--------

 1 file changed, 5 insertions(+), 8 deletions(-)
reviewer
#5 lore raw
In reply to Marek Vasut

Hi Marek,

Quoted 16 lines · Marek Vasut

Boot from FSPI requires additional 448 Byte long header, with U-Boot SPL starting at offset 0x1000. Currently, both i.MX8MM and i.MX8MN attempt to generate this header using fspi_conf_block with filename pointing at CONFIG_FSPI_CONF_FILE file. This does not work, for two reasons.

First, the CONFIG_FSPI_CONF_FILE is generated by mkimage -T imx8mimage and may not be available yet when the fspi_conf_block is evaluated. That leads to a race condition where highly parallel builds fail to find the CONFIG_FSPI_CONF_FILE, which is usually called fspi_header.bin, on first build attempt.

Second, binman gets confused and patches incorrect offset of DDR PHY firmware blobs into U-Boot SPL, the offset is incremented by exactly 0x1000 which is the size of fspi_conf_block.

Quoted 8 lines

Fix both problems at once, make imx8mimage handle the generated FSPI header and prepend it in front of the imx8mimage processed data. This way, the race condition is solved, because the data generated by the imx8mimage are surely combined only after mkimage -T imx8mimage ran. The binman offset calculation is also solved, because there is no fspi_conf_block node in the DT anymore.

Is this series 2026.07 material, or can it wait until 2026.10?

Alexander, if possible, please test this series and reply with your Tested-by tag.

Thanks

#6 lore raw
Quoted 26 lines · Fabio Estevam

Hi Marek,

Quoted 23 lines · Marek Vasut

Boot from FSPI requires additional 448 Byte long header, with U-Boot SPL starting at offset 0x1000. Currently, both i.MX8MM and i.MX8MN attempt to generate this header using fspi_conf_block with filename pointing at CONFIG_FSPI_CONF_FILE file. This does not work, for two reasons.

First, the CONFIG_FSPI_CONF_FILE is generated by mkimage -T imx8mimage and may not be available yet when the fspi_conf_block is evaluated. That leads to a race condition where highly parallel builds fail to find the CONFIG_FSPI_CONF_FILE, which is usually called fspi_header.bin, on first build attempt.

Second, binman gets confused and patches incorrect offset of DDR PHY firmware blobs into U-Boot SPL, the offset is incremented by exactly 0x1000 which is the size of fspi_conf_block.

Fix both problems at once, make imx8mimage handle the generated FSPI header and prepend it in front of the imx8mimage processed data. This way, the race condition is solved, because the data generated by the imx8mimage are surely combined only after mkimage -T imx8mimage ran. The binman offset calculation is also solved, because there is no fspi_conf_block node in the DT anymore.

Quoted 6 lines
Quoted 1 line

Is this series 2026.07 material, or can it wait until 2026.10?

Alexander, if possible, please test this series and reply with your Tested-by tag.

This should have been 2024.07 material, but I had no hardware to debug this on, so 2026.07 will do.

#7 lore raw
In reply to Marek Vasut

Hi Marek,

Quoted 29 lines · Marek Vasut

binman: imx8mimage: Handle nxp,boot-from = 'fspi'

Boot from FSPI requires additional 448 Byte long header, with U-Boot SPL starting at offset 0x1000. Currently, both i.MX8MM and i.MX8MN attempt to generate this header using fspi_conf_block with filename pointing at CONFIG_FSPI_CONF_FILE file. This does not work, for two reasons.

First, the CONFIG_FSPI_CONF_FILE is generated by mkimage -T imx8mimage and may not be available yet when the fspi_conf_block is evaluated. That leads to a race condition where highly parallel builds fail to find the CONFIG_FSPI_CONF_FILE, which is usually called fspi_header.bin, on first build attempt.

Second, binman gets confused and patches incorrect offset of DDR PHY firmware blobs into U-Boot SPL, the offset is incremented by exactly 0x1000 which is the size of fspi_conf_block.

Fix both problems at once, make imx8mimage handle the generated FSPI header and prepend it in front of the imx8mimage processed data. This way, the race condition is solved, because the data generated by the [...]

tools/binman/etype/nxp_imx8mimage.py | 11 ++++++++++-

 tools/binman/ftest.py                       |  9 +++++++++
 tools/binman/test/vendor/nxp_imx8m_fspi.dts | 18 ++++++++++++++++++
 3 files changed, 37 insertions(+), 1 deletion(-)

tools/binman/etype/nxp_imx8mimage.py class Entry_nxp_imx8mimage(Entry_mkimage): · line 40

Quoted 6 lines
tools/binman/etype/nxp_imx8mimage.py +1 -0
@@ -33,6 +35,7 @@ class Entry_nxp_imx8mimage(Entry_mkimage):
     def ReadNode(self):
         super().ReadNode()
         self.boot_from = fdt_util.GetString(self._node, 'nxp,boot-from')
+        self.fspi_header = fdt_util.GetString(self._node, 'nxp,fspi-header-filename')
         self.loader_address = fdt_util.GetInt(self._node, 'nxp,loader-address')
         self.rom_version = fdt_util.GetInt(self._node, 'nxp,rom-version')

Please update the class docstring to document nxp,fspi-header-filename: what it is, that it only applies when nxp,boot-from = 'fspi', and that the file is read relative to the binman output directory. Binman has no separate entries.rst, so the docstring is the documentation.

tools/binman/etype/nxp_imx8mimage.py class Entry_nxp_imx8mimage(Entry_mkimage): · line 61

Quoted 10 lines
tools/binman/etype/nxp_imx8mimage.py +6 -1
@@ -52,7 +55,13 @@ class Entry_nxp_imx8mimage(Entry_mkimage):
         if self.mkimage.run_cmd(*args) is not None:
-            return tools.read_file(output_fname)
+            outdata = tools.read_file(output_fname)
+            if self.boot_from == 'fspi' and self.fspi_header:
+                spidata = tools.read_file(os.path.join(tools.get_output_dir(), self.fspi_header))
+                if len(spidata) < 0x1000:
+                    spidata += tools.get_bytes(0, 0x1000 - len(spidata))
+                outdata = spidata + outdata

What happens if the header file is larger than 0x1000? The current code silently concatenates and shifts everything downstream - exactly the offset bug the commit message says we are trying to avoid. Please raise a clear error when len(spidata) > 0x1000.

Also, if boot_from == 'fspi' but nxp,fspi-header-filename is unset, the code silently produces an image with no FSPI header. A debug log line noting the header is being skipped would help later.

tools/binman/ftest.py fdt fdtmap Extract the devicetree blob from the fdtmap · line 8106

Quoted 10 lines
tools/binman/ftest.py +8 -0
@@ -8099,6 +8099,15 @@ fdt         fdtmap                Extract the devicetree blob from the fdtmap
+    def testNxpImx8MFSPI(self):
+        """Test that binman can produce an iMX8m FSPI image"""
+        testdir = tempfile.mkdtemp(prefix='binman.')
+        image_path = os.path.join(testdir, 'fspi_header.bin')
+        with open(image_path, 'w') as f:
+            f.write(bytes([0x87]).decode('latin1') * 448)
+        with terminal.capture():
+            self._DoTestFile('vendor/nxp_imx8m_fspi.dts', output_dir=testdir)

This only checks that binman does not crash. Please read back the produced image and assert that the first 448 bytes are 0x87, that bytes 0x1c0..0x1000 are zero, and that the mkimage output follows at 0x1000 - otherwise the regression we are guarding against would not be caught.

Also, you should write files using tools.write_file() and and write tools.get_bytes(0x87, 448) rather than the decode('latin1') trick.

Regards,
Simon

#8 lore raw
Quoted 30 lines · Simon Glass

Hi Marek,

Quoted 26 lines · Marek Vasut

binman: imx8mimage: Handle nxp,boot-from = 'fspi'

Boot from FSPI requires additional 448 Byte long header, with U-Boot SPL starting at offset 0x1000. Currently, both i.MX8MM and i.MX8MN attempt to generate this header using fspi_conf_block with filename pointing at CONFIG_FSPI_CONF_FILE file. This does not work, for two reasons.

First, the CONFIG_FSPI_CONF_FILE is generated by mkimage -T imx8mimage and may not be available yet when the fspi_conf_block is evaluated. That leads to a race condition where highly parallel builds fail to find the CONFIG_FSPI_CONF_FILE, which is usually called fspi_header.bin, on first build attempt.

Second, binman gets confused and patches incorrect offset of DDR PHY firmware blobs into U-Boot SPL, the offset is incremented by exactly 0x1000 which is the size of fspi_conf_block.

Fix both problems at once, make imx8mimage handle the generated FSPI header and prepend it in front of the imx8mimage processed data. This way, the race condition is solved, because the data generated by the [...]

tools/binman/etype/nxp_imx8mimage.py | 11 ++++++++++-

  tools/binman/ftest.py                       |  9 +++++++++
  tools/binman/test/vendor/nxp_imx8m_fspi.dts | 18 ++++++++++++++++++
  3 files changed, 37 insertions(+), 1 deletion(-)
Quoted 14 lines

tools/binman/etype/nxp_imx8mimage.py class Entry_nxp_imx8mimage(Entry_mkimage): · line 40

Quoted 8 lines
tools/binman/etype/nxp_imx8mimage.py +1 -0
@@ -33,6 +35,7 @@ class Entry_nxp_imx8mimage(Entry_mkimage):
      def ReadNode(self):
          super().ReadNode()
          self.boot_from = fdt_util.GetString(self._node, 'nxp,boot-from')
+        self.fspi_header = fdt_util.GetString(self._node, 'nxp,fspi-header-filename')
          self.loader_address = fdt_util.GetInt(self._node, 'nxp,loader-address')
          self.rom_version = fdt_util.GetInt(self._node, 'nxp,rom-version')

Please update the class docstring to document nxp,fspi-header-filename: what it is, that it only applies when nxp,boot-from = 'fspi', and that the file is read relative to the binman output directory. Binman has no separate entries.rst, so the docstring is the documentation.

All feedback should be addressed in V3, thanks.