blob: 507e8326a3a64d6a2363366156351682f8d8ec28 [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
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +020070#endif /* CONFIG_ENV_IS_IN_FLASH */
wdenkc6097192002-11-03 00:24:07 +000071
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020072#if defined(CONFIG_ENV_IS_IN_NAND)
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020073# ifndef CONFIG_ENV_OFFSET
74# error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
Markus Klotzbuechere443c942006-03-20 18:02:44 +010075# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020076# ifndef CONFIG_ENV_SIZE
77# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
Markus Klotzbuechere443c942006-03-20 18:02:44 +010078# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020079# ifdef CONFIG_ENV_OFFSET_REDUND
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020080# define CONFIG_SYS_REDUNDAND_ENVIRONMENT
Markus Klotzbuechere443c942006-03-20 18:02:44 +010081# endif
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020082# ifdef CONFIG_ENV_IS_EMBEDDED
Stefan Roesed12ae802006-09-12 20:19:10 +020083# define ENV_IS_EMBEDDED 1
84# endif
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +020085#endif /* CONFIG_ENV_IS_IN_NAND */
Markus Klotzbuechere443c942006-03-20 18:02:44 +010086
unsik Kim75eb82e2009-02-25 11:31:24 +090087#if defined(CONFIG_ENV_IS_IN_MG_DISK)
88# ifndef CONFIG_ENV_ADDR
89# error "Need to define CONFIG_ENV_ADDR when using CONFIG_ENV_IS_IN_MG_DISK"
90# endif
91# ifndef CONFIG_ENV_SIZE
92# error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_MG_DISK"
93# endif
94# ifdef CONFIG_ENV_IS_EMBEDDED
95# error "CONFIG_ENV_IS_EMBEDDED not supported when using CONFIG_ENV_IS_IN_MG_DISK"
96# endif
97#endif /* CONFIG_ENV_IS_IN_MG_DISK */
98
Mike Frysinger89cdab72008-03-31 11:02:01 -040099#ifdef USE_HOSTCC
100# include <stdint.h>
101#else
102# include <linux/types.h>
103#endif
wdenkc6097192002-11-03 00:24:07 +0000104
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200105#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
Mike Frysinger89cdab72008-03-31 11:02:01 -0400106# define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
wdenkc6097192002-11-03 00:24:07 +0000107#else
Mike Frysinger89cdab72008-03-31 11:02:01 -0400108# define ENV_HEADER_SIZE (sizeof(uint32_t))
wdenkc6097192002-11-03 00:24:07 +0000109#endif
110
111
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +0200112#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
wdenkc6097192002-11-03 00:24:07 +0000113
114typedef struct environment_s {
Mike Frysinger89cdab72008-03-31 11:02:01 -0400115 uint32_t crc; /* CRC32 over data bytes */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200116#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenkc6097192002-11-03 00:24:07 +0000117 unsigned char flags; /* active/obsolete flags */
118#endif
119 unsigned char data[ENV_SIZE]; /* Environment data */
120} env_t;
121
Joakim Tjernlundb5026112008-07-06 12:30:09 +0200122/* Function that returns a character from the environment */
123unsigned char env_get_char (int);
Wolfgang Denka8409f42008-05-14 12:22:49 +0200124
125/* Function that returns a pointer to a value from the environment */
126unsigned char *env_get_addr(int);
127unsigned char env_get_char_memory (int index);
128
129/* Function that updates CRC of the enironment */
130void env_crc_update (void);
131
Harald Welte5bb12db2008-07-07 15:40:39 +0800132/* [re]set to the default environment */
133void set_default_env(void);
134
wdenkc6097192002-11-03 00:24:07 +0000135#endif /* _ENVIRONMENT_H_ */