blob: b7bddcb00d81c25b8b0fa96b55911ad10edb8412 [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;
57# define CONFIG_ENV_OFFSET nand_env_oob_offset
Ben Gardinerc9f73512010-07-05 13:27:07 -040058# endif /* CONFIG_ENV_OFFSET_OOB */
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020059#endif /* CONFIG_ENV_IS_IN_NAND */
Markus Klotzbuechere443c942006-03-20 18:02:44 +010060
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040061/*
62 * For the flash types where embedded env is supported, but it cannot be
63 * calculated automatically (i.e. NAND), take the board opt-in.
64 */
65#if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000066# define ENV_IS_EMBEDDED
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040067#endif
68
69/* The build system likes to know if the env is embedded */
70#ifdef DO_DEPS_ONLY
71# ifdef ENV_IS_EMBEDDED
Wolfgang Denk33a6b9e2011-07-30 14:01:08 +000072# ifndef CONFIG_ENV_IS_EMBEDDED
73# define CONFIG_ENV_IS_EMBEDDED
74# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040075# endif
76#endif
77
Mike Frysinger37566092009-07-02 19:23:25 -040078#include "compiler.h"
wdenkc6097192002-11-03 00:24:07 +000079
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020080#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Mike Frysinger89cdab72008-03-31 11:02:01 -040081# define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
wdenkc6097192002-11-03 00:24:07 +000082#else
Mike Frysinger89cdab72008-03-31 11:02:01 -040083# define ENV_HEADER_SIZE (sizeof(uint32_t))
wdenkc6097192002-11-03 00:24:07 +000084#endif
85
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020086#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
wdenkc6097192002-11-03 00:24:07 +000087
Simon Glassf030b7b2019-08-01 09:47:11 -060088/*
89 * If the environment is in RAM, allocate extra space for it in the malloc
90 * region.
91 */
92#if defined(CONFIG_ENV_IS_EMBEDDED)
93#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
94#elif (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE < CONFIG_SYS_MONITOR_BASE) || \
95 (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) || \
96 defined(CONFIG_ENV_IS_IN_NVRAM)
97#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
98#else
99#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
100#endif
101
Igor Grinberg507651d2011-11-07 01:13:55 +0000102typedef struct environment_s {
Mike Frysinger89cdab72008-03-31 11:02:01 -0400103 uint32_t crc; /* CRC32 over data bytes */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200104#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Simon Glassd3716dd2019-08-01 09:47:08 -0600105 unsigned char flags; /* active/obsolete flags ENVF_REDUND_ */
wdenkc6097192002-11-03 00:24:07 +0000106#endif
107 unsigned char data[ENV_SIZE]; /* Environment data */
Tom Rinic6831c72017-11-14 08:39:35 -0500108} env_t;
wdenkc6097192002-11-03 00:24:07 +0000109
Igor Grinberg994bc672011-11-17 06:07:23 +0000110#ifdef ENV_IS_EMBEDDED
Simon Glassbe54ec12019-08-01 09:47:03 -0600111extern env_t embedded_environment;
Igor Grinberg994bc672011-11-17 06:07:23 +0000112#endif /* ENV_IS_EMBEDDED */
113
Pali Rohár93f40482020-12-23 12:21:28 +0100114#ifdef DEFAULT_ENV_IS_RW
115extern unsigned char default_environment[];
116#else
Igor Grinbergd1459f02011-11-07 01:13:57 +0000117extern const unsigned char default_environment[];
Pali Rohár93f40482020-12-23 12:21:28 +0100118#endif
Igor Grinberg27aafe92011-11-07 01:14:11 +0000119
Mike Frysinger2eb15732010-12-08 06:26:04 -0500120#ifndef DO_DEPS_ONLY
121
Joe Hershberger170ab112012-12-11 22:16:24 -0600122#include <env_attr.h>
123#include <env_callback.h>
Joe Hershberger25980902012-12-11 22:16:31 -0600124#include <env_flags.h>
Mike Frysinger2eb15732010-12-08 06:26:04 -0500125#include <search.h>
126
Simon Glass4415f1d2017-08-03 12:21:58 -0600127enum env_location {
York Sune1caa582018-02-07 14:17:11 -0800128 ENVL_UNKNOWN,
Simon Glass4415f1d2017-08-03 12:21:58 -0600129 ENVL_EEPROM,
130 ENVL_EXT4,
131 ENVL_FAT,
132 ENVL_FLASH,
133 ENVL_MMC,
134 ENVL_NAND,
135 ENVL_NVRAM,
136 ENVL_ONENAND,
137 ENVL_REMOTE,
138 ENVL_SPI_FLASH,
139 ENVL_UBI,
140 ENVL_NOWHERE,
141
142 ENVL_COUNT,
Simon Glass4415f1d2017-08-03 12:21:58 -0600143};
144
Maxime Ripard8a3a7e22018-01-23 21:16:52 +0100145/* value for the various operations we want to perform on the env */
146enum env_operation {
147 ENVOP_GET_CHAR, /* we want to call the get_char function */
148 ENVOP_INIT, /* we want to call the init function */
149 ENVOP_LOAD, /* we want to call the load function */
150 ENVOP_SAVE, /* we want to call the save function */
Frank Wunderlichcd121bd2019-06-29 11:36:19 +0200151 ENVOP_ERASE, /* we want to call the erase function */
Maxime Ripard8a3a7e22018-01-23 21:16:52 +0100152};
153
Simon Glass4415f1d2017-08-03 12:21:58 -0600154struct env_driver {
Simon Glassac358be2017-08-03 12:22:03 -0600155 const char *name;
Simon Glass4415f1d2017-08-03 12:21:58 -0600156 enum env_location location;
157
158 /**
Simon Glass4415f1d2017-08-03 12:21:58 -0600159 * load() - Load the environment from storage
160 *
Patrick Delaunay466d9852020-07-28 11:51:19 +0200161 * This method is required for loading environment
Simon Glassc5951992017-08-03 12:22:17 -0600162 *
163 * @return 0 if OK, -ve on error
Simon Glass4415f1d2017-08-03 12:21:58 -0600164 */
Simon Glassc5951992017-08-03 12:22:17 -0600165 int (*load)(void);
Simon Glass4415f1d2017-08-03 12:21:58 -0600166
167 /**
168 * save() - Save the environment to storage
169 *
170 * This method is required for 'saveenv' to work.
171 *
172 * @return 0 if OK, -ve on error
173 */
174 int (*save)(void);
175
176 /**
Frank Wunderlichcd121bd2019-06-29 11:36:19 +0200177 * erase() - Erase the environment on storage
178 *
179 * This method is optional and required for 'eraseenv' to work.
180 *
181 * @return 0 if OK, -ve on error
182 */
183 int (*erase)(void);
184
185 /**
Simon Glass4415f1d2017-08-03 12:21:58 -0600186 * init() - Set up the initial pre-relocation environment
187 *
188 * This method is optional.
189 *
Simon Glass79388222017-08-03 12:22:02 -0600190 * @return 0 if OK, -ENOENT if no initial environment could be found,
191 * other -ve on error
Simon Glass4415f1d2017-08-03 12:21:58 -0600192 */
193 int (*init)(void);
194};
195
196/* Declare a new environment location driver */
197#define U_BOOT_ENV_LOCATION(__name) \
198 ll_entry_declare(struct env_driver, __name, env_driver)
199
Simon Glassac358be2017-08-03 12:22:03 -0600200/* Declare the name of a location */
201#ifdef CONFIG_CMD_SAVEENV
202#define ENV_NAME(_name) .name = _name,
203#else
204#define ENV_NAME(_name)
205#endif
206
Simon Glass4415f1d2017-08-03 12:21:58 -0600207#ifdef CONFIG_CMD_SAVEENV
208#define env_save_ptr(x) x
209#else
210#define env_save_ptr(x) NULL
211#endif
212
Rasmus Villemoes82b2f412020-02-19 09:47:40 +0000213#define ENV_SAVE_PTR(x) (CONFIG_IS_ENABLED(SAVEENV) ? (x) : NULL)
Patrick Delaunay1af031a2021-02-09 11:48:50 +0100214#define ENV_ERASE_PTR(x) (CONFIG_IS_ENABLED(CMD_ERASEENV) ? (x) : NULL)
Rasmus Villemoes82b2f412020-02-19 09:47:40 +0000215
Mike Frysinger2eb15732010-12-08 06:26:04 -0500216extern struct hsearch_data env_htab;
217
Patrick Delaunay2f96b322020-06-19 14:03:35 +0200218/**
Patrick Delaunay879369e2020-06-15 16:52:17 +0200219 * env_ext4_get_intf() - Provide the interface for env in EXT4
220 *
221 * It is a weak function allowing board to overidde the default interface for
222 * U-Boot env in EXT4: CONFIG_ENV_EXT4_INTERFACE
223 *
224 * @return string of interface, empty if not supported
225 */
226const char *env_ext4_get_intf(void);
227
228/**
229 * env_ext4_get_dev_part() - Provide the device and partition for env in EXT4
230 *
231 * It is a weak function allowing board to overidde the default device and
232 * partition used for U-Boot env in EXT4: CONFIG_ENV_EXT4_DEVICE_AND_PART
233 *
234 * @return string of device and partition
235 */
236const char *env_ext4_get_dev_part(void);
237
238/**
Patrick Delaunay2f96b322020-06-19 14:03:35 +0200239 * env_get_location()- Provide the best location for the U-Boot environment
240 *
241 * It is a weak function allowing board to overidde the environment location
242 *
243 * @op: operations performed on the environment
244 * @prio: priority between the multiple environments, 0 being the
245 * highest priority
246 * @return an enum env_location value on success, or -ve error code.
247 */
248enum env_location env_get_location(enum env_operation op, int prio);
Igor Grinberg507651d2011-11-07 01:13:55 +0000249#endif /* DO_DEPS_ONLY */
Mike Frysinger2eb15732010-12-08 06:26:04 -0500250
Simon Glassf3998fd2019-08-02 09:44:25 -0600251#endif /* _ENV_INTERNAL_H_ */