Re: [PATCH v5 7/9] rockchip: tools: add comment section to rkimage.c

Hi Johan,

On 8/6/26 1:12 PM, Johan Jonker wrote:
> README.rockchip must be removed.
> Move the rkimage comment section to rkimage.c
> 
> Signed-off-by: Johan Jonker <[email protected]>
> Reviewed-by: Simon Glass <[email protected]>
> ---
>   tools/rkimage.c | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/tools/rkimage.c b/tools/rkimage.c
> index 1c5540b1c3d1..0cabdf2f6723 100644
> --- a/tools/rkimage.c
> +++ b/tools/rkimage.c
> @@ -3,7 +3,9 @@
>    * (C) Copyright 2015 Google, Inc
>    * Written by Simon Glass <[email protected]>
>    *
> - * See README.rockchip for details of the rkimage format
> + * rkimage.c produces a SPL image suitable for sending directly to the boot ROM
> + * over USB OTG. This is a very simple format - just the string RK32 (as 4 bytes)
> + * followed by u-boot-spl-dtb.bin.

It actually does a bit more than that. It's not RK32 for starters, it's 
whatever the SoC (passed via the -n argument to mkimage) expects (can be 
RK33, RK30, RK31, RK32, RK35, RK11 or 110B for example, see 
tools/rkcommon.c) the magic value to be. If the SoC requires rc4 
encoding, the image is also encoded.

To be honest, I'm not even sure this still works and for which SoCs this 
applies.

I'm thinking we should reword this to something like:

"""
Takes a single image, sets the magic value expected by the SoC in the 
first 4 bytes, and RC4-encodes the result if needed.

The output is typically used as payload for the Mask ROM, uploaded via 
USB OTG.
"""

Vague enough yet precise enough. What do you think?

Cheers,
Quentin