blob: b704c033631c1c318702274036737c3e3755dc60 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenkc6097192002-11-03 00:24:07 +00002/*
Simon Glassf3998fd2019-08-02 09:44:25 -06003 * Internal environment header file. This includes direct access to environment
4 * information such as its size and offset, direct access to the default
5 * environment and embedded environment (if used). It also provides environment
6 * drivers with various declarations.
7 *
8 * It should not be included by board files, drivers and code other than that
9 * related to the environment implementation.
10 *
wdenkc6097192002-11-03 00:24:07 +000011 * (C) Copyright 2002
12 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkc6097192002-11-03 00:24:07 +000013 */
14
Simon Glassf3998fd2019-08-02 09:44:25 -060015#ifndef _ENV_INTERNAL_H_
16#define _ENV_INTERNAL_H_
wdenkc6097192002-11-03 00:24:07 +000017
Maxime Ripardfb1c43c2017-02-27 18:22:03 +010018#include <linux/kconfig.h>
19
wdenkc6097192002-11-03 00:24:07 +000020/**************************************************************************
21 *
22 * The "environment" is stored as a list of '\0' terminated
23 * "name=value" strings. The end of the list is marked by a double
24 * '\0'. New entries are always added at the end. Deleting an entry
25 * shifts the remaining entries to the front. Replacing an entry is a
26 * combination of deleting the old value and adding the new one.
27 *
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -040028 * The environment is preceded by a 32 bit CRC over the data part.
wdenkc6097192002-11-03 00:24:07 +000029 *
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -040030 *************************************************************************/
wdenkc6097192002-11-03 00:24:07 +000031
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020032#if defined(CONFIG_ENV_IS_IN_FLASH)
Tom Rinia8992e72019-11-18 20:02:07 -050033# if defined(CONFIG_ENV_ADDR_REDUND) && \
34 ((CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
35 (CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SIZE) <= \
36 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN))
37# define ENV_IS_EMBEDDED
wdenkc6097192002-11-03 00:24:07 +000038# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000039# if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
40 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \
41 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000042# define ENV_IS_EMBEDDED
wdenkc6097192002-11-03 00:24:07 +000043# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040044# ifdef CONFIG_ENV_IS_EMBEDDED
45# error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
46# error "it is calculated automatically for you"
47# endif
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020048#endif /* CONFIG_ENV_IS_IN_FLASH */
wdenkc6097192002-11-03 00:24:07 +000049
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020050#if defined(CONFIG_ENV_IS_IN_NAND)
Ben Gardinerc9f73512010-07-05 13:27:07 -040051# if defined(CONFIG_ENV_OFFSET_OOB)
52# ifdef CONFIG_ENV_OFFSET_REDUND
53# error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
54# error "is set"
55# endif
56extern unsigned long nand_env_oob_offset;
Ben Gardinerc9f73512010-07-05 13:27:07 -040057# endif /* CONFIG_ENV_OFFSET_OOB */
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020058#endif /* CONFIG_ENV_IS_IN_NAND */
Markus Klotzbuechere443c942006-03-20 18:02:44 +010059
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040060/*
61 * For the flash types where embedded env is supported, but it cannot be
62 * calculated automatically (i.e. NAND), take the board opt-in.
63 */
64#if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000065# define ENV_IS_EMBEDDED
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040066#endif
67
68/* The build system likes to know if the env is embedded */
69#ifdef DO_DEPS_ONLY
70# ifdef ENV_IS_EMBEDDED
Wolfgang Denk33a6b9e2011-07-30 14:01:08 +000071# ifndef CONFIG_ENV_IS_EMBEDDED
72# define CONFIG_ENV_IS_EMBEDDED
73# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040074# endif
75#endif
76
Mike Frysinger37566092009-07-02 19:23:25 -040077#include "compiler.h"
wdenkc6097192002-11-03 00:24:07 +000078
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020079#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Mike Frysinger89cdab72008-03-31 11:02:01 -040080# define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
wdenkc6097192002-11-03 00:24:07 +000081#else
Mike Frysinger89cdab72008-03-31 11:02:01 -040082# define ENV_HEADER_SIZE (sizeof(uint32_t))
wdenkc6097192002-11-03 00:24:07 +000083#endif
84
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020085#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
wdenkc6097192002-11-03 00:24:07 +000086
Simon Glassf030b7b2019-08-01 09:47:11 -060087/*
88 * If the environment is in RAM, allocate extra space for it in the malloc
89 * region.
90 */
91#if defined(CONFIG_ENV_IS_EMBEDDED)
92#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
93#elif (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE < CONFIG_SYS_MONITOR_BASE) || \
94 (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) || \
95 defined(CONFIG_ENV_IS_IN_NVRAM)
96#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
97#else
98#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
99#endif
100
Igor Grinberg507651d2011-11-07 01:13:55 +0000101typedef struct environment_s {
Mike Frysinger89cdab72008-03-31 11:02:01 -0400102 uint32_t crc; /* CRC32 over data bytes */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200103#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Simon Glassd3716dd2019-08-01 09:47:08 -0600104 unsigned char flags; /* active/obsolete flags ENVF_REDUND_ */
wdenkc6097192002-11-03 00:24:07 +0000105#endif
106 unsigned char data[ENV_SIZE]; /* Environment data */
Tom Rinic6831c72017-11-14 08:39:35 -0500107} env_t;
wdenkc6097192002-11-03 00:24:07 +0000108
Igor Grinberg994bc672011-11-17 06:07:23 +0000109#ifdef ENV_IS_EMBEDDED
Simon Glassbe54ec12019-08-01 09:47:03 -0600110extern env_t embedded_environment;
Igor Grinberg994bc672011-11-17 06:07:23 +0000111#endif /* ENV_IS_EMBEDDED */
112
Pali Rohár93f40482020-12-23 12:21:28 +0100113#ifdef DEFAULT_ENV_IS_RW
Marek Behúnc5cbbe32021-10-22 15:47:24 +0200114extern char default_environment[];
Pali Rohár93f40482020-12-23 12:21:28 +0100115#else
Marek Behúnc5cbbe32021-10-22 15:47:24 +0200116extern const char default_environment[];
Pali Rohár93f40482020-12-23 12:21:28 +0100117#endif
Igor Grinberg27aafe92011-11-07 01:14:11 +0000118
Mike Frysinger2eb15732010-12-08 06:26:04 -0500119#ifndef DO_DEPS_ONLY
120
Joe Hershberger170ab112012-12-11 22:16:24 -0600121#include <env_attr.h>
122#include <env_callback.h>
Joe Hershberger25980902012-12-11 22:16:31 -0600123#include <env_flags.h>
Mike Frysinger2eb15732010-12-08 06:26:04 -0500124#include <search.h>
125
Simon Glass4415f1d2017-08-03 12:21:58 -0600126enum env_location {
York Sune1caa582018-02-07 14:17:11 -0800127 ENVL_UNKNOWN,
Simon Glass4415f1d2017-08-03 12:21:58 -0600128 ENVL_EEPROM,
129 ENVL_EXT4,
130 ENVL_FAT,
131 ENVL_FLASH,
132 ENVL_MMC,
133 ENVL_NAND,
134 ENVL_NVRAM,
135 ENVL_ONENAND,
136 ENVL_REMOTE,
137 ENVL_SPI_FLASH,
138 ENVL_UBI,
139 ENVL_NOWHERE,
140
141 ENVL_COUNT,
Simon Glass4415f1d2017-08-03 12:21:58 -0600142};
143
Maxime Ripard8a3a7e22018-01-23 21:16:52 +0100144/* value for the various operations we want to perform on the env */
145enum env_operation {
146 ENVOP_GET_CHAR, /* we want to call the get_char function */
147 ENVOP_INIT, /* we want to call the init function */
148 ENVOP_LOAD, /* we want to call the load function */
149 ENVOP_SAVE, /* we want to call the save function */
Frank Wunderlichcd121bd2019-06-29 11:36:19 +0200150 ENVOP_ERASE, /* we want to call the erase function */
Maxime Ripard8a3a7e22018-01-23 21:16:52 +0100151};
152
Simon Glass4415f1d2017-08-03 12:21:58 -0600153struct env_driver {
Simon Glassac358be2017-08-03 12:22:03 -0600154 const char *name;
Simon Glass4415f1d2017-08-03 12:21:58 -0600155 enum env_location location;
156
157 /**
Simon Glass4415f1d2017-08-03 12:21:58 -0600158 * load() - Load the environment from storage
159 *
Patrick Delaunay466d9852020-07-28 11:51:19 +0200160 * This method is required for loading environment
Simon Glassc5951992017-08-03 12:22:17 -0600161 *
162 * @return 0 if OK, -ve on error
Simon Glass4415f1d2017-08-03 12:21:58 -0600163 */
Simon Glassc5951992017-08-03 12:22:17 -0600164 int (*load)(void);
Simon Glass4415f1d2017-08-03 12:21:58 -0600165
166 /**
167 * save() - Save the environment to storage
168 *
169 * This method is required for 'saveenv' to work.
170 *
171 * @return 0 if OK, -ve on error
172 */
173 int (*save)(void);
174
175 /**
Frank Wunderlichcd121bd2019-06-29 11:36:19 +0200176 * erase() - Erase the environment on storage
177 *
178 * This method is optional and required for 'eraseenv' to work.
179 *
180 * @return 0 if OK, -ve on error
181 */
182 int (*erase)(void);
183
184 /**
Simon Glass4415f1d2017-08-03 12:21:58 -0600185 * init() - Set up the initial pre-relocation environment
186 *
187 * This method is optional.
188 *
Simon Glass79388222017-08-03 12:22:02 -0600189 * @return 0 if OK, -ENOENT if no initial environment could be found,
190 * other -ve on error
Simon Glass4415f1d2017-08-03 12:21:58 -0600191 */
192 int (*init)(void);
193};
194
195/* Declare a new environment location driver */
196#define U_BOOT_ENV_LOCATION(__name) \
197 ll_entry_declare(struct env_driver, __name, env_driver)
198
Simon Glassac358be2017-08-03 12:22:03 -0600199/* Declare the name of a location */
200#ifdef CONFIG_CMD_SAVEENV
201#define ENV_NAME(_name) .name = _name,
202#else
203#define ENV_NAME(_name)
204#endif
205
Simon Glass4415f1d2017-08-03 12:21:58 -0600206#ifdef CONFIG_CMD_SAVEENV
207#define env_save_ptr(x) x
208#else
209#define env_save_ptr(x) NULL
210#endif
211
Rasmus Villemoes82b2f412020-02-19 09:47:40 +0000212#define ENV_SAVE_PTR(x) (CONFIG_IS_ENABLED(SAVEENV) ? (x) : NULL)
Patrick Delaunay1af031a2021-02-09 11:48:50 +0100213#define ENV_ERASE_PTR(x) (CONFIG_IS_ENABLED(CMD_ERASEENV) ? (x) : NULL)
Rasmus Villemoes82b2f412020-02-19 09:47:40 +0000214
Mike Frysinger2eb15732010-12-08 06:26:04 -0500215extern struct hsearch_data env_htab;
216
Patrick Delaunay2f96b322020-06-19 14:03:35 +0200217/**
Patrick Delaunay879369e2020-06-15 16:52:17 +0200218 * env_ext4_get_intf() - Provide the interface for env in EXT4
219 *
220 * It is a weak function allowing board to overidde the default interface for
221 * U-Boot env in EXT4: CONFIG_ENV_EXT4_INTERFACE
222 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100223 * Return: string of interface, empty if not supported
Patrick Delaunay879369e2020-06-15 16:52:17 +0200224 */
225const char *env_ext4_get_intf(void);
226
227/**
228 * env_ext4_get_dev_part() - Provide the device and partition for env in EXT4
229 *
230 * It is a weak function allowing board to overidde the default device and
231 * partition used for U-Boot env in EXT4: CONFIG_ENV_EXT4_DEVICE_AND_PART
232 *
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100233 * Return: string of device and partition
Patrick Delaunay879369e2020-06-15 16:52:17 +0200234 */
235const char *env_ext4_get_dev_part(void);
236
237/**
Patrick Delaunay2f96b322020-06-19 14:03:35 +0200238 * env_get_location()- Provide the best location for the U-Boot environment
239 *
240 * It is a weak function allowing board to overidde the environment location
241 *
242 * @op: operations performed on the environment
243 * @prio: priority between the multiple environments, 0 being the
244 * highest priority
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100245 * Return: an enum env_location value on success, or -ve error code.
Patrick Delaunay2f96b322020-06-19 14:03:35 +0200246 */
247enum env_location env_get_location(enum env_operation op, int prio);
He Yongeb68ead2022-02-18 00:07:25 +0800248
249/**
250 * env_fat_get_intf() - Provide the interface for env in FAT
251 *
252 * It is a weak function allowing board to overidde the default interface for
253 * U-Boot env in FAT: CONFIG_ENV_FAT_INTERFACE
254 *
255 * Return: string of interface, empty if not supported
256 */
257const char *env_fat_get_intf(void);
258
259/**
260 * env_fat_get_dev_part() - Provide the device and partition for env in FAT
261 *
262 * It is a weak function allowing board to overidde the default device and
263 * partition used for U-Boot env in FAT: CONFIG_ENV_FAT_DEVICE_AND_PART
264 *
265 * Return: string of device and partition
266 */
267char *env_fat_get_dev_part(void);
Igor Grinberg507651d2011-11-07 01:13:55 +0000268#endif /* DO_DEPS_ONLY */
Mike Frysinger2eb15732010-12-08 06:26:04 -0500269
Simon Glassf3998fd2019-08-02 09:44:25 -0600270#endif /* _ENV_INTERNAL_H_ */