include/environment.h

   1 /*
   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
  40 #if defined(CONFIG_ENV_IS_IN_FLASH)
  41 # ifndef        CONFIG_ENV_ADDR
  42 #  define       CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
  43 # endif
  44 # ifndef        CONFIG_ENV_OFFSET
  45 #  define       CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
  46 # endif
  47 # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
  48 #  define       CONFIG_ENV_ADDR_REDUND  \
  49                 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
  50 # endif
  51 # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
  52 #  ifndef       CONFIG_ENV_SECT_SIZE
  53 #   define      CONFIG_ENV_SECT_SIZE    CONFIG_ENV_SIZE
  54 #  endif
  55 #  ifndef       CONFIG_ENV_SIZE
  56 #   define      CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
  57 #  endif
  58 # else
  59 #  error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
  60 # endif
  61 # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
  62 #  define CONFIG_ENV_SIZE_REDUND        CONFIG_ENV_SIZE
  63 # endif
  64 # if    (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) &&         \
  65         (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <=                  \
  66         (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
  67 #  define ENV_IS_EMBEDDED       1
  68 # endif
  69 # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
  70 #  define CONFIG_SYS_REDUNDAND_ENVIRONMENT      1
  71 # endif
  72 # 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
  76 #endif  /* CONFIG_ENV_IS_IN_FLASH */
  77
  78 #if defined(CONFIG_ENV_IS_IN_NAND)
  79 # 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
  84 extern 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 */
  94 # ifndef CONFIG_ENV_SIZE
  95 #  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
  96 # endif
  97 #endif /* CONFIG_ENV_IS_IN_NAND */
  98
  99 #if defined(CONFIG_ENV_IS_IN_MG_DISK)
 100 # ifndef CONFIG_ENV_ADDR
 101 #  error "Need to define CONFIG_ENV_ADDR when using CONFIG_ENV_IS_IN_MG_DISK"
 102 # endif
 103 # ifndef CONFIG_ENV_SIZE
 104 #  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_MG_DISK"
 105 # endif
 106 #endif /* CONFIG_ENV_IS_IN_MG_DISK */
 107
 108 /* Embedded env is only supported for some flash types */
 109 #ifdef CONFIG_ENV_IS_EMBEDDED
 110 # if    !defined(CONFIG_ENV_IS_IN_FLASH)        && \
 111         !defined(CONFIG_ENV_IS_IN_NAND)         && \
 112         !defined(CONFIG_ENV_IS_IN_ONENAND)      && \
 113         !defined(CONFIG_ENV_IS_IN_SPI_FLASH)
 114 #  error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
 115 # endif
 116 #endif
 117
 118 /*
 119  * For the flash types where embedded env is supported, but it cannot be
 120  * calculated automatically (i.e. NAND), take the board opt-in.
 121  */
 122 #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
 123 # define ENV_IS_EMBEDDED 1
 124 #endif
 125
 126 /* The build system likes to know if the env is embedded */
 127 #ifdef DO_DEPS_ONLY
 128 # ifdef ENV_IS_EMBEDDED
 129 #  ifndef CONFIG_ENV_IS_EMBEDDED
 130 #   define CONFIG_ENV_IS_EMBEDDED
 131 #  endif
 132 # endif
 133 #endif
 134
 135 #include "compiler.h"
 136
 137 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 138 # define ENV_HEADER_SIZE        (sizeof(uint32_t) + 1)
 139
 140 # define ACTIVE_FLAG   1
 141 # define OBSOLETE_FLAG 0
 142 #else
 143 # define ENV_HEADER_SIZE        (sizeof(uint32_t))
 144 #endif
 145
 146
 147 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
 148
 149 typedef struct environment_s {
 150         uint32_t        crc;            /* CRC32 over data bytes        */
 151 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 152         unsigned char   flags;          /* active/obsolete flags        */
 153 #endif
 154         unsigned char   data[ENV_SIZE]; /* Environment data             */
 155 } env_t;
 156
 157 #ifdef ENV_IS_EMBEDDED
 158 extern env_t environment;
 159 #endif /* ENV_IS_EMBEDDED */
 160
 161 extern const unsigned char default_environment[];
 162
 163 #ifndef DO_DEPS_ONLY
 164
 165 #include <search.h>
 166
 167 extern struct hsearch_data env_htab;
 168
 169 /* Function that returns a character from the environment */
 170 unsigned char env_get_char(int);
 171
 172 /* Function that returns a pointer to a value from the environment */
 173 const unsigned char *env_get_addr(int);
 174 unsigned char env_get_char_memory(int index);
 175
 176 /* Function that updates CRC of the enironment */
 177 void env_crc_update(void);
 178
 179 /* [re]set to the default environment */
 180 void set_default_env(const char *s);
 181
 182 /* Import from binary representation into hash table */
 183 int env_import(const char *buf, int check);
 184
 185 #endif /* DO_DEPS_ONLY */
 186
 187 #endif /* _ENVIRONMENT_H_ */