[PATCH] doc: rockchip: Clarify the rkspi image format further

Dragan Simic dsimic at manjaro.org
Sat Feb 10 19:18:10 CET 2024


As discussed on the U-Boot mailing list, [1][2] only some Rockchip SoCs
suffer from a bug in their BROMs that requires a specific format for their
SPI images, which was the reason for the rkspi format to be introduced.

Improve the description of the rkspi format a bit to mention this, for
future reference and to make understanding it easier.

[1] https://lore.kernel.org/u-boot/c32129ba-db25-4b9d-9a4a-032d88dfb9cd@kwiboo.se/
[2] https://lore.kernel.org/u-boot/CACdvmAjfCWicRd=LKKyob7fZo79AFkUQKy0e1HBb0zyJuoO70g@mail.gmail.com/

Signed-off-by: Dragan Simic <dsimic at manjaro.org>
---
 doc/README.rockchip | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/doc/README.rockchip b/doc/README.rockchip
index 84caff8a24d3..e0c5c395ec6a 100644
--- a/doc/README.rockchip
+++ b/doc/README.rockchip
@@ -649,7 +649,12 @@ sector is used. The header is the same as with rksd and the maximum size is
 also 32KB (before spreading). The image should be written to the start of
 SPI flash.
 
-See above for instructions on how to write a SPI image.
+Only the BROMs of some Rockchip SoCs, such as the RK3399, suffer from a bug
+that mandates the above-described data spreading, thus requiring the rkspi
+format to be used for their SPI images. Rockchip SoCs that don't suffer
+from this bug use the rksd format for their SPI images.
+
+See the section above for instructions on how to write an SPI image.
 
 rkmux.py
 --------


More information about the U-Boot mailing list