Skip to contentSkip to conversation

rkspi: only enable padding quirk on SoCs which need it

PATCH In review Lorenz Brun 2 participants 2 messages Sep 20, 2022 – Oct 17, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rkspi: only enable padding quirk on SoCs which need it

The workaround for the Mask ROM bug in a lot of Rockchip SoCs is applied unconditionally, but at least on the RK3328 it is not needed and causes a boot failure if applied.

Make a new column in the SoC feature description and skip the workaround if the SoC doesn't need it.

---
 tools/rkcommon.c | 35 ++++++++++++++++++++++-------------
 tools/rkcommon.h |  9 +++++++++
 tools/rkspi.c    |  6 ++++++
 3 files changed, 37 insertions(+), 13 deletions(-)
tools/rkcommon.c +22 -13
index 0db45c2d41..4b4de24f21 100644
@@ -118,22 +118,24 @@ struct spl_info {
 	const uint32_t spl_size;
 	const bool spl_rc4;
 	const uint32_t header_ver;
+	const bool has_spi_halfblock_quirk;
 };
 
+// Note: has_spi_halfblock_quirk is not certain on all SoCs.
 static struct spl_info spl_infos[] = {
-	{ "px30", "RK33", 0x2800, false, RK_HEADER_V1 },
-	{ "rk3036", "RK30", 0x1000, false, RK_HEADER_V1 },
-	{ "rk3066", "RK30", 0x8000 - 0x800, true, RK_HEADER_V1 },
-	{ "rk3128", "RK31", 0x1800, false, RK_HEADER_V1 },
-	{ "rk3188", "RK31", 0x8000 - 0x800, true, RK_HEADER_V1 },
-	{ "rk322x", "RK32", 0x8000 - 0x1000, false, RK_HEADER_V1 },
-	{ "rk3288", "RK32", 0x8000, false, RK_HEADER_V1 },
-	{ "rk3308", "RK33", 0x40000 - 0x1000, false, RK_HEADER_V1 },
-	{ "rk3328", "RK32", 0x8000 - 0x1000, false, RK_HEADER_V1 },
-	{ "rk3368", "RK33", 0x8000 - 0x1000, false, RK_HEADER_V1 },
-	{ "rk3399", "RK33", 0x30000 - 0x2000, false, RK_HEADER_V1 },
-	{ "rv1108", "RK11", 0x1800, false, RK_HEADER_V1 },
-	{ "rk3568", "RK35", 0x14000 - 0x1000, false, RK_HEADER_V2 },
+	{ "px30", "RK33", 0x2800, false, RK_HEADER_V1, true},
+	{ "rk3036", "RK30", 0x1000, false, RK_HEADER_V1, true },
+	{ "rk3066", "RK30", 0x8000 - 0x800, true, RK_HEADER_V1, true },
+	{ "rk3128", "RK31", 0x1800, false, RK_HEADER_V1, true },
+	{ "rk3188", "RK31", 0x8000 - 0x800, true, RK_HEADER_V1, true },
+	{ "rk322x", "RK32", 0x8000 - 0x1000, false, RK_HEADER_V1, true },
+	{ "rk3288", "RK32", 0x8000, false, RK_HEADER_V1, true },
+	{ "rk3308", "RK33", 0x40000 - 0x1000, false, RK_HEADER_V1, true },
+	{ "rk3328", "RK32", 0x8000 - 0x1000, false, RK_HEADER_V1, false },
+	{ "rk3368", "RK33", 0x8000 - 0x1000, false, RK_HEADER_V1, true },
+	{ "rk3399", "RK33", 0x30000 - 0x2000, false, RK_HEADER_V1, true },
+	{ "rv1108", "RK11", 0x1800, false, RK_HEADER_V1, true },
+	{ "rk3568", "RK35", 0x14000 - 0x1000, false, RK_HEADER_V2, true },
 };
 
 /**
@@ -282,6 +284,13 @@ bool rkcommon_is_header_v2(struct image_tool_params *params)
 	return (info->header_ver == RK_HEADER_V2);
 }
 
+bool rkcommon_has_spi_halfblock_quirk(struct image_tool_params *params)
+{
+	struct spl_info *info = rkcommon_get_spl_info(params->imagename);
+
+	return info->has_spi_halfblock_quirk;
+}
+
 static void do_sha256_hash(uint8_t *buf, uint32_t size, uint8_t *out)
 {
 	sha256_context ctx;
tools/rkcommon.h +9 -0
index 49b6df3185..7b0c036dac 100644
@@ -41,6 +41,15 @@ const char *rkcommon_get_spl_hdr(struct image_tool_params *params);
  */
 int rkcommon_get_spl_size(struct image_tool_params *params);
 
+
+/**
+ * rkcommon_has_spi_halfblock_quirk checks if the SoC MaskROM has the SPI block
+ * loading quirk.
+ * SoCs with this quirk load the initial TPL/SPL incorrectly and need each 4K
+ * block of it to be split into two 2K blocks with the upper half padded.
+ */
+bool rkcommon_has_spi_halfblock_quirk(struct image_tool_params *params);
+
 /**
  * rkcommon_set_header() - set up the header for a Rockchip boot image
  *
tools/rkspi.c +6 -0
index f2530f7bde..b6f75fae1b 100644
@@ -26,6 +26,9 @@ static void rkspi_set_header(void *buf, struct stat *sbuf, int ifd,
 
 	rkcommon_set_header(buf, sbuf, ifd, params);
 
+	if(!rkcommon_has_spi_halfblock_quirk(params))
+		return;
+
 	/*
 	 * Spread the image out so we only use the first 2KB of each 4KB
 	 * region. This is a feature of the SPI format required by the Rockchip
@@ -62,6 +65,9 @@ static int rkspi_vrec_header(struct image_tool_params *params,
 {
 	rkcommon_vrec_header(params, tparams);
 
+	if(!rkcommon_has_spi_halfblock_quirk(params))
+		return 0;
+
 	/*
 	 * Converting to the SPI format (i.e. splitting each 4K page into two
 	 * 2K subpages and then padding these 2K pages up to take a complete
Signature · 1 line
2.37.2
#1 lore raw

Hi Lorenz,

    This is no need because:

- a type rkspi is need because the format is different requirement for the image format;

- when then issue fixed in new SoC, then the image format is the same as rksd, so you can

  use rksd for all the image in new SoCs.

Thanks,

- Kever

Quoted 114 lines · Lorenz Brun

The workaround for the Mask ROM bug in a lot of Rockchip SoCs is applied unconditionally, but at least on the RK3328 it is not needed and causes a boot failure if applied.

Make a new column in the SoC feature description and skip the workaround if the SoC doesn't need it.

---
  tools/rkcommon.c | 35 ++++++++++++++++++++++-------------
  tools/rkcommon.h |  9 +++++++++
  tools/rkspi.c    |  6 ++++++
  3 files changed, 37 insertions(+), 13 deletions(-)
tools/rkcommon.c +22 -13
index 0db45c2d41..4b4de24f21 100644
@@ -118,22 +118,24 @@ struct spl_info {
  	const uint32_t spl_size;
  	const bool spl_rc4;
  	const uint32_t header_ver;
+	const bool has_spi_halfblock_quirk;
  };
 
+// Note: has_spi_halfblock_quirk is not certain on all SoCs.
  static struct spl_info spl_infos[] = {
-	{ "px30", "RK33", 0x2800, false, RK_HEADER_V1 },
-	{ "rk3036", "RK30", 0x1000, false, RK_HEADER_V1 },
-	{ "rk3066", "RK30", 0x8000 - 0x800, true, RK_HEADER_V1 },
-	{ "rk3128", "RK31", 0x1800, false, RK_HEADER_V1 },
-	{ "rk3188", "RK31", 0x8000 - 0x800, true, RK_HEADER_V1 },
-	{ "rk322x", "RK32", 0x8000 - 0x1000, false, RK_HEADER_V1 },
-	{ "rk3288", "RK32", 0x8000, false, RK_HEADER_V1 },
-	{ "rk3308", "RK33", 0x40000 - 0x1000, false, RK_HEADER_V1 },
-	{ "rk3328", "RK32", 0x8000 - 0x1000, false, RK_HEADER_V1 },
-	{ "rk3368", "RK33", 0x8000 - 0x1000, false, RK_HEADER_V1 },
-	{ "rk3399", "RK33", 0x30000 - 0x2000, false, RK_HEADER_V1 },
-	{ "rv1108", "RK11", 0x1800, false, RK_HEADER_V1 },
-	{ "rk3568", "RK35", 0x14000 - 0x1000, false, RK_HEADER_V2 },
+	{ "px30", "RK33", 0x2800, false, RK_HEADER_V1, true},
+	{ "rk3036", "RK30", 0x1000, false, RK_HEADER_V1, true },
+	{ "rk3066", "RK30", 0x8000 - 0x800, true, RK_HEADER_V1, true },
+	{ "rk3128", "RK31", 0x1800, false, RK_HEADER_V1, true },
+	{ "rk3188", "RK31", 0x8000 - 0x800, true, RK_HEADER_V1, true },
+	{ "rk322x", "RK32", 0x8000 - 0x1000, false, RK_HEADER_V1, true },
+	{ "rk3288", "RK32", 0x8000, false, RK_HEADER_V1, true },
+	{ "rk3308", "RK33", 0x40000 - 0x1000, false, RK_HEADER_V1, true },
+	{ "rk3328", "RK32", 0x8000 - 0x1000, false, RK_HEADER_V1, false },
+	{ "rk3368", "RK33", 0x8000 - 0x1000, false, RK_HEADER_V1, true },
+	{ "rk3399", "RK33", 0x30000 - 0x2000, false, RK_HEADER_V1, true },
+	{ "rv1108", "RK11", 0x1800, false, RK_HEADER_V1, true },
+	{ "rk3568", "RK35", 0x14000 - 0x1000, false, RK_HEADER_V2, true },
  };
 
  /**
@@ -282,6 +284,13 @@ bool rkcommon_is_header_v2(struct image_tool_params *params)
  	return (info->header_ver == RK_HEADER_V2);
  }
 
+bool rkcommon_has_spi_halfblock_quirk(struct image_tool_params *params)
+{
+	struct spl_info *info = rkcommon_get_spl_info(params->imagename);
+
+	return info->has_spi_halfblock_quirk;
+}
+
  static void do_sha256_hash(uint8_t *buf, uint32_t size, uint8_t *out)
  {
  	sha256_context ctx;
tools/rkcommon.h +9 -0
index 49b6df3185..7b0c036dac 100644
@@ -41,6 +41,15 @@ const char *rkcommon_get_spl_hdr(struct image_tool_params *params);
   */
  int rkcommon_get_spl_size(struct image_tool_params *params);
 
+
+/**
+ * rkcommon_has_spi_halfblock_quirk checks if the SoC MaskROM has the SPI block
+ * loading quirk.
+ * SoCs with this quirk load the initial TPL/SPL incorrectly and need each 4K
+ * block of it to be split into two 2K blocks with the upper half padded.
+ */
+bool rkcommon_has_spi_halfblock_quirk(struct image_tool_params *params);
+
  /**
   * rkcommon_set_header() - set up the header for a Rockchip boot image
   *
tools/rkspi.c +6 -0
index f2530f7bde..b6f75fae1b 100644
@@ -26,6 +26,9 @@ static void rkspi_set_header(void *buf, struct stat *sbuf, int ifd,
 
  	rkcommon_set_header(buf, sbuf, ifd, params);
 
+	if(!rkcommon_has_spi_halfblock_quirk(params))
+		return;
+
  	/*
  	 * Spread the image out so we only use the first 2KB of each 4KB
  	 * region. This is a feature of the SPI format required by the Rockchip
@@ -62,6 +65,9 @@ static int rkspi_vrec_header(struct image_tool_params *params,
  {
  	rkcommon_vrec_header(params, tparams);
 
+	if(!rkcommon_has_spi_halfblock_quirk(params))
+		return 0;
+
  	/*
  	 * Converting to the SPI format (i.e. splitting each 4K page into two
  	 * 2K subpages and then padding these 2K pages up to take a complete