blob: 1fdbdad882227cfad5d7cfa8cea1a75065e8ee70 [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
11/**************************************************************************
12 *
13 * The "environment" is stored as a list of '\0' terminated
14 * "name=value" strings. The end of the list is marked by a double
15 * '\0'. New entries are always added at the end. Deleting an entry
16 * shifts the remaining entries to the front. Replacing an entry is a
17 * combination of deleting the old value and adding the new one.
18 *
19 * The environment is preceeded by a 32 bit CRC over the data part.
20 *
21 **************************************************************************
22 */
23
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020024#if defined(CONFIG_ENV_IS_IN_FLASH)
Igor Grinberg507651d2011-11-07 01:13:55 +000025# ifndef CONFIG_ENV_ADDR
26# define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
wdenkc6097192002-11-03 00:24:07 +000027# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000028# ifndef CONFIG_ENV_OFFSET
29# define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
wdenkc6097192002-11-03 00:24:07 +000030# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020031# if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
Igor Grinberg507651d2011-11-07 01:13:55 +000032# define CONFIG_ENV_ADDR_REDUND \
33 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
wdenkc6097192002-11-03 00:24:07 +000034# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020035# if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
Igor Grinberg507651d2011-11-07 01:13:55 +000036# ifndef CONFIG_ENV_SECT_SIZE
37# define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
wdenk500545c2003-03-06 14:23:06 +000038# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000039# ifndef CONFIG_ENV_SIZE
40# define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
wdenk500545c2003-03-06 14:23:06 +000041# endif
42# else
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020043# error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
wdenkc6097192002-11-03 00:24:07 +000044# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020045# if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
46# define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE
wdenkc6097192002-11-03 00:24:07 +000047# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000048# if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
49 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \
50 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000051# define ENV_IS_EMBEDDED
wdenkc6097192002-11-03 00:24:07 +000052# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020053# if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000054# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenkc6097192002-11-03 00:24:07 +000055# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040056# ifdef CONFIG_ENV_IS_EMBEDDED
57# error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
58# error "it is calculated automatically for you"
59# endif
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020060#endif /* CONFIG_ENV_IS_IN_FLASH */
wdenkc6097192002-11-03 00:24:07 +000061
Bo Shen5707df72013-05-15 09:38:16 +080062#if defined(CONFIG_ENV_IS_IN_MMC)
63# ifdef CONFIG_ENV_OFFSET_REDUND
64# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
65# endif
66#endif
67
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020068#if defined(CONFIG_ENV_IS_IN_NAND)
Ben Gardinerc9f73512010-07-05 13:27:07 -040069# if defined(CONFIG_ENV_OFFSET_OOB)
70# ifdef CONFIG_ENV_OFFSET_REDUND
71# error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
72# error "is set"
73# endif
74extern unsigned long nand_env_oob_offset;
75# define CONFIG_ENV_OFFSET nand_env_oob_offset
76# else
77# ifndef CONFIG_ENV_OFFSET
78# error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
79# endif
80# ifdef CONFIG_ENV_OFFSET_REDUND
81# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
82# endif
83# endif /* CONFIG_ENV_OFFSET_OOB */
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020084# ifndef CONFIG_ENV_SIZE
85# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
Markus Klotzbuechere443c942006-03-20 18:02:44 +010086# endif
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020087#endif /* CONFIG_ENV_IS_IN_NAND */
Markus Klotzbuechere443c942006-03-20 18:02:44 +010088
Joe Hershberger2b744332013-04-08 10:32:51 +000089#if defined(CONFIG_ENV_IS_IN_UBI)
90# ifndef CONFIG_ENV_UBI_PART
91# error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI"
92# endif
93# ifndef CONFIG_ENV_UBI_VOLUME
94# error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
95# endif
Joe Hershberger785881f2013-04-08 10:32:52 +000096# if defined(CONFIG_ENV_UBI_VOLUME_REDUND)
97# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
98# endif
Joe Hershberger2b744332013-04-08 10:32:51 +000099# ifndef CONFIG_ENV_SIZE
100# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
101# endif
102# ifndef CONFIG_CMD_UBI
103# error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
104# endif
105#endif /* CONFIG_ENV_IS_IN_UBI */
106
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400107/* Embedded env is only supported for some flash types */
108#ifdef CONFIG_ENV_IS_EMBEDDED
Igor Grinberg507651d2011-11-07 01:13:55 +0000109# if !defined(CONFIG_ENV_IS_IN_FLASH) && \
110 !defined(CONFIG_ENV_IS_IN_NAND) && \
111 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
112 !defined(CONFIG_ENV_IS_IN_SPI_FLASH)
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400113# error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
114# endif
115#endif
116
117/*
118 * For the flash types where embedded env is supported, but it cannot be
119 * calculated automatically (i.e. NAND), take the board opt-in.
120 */
121#if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
Igor Grinberg6f403ba2011-12-25 01:42:57 +0000122# define ENV_IS_EMBEDDED
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400123#endif
124
125/* The build system likes to know if the env is embedded */
126#ifdef DO_DEPS_ONLY
127# ifdef ENV_IS_EMBEDDED
Wolfgang Denk33a6b9e2011-07-30 14:01:08 +0000128# ifndef CONFIG_ENV_IS_EMBEDDED
129# define CONFIG_ENV_IS_EMBEDDED
130# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400131# endif
132#endif
133
Mike Frysinger37566092009-07-02 19:23:25 -0400134#include "compiler.h"
wdenkc6097192002-11-03 00:24:07 +0000135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200136#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Mike Frysinger89cdab72008-03-31 11:02:01 -0400137# define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
Wolfgang Denkb218ccb2010-06-22 15:44:16 +0200138
139# define ACTIVE_FLAG 1
140# define OBSOLETE_FLAG 0
wdenkc6097192002-11-03 00:24:07 +0000141#else
Mike Frysinger89cdab72008-03-31 11:02:01 -0400142# define ENV_HEADER_SIZE (sizeof(uint32_t))
wdenkc6097192002-11-03 00:24:07 +0000143#endif
144
Igor Grinbergd09b1782011-11-07 01:13:59 +0000145#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
146extern char *env_name_spec;
147#endif
wdenkc6097192002-11-03 00:24:07 +0000148
Marek Vasuta4223b72014-03-05 19:59:51 +0100149#ifdef CONFIG_ENV_AES
150/* Make sure the payload is multiple of AES block size */
151#define ENV_SIZE ((CONFIG_ENV_SIZE - ENV_HEADER_SIZE) & ~(16 - 1))
152#else
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +0200153#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
Marek Vasuta4223b72014-03-05 19:59:51 +0100154#endif
wdenkc6097192002-11-03 00:24:07 +0000155
Igor Grinberg507651d2011-11-07 01:13:55 +0000156typedef struct environment_s {
Mike Frysinger89cdab72008-03-31 11:02:01 -0400157 uint32_t crc; /* CRC32 over data bytes */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200158#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenkc6097192002-11-03 00:24:07 +0000159 unsigned char flags; /* active/obsolete flags */
160#endif
161 unsigned char data[ENV_SIZE]; /* Environment data */
Marek Vasuta4223b72014-03-05 19:59:51 +0100162} env_t
163#ifdef CONFIG_ENV_AES
164/* Make sure the env is aligned to block size. */
165__attribute__((aligned(16)))
166#endif
167;
wdenkc6097192002-11-03 00:24:07 +0000168
Igor Grinberg994bc672011-11-17 06:07:23 +0000169#ifdef ENV_IS_EMBEDDED
170extern env_t environment;
171#endif /* ENV_IS_EMBEDDED */
172
Igor Grinbergd1459f02011-11-07 01:13:57 +0000173extern const unsigned char default_environment[];
Igor Grinberg27aafe92011-11-07 01:14:11 +0000174extern env_t *env_ptr;
175
176extern void env_relocate_spec(void);
177extern unsigned char env_get_char_spec(int);
178
179#if defined(CONFIG_NEEDS_MANUAL_RELOC)
180extern void env_reloc(void);
181#endif
Igor Grinbergd1459f02011-11-07 01:13:57 +0000182
Dmitry Lifshitzac77f422014-07-30 13:19:05 +0300183#ifdef CONFIG_ENV_IS_IN_MMC
184#include <mmc.h>
185
186extern int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
Dmitry Lifshitz6e7b7df2014-07-30 13:19:06 +0300187# ifdef CONFIG_SYS_MMC_ENV_PART
188extern uint mmc_get_env_part(struct mmc *mmc);
189# endif
Dmitry Lifshitzac77f422014-07-30 13:19:05 +0300190#endif
191
Mike Frysinger2eb15732010-12-08 06:26:04 -0500192#ifndef DO_DEPS_ONLY
193
Joe Hershberger170ab112012-12-11 22:16:24 -0600194#include <env_attr.h>
195#include <env_callback.h>
Joe Hershberger25980902012-12-11 22:16:31 -0600196#include <env_flags.h>
Mike Frysinger2eb15732010-12-08 06:26:04 -0500197#include <search.h>
198
199extern struct hsearch_data env_htab;
200
Joakim Tjernlundb5026112008-07-06 12:30:09 +0200201/* Function that returns a character from the environment */
Igor Grinberg507651d2011-11-07 01:13:55 +0000202unsigned char env_get_char(int);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200203
204/* Function that returns a pointer to a value from the environment */
Mike Frysinger147c7162011-04-23 23:43:21 +0000205const unsigned char *env_get_addr(int);
Igor Grinberg507651d2011-11-07 01:13:55 +0000206unsigned char env_get_char_memory(int index);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200207
208/* Function that updates CRC of the enironment */
Igor Grinberg507651d2011-11-07 01:13:55 +0000209void env_crc_update(void);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200210
Joe Hershberger267541f2012-12-11 22:16:34 -0600211/* Look up the variable from the default environment */
212char *getenv_default(const char *name);
213
Harald Welte5bb12db2008-07-07 15:40:39 +0800214/* [re]set to the default environment */
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200215void set_default_env(const char *s);
216
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000217/* [re]set individual variables to their value in the default environment */
218int set_default_vars(int nvars, char * const vars[]);
219
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200220/* Import from binary representation into hash table */
221int env_import(const char *buf, int check);
Harald Welte5bb12db2008-07-07 15:40:39 +0800222
Marek Vasut7ce15262014-03-05 19:59:50 +0100223/* Export from hash table into binary representation */
224int env_export(env_t *env_out);
225
Igor Grinberg507651d2011-11-07 01:13:55 +0000226#endif /* DO_DEPS_ONLY */
Mike Frysinger2eb15732010-12-08 06:26:04 -0500227
Igor Grinberg507651d2011-11-07 01:13:55 +0000228#endif /* _ENVIRONMENT_H_ */