Skip to contentSkip to conversation

env: Implement lower priority arch_env_get_location()

PATCH In review Marek Vasut 2 participants 6 messages Apr 6, 2022 – Apr 21, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/3 env: Implement lower priority arch_env_get_location()

Currently there is only one way to override desired environment location, by implementing env_get_location(). This is increasingly being conflated both on board level and architecture level, which leads to a problem on boards where this function is already implemented on architecture level, since those boards have no way to override this environment location on board level anymore.

Implement arch_env_get_location() function which is architecture specific and should only ever be implemented in architecture code. This function has lower priority than env_get_location(), which should only ever be implemented in board code, and which overrides the arch_env_get_location() architecture environment selection.

This way, architecture can define its default environment chooser, while board can now override it as needed at all times.

There is no functional change, since env_get_location() simply returns arch_env_get_location(), and arch_env_get_location() implements the current env_get_location() default content.

Cc Adam Ford <[email protected]>
Cc Fabio Estevam <[email protected]>
Cc Marek Behún <[email protected]>
Cc Peng Fan <[email protected]>
Cc Simon Glass <[email protected]>
Cc Stefano Babic <[email protected]>
Cc Tim Harvey <[email protected]>
Cc Tom Rini <[email protected]>
Cc Tommaso Merciai <[email protected]>
Cc Vladimir Oltean <[email protected]>
---
 env/env.c              | 29 ++++++++++++++++++++++++++---
 include/env_internal.h | 16 ++++++++++++++++
 2 files changed, 42 insertions(+), 3 deletions(-)
env/env.c +26 -3
index e4dfb92e154..69848fb0608 100644
@@ -110,13 +110,14 @@ static void env_set_inited(enum env_location location)
 }
 
 /**
- * env_get_location() - Returns the best env location for a board
+ * arch_env_get_location() - Returns the best env location for an arch
  * @op: operations performed on the environment
  * @prio: priority between the multiple environments, 0 being the
  *        highest priority
  *
  * This will return the preferred environment for the given priority.
- * This is overridable by boards if they need to.
+ * This is overridable by architectures if they need to and has lower
+ * priority than board side env_get_location() override.
  *
  * All implementations are free to use the operation, the priority and
  * any other data relevant to their choice, but must take into account
@@ -127,7 +128,7 @@ static void env_set_inited(enum env_location location)
  * Returns:
  * an enum env_location value on success, a negative error code otherwise
  */
-__weak enum env_location env_get_location(enum env_operation op, int prio)
+__weak enum env_location arch_env_get_location(enum env_operation op, int prio)
 {
 	if (prio >= ARRAY_SIZE(env_locations))
 		return ENVL_UNKNOWN;
@@ -135,6 +136,28 @@ __weak enum env_location env_get_location(enum env_operation op, int prio)
 	return env_locations[prio];
 }
 
+/**
+ * env_get_location() - Returns the best env location for a board
+ * @op: operations performed on the environment
+ * @prio: priority between the multiple environments, 0 being the
+ *        highest priority
+ *
+ * This will return the preferred environment for the given priority.
+ * This is overridable by boards if they need to.
+ *
+ * All implementations are free to use the operation, the priority and
+ * any other data relevant to their choice, but must take into account
+ * the fact that the lowest prority (0) is the most important location
+ * in the system. The following locations should be returned by order
+ * of descending priorities, from the highest to the lowest priority.
+ *
+ * Returns:
+ * an enum env_location value on success, a negative error code otherwise
+ */
+__weak enum env_location env_get_location(enum env_operation op, int prio)
+{
+	return arch_env_get_location(op, prio);
+}
 
 /**
  * env_driver_lookup() - Finds the most suited environment location
include/env_internal.h +16 -0
index 07c227ecc03..14f4c696785 100644
@@ -234,10 +234,26 @@ const char *env_ext4_get_intf(void);
  */
 const char *env_ext4_get_dev_part(void);
 
+/**
+ * arch_env_get_location()- Provide the best location for the U-Boot environment
+ *
+ * It is a weak function allowing board to overidde the environment location
+ * on architecture level. This has lower priority than env_get_location(),
+ * which can be defined on board level.
+ *
+ * @op: operations performed on the environment
+ * @prio: priority between the multiple environments, 0 being the
+ *        highest priority
+ * Return:  an enum env_location value on success, or -ve error code.
+ */
+enum env_location arch_env_get_location(enum env_operation op, int prio);
+
 /**
  * env_get_location()- Provide the best location for the U-Boot environment
  *
  * It is a weak function allowing board to overidde the environment location
+ * on board level. This has higher priority than arch_env_get_location(),
+ * which can be defined on architecture level.
  *
  * @op: operations performed on the environment
  * @prio: priority between the multiple environments, 0 being the
Signature · 1 line
2.35.1
#1 lore raw

PATCH 2/3 armv8: layerscape: env: Switch to arch_env_get_location()

Implement arch_env_get_location() instead of env_get_location(), so that the env_get_location() can be implemented on board level and override the arch_env_get_location() architecture defaults.

Cc Adam Ford <[email protected]>
Cc Fabio Estevam <[email protected]>
Cc Marek Behún <[email protected]>
Cc Peng Fan <[email protected]>
Cc Simon Glass <[email protected]>
Cc Stefano Babic <[email protected]>
Cc Tim Harvey <[email protected]>
Cc Tom Rini <[email protected]>
Cc Tommaso Merciai <[email protected]>
Cc Vladimir Oltean <[email protected]>
---
 arch/arm/cpu/armv8/fsl-layerscape/cpu.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/arm/cpu/armv8/fsl-layerscape/cpu.c +1 -1
index 177f568f26e..8eed389cc3e 100644
@@ -818,7 +818,7 @@ int mmc_get_env_dev(void)
 }
 #endif
 
-enum env_location env_get_location(enum env_operation op, int prio)
+enum env_location arch_env_get_location(enum env_operation op, int prio)
 {
 	enum boot_src src = get_boot_src();
 	enum env_location env_loc = ENVL_NOWHERE;
Signature · 1 line
2.35.1
#2 lore raw

Re: [PATCH 2/3] armv8: layerscape: env: Switch to arch_env_get_location()

Quoted 4 lines · Marek Vasut

Implement arch_env_get_location() instead of env_get_location(), so that the env_get_location() can be implemented on board level and override the arch_env_get_location() architecture defaults.

Quoted 11 lines
Cc Adam Ford <[email protected]>
Cc Fabio Estevam <[email protected]>
Cc Marek Behún <[email protected]>
Cc Peng Fan <[email protected]>
Cc Simon Glass <[email protected]>
Cc Stefano Babic <[email protected]>
Cc Tim Harvey <[email protected]>
Cc Tom Rini <[email protected]>
Cc Tommaso Merciai <[email protected]>
Cc Vladimir Oltean <[email protected]>

Applied to u-boot/master, thanks!

Signature · 1 line
Tom
#3 lore raw

PATCH 3/3 ARM: imx: imx8m: env: Switch to arch_env_get_location()

In reply to Marek Vasut

Implement arch_env_get_location() instead of env_get_location(), so that the env_get_location() can be implemented on board level and override the arch_env_get_location() architecture defaults.

Cc Adam Ford <[email protected]>
Cc Fabio Estevam <[email protected]>
Cc Marek Behún <[email protected]>
Cc Peng Fan <[email protected]>
Cc Simon Glass <[email protected]>
Cc Stefano Babic <[email protected]>
Cc Tim Harvey <[email protected]>
Cc Tom Rini <[email protected]>
Cc Tommaso Merciai <[email protected]>
Cc Vladimir Oltean <[email protected]>
---
 arch/arm/mach-imx/imx8m/soc.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/arm/mach-imx/imx8m/soc.c +1 -1
index fc29208af29..ea6cbf2c3f0 100644
@@ -1314,7 +1314,7 @@ void do_error(struct pt_regs *pt_regs)
 #endif
 
 #if defined(CONFIG_IMX8MN) || defined(CONFIG_IMX8MP)
-enum env_location env_get_location(enum env_operation op, int prio)
+enum env_location arch_env_get_location(enum env_operation op, int prio)
 {
 	enum boot_device dev = get_boot_device();
 
Signature · 1 line
2.35.1
#4 lore raw

Re: [PATCH 3/3] ARM: imx: imx8m: env: Switch to arch_env_get_location()

Quoted 4 lines · Marek Vasut

Implement arch_env_get_location() instead of env_get_location(), so that the env_get_location() can be implemented on board level and override the arch_env_get_location() architecture defaults.

Quoted 11 lines
Cc Adam Ford <[email protected]>
Cc Fabio Estevam <[email protected]>
Cc Marek Behún <[email protected]>
Cc Peng Fan <[email protected]>
Cc Simon Glass <[email protected]>
Cc Stefano Babic <[email protected]>
Cc Tim Harvey <[email protected]>
Cc Tom Rini <[email protected]>
Cc Tommaso Merciai <[email protected]>
Cc Vladimir Oltean <[email protected]>

Applied to u-boot/master, thanks!

Signature · 1 line
Tom
#5 lore raw
In reply to Marek Vasut
Quoted 20 lines · Marek Vasut

Currently there is only one way to override desired environment location, by implementing env_get_location(). This is increasingly being conflated both on board level and architecture level, which leads to a problem on boards where this function is already implemented on architecture level, since those boards have no way to override this environment location on board level anymore.

Implement arch_env_get_location() function which is architecture specific and should only ever be implemented in architecture code. This function has lower priority than env_get_location(), which should only ever be implemented in board code, and which overrides the arch_env_get_location() architecture environment selection.

This way, architecture can define its default environment chooser, while board can now override it as needed at all times.

There is no functional change, since env_get_location() simply returns arch_env_get_location(), and arch_env_get_location() implements the current env_get_location() default content.

Quoted 11 lines
Cc Adam Ford <[email protected]>
Cc Fabio Estevam <[email protected]>
Cc Marek Behún <[email protected]>
Cc Peng Fan <[email protected]>
Cc Simon Glass <[email protected]>
Cc Stefano Babic <[email protected]>
Cc Tim Harvey <[email protected]>
Cc Tom Rini <[email protected]>
Cc Tommaso Merciai <[email protected]>
Cc Vladimir Oltean <[email protected]>

Applied to u-boot/master, thanks!

Signature · 1 line
Tom