[PATCH] ARM: i.MX: HABv4: point out i.MX6 specifics in docs and Kconfig help text

[PATCH] ARM: i.MX: HABv4: point out i.MX6 specifics in docs and Kconfig help text

[Ahmad Fatoum]

Signed USB images are a i.MX6 quirk as we need a point to DCD for
imx-usb-loader to work with, but the DCD pointer needs to be invalidated
for actual boot.

On i.MX8M*, RAM setup can't be done completely by DCD anymore, so not
having a DCD table is the norm and we don't need a signed USB image.

Thus mark CONFIG_HABV4_IMAGE_SIGNED_USB i.MX6 only and while at it, fix
hardcoded instances of i.MX6 headers.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/boards/imx.rst |  6 +++---
 arch/arm/mach-imx/Kconfig    | 11 +++++++----
 2 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
index 5a4f52b392d5..c64446aff640 100644
--- a/Documentation/boards/imx.rst
+++ b/Documentation/boards/imx.rst
@@ -150,7 +150,7 @@ Unlike the typical ``imximg`` file extension the following ones are used for
 these cases:
 
 * ``simximg``: generate signed image
-* ``usimximg``: generate signed USB image
+* ``usimximg``: generate signed USB image (i.MX6-specific)
 * ``esimximg``: generate encrypted and signed image
 
 The imx-image tool is then automatically called with the appropriate flags
@@ -168,9 +168,9 @@ keys/certificates are expected in these config variables (assuming HABv4):
   CONFIG_HABV4_IMG_CRT_PEM
 
 A CSF template is located in
-``include/mach/imx/habv4-imx6-gencsf.h`` which is preprocessed
+``include/mach/imx/habv4-imx*-gencsf.h`` which is preprocessed
 by barebox.
-It must be included in the board's flash header:
+It must be included in the board's flash header, e.g. for i.MX6:
 
 .. code-block:: none
 
diff --git a/arch/arm/mach-imx/Kconfig b/arch/arm/mach-imx/Kconfig
index 8cab6de7763f..2d55015e5acb 100644
--- a/arch/arm/mach-imx/Kconfig
+++ b/arch/arm/mach-imx/Kconfig
@@ -798,11 +798,13 @@ if HABV4
 config HABV4_IMAGE_SIGNED
 	bool "build signed images"
 	help
-	  enable the creation of a signed image, if the habv4-imx6-gencsf.h
-	  included in the flash-header and the NXP cst Tool is available
+	  enable the creation of a signed image, if the habv4-imx*-gencsf.h
+	  file appropriate for the SoC is included in the flash-header and
+	  the NXP cst Tool is available
 
 config HABV4_IMAGE_SIGNED_USB
 	bool "build signed USB images"
+	depends on ARCH_IMX6
 	help
 	  enable the creation of a usb signed image, if the habv4-imx6-gencsf.h
 	  included in the flash-header and the NXP cst Tool is available
@@ -810,8 +812,9 @@ config HABV4_IMAGE_SIGNED_USB
 config HABV4_IMAGE_SIGNED_ENCRYPTED
 	bool "build signed encrypted images"
 	help
-	  enable the creation of the encrypted image, if the habv4-imx6-gencsf.h
-	  included in the flash-header and the NXP cst Tool is available
+	  enable the creation of the encrypted image, if the habv4-imx*-gencsf.h
+	  file appropriate for the SoC is included in the flash-header and
+	  the NXP cst Tool is available
 
 endif
 
-- 
2.39.2

Re: [PATCH] ARM: i.MX: HABv4: point out i.MX6 specifics in docs and Kconfig help text

[Sascha Hauer]

On Thu, Sep 21, 2023 at 09:55:11AM +0200, Ahmad Fatoum wrote:
> Signed USB images are a i.MX6 quirk as we need a point to DCD for
> imx-usb-loader to work with, but the DCD pointer needs to be invalidated
> for actual boot.
> 
> On i.MX8M*, RAM setup can't be done completely by DCD anymore, so not
> having a DCD table is the norm and we don't need a signed USB image.
> 
> Thus mark CONFIG_HABV4_IMAGE_SIGNED_USB i.MX6 only and while at it, fix
> hardcoded instances of i.MX6 headers.
> 
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
>  Documentation/boards/imx.rst |  6 +++---
>  arch/arm/mach-imx/Kconfig    | 11 +++++++----
>  2 files changed, 10 insertions(+), 7 deletions(-)

Applied, thanks

Sascha

> 
> diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
> index 5a4f52b392d5..c64446aff640 100644
> --- a/Documentation/boards/imx.rst
> +++ b/Documentation/boards/imx.rst
> @@ -150,7 +150,7 @@ Unlike the typical ``imximg`` file extension the following ones are used for
>  these cases:
>  
>  * ``simximg``: generate signed image
> -* ``usimximg``: generate signed USB image
> +* ``usimximg``: generate signed USB image (i.MX6-specific)
>  * ``esimximg``: generate encrypted and signed image
>  
>  The imx-image tool is then automatically called with the appropriate flags
> @@ -168,9 +168,9 @@ keys/certificates are expected in these config variables (assuming HABv4):
>    CONFIG_HABV4_IMG_CRT_PEM
>  
>  A CSF template is located in
> -``include/mach/imx/habv4-imx6-gencsf.h`` which is preprocessed
> +``include/mach/imx/habv4-imx*-gencsf.h`` which is preprocessed
>  by barebox.
> -It must be included in the board's flash header:
> +It must be included in the board's flash header, e.g. for i.MX6:
>  
>  .. code-block:: none
>  
> diff --git a/arch/arm/mach-imx/Kconfig b/arch/arm/mach-imx/Kconfig
> index 8cab6de7763f..2d55015e5acb 100644
> --- a/arch/arm/mach-imx/Kconfig
> +++ b/arch/arm/mach-imx/Kconfig
> @@ -798,11 +798,13 @@ if HABV4
>  config HABV4_IMAGE_SIGNED
>  	bool "build signed images"
>  	help
> -	  enable the creation of a signed image, if the habv4-imx6-gencsf.h
> -	  included in the flash-header and the NXP cst Tool is available
> +	  enable the creation of a signed image, if the habv4-imx*-gencsf.h
> +	  file appropriate for the SoC is included in the flash-header and
> +	  the NXP cst Tool is available
>  
>  config HABV4_IMAGE_SIGNED_USB
>  	bool "build signed USB images"
> +	depends on ARCH_IMX6
>  	help
>  	  enable the creation of a usb signed image, if the habv4-imx6-gencsf.h
>  	  included in the flash-header and the NXP cst Tool is available
> @@ -810,8 +812,9 @@ config HABV4_IMAGE_SIGNED_USB
>  config HABV4_IMAGE_SIGNED_ENCRYPTED
>  	bool "build signed encrypted images"
>  	help
> -	  enable the creation of the encrypted image, if the habv4-imx6-gencsf.h
> -	  included in the flash-header and the NXP cst Tool is available
> +	  enable the creation of the encrypted image, if the habv4-imx*-gencsf.h
> +	  file appropriate for the SoC is included in the flash-header and
> +	  the NXP cst Tool is available
>  
>  endif
>  
> -- 
> 2.39.2
> 
> 
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |