blob: fbccf6ab0c442745ed194a18d62bcbeb70693ad7 [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_
25#define _ENVIRONMENT_H_ 1
26
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)
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020041# ifndef CONFIG_ENV_ADDR
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020042# define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
wdenkc6097192002-11-03 00:24:07 +000043# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020044# ifndef CONFIG_ENV_OFFSET
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020045# 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)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020048# define CONFIG_ENV_ADDR_REDUND (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
wdenkc6097192002-11-03 00:24:07 +000049# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020050# if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
51# ifndef CONFIG_ENV_SECT_SIZE
52# define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
wdenk500545c2003-03-06 14:23:06 +000053# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020054# ifndef CONFIG_ENV_SIZE
55# define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
wdenk500545c2003-03-06 14:23:06 +000056# endif
57# else
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020058# error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
wdenkc6097192002-11-03 00:24:07 +000059# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020060# if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
61# define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE
wdenkc6097192002-11-03 00:24:07 +000062# endif
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020063# if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
64 (CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) <= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
wdenkc6097192002-11-03 00:24:07 +000065# define ENV_IS_EMBEDDED 1
66# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020067# if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020068# define CONFIG_SYS_REDUNDAND_ENVIRONMENT 1
wdenkc6097192002-11-03 00:24:07 +000069# endif
Mike Frysinger0a9e4e72009-07-24 16:34:32 -040070# ifdef CONFIG_ENV_IS_EMBEDDED
71# error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
72# error "it is calculated automatically for you"
73# endif
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020074#endif /* CONFIG_ENV_IS_IN_FLASH */
wdenkc6097192002-11-03 00:24:07 +000075
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020076#if defined(CONFIG_ENV_IS_IN_NAND)
Ben Gardinerc9f73512010-07-05 13:27:07 -040077# if defined(CONFIG_ENV_OFFSET_OOB)
78# ifdef CONFIG_ENV_OFFSET_REDUND
79# error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
80# error "is set"
81# endif
82extern unsigned long nand_env_oob_offset;
83# define CONFIG_ENV_OFFSET nand_env_oob_offset
84# else
85# ifndef CONFIG_ENV_OFFSET
86# error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
87# endif
88# ifdef CONFIG_ENV_OFFSET_REDUND
89# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
90# endif
91# endif /* CONFIG_ENV_OFFSET_OOB */
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020092# ifndef CONFIG_ENV_SIZE
93# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
Markus Klotzbuechere443c942006-03-20 18:02:44 +010094# endif
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020095#endif /* CONFIG_ENV_IS_IN_NAND */
Markus Klotzbuechere443c942006-03-20 18:02:44 +010096
unsik Kim75eb82e2009-02-25 11:31:24 +090097#if defined(CONFIG_ENV_IS_IN_MG_DISK)
98# ifndef CONFIG_ENV_ADDR
99# error "Need to define CONFIG_ENV_ADDR when using CONFIG_ENV_IS_IN_MG_DISK"
100# endif
101# ifndef CONFIG_ENV_SIZE
102# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_MG_DISK"
103# endif
unsik Kim75eb82e2009-02-25 11:31:24 +0900104#endif /* CONFIG_ENV_IS_IN_MG_DISK */
105
Mike Frysinger0a9e4e72009-07-24 16:34:32 -0400106/* Embedded env is only supported for some flash types */
107#ifdef CONFIG_ENV_IS_EMBEDDED
108# if !defined(CONFIG_ENV_IS_IN_FLASH) && \
109 !defined(CONFIG_ENV_IS_IN_NAND) && \
110 !defined(CONFIG_ENV_IS_IN_ONENAND)
111# error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
112# endif
113#endif
114
115/*
116 * For the flash types where embedded env is supported, but it cannot be
117 * calculated automatically (i.e. NAND), take the board opt-in.
118 */
119#if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
120# define ENV_IS_EMBEDDED 1
121#endif
122
123/* The build system likes to know if the env is embedded */
124#ifdef DO_DEPS_ONLY
125# ifdef ENV_IS_EMBEDDED
126# define CONFIG_ENV_IS_EMBEDDED
127# endif
128#endif
129
Mike Frysinger37566092009-07-02 19:23:25 -0400130#include "compiler.h"
wdenkc6097192002-11-03 00:24:07 +0000131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200132#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Mike Frysinger89cdab72008-03-31 11:02:01 -0400133# define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
Wolfgang Denkb218ccb2010-06-22 15:44:16 +0200134
135# define ACTIVE_FLAG 1
136# define OBSOLETE_FLAG 0
wdenkc6097192002-11-03 00:24:07 +0000137#else
Mike Frysinger89cdab72008-03-31 11:02:01 -0400138# define ENV_HEADER_SIZE (sizeof(uint32_t))
wdenkc6097192002-11-03 00:24:07 +0000139#endif
140
141
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +0200142#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
wdenkc6097192002-11-03 00:24:07 +0000143
144typedef struct environment_s {
Mike Frysinger89cdab72008-03-31 11:02:01 -0400145 uint32_t crc; /* CRC32 over data bytes */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200146#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenkc6097192002-11-03 00:24:07 +0000147 unsigned char flags; /* active/obsolete flags */
148#endif
149 unsigned char data[ENV_SIZE]; /* Environment data */
150} env_t;
151
Joakim Tjernlundb5026112008-07-06 12:30:09 +0200152/* Function that returns a character from the environment */
153unsigned char env_get_char (int);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200154
155/* Function that returns a pointer to a value from the environment */
156unsigned char *env_get_addr(int);
157unsigned char env_get_char_memory (int index);
158
159/* Function that updates CRC of the enironment */
160void env_crc_update (void);
161
Harald Welte5bb12db2008-07-07 15:40:39 +0800162/* [re]set to the default environment */
163void set_default_env(void);
164
wdenkc6097192002-11-03 00:24:07 +0000165#endif /* _ENVIRONMENT_H_ */