[PATCH 1/3] ARM: i.MX8M: atf: mark ATF start functions as __noreturn

[PATCH 1/3] ARM: i.MX8M: atf: mark ATF start functions as __noreturn

[Ahmad Fatoum]

The early exit in imx8m_atf_load_bl31 doesn't serve any real purpose.
If a too big TF-A ends up being loaded we shouldn't return, but
just panic outright, so the user fixes their barebox build.

Change the WARN_ON to a BUG_ON() and then mark all callers of this
function as __noreturn to document their purpose and to guide
optimization.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 arch/arm/mach-imx/atf.c                | 26 ++++++++++----------------
 arch/arm/mach-imx/include/mach/atf.h   | 10 ++++++----
 arch/arm/mach-imx/include/mach/xload.h |  9 ++++++---
 3 files changed, 22 insertions(+), 23 deletions(-)

diff --git a/arch/arm/mach-imx/atf.c b/arch/arm/mach-imx/atf.c
index a4c658283006..df23dbfc0e5a 100644
--- a/arch/arm/mach-imx/atf.c
+++ b/arch/arm/mach-imx/atf.c
@@ -35,12 +35,11 @@
  *
  */
 
-static void imx8m_atf_load_bl31(const void *fw, size_t fw_size, void *atf_dest)
+static __noreturn void imx8m_atf_load_bl31(const void *fw, size_t fw_size, void *atf_dest)
 {
 	void __noreturn (*bl31)(void) = atf_dest;
 
-	if (WARN_ON(fw_size > MX8M_ATF_BL31_SIZE_LIMIT))
-		return;
+	BUG_ON(fw_size > MX8M_ATF_BL31_SIZE_LIMIT);
 
 	memcpy(bl31, fw, fw_size);
 
@@ -48,29 +47,30 @@ static void imx8m_atf_load_bl31(const void *fw, size_t fw_size, void *atf_dest)
 		     "r" (atf_dest - 16) :
 		     "cc");
 	bl31();
+	__builtin_unreachable();
 }
 
-void imx8mm_atf_load_bl31(const void *fw, size_t fw_size)
+__noreturn void imx8mm_atf_load_bl31(const void *fw, size_t fw_size)
 {
 	imx8m_atf_load_bl31(fw, fw_size, (void *)MX8MM_ATF_BL31_BASE_ADDR);
 }
 
-void imx8mn_atf_load_bl31(const void *fw, size_t fw_size)
+__noreturn void imx8mn_atf_load_bl31(const void *fw, size_t fw_size)
 {
 	imx8m_atf_load_bl31(fw, fw_size, (void *)MX8MN_ATF_BL31_BASE_ADDR);
 }
 
-void imx8mp_atf_load_bl31(const void *fw, size_t fw_size)
+__noreturn void imx8mp_atf_load_bl31(const void *fw, size_t fw_size)
 {
 	imx8m_atf_load_bl31(fw, fw_size, (void *)MX8MP_ATF_BL31_BASE_ADDR);
 }
 
-void imx8mq_atf_load_bl31(const void *fw, size_t fw_size)
+__noreturn void imx8mq_atf_load_bl31(const void *fw, size_t fw_size)
 {
 	imx8m_atf_load_bl31(fw, fw_size, (void *)MX8MQ_ATF_BL31_BASE_ADDR);
 }
 
-void imx8mm_load_and_start_image_via_tfa(void)
+__noreturn void imx8mm_load_and_start_image_via_tfa(void)
 {
 	size_t bl31_size;
 	const u8 *bl31;
@@ -126,11 +126,9 @@ void imx8mm_load_and_start_image_via_tfa(void)
 	get_builtin_firmware(imx8mm_bl31_bin, &bl31, &bl31_size);
 
 	imx8mm_atf_load_bl31(bl31, bl31_size);
-
-	/* not reached */
 }
 
-void imx8mp_load_and_start_image_via_tfa(void)
+__noreturn void imx8mp_load_and_start_image_via_tfa(void)
 {
 	size_t bl31_size;
 	const u8 *bl31;
@@ -165,11 +163,9 @@ void imx8mp_load_and_start_image_via_tfa(void)
 	get_builtin_firmware(imx8mp_bl31_bin, &bl31, &bl31_size);
 
 	imx8mp_atf_load_bl31(bl31, bl31_size);
-
-	/* not reached */
 }
 
-void imx8mn_load_and_start_image_via_tfa(void)
+__noreturn void imx8mn_load_and_start_image_via_tfa(void)
 {
 	size_t bl31_size;
 	const u8 *bl31;
@@ -204,6 +200,4 @@ void imx8mn_load_and_start_image_via_tfa(void)
 	get_builtin_firmware(imx8mn_bl31_bin, &bl31, &bl31_size);
 
 	imx8mn_atf_load_bl31(bl31, bl31_size);
-
-	/* not reached */
 }
diff --git a/arch/arm/mach-imx/include/mach/atf.h b/arch/arm/mach-imx/include/mach/atf.h
index bc400ddbad4c..ca54bb5fbf82 100644
--- a/arch/arm/mach-imx/include/mach/atf.h
+++ b/arch/arm/mach-imx/include/mach/atf.h
@@ -4,6 +4,8 @@
 #define __IMX_ATF_H__
 
 #include <linux/sizes.h>
+#include <linux/compiler.h>
+#include <linux/types.h>
 #include <asm/system.h>
 
 #define MX8M_ATF_BL31_SIZE_LIMIT	SZ_64K
@@ -16,9 +18,9 @@
 #define MX8MM_ATF_BL33_BASE_ADDR	MX8M_ATF_BL33_BASE_ADDR
 #define MX8MQ_ATF_BL33_BASE_ADDR	MX8M_ATF_BL33_BASE_ADDR
 
-void imx8mm_atf_load_bl31(const void *fw, size_t fw_size);
-void imx8mn_atf_load_bl31(const void *fw, size_t fw_size);
-void imx8mp_atf_load_bl31(const void *fw, size_t fw_size);
-void imx8mq_atf_load_bl31(const void *fw, size_t fw_size);
+void __noreturn imx8mm_atf_load_bl31(const void *fw, size_t fw_size);
+void __noreturn imx8mn_atf_load_bl31(const void *fw, size_t fw_size);
+void __noreturn imx8mp_atf_load_bl31(const void *fw, size_t fw_size);
+void __noreturn imx8mq_atf_load_bl31(const void *fw, size_t fw_size);
 
 #endif
diff --git a/arch/arm/mach-imx/include/mach/xload.h b/arch/arm/mach-imx/include/mach/xload.h
index 3090c9c83bd7..fe43d2502632 100644
--- a/arch/arm/mach-imx/include/mach/xload.h
+++ b/arch/arm/mach-imx/include/mach/xload.h
@@ -3,6 +3,9 @@
 #ifndef __MACH_XLOAD_H
 #define __MACH_XLOAD_H
 
+#include <linux/compiler.h>
+#include <linux/types.h>
+
 int imx53_nand_start_image(void);
 int imx6_spi_load_image(int instance, unsigned int flash_offset, void *buf, int len);
 int imx6_spi_start_image(int instance);
@@ -13,9 +16,9 @@ int imx8m_esdhc_load_image(int instance, bool start);
 int imx8mn_esdhc_load_image(int instance, bool start);
 int imx8mp_esdhc_load_image(int instance, bool start);
 
-void imx8mm_load_and_start_image_via_tfa(void);
-void imx8mn_load_and_start_image_via_tfa(void);
-void imx8mp_load_and_start_image_via_tfa(void);
+void __noreturn imx8mm_load_and_start_image_via_tfa(void);
+void __noreturn imx8mn_load_and_start_image_via_tfa(void);
+void __noreturn imx8mp_load_and_start_image_via_tfa(void);
 
 int imx_image_size(void);
 int piggydata_size(void);
-- 
2.30.2

[PATCH 2/3] ARM: i.MX8M: rename imx8m_atf_load_bl31 for clarity

[Ahmad Fatoum]

The functions imx8mX_load_and_start_image_via_tfa() suggest that loading
does not involve starting. The functions imx8mX_atf_load_bl31()
relocates bl31 and starts it, but doesn't actually load it (either from
boot medium or via get_builtin_firmware).

We won't rename these yet to avoid breaking out-of-tree boards,
but we can at least rename the static imx8mX_atf_load_bl31 to reflect
that it starts bl31.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 arch/arm/mach-imx/atf.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/arch/arm/mach-imx/atf.c b/arch/arm/mach-imx/atf.c
index df23dbfc0e5a..675e90792a32 100644
--- a/arch/arm/mach-imx/atf.c
+++ b/arch/arm/mach-imx/atf.c
@@ -35,7 +35,7 @@
  *
  */
 
-static __noreturn void imx8m_atf_load_bl31(const void *fw, size_t fw_size, void *atf_dest)
+static __noreturn void imx8m_atf_start_bl31(const void *fw, size_t fw_size, void *atf_dest)
 {
 	void __noreturn (*bl31)(void) = atf_dest;
 
@@ -52,22 +52,22 @@ static __noreturn void imx8m_atf_load_bl31(const void *fw, size_t fw_size, void
 
 __noreturn void imx8mm_atf_load_bl31(const void *fw, size_t fw_size)
 {
-	imx8m_atf_load_bl31(fw, fw_size, (void *)MX8MM_ATF_BL31_BASE_ADDR);
+	imx8m_atf_start_bl31(fw, fw_size, (void *)MX8MM_ATF_BL31_BASE_ADDR);
 }
 
 __noreturn void imx8mn_atf_load_bl31(const void *fw, size_t fw_size)
 {
-	imx8m_atf_load_bl31(fw, fw_size, (void *)MX8MN_ATF_BL31_BASE_ADDR);
+	imx8m_atf_start_bl31(fw, fw_size, (void *)MX8MN_ATF_BL31_BASE_ADDR);
 }
 
 __noreturn void imx8mp_atf_load_bl31(const void *fw, size_t fw_size)
 {
-	imx8m_atf_load_bl31(fw, fw_size, (void *)MX8MP_ATF_BL31_BASE_ADDR);
+	imx8m_atf_start_bl31(fw, fw_size, (void *)MX8MP_ATF_BL31_BASE_ADDR);
 }
 
 __noreturn void imx8mq_atf_load_bl31(const void *fw, size_t fw_size)
 {
-	imx8m_atf_load_bl31(fw, fw_size, (void *)MX8MQ_ATF_BL31_BASE_ADDR);
+	imx8m_atf_start_bl31(fw, fw_size, (void *)MX8MQ_ATF_BL31_BASE_ADDR);
 }
 
 __noreturn void imx8mm_load_and_start_image_via_tfa(void)
-- 
2.30.2

[PATCH 3/3] ARM: i.MX8M: define imx8mX_load_bl33 and imx8mX_load_and_start_tfa

[Ahmad Fatoum]

For most users imx8mX_load_and_start_tfa saves a good deal of
boilerplate. It's not always sufficient though:

  - board code may need a pointer to bl33 to install other firmware
    besides barebox proper from there before jumping to bl31 (TF-A).

  - board code may want to use a different ARM Trusted Firmware,
    e.g. when OP-TEE is to be installed.

Thus define two more helper: imx8mX_load_bl33 and
imx8mn_load_and_start_tfa, which allows board code to avoid duplicating
the chainload logic and focus on doing the board specific stuff only.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 arch/arm/mach-imx/atf.c                | 43 ++++++++++++--------------
 arch/arm/mach-imx/include/mach/atf.h   | 12 +++++++
 arch/arm/mach-imx/include/mach/xload.h |  4 +++
 3 files changed, 36 insertions(+), 23 deletions(-)

diff --git a/arch/arm/mach-imx/atf.c b/arch/arm/mach-imx/atf.c
index 675e90792a32..5301c0fbe8e5 100644
--- a/arch/arm/mach-imx/atf.c
+++ b/arch/arm/mach-imx/atf.c
@@ -70,13 +70,10 @@ __noreturn void imx8mq_atf_load_bl31(const void *fw, size_t fw_size)
 	imx8m_atf_start_bl31(fw, fw_size, (void *)MX8MQ_ATF_BL31_BASE_ADDR);
 }
 
-__noreturn void imx8mm_load_and_start_image_via_tfa(void)
+void imx8mm_load_bl33(void *bl33)
 {
-	size_t bl31_size;
-	const u8 *bl31;
 	enum bootsource src;
 	int instance;
-	void *bl33 = (void *)MX8M_ATF_BL33_BASE_ADDR;
 
 	imx8mm_get_boot_source(&src, &instance);
 	switch (src) {
@@ -122,16 +119,16 @@ __noreturn void imx8mm_load_and_start_image_via_tfa(void)
 	 * the same code in DRAM.
 	 */
 	memcpy(bl33, __image_start, barebox_pbl_size);
+}
 
-	get_builtin_firmware(imx8mm_bl31_bin, &bl31, &bl31_size);
-
-	imx8mm_atf_load_bl31(bl31, bl31_size);
+__noreturn void imx8mm_load_and_start_image_via_tfa(void)
+{
+	imx8mm_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
+	imx8mm_load_and_start_tfa(imx8mm_bl31_bin);
 }
 
-__noreturn void imx8mp_load_and_start_image_via_tfa(void)
+void imx8mp_load_bl33(void *bl33)
 {
-	size_t bl31_size;
-	const u8 *bl31;
 	enum bootsource src;
 	int instance;
 
@@ -157,18 +154,17 @@ __noreturn void imx8mp_load_and_start_image_via_tfa(void)
 	 * for the piggy data, so we need to ensure that we are running
 	 * the same code in DRAM.
 	 */
-	memcpy((void *)MX8M_ATF_BL33_BASE_ADDR,
-	       __image_start, barebox_pbl_size);
-
-	get_builtin_firmware(imx8mp_bl31_bin, &bl31, &bl31_size);
+	memcpy(bl33, __image_start, barebox_pbl_size);
+}
 
-	imx8mp_atf_load_bl31(bl31, bl31_size);
+void imx8mp_load_and_start_image_via_tfa(void)
+{
+	imx8mp_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
+	imx8mp_load_and_start_tfa(imx8mp_bl31_bin);
 }
 
-__noreturn void imx8mn_load_and_start_image_via_tfa(void)
+void imx8mn_load_bl33(void *bl33)
 {
-	size_t bl31_size;
-	const u8 *bl31;
 	enum bootsource src;
 	int instance;
 
@@ -194,10 +190,11 @@ __noreturn void imx8mn_load_and_start_image_via_tfa(void)
 	 * for the piggy data, so we need to ensure that we are running
 	 * the same code in DRAM.
 	 */
-	memcpy((void *)MX8M_ATF_BL33_BASE_ADDR,
-	       __image_start, barebox_pbl_size);
-
-	get_builtin_firmware(imx8mn_bl31_bin, &bl31, &bl31_size);
+	memcpy(bl33, __image_start, barebox_pbl_size);
+}
 
-	imx8mn_atf_load_bl31(bl31, bl31_size);
+void imx8mn_load_and_start_image_via_tfa(void)
+{
+	imx8mn_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
+	imx8mn_load_and_start_tfa(imx8mn_bl31_bin);
 }
diff --git a/arch/arm/mach-imx/include/mach/atf.h b/arch/arm/mach-imx/include/mach/atf.h
index ca54bb5fbf82..b3c4ecb92576 100644
--- a/arch/arm/mach-imx/include/mach/atf.h
+++ b/arch/arm/mach-imx/include/mach/atf.h
@@ -23,4 +23,16 @@ void __noreturn imx8mn_atf_load_bl31(const void *fw, size_t fw_size);
 void __noreturn imx8mp_atf_load_bl31(const void *fw, size_t fw_size);
 void __noreturn imx8mq_atf_load_bl31(const void *fw, size_t fw_size);
 
+#define imx8m_load_and_start_tfa(soc,fw_name) do { \
+	size_t __bl31_size; \
+	const u8 *__bl31; \
+	soc##_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR); \
+	get_builtin_firmware(fw_name, &__bl31, &__bl31_size); \
+	soc##_atf_load_bl31(__bl31, __bl31_size); \
+} while (0)
+
+#define imx8mm_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mm, fw_name)
+#define imx8mn_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mn, fw_name)
+#define imx8mp_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mp, fw_name)
+
 #endif
diff --git a/arch/arm/mach-imx/include/mach/xload.h b/arch/arm/mach-imx/include/mach/xload.h
index fe43d2502632..82bf663c4266 100644
--- a/arch/arm/mach-imx/include/mach/xload.h
+++ b/arch/arm/mach-imx/include/mach/xload.h
@@ -16,6 +16,10 @@ int imx8m_esdhc_load_image(int instance, bool start);
 int imx8mn_esdhc_load_image(int instance, bool start);
 int imx8mp_esdhc_load_image(int instance, bool start);
 
+void imx8mm_load_bl33(void *bl33);
+void imx8mn_load_bl33(void *bl33);
+void imx8mp_load_bl33(void *bl33);
+
 void __noreturn imx8mm_load_and_start_image_via_tfa(void);
 void __noreturn imx8mn_load_and_start_image_via_tfa(void);
 void __noreturn imx8mp_load_and_start_image_via_tfa(void);
-- 
2.30.2

Re: [PATCH 3/3] ARM: i.MX8M: define imx8mX_load_bl33 and imx8mX_load_and_start_tfa

[Marco Felsch]

Hi Ahmad,

On 22-08-15, Ahmad Fatoum wrote:
> For most users imx8mX_load_and_start_tfa saves a good deal of
> boilerplate. It's not always sufficient though:
> 
>   - board code may need a pointer to bl33 to install other firmware
>     besides barebox proper from there before jumping to bl31 (TF-A).
> 
>   - board code may want to use a different ARM Trusted Firmware,
>     e.g. when OP-TEE is to be installed.
> 
> Thus define two more helper: imx8mX_load_bl33 and
> imx8mn_load_and_start_tfa, which allows board code to avoid duplicating
> the chainload logic and focus on doing the board specific stuff only.
> 
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
>  arch/arm/mach-imx/atf.c                | 43 ++++++++++++--------------
>  arch/arm/mach-imx/include/mach/atf.h   | 12 +++++++
>  arch/arm/mach-imx/include/mach/xload.h |  4 +++
>  3 files changed, 36 insertions(+), 23 deletions(-)
> 
> diff --git a/arch/arm/mach-imx/atf.c b/arch/arm/mach-imx/atf.c
> index 675e90792a32..5301c0fbe8e5 100644
> --- a/arch/arm/mach-imx/atf.c
> +++ b/arch/arm/mach-imx/atf.c
> @@ -70,13 +70,10 @@ __noreturn void imx8mq_atf_load_bl31(const void *fw, size_t fw_size)
>  	imx8m_atf_start_bl31(fw, fw_size, (void *)MX8MQ_ATF_BL31_BASE_ADDR);
>  }
>  
> -__noreturn void imx8mm_load_and_start_image_via_tfa(void)
> +void imx8mm_load_bl33(void *bl33)
>  {
> -	size_t bl31_size;
> -	const u8 *bl31;
>  	enum bootsource src;
>  	int instance;
> -	void *bl33 = (void *)MX8M_ATF_BL33_BASE_ADDR;
>  
>  	imx8mm_get_boot_source(&src, &instance);
>  	switch (src) {
> @@ -122,16 +119,16 @@ __noreturn void imx8mm_load_and_start_image_via_tfa(void)
>  	 * the same code in DRAM.
>  	 */
>  	memcpy(bl33, __image_start, barebox_pbl_size);
> +}
>  
> -	get_builtin_firmware(imx8mm_bl31_bin, &bl31, &bl31_size);
> -
> -	imx8mm_atf_load_bl31(bl31, bl31_size);
> +__noreturn void imx8mm_load_and_start_image_via_tfa(void)
> +{
> +	imx8mm_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
              ^
This is already defined by your macro "imx8mm_load_and_start_tfa".

Regards,
  Marco

> +	imx8mm_load_and_start_tfa(imx8mm_bl31_bin);
>  }
>  
> -__noreturn void imx8mp_load_and_start_image_via_tfa(void)
> +void imx8mp_load_bl33(void *bl33)
>  {
> -	size_t bl31_size;
> -	const u8 *bl31;
>  	enum bootsource src;
>  	int instance;
>  
> @@ -157,18 +154,17 @@ __noreturn void imx8mp_load_and_start_image_via_tfa(void)
>  	 * for the piggy data, so we need to ensure that we are running
>  	 * the same code in DRAM.
>  	 */
> -	memcpy((void *)MX8M_ATF_BL33_BASE_ADDR,
> -	       __image_start, barebox_pbl_size);
> -
> -	get_builtin_firmware(imx8mp_bl31_bin, &bl31, &bl31_size);
> +	memcpy(bl33, __image_start, barebox_pbl_size);
> +}
>  
> -	imx8mp_atf_load_bl31(bl31, bl31_size);
> +void imx8mp_load_and_start_image_via_tfa(void)
> +{
> +	imx8mp_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
> +	imx8mp_load_and_start_tfa(imx8mp_bl31_bin);
>  }
>  
> -__noreturn void imx8mn_load_and_start_image_via_tfa(void)
> +void imx8mn_load_bl33(void *bl33)
>  {
> -	size_t bl31_size;
> -	const u8 *bl31;
>  	enum bootsource src;
>  	int instance;
>  
> @@ -194,10 +190,11 @@ __noreturn void imx8mn_load_and_start_image_via_tfa(void)
>  	 * for the piggy data, so we need to ensure that we are running
>  	 * the same code in DRAM.
>  	 */
> -	memcpy((void *)MX8M_ATF_BL33_BASE_ADDR,
> -	       __image_start, barebox_pbl_size);
> -
> -	get_builtin_firmware(imx8mn_bl31_bin, &bl31, &bl31_size);
> +	memcpy(bl33, __image_start, barebox_pbl_size);
> +}
>  
> -	imx8mn_atf_load_bl31(bl31, bl31_size);
> +void imx8mn_load_and_start_image_via_tfa(void)
> +{
> +	imx8mn_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
> +	imx8mn_load_and_start_tfa(imx8mn_bl31_bin);
>  }
> diff --git a/arch/arm/mach-imx/include/mach/atf.h b/arch/arm/mach-imx/include/mach/atf.h
> index ca54bb5fbf82..b3c4ecb92576 100644
> --- a/arch/arm/mach-imx/include/mach/atf.h
> +++ b/arch/arm/mach-imx/include/mach/atf.h
> @@ -23,4 +23,16 @@ void __noreturn imx8mn_atf_load_bl31(const void *fw, size_t fw_size);
>  void __noreturn imx8mp_atf_load_bl31(const void *fw, size_t fw_size);
>  void __noreturn imx8mq_atf_load_bl31(const void *fw, size_t fw_size);
>  
> +#define imx8m_load_and_start_tfa(soc,fw_name) do { \
> +	size_t __bl31_size; \
> +	const u8 *__bl31; \
> +	soc##_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR); \
> +	get_builtin_firmware(fw_name, &__bl31, &__bl31_size); \
> +	soc##_atf_load_bl31(__bl31, __bl31_size); \
> +} while (0)
> +
> +#define imx8mm_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mm, fw_name)
> +#define imx8mn_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mn, fw_name)
> +#define imx8mp_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mp, fw_name)
> +
>  #endif
> diff --git a/arch/arm/mach-imx/include/mach/xload.h b/arch/arm/mach-imx/include/mach/xload.h
> index fe43d2502632..82bf663c4266 100644
> --- a/arch/arm/mach-imx/include/mach/xload.h
> +++ b/arch/arm/mach-imx/include/mach/xload.h
> @@ -16,6 +16,10 @@ int imx8m_esdhc_load_image(int instance, bool start);
>  int imx8mn_esdhc_load_image(int instance, bool start);
>  int imx8mp_esdhc_load_image(int instance, bool start);
>  
> +void imx8mm_load_bl33(void *bl33);
> +void imx8mn_load_bl33(void *bl33);
> +void imx8mp_load_bl33(void *bl33);
> +
>  void __noreturn imx8mm_load_and_start_image_via_tfa(void);
>  void __noreturn imx8mn_load_and_start_image_via_tfa(void);
>  void __noreturn imx8mp_load_and_start_image_via_tfa(void);
> -- 
> 2.30.2
> 
> 
> 

Re: [PATCH 3/3] ARM: i.MX8M: define imx8mX_load_bl33 and imx8mX_load_and_start_tfa

[Ahmad Fatoum]

Hello Marco,

On 16.08.22 08:14, Marco Felsch wrote:
> Hi Ahmad,
> 
> On 22-08-15, Ahmad Fatoum wrote:
>> For most users imx8mX_load_and_start_tfa saves a good deal of
>> boilerplate. It's not always sufficient though:
>>
>>   - board code may need a pointer to bl33 to install other firmware
>>     besides barebox proper from there before jumping to bl31 (TF-A).
>>
>>   - board code may want to use a different ARM Trusted Firmware,
>>     e.g. when OP-TEE is to be installed.
>>
>> Thus define two more helper: imx8mX_load_bl33 and
>> imx8mn_load_and_start_tfa, which allows board code to avoid duplicating
>> the chainload logic and focus on doing the board specific stuff only.
>>
>> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
>> ---
>>  arch/arm/mach-imx/atf.c                | 43 ++++++++++++--------------
>>  arch/arm/mach-imx/include/mach/atf.h   | 12 +++++++
>>  arch/arm/mach-imx/include/mach/xload.h |  4 +++
>>  3 files changed, 36 insertions(+), 23 deletions(-)
>>
>> diff --git a/arch/arm/mach-imx/atf.c b/arch/arm/mach-imx/atf.c
>> index 675e90792a32..5301c0fbe8e5 100644
>> --- a/arch/arm/mach-imx/atf.c
>> +++ b/arch/arm/mach-imx/atf.c
>> @@ -70,13 +70,10 @@ __noreturn void imx8mq_atf_load_bl31(const void *fw, size_t fw_size)
>>  	imx8m_atf_start_bl31(fw, fw_size, (void *)MX8MQ_ATF_BL31_BASE_ADDR);
>>  }
>>  
>> -__noreturn void imx8mm_load_and_start_image_via_tfa(void)
>> +void imx8mm_load_bl33(void *bl33)
>>  {
>> -	size_t bl31_size;
>> -	const u8 *bl31;
>>  	enum bootsource src;
>>  	int instance;
>> -	void *bl33 = (void *)MX8M_ATF_BL33_BASE_ADDR;
>>  
>>  	imx8mm_get_boot_source(&src, &instance);
>>  	switch (src) {
>> @@ -122,16 +119,16 @@ __noreturn void imx8mm_load_and_start_image_via_tfa(void)
>>  	 * the same code in DRAM.
>>  	 */
>>  	memcpy(bl33, __image_start, barebox_pbl_size);
>> +}
>>  
>> -	get_builtin_firmware(imx8mm_bl31_bin, &bl31, &bl31_size);
>> -
>> -	imx8mm_atf_load_bl31(bl31, bl31_size);
>> +__noreturn void imx8mm_load_and_start_image_via_tfa(void)
>> +{
>> +	imx8mm_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
>               ^
> This is already defined by your macro "imx8mm_load_and_start_tfa".

Ouch, thanks for spotting. Just fixed in v2.

> 
> Regards,
>   Marco
> 
>> +	imx8mm_load_and_start_tfa(imx8mm_bl31_bin);
>>  }
>>  
>> -__noreturn void imx8mp_load_and_start_image_via_tfa(void)
>> +void imx8mp_load_bl33(void *bl33)
>>  {
>> -	size_t bl31_size;
>> -	const u8 *bl31;
>>  	enum bootsource src;
>>  	int instance;
>>  
>> @@ -157,18 +154,17 @@ __noreturn void imx8mp_load_and_start_image_via_tfa(void)
>>  	 * for the piggy data, so we need to ensure that we are running
>>  	 * the same code in DRAM.
>>  	 */
>> -	memcpy((void *)MX8M_ATF_BL33_BASE_ADDR,
>> -	       __image_start, barebox_pbl_size);
>> -
>> -	get_builtin_firmware(imx8mp_bl31_bin, &bl31, &bl31_size);
>> +	memcpy(bl33, __image_start, barebox_pbl_size);
>> +}
>>  
>> -	imx8mp_atf_load_bl31(bl31, bl31_size);
>> +void imx8mp_load_and_start_image_via_tfa(void)
>> +{
>> +	imx8mp_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
>> +	imx8mp_load_and_start_tfa(imx8mp_bl31_bin);
>>  }
>>  
>> -__noreturn void imx8mn_load_and_start_image_via_tfa(void)
>> +void imx8mn_load_bl33(void *bl33)
>>  {
>> -	size_t bl31_size;
>> -	const u8 *bl31;
>>  	enum bootsource src;
>>  	int instance;
>>  
>> @@ -194,10 +190,11 @@ __noreturn void imx8mn_load_and_start_image_via_tfa(void)
>>  	 * for the piggy data, so we need to ensure that we are running
>>  	 * the same code in DRAM.
>>  	 */
>> -	memcpy((void *)MX8M_ATF_BL33_BASE_ADDR,
>> -	       __image_start, barebox_pbl_size);
>> -
>> -	get_builtin_firmware(imx8mn_bl31_bin, &bl31, &bl31_size);
>> +	memcpy(bl33, __image_start, barebox_pbl_size);
>> +}
>>  
>> -	imx8mn_atf_load_bl31(bl31, bl31_size);
>> +void imx8mn_load_and_start_image_via_tfa(void)
>> +{
>> +	imx8mn_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR);
>> +	imx8mn_load_and_start_tfa(imx8mn_bl31_bin);
>>  }
>> diff --git a/arch/arm/mach-imx/include/mach/atf.h b/arch/arm/mach-imx/include/mach/atf.h
>> index ca54bb5fbf82..b3c4ecb92576 100644
>> --- a/arch/arm/mach-imx/include/mach/atf.h
>> +++ b/arch/arm/mach-imx/include/mach/atf.h
>> @@ -23,4 +23,16 @@ void __noreturn imx8mn_atf_load_bl31(const void *fw, size_t fw_size);
>>  void __noreturn imx8mp_atf_load_bl31(const void *fw, size_t fw_size);
>>  void __noreturn imx8mq_atf_load_bl31(const void *fw, size_t fw_size);
>>  
>> +#define imx8m_load_and_start_tfa(soc,fw_name) do { \
>> +	size_t __bl31_size; \
>> +	const u8 *__bl31; \
>> +	soc##_load_bl33((void *)MX8M_ATF_BL33_BASE_ADDR); \
>> +	get_builtin_firmware(fw_name, &__bl31, &__bl31_size); \
>> +	soc##_atf_load_bl31(__bl31, __bl31_size); \
>> +} while (0)
>> +
>> +#define imx8mm_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mm, fw_name)
>> +#define imx8mn_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mn, fw_name)
>> +#define imx8mp_load_and_start_tfa(fw_name) imx8m_load_and_start_tfa(imx8mp, fw_name)
>> +
>>  #endif
>> diff --git a/arch/arm/mach-imx/include/mach/xload.h b/arch/arm/mach-imx/include/mach/xload.h
>> index fe43d2502632..82bf663c4266 100644
>> --- a/arch/arm/mach-imx/include/mach/xload.h
>> +++ b/arch/arm/mach-imx/include/mach/xload.h
>> @@ -16,6 +16,10 @@ int imx8m_esdhc_load_image(int instance, bool start);
>>  int imx8mn_esdhc_load_image(int instance, bool start);
>>  int imx8mp_esdhc_load_image(int instance, bool start);
>>  
>> +void imx8mm_load_bl33(void *bl33);
>> +void imx8mn_load_bl33(void *bl33);
>> +void imx8mp_load_bl33(void *bl33);
>> +
>>  void __noreturn imx8mm_load_and_start_image_via_tfa(void);
>>  void __noreturn imx8mn_load_and_start_image_via_tfa(void);
>>  void __noreturn imx8mp_load_and_start_image_via_tfa(void);
>> -- 
>> 2.30.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 |