blob: d29f82cb5d6faf148f126df5aa2207928a1628ef [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001/*
2 * (C) Copyright 2002
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006 */
7
8#ifndef _ENVIRONMENT_H_
Igor Grinberg6f403ba2011-12-25 01:42:57 +00009#define _ENVIRONMENT_H_
wdenkc6097192002-11-03 00:24:07 +000010
Maxime Ripardfb1c43c2017-02-27 18:22:03 +010011#include <linux/kconfig.h>
12
wdenkc6097192002-11-03 00:24:07 +000013/**************************************************************************
14 *
15 * The "environment" is stored as a list of '\0' terminated
16 * "name=value" strings. The end of the list is marked by a double
17 * '\0'. New entries are always added at the end. Deleting an entry
18 * shifts the remaining entries to the front. Replacing an entry is a
19 * combination of deleting the old value and adding the new one.
20 *
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -040021 * The environment is preceded by a 32 bit CRC over the data part.
wdenkc6097192002-11-03 00:24:07 +000022 *
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -040023 *************************************************************************/
wdenkc6097192002-11-03 00:24:07 +000024
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020025#if defined(CONFIG_ENV_IS_IN_FLASH)
Igor Grinberg507651d2011-11-07 01:13:55 +000026# ifndef CONFIG_ENV_ADDR
27# define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
wdenkc6097192002-11-03 00:24:07 +000028# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000029# ifndef CONFIG_ENV_OFFSET
30# define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
wdenkc6097192002-11-03 00:24:07 +000031# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020032# if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
Igor Grinberg507651d2011-11-07 01:13:55 +000033# define CONFIG_ENV_ADDR_REDUND \
34 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
wdenkc6097192002-11-03 00:24:07 +000035# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020036# if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
Igor Grinberg507651d2011-11-07 01:13:55 +000037# ifndef CONFIG_ENV_SECT_SIZE
38# define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
wdenk500545c2003-03-06 14:23:06 +000039# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000040# ifndef CONFIG_ENV_SIZE
41# define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
wdenk500545c2003-03-06 14:23:06 +000042# endif
43# else
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020044# error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
wdenkc6097192002-11-03 00:24:07 +000045# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020046# if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
47# define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE
wdenkc6097192002-11-03 00:24:07 +000048# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000049# if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
50 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \
51 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000052# define ENV_IS_EMBEDDED
wdenkc6097192002-11-03 00:24:07 +000053# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020054# if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000055# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenkc6097192002-11-03 00:24:07 +000056# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040057# ifdef CONFIG_ENV_IS_EMBEDDED
58# error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
59# error "it is calculated automatically for you"
60# endif
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020061#endif /* CONFIG_ENV_IS_IN_FLASH */
wdenkc6097192002-11-03 00:24:07 +000062
Bo Shen5707df72013-05-15 09:38:16 +080063#if defined(CONFIG_ENV_IS_IN_MMC)
64# ifdef CONFIG_ENV_OFFSET_REDUND
65# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
66# endif
67#endif
68
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020069#if defined(CONFIG_ENV_IS_IN_NAND)
Ben Gardinerc9f73512010-07-05 13:27:07 -040070# if defined(CONFIG_ENV_OFFSET_OOB)
71# ifdef CONFIG_ENV_OFFSET_REDUND
72# error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
73# error "is set"
74# endif
75extern unsigned long nand_env_oob_offset;
76# define CONFIG_ENV_OFFSET nand_env_oob_offset
77# else
78# ifndef CONFIG_ENV_OFFSET
79# error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
80# endif
81# ifdef CONFIG_ENV_OFFSET_REDUND
82# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
83# endif
84# endif /* CONFIG_ENV_OFFSET_OOB */
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020085# ifndef CONFIG_ENV_SIZE
86# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
Markus Klotzbuechere443c942006-03-20 18:02:44 +010087# endif
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020088#endif /* CONFIG_ENV_IS_IN_NAND */
Markus Klotzbuechere443c942006-03-20 18:02:44 +010089
Joe Hershberger2b744332013-04-08 10:32:51 +000090#if defined(CONFIG_ENV_IS_IN_UBI)
91# ifndef CONFIG_ENV_UBI_PART
92# error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI"
93# endif
94# ifndef CONFIG_ENV_UBI_VOLUME
95# error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
96# endif
Joe Hershberger785881f2013-04-08 10:32:52 +000097# if defined(CONFIG_ENV_UBI_VOLUME_REDUND)
98# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
99# endif
Joe Hershberger2b744332013-04-08 10:32:51 +0000100# ifndef CONFIG_ENV_SIZE
101# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
102# endif
103# ifndef CONFIG_CMD_UBI
104# error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
105# endif
106#endif /* CONFIG_ENV_IS_IN_UBI */
107
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400108/* Embedded env is only supported for some flash types */
109#ifdef CONFIG_ENV_IS_EMBEDDED
Igor Grinberg507651d2011-11-07 01:13:55 +0000110# if !defined(CONFIG_ENV_IS_IN_FLASH) && \
111 !defined(CONFIG_ENV_IS_IN_NAND) && \
112 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
113 !defined(CONFIG_ENV_IS_IN_SPI_FLASH)
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400114# error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
115# endif
116#endif
117
118/*
119 * For the flash types where embedded env is supported, but it cannot be
120 * calculated automatically (i.e. NAND), take the board opt-in.
121 */
122#if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
Igor Grinberg6f403ba2011-12-25 01:42:57 +0000123# define ENV_IS_EMBEDDED
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400124#endif
125
126/* The build system likes to know if the env is embedded */
127#ifdef DO_DEPS_ONLY
128# ifdef ENV_IS_EMBEDDED
Wolfgang Denk33a6b9e2011-07-30 14:01:08 +0000129# ifndef CONFIG_ENV_IS_EMBEDDED
130# define CONFIG_ENV_IS_EMBEDDED
131# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400132# endif
133#endif
134
Mike Frysinger37566092009-07-02 19:23:25 -0400135#include "compiler.h"
wdenkc6097192002-11-03 00:24:07 +0000136
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200137#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Mike Frysinger89cdab72008-03-31 11:02:01 -0400138# define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
Wolfgang Denkb218ccb2010-06-22 15:44:16 +0200139
140# define ACTIVE_FLAG 1
141# define OBSOLETE_FLAG 0
wdenkc6097192002-11-03 00:24:07 +0000142#else
Mike Frysinger89cdab72008-03-31 11:02:01 -0400143# define ENV_HEADER_SIZE (sizeof(uint32_t))
wdenkc6097192002-11-03 00:24:07 +0000144#endif
145
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +0200146#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
wdenkc6097192002-11-03 00:24:07 +0000147
Igor Grinberg507651d2011-11-07 01:13:55 +0000148typedef struct environment_s {
Mike Frysinger89cdab72008-03-31 11:02:01 -0400149 uint32_t crc; /* CRC32 over data bytes */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200150#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenkc6097192002-11-03 00:24:07 +0000151 unsigned char flags; /* active/obsolete flags */
152#endif
153 unsigned char data[ENV_SIZE]; /* Environment data */
Tom Rinic6831c72017-11-14 08:39:35 -0500154} env_t;
wdenkc6097192002-11-03 00:24:07 +0000155
Igor Grinberg994bc672011-11-17 06:07:23 +0000156#ifdef ENV_IS_EMBEDDED
157extern env_t environment;
158#endif /* ENV_IS_EMBEDDED */
159
Igor Grinbergd1459f02011-11-07 01:13:57 +0000160extern const unsigned char default_environment[];
Igor Grinberg27aafe92011-11-07 01:14:11 +0000161extern env_t *env_ptr;
162
Igor Grinberg27aafe92011-11-07 01:14:11 +0000163#if defined(CONFIG_NEEDS_MANUAL_RELOC)
164extern void env_reloc(void);
165#endif
Igor Grinbergd1459f02011-11-07 01:13:57 +0000166
Dmitry Lifshitzac77f422014-07-30 13:19:05 +0300167#ifdef CONFIG_ENV_IS_IN_MMC
168#include <mmc.h>
169
170extern int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
Dmitry Lifshitz6e7b7df2014-07-30 13:19:06 +0300171# ifdef CONFIG_SYS_MMC_ENV_PART
172extern uint mmc_get_env_part(struct mmc *mmc);
173# endif
Dmitry Lifshitzac77f422014-07-30 13:19:05 +0300174#endif
175
Mike Frysinger2eb15732010-12-08 06:26:04 -0500176#ifndef DO_DEPS_ONLY
177
Joe Hershberger170ab112012-12-11 22:16:24 -0600178#include <env_attr.h>
179#include <env_callback.h>
Joe Hershberger25980902012-12-11 22:16:31 -0600180#include <env_flags.h>
Mike Frysinger2eb15732010-12-08 06:26:04 -0500181#include <search.h>
182
Simon Glass203e94f2017-08-03 12:21:56 -0600183/* Value for environment validity */
184enum env_valid {
185 ENV_INVALID, /* No valid environment */
186 ENV_VALID, /* First or only environment is valid */
187 ENV_REDUND, /* Redundant environment is valid */
188};
189
Simon Glass4415f1d2017-08-03 12:21:58 -0600190enum env_location {
Simon Glass4415f1d2017-08-03 12:21:58 -0600191 ENVL_EEPROM,
192 ENVL_EXT4,
193 ENVL_FAT,
194 ENVL_FLASH,
195 ENVL_MMC,
196 ENVL_NAND,
197 ENVL_NVRAM,
198 ENVL_ONENAND,
199 ENVL_REMOTE,
200 ENVL_SPI_FLASH,
201 ENVL_UBI,
202 ENVL_NOWHERE,
203
204 ENVL_COUNT,
205 ENVL_UNKNOWN,
206};
207
208struct env_driver {
Simon Glassac358be2017-08-03 12:22:03 -0600209 const char *name;
Simon Glass4415f1d2017-08-03 12:21:58 -0600210 enum env_location location;
211
212 /**
213 * get_char() - Read a character from the environment
214 *
215 * This method is optional. If not provided, a default implementation
216 * will read from gd->env_addr.
217 *
218 * @index: Index of character to read (0=first)
Simon Glass21f63942017-08-03 12:22:16 -0600219 * @return character read, or -ve on error
Simon Glass4415f1d2017-08-03 12:21:58 -0600220 */
Simon Glass21f63942017-08-03 12:22:16 -0600221 int (*get_char)(int index);
Simon Glass4415f1d2017-08-03 12:21:58 -0600222
223 /**
224 * load() - Load the environment from storage
225 *
226 * This method is optional. If not provided, no environment will be
227 * loaded.
Simon Glassc5951992017-08-03 12:22:17 -0600228 *
229 * @return 0 if OK, -ve on error
Simon Glass4415f1d2017-08-03 12:21:58 -0600230 */
Simon Glassc5951992017-08-03 12:22:17 -0600231 int (*load)(void);
Simon Glass4415f1d2017-08-03 12:21:58 -0600232
233 /**
234 * save() - Save the environment to storage
235 *
236 * This method is required for 'saveenv' to work.
237 *
238 * @return 0 if OK, -ve on error
239 */
240 int (*save)(void);
241
242 /**
243 * init() - Set up the initial pre-relocation environment
244 *
245 * This method is optional.
246 *
Simon Glass79388222017-08-03 12:22:02 -0600247 * @return 0 if OK, -ENOENT if no initial environment could be found,
248 * other -ve on error
Simon Glass4415f1d2017-08-03 12:21:58 -0600249 */
250 int (*init)(void);
251};
252
253/* Declare a new environment location driver */
254#define U_BOOT_ENV_LOCATION(__name) \
255 ll_entry_declare(struct env_driver, __name, env_driver)
256
Simon Glassac358be2017-08-03 12:22:03 -0600257/* Declare the name of a location */
258#ifdef CONFIG_CMD_SAVEENV
259#define ENV_NAME(_name) .name = _name,
260#else
261#define ENV_NAME(_name)
262#endif
263
Simon Glass4415f1d2017-08-03 12:21:58 -0600264#ifdef CONFIG_CMD_SAVEENV
265#define env_save_ptr(x) x
266#else
267#define env_save_ptr(x) NULL
268#endif
269
Mike Frysinger2eb15732010-12-08 06:26:04 -0500270extern struct hsearch_data env_htab;
271
Wolfgang Denka8409f42008-05-14 12:22:49 +0200272/* Function that updates CRC of the enironment */
Igor Grinberg507651d2011-11-07 01:13:55 +0000273void env_crc_update(void);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200274
Joe Hershberger267541f2012-12-11 22:16:34 -0600275/* Look up the variable from the default environment */
Simon Glass723806c2017-08-03 12:22:15 -0600276char *env_get_default(const char *name);
Joe Hershberger267541f2012-12-11 22:16:34 -0600277
Harald Welte5bb12db2008-07-07 15:40:39 +0800278/* [re]set to the default environment */
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200279void set_default_env(const char *s);
280
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000281/* [re]set individual variables to their value in the default environment */
282int set_default_vars(int nvars, char * const vars[]);
283
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200284/* Import from binary representation into hash table */
285int env_import(const char *buf, int check);
Harald Welte5bb12db2008-07-07 15:40:39 +0800286
Marek Vasut7ce15262014-03-05 19:59:50 +0100287/* Export from hash table into binary representation */
288int env_export(env_t *env_out);
289
Fiach Antaw76768f52017-01-25 18:53:11 +1000290#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
291/* Select and import one of two redundant environments */
292int env_import_redund(const char *buf1, const char *buf2);
293#endif
294
Simon Glassac358be2017-08-03 12:22:03 -0600295/**
296 * env_driver_lookup_default() - Look up the default environment driver
297 *
298 * @return pointer to driver, or NULL if none (which should not happen)
299 */
300struct env_driver *env_driver_lookup_default(void);
301
Simon Glassa69d0f62017-08-03 12:22:06 -0600302/**
303 * env_get_char() - Get a character from the early environment
304 *
305 * This reads from the pre-relocation environemnt
306 *
307 * @index: Index of character to read (0 = first)
308 * @return character read, or -ve on error
309 */
310int env_get_char(int index);
311
Simon Glass310fb142017-08-03 12:22:07 -0600312/**
313 * env_load() - Load the environment from storage
314 *
315 * @return 0 if OK, -ve on error
316 */
317int env_load(void);
318
Simon Glass01510092017-08-03 12:22:08 -0600319/**
320 * env_save() - Save the environment to storage
321 *
322 * @return 0 if OK, -ve on error
323 */
324int env_save(void);
325
Igor Grinberg507651d2011-11-07 01:13:55 +0000326#endif /* DO_DEPS_ONLY */
Mike Frysinger2eb15732010-12-08 06:26:04 -0500327
Igor Grinberg507651d2011-11-07 01:13:55 +0000328#endif /* _ENVIRONMENT_H_ */