xref: /rk3399_rockchip-uboot/include/environment.h (revision 500545cc6b83958209128bffa825b3c842a21a4e)
1c609719bSwdenk /*
2c609719bSwdenk  * (C) Copyright 2002
3c609719bSwdenk  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk  *
5c609719bSwdenk  * See file CREDITS for list of people who contributed to this
6c609719bSwdenk  * project.
7c609719bSwdenk  *
8c609719bSwdenk  * This program is free software; you can redistribute it and/or
9c609719bSwdenk  * modify it under the terms of the GNU General Public License as
10c609719bSwdenk  * published by the Free Software Foundation; either version 2 of
11c609719bSwdenk  * the License, or (at your option) any later version.
12c609719bSwdenk  *
13c609719bSwdenk  * This program is distributed in the hope that it will be useful,
14c609719bSwdenk  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16c609719bSwdenk  * GNU General Public License for more details.
17c609719bSwdenk  *
18c609719bSwdenk  * You should have received a copy of the GNU General Public License
19c609719bSwdenk  * along with this program; if not, write to the Free Software
20c609719bSwdenk  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk  * MA 02111-1307 USA
22c609719bSwdenk  */
23c609719bSwdenk 
24c609719bSwdenk #ifndef _ENVIRONMENT_H_
25c609719bSwdenk #define _ENVIRONMENT_H_	1
26c609719bSwdenk 
27c609719bSwdenk /**************************************************************************
28c609719bSwdenk  *
29c609719bSwdenk  * The "environment" is stored as a list of '\0' terminated
30c609719bSwdenk  * "name=value" strings. The end of the list is marked by a double
31c609719bSwdenk  * '\0'. New entries are always added at the end. Deleting an entry
32c609719bSwdenk  * shifts the remaining entries to the front. Replacing an entry is a
33c609719bSwdenk  * combination of deleting the old value and adding the new one.
34c609719bSwdenk  *
35c609719bSwdenk  * The environment is preceeded by a 32 bit CRC over the data part.
36c609719bSwdenk  *
37c609719bSwdenk  **************************************************************************
38c609719bSwdenk  */
39c609719bSwdenk 
40c609719bSwdenk #if defined(CFG_ENV_IS_IN_FLASH)
41c609719bSwdenk # ifndef  CFG_ENV_ADDR
42c609719bSwdenk #  define CFG_ENV_ADDR	(CFG_FLASH_BASE + CFG_ENV_OFFSET)
43c609719bSwdenk # endif
44c609719bSwdenk # ifndef  CFG_ENV_OFFSET
45c609719bSwdenk #  define CFG_ENV_OFFSET (CFG_ENV_ADDR - CFG_FLASH_BASE)
46c609719bSwdenk # endif
47c609719bSwdenk # if !defined(CFG_ENV_ADDR_REDUND) && defined(CFG_ENV_OFFSET_REDUND)
48c609719bSwdenk #  define CFG_ENV_ADDR_REDUND	(CFG_FLASH_BASE + CFG_ENV_OFFSET_REDUND)
49c609719bSwdenk # endif
50*500545ccSwdenk # if defined(CFG_ENV_SECT_SIZE) || defined(CFG_ENV_SIZE)
51*500545ccSwdenk #  ifndef  CFG_ENV_SECT_SIZE
52*500545ccSwdenk #   define CFG_ENV_SECT_SIZE	CFG_ENV_SIZE
53*500545ccSwdenk #  endif
54c609719bSwdenk #  ifndef  CFG_ENV_SIZE
55c609719bSwdenk #   define CFG_ENV_SIZE	CFG_ENV_SECT_SIZE
56c609719bSwdenk #  endif
57*500545ccSwdenk # else
58*500545ccSwdenk #  error "Both CFG_ENV_SECT_SIZE and CFG_ENV_SIZE undefined"
59*500545ccSwdenk # endif
60c609719bSwdenk # if defined(CFG_ENV_ADDR_REDUND) && !defined(CFG_ENV_SIZE_REDUND)
61c609719bSwdenk #  define CFG_ENV_SIZE_REDUND	CFG_ENV_SIZE
62c609719bSwdenk # endif
63c609719bSwdenk # if (CFG_ENV_ADDR >= CFG_MONITOR_BASE) && \
64c609719bSwdenk      (CFG_ENV_ADDR+CFG_ENV_SIZE) <= (CFG_MONITOR_BASE + CFG_MONITOR_LEN)
65c609719bSwdenk #  define ENV_IS_EMBEDDED	1
66c609719bSwdenk # endif
67c609719bSwdenk # if defined(CFG_ENV_ADDR_REDUND) || defined(CFG_ENV_OFFSET_REDUND)
68c609719bSwdenk #  define CFG_REDUNDAND_ENVIRONMENT	1
69c609719bSwdenk # endif
70c609719bSwdenk #endif	/* CFG_ENV_IS_IN_FLASH */
71c609719bSwdenk 
72c609719bSwdenk 
73c609719bSwdenk #ifdef CFG_REDUNDAND_ENVIRONMENT
74c609719bSwdenk # define ENV_HEADER_SIZE	(sizeof(unsigned long) + 1)
75c609719bSwdenk #else
76c609719bSwdenk # define ENV_HEADER_SIZE	(sizeof(unsigned long))
77c609719bSwdenk #endif
78c609719bSwdenk 
79c609719bSwdenk 
80c609719bSwdenk #define ENV_SIZE (CFG_ENV_SIZE - ENV_HEADER_SIZE)
81c609719bSwdenk 
82c609719bSwdenk typedef	struct environment_s {
83c609719bSwdenk 	unsigned long	crc;		/* CRC32 over data bytes	*/
84c609719bSwdenk #ifdef CFG_REDUNDAND_ENVIRONMENT
85c609719bSwdenk 	unsigned char	flags;		/* active/obsolete flags	*/
86c609719bSwdenk #endif
87c609719bSwdenk 	unsigned char	data[ENV_SIZE]; /* Environment data		*/
88c609719bSwdenk } env_t;
89c609719bSwdenk 
90c609719bSwdenk #endif	/* _ENVIRONMENT_H_ */
91