blob: e64b43d2d94834760553dc9a0cd06f632022394b [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001/*
2 * (C) Copyright 2002
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
5 * See file CREDITS for list of people who contributed to this
6 * project.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 * MA 02111-1307 USA
22 */
23
24#ifndef _ENVIRONMENT_H_
Igor Grinberg6f403ba2011-12-25 01:42:57 +000025#define _ENVIRONMENT_H_
wdenkc6097192002-11-03 00:24:07 +000026
27/**************************************************************************
28 *
29 * The "environment" is stored as a list of '\0' terminated
30 * "name=value" strings. The end of the list is marked by a double
31 * '\0'. New entries are always added at the end. Deleting an entry
32 * shifts the remaining entries to the front. Replacing an entry is a
33 * combination of deleting the old value and adding the new one.
34 *
35 * The environment is preceeded by a 32 bit CRC over the data part.
36 *
37 **************************************************************************
38 */
39
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020040#if defined(CONFIG_ENV_IS_IN_FLASH)
Igor Grinberg507651d2011-11-07 01:13:55 +000041# ifndef CONFIG_ENV_ADDR
42# define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
wdenkc6097192002-11-03 00:24:07 +000043# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000044# ifndef CONFIG_ENV_OFFSET
45# define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
wdenkc6097192002-11-03 00:24:07 +000046# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020047# if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
Igor Grinberg507651d2011-11-07 01:13:55 +000048# define CONFIG_ENV_ADDR_REDUND \
49 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
wdenkc6097192002-11-03 00:24:07 +000050# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020051# if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
Igor Grinberg507651d2011-11-07 01:13:55 +000052# ifndef CONFIG_ENV_SECT_SIZE
53# define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
wdenk500545c2003-03-06 14:23:06 +000054# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000055# ifndef CONFIG_ENV_SIZE
56# define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
wdenk500545c2003-03-06 14:23:06 +000057# endif
58# else
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020059# error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
wdenkc6097192002-11-03 00:24:07 +000060# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020061# if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
62# define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE
wdenkc6097192002-11-03 00:24:07 +000063# endif
Igor Grinberg507651d2011-11-07 01:13:55 +000064# if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
65 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \
66 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000067# define ENV_IS_EMBEDDED
wdenkc6097192002-11-03 00:24:07 +000068# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020069# if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
Igor Grinberg6f403ba2011-12-25 01:42:57 +000070# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenkc6097192002-11-03 00:24:07 +000071# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040072# ifdef CONFIG_ENV_IS_EMBEDDED
73# error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
74# error "it is calculated automatically for you"
75# endif
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020076#endif /* CONFIG_ENV_IS_IN_FLASH */
wdenkc6097192002-11-03 00:24:07 +000077
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020078#if defined(CONFIG_ENV_IS_IN_NAND)
Ben Gardinerc9f73512010-07-05 13:27:07 -040079# if defined(CONFIG_ENV_OFFSET_OOB)
80# ifdef CONFIG_ENV_OFFSET_REDUND
81# error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
82# error "is set"
83# endif
84extern unsigned long nand_env_oob_offset;
85# define CONFIG_ENV_OFFSET nand_env_oob_offset
86# else
87# ifndef CONFIG_ENV_OFFSET
88# error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
89# endif
90# ifdef CONFIG_ENV_OFFSET_REDUND
91# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
92# endif
93# endif /* CONFIG_ENV_OFFSET_OOB */
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020094# ifndef CONFIG_ENV_SIZE
95# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
Markus Klotzbuechere443c942006-03-20 18:02:44 +010096# endif
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020097#endif /* CONFIG_ENV_IS_IN_NAND */
Markus Klotzbuechere443c942006-03-20 18:02:44 +010098
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040099/* Embedded env is only supported for some flash types */
100#ifdef CONFIG_ENV_IS_EMBEDDED
Igor Grinberg507651d2011-11-07 01:13:55 +0000101# if !defined(CONFIG_ENV_IS_IN_FLASH) && \
102 !defined(CONFIG_ENV_IS_IN_NAND) && \
103 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
104 !defined(CONFIG_ENV_IS_IN_SPI_FLASH)
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400105# error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
106# endif
107#endif
108
109/*
110 * For the flash types where embedded env is supported, but it cannot be
111 * calculated automatically (i.e. NAND), take the board opt-in.
112 */
113#if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
Igor Grinberg6f403ba2011-12-25 01:42:57 +0000114# define ENV_IS_EMBEDDED
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400115#endif
116
117/* The build system likes to know if the env is embedded */
118#ifdef DO_DEPS_ONLY
119# ifdef ENV_IS_EMBEDDED
Wolfgang Denk33a6b9e2011-07-30 14:01:08 +0000120# ifndef CONFIG_ENV_IS_EMBEDDED
121# define CONFIG_ENV_IS_EMBEDDED
122# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400123# endif
124#endif
125
Mike Frysinger37566092009-07-02 19:23:25 -0400126#include "compiler.h"
wdenkc6097192002-11-03 00:24:07 +0000127
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200128#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Mike Frysinger89cdab72008-03-31 11:02:01 -0400129# define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
Wolfgang Denkb218ccb2010-06-22 15:44:16 +0200130
131# define ACTIVE_FLAG 1
132# define OBSOLETE_FLAG 0
wdenkc6097192002-11-03 00:24:07 +0000133#else
Mike Frysinger89cdab72008-03-31 11:02:01 -0400134# define ENV_HEADER_SIZE (sizeof(uint32_t))
wdenkc6097192002-11-03 00:24:07 +0000135#endif
136
Igor Grinbergd09b1782011-11-07 01:13:59 +0000137#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
138extern char *env_name_spec;
139#endif
wdenkc6097192002-11-03 00:24:07 +0000140
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +0200141#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
wdenkc6097192002-11-03 00:24:07 +0000142
Igor Grinberg507651d2011-11-07 01:13:55 +0000143typedef struct environment_s {
Mike Frysinger89cdab72008-03-31 11:02:01 -0400144 uint32_t crc; /* CRC32 over data bytes */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200145#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenkc6097192002-11-03 00:24:07 +0000146 unsigned char flags; /* active/obsolete flags */
147#endif
148 unsigned char data[ENV_SIZE]; /* Environment data */
149} env_t;
150
Igor Grinberg994bc672011-11-17 06:07:23 +0000151#ifdef ENV_IS_EMBEDDED
152extern env_t environment;
153#endif /* ENV_IS_EMBEDDED */
154
Igor Grinbergd1459f02011-11-07 01:13:57 +0000155extern const unsigned char default_environment[];
Igor Grinberg27aafe92011-11-07 01:14:11 +0000156extern env_t *env_ptr;
157
158extern void env_relocate_spec(void);
159extern unsigned char env_get_char_spec(int);
160
161#if defined(CONFIG_NEEDS_MANUAL_RELOC)
162extern void env_reloc(void);
163#endif
Igor Grinbergd1459f02011-11-07 01:13:57 +0000164
Mike Frysinger2eb15732010-12-08 06:26:04 -0500165#ifndef DO_DEPS_ONLY
166
Joe Hershberger170ab112012-12-11 22:16:24 -0600167#include <env_attr.h>
168#include <env_callback.h>
Joe Hershberger25980902012-12-11 22:16:31 -0600169#include <env_flags.h>
Mike Frysinger2eb15732010-12-08 06:26:04 -0500170#include <search.h>
171
172extern struct hsearch_data env_htab;
173
Joakim Tjernlundb5026112008-07-06 12:30:09 +0200174/* Function that returns a character from the environment */
Igor Grinberg507651d2011-11-07 01:13:55 +0000175unsigned char env_get_char(int);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200176
177/* Function that returns a pointer to a value from the environment */
Mike Frysinger147c7162011-04-23 23:43:21 +0000178const unsigned char *env_get_addr(int);
Igor Grinberg507651d2011-11-07 01:13:55 +0000179unsigned char env_get_char_memory(int index);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200180
181/* Function that updates CRC of the enironment */
Igor Grinberg507651d2011-11-07 01:13:55 +0000182void env_crc_update(void);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200183
Joe Hershberger267541f2012-12-11 22:16:34 -0600184/* Look up the variable from the default environment */
185char *getenv_default(const char *name);
186
Harald Welte5bb12db2008-07-07 15:40:39 +0800187/* [re]set to the default environment */
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200188void set_default_env(const char *s);
189
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000190/* [re]set individual variables to their value in the default environment */
191int set_default_vars(int nvars, char * const vars[]);
192
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200193/* Import from binary representation into hash table */
194int env_import(const char *buf, int check);
Harald Welte5bb12db2008-07-07 15:40:39 +0800195
Igor Grinberg507651d2011-11-07 01:13:55 +0000196#endif /* DO_DEPS_ONLY */
Mike Frysinger2eb15732010-12-08 06:26:04 -0500197
Igor Grinberg507651d2011-11-07 01:13:55 +0000198#endif /* _ENVIRONMENT_H_ */