2 * Copyright (C) 2017 Google, Inc
3 * Written by Simon Glass <sjg@chromium.org>
5 * SPDX-License-Identifier: GPL-2.0+
9 #include <environment.h>
11 DECLARE_GLOBAL_DATA_PTR;
13 static struct env_driver *_env_driver_lookup(enum env_location loc)
15 struct env_driver *drv;
16 const int n_ents = ll_entry_count(struct env_driver, env_driver);
17 struct env_driver *entry;
19 drv = ll_entry_start(struct env_driver, env_driver);
20 for (entry = drv; entry != drv + n_ents; entry++) {
21 if (loc == entry->location)
29 static enum env_location env_locations[] = {
30 #ifdef CONFIG_ENV_IS_IN_EEPROM
33 #ifdef CONFIG_ENV_IS_IN_EXT4
36 #ifdef CONFIG_ENV_IS_IN_FAT
39 #ifdef CONFIG_ENV_IS_IN_FLASH
42 #ifdef CONFIG_ENV_IS_IN_MMC
45 #ifdef CONFIG_ENV_IS_IN_NAND
48 #ifdef CONFIG_ENV_IS_IN_NVRAM
51 #ifdef CONFIG_ENV_IS_IN_REMOTE
54 #ifdef CONFIG_ENV_IS_IN_SPI_FLASH
57 #ifdef CONFIG_ENV_IS_IN_UBI
60 #ifdef CONFIG_ENV_IS_NOWHERE
65 static bool env_has_inited(enum env_location location)
67 return gd->env_has_init & BIT(location);
70 static void env_set_inited(enum env_location location)
73 * We're using a 32-bits bitmask stored in gd (env_has_init)
74 * using the above enum value as the bit index. We need to
75 * make sure that we're not overflowing it.
77 BUILD_BUG_ON(ARRAY_SIZE(env_locations) > BITS_PER_LONG);
79 gd->env_has_init |= BIT(location);
83 * env_get_location() - Returns the best env location for a board
84 * @op: operations performed on the environment
85 * @prio: priority between the multiple environments, 0 being the
88 * This will return the preferred environment for the given priority.
89 * This is overridable by boards if they need to.
91 * All implementations are free to use the operation, the priority and
92 * any other data relevant to their choice, but must take into account
93 * the fact that the lowest prority (0) is the most important location
94 * in the system. The following locations should be returned by order
95 * of descending priorities, from the highest to the lowest priority.
98 * an enum env_location value on success, a negative error code otherwise
100 __weak enum env_location env_get_location(enum env_operation op, int prio)
106 if (prio >= ARRAY_SIZE(env_locations))
109 gd->env_load_location = env_locations[prio];
110 return gd->env_load_location;
113 return gd->env_load_location;
121 * env_driver_lookup() - Finds the most suited environment location
122 * @op: operations performed on the environment
123 * @prio: priority between the multiple environments, 0 being the
126 * This will try to find the available environment with the highest
127 * priority in the system.
130 * NULL on error, a pointer to a struct env_driver otherwise
132 static struct env_driver *env_driver_lookup(enum env_operation op, int prio)
134 enum env_location loc = env_get_location(op, prio);
135 struct env_driver *drv;
137 if (loc == ENVL_UNKNOWN)
140 drv = _env_driver_lookup(loc);
142 debug("%s: No environment driver for location %d\n", __func__,
150 __weak int env_get_char_spec(int index)
152 return *(uchar *)(gd->env_addr + index);
155 int env_get_char(int index)
157 if (gd->env_valid == ENV_INVALID)
158 return default_environment[index];
160 return env_get_char_spec(index);
165 struct env_driver *drv;
168 for (prio = 0; (drv = env_driver_lookup(ENVOP_LOAD, prio)); prio++) {
174 if (!env_has_inited(drv->location))
177 printf("Loading Environment from %s... ", drv->name);
180 printf("Failed (%d)\n", ret);
193 struct env_driver *drv;
196 for (prio = 0; (drv = env_driver_lookup(ENVOP_SAVE, prio)); prio++) {
202 if (!env_has_inited(drv->location))
205 printf("Saving Environment to %s... ", drv->name);
208 printf("Failed (%d)\n", ret);
221 struct env_driver *drv;
225 for (prio = 0; (drv = env_driver_lookup(ENVOP_INIT, prio)); prio++) {
226 if (!drv->init || !(ret = drv->init()))
227 env_set_inited(drv->location);
229 debug("%s: Environment %s init done (ret=%d)\n", __func__,
236 if (ret == -ENOENT) {
237 gd->env_addr = (ulong)&default_environment[0];
238 gd->env_valid = ENV_VALID;