include/environment.h

   1 /*
   2  * (C) Copyright 2002
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #ifndef _ENVIRONMENT_H_
   9 #define _ENVIRONMENT_H_
  10
  11 #include <linux/kconfig.h>
  12
  13 /**************************************************************************
  14  *
  15  * The "environment" is stored as a list of '\0' terminated
  16  * "name=value" strings. The end of the list is marked by a double
  17  * '\0'. New entries are always added at the end. Deleting an entry
  18  * shifts the remaining entries to the front. Replacing an entry is a
  19  * combination of deleting the old value and adding the new one.
  20  *
  21  * The environment is preceded by a 32 bit CRC over the data part.
  22  *
  23  *************************************************************************/
  24
  25 #if defined(CONFIG_ENV_IS_IN_FLASH)
  26 # ifndef        CONFIG_ENV_ADDR
  27 #  define       CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
  28 # endif
  29 # ifndef        CONFIG_ENV_OFFSET
  30 #  define       CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
  31 # endif
  32 # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
  33 #  define       CONFIG_ENV_ADDR_REDUND  \
  34                 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
  35 # endif
  36 # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
  37 #  ifndef       CONFIG_ENV_SECT_SIZE
  38 #   define      CONFIG_ENV_SECT_SIZE    CONFIG_ENV_SIZE
  39 #  endif
  40 #  ifndef       CONFIG_ENV_SIZE
  41 #   define      CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
  42 #  endif
  43 # else
  44 #  error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
  45 # endif
  46 # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
  47 #  define CONFIG_ENV_SIZE_REDUND        CONFIG_ENV_SIZE
  48 # endif
  49 # if    (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) &&         \
  50         (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <=                  \
  51         (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
  52 #  define ENV_IS_EMBEDDED
  53 # endif
  54 # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
  55 #  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
  56 # endif
  57 # ifdef CONFIG_ENV_IS_EMBEDDED
  58 #  error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
  59 #  error "it is calculated automatically for you"
  60 # endif
  61 #endif  /* CONFIG_ENV_IS_IN_FLASH */
  62
  63 #if defined(CONFIG_ENV_IS_IN_MMC)
  64 # ifdef CONFIG_ENV_OFFSET_REDUND
  65 #  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
  66 # endif
  67 #endif
  68
  69 #if defined(CONFIG_ENV_IS_IN_NAND)
  70 # if defined(CONFIG_ENV_OFFSET_OOB)
  71 #  ifdef CONFIG_ENV_OFFSET_REDUND
  72 #   error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
  73 #   error "is set"
  74 #  endif
  75 extern unsigned long nand_env_oob_offset;
  76 #  define CONFIG_ENV_OFFSET nand_env_oob_offset
  77 # else
  78 #  ifndef CONFIG_ENV_OFFSET
  79 #   error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
  80 #  endif
  81 #  ifdef CONFIG_ENV_OFFSET_REDUND
  82 #   define CONFIG_SYS_REDUNDAND_ENVIRONMENT
  83 #  endif
  84 # endif /* CONFIG_ENV_OFFSET_OOB */
  85 # ifndef CONFIG_ENV_SIZE
  86 #  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
  87 # endif
  88 #endif /* CONFIG_ENV_IS_IN_NAND */
  89
  90 #if defined(CONFIG_ENV_IS_IN_UBI)
  91 # ifndef CONFIG_ENV_UBI_PART
  92 #  error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI"
  93 # endif
  94 # ifndef CONFIG_ENV_UBI_VOLUME
  95 #  error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
  96 # endif
  97 # if defined(CONFIG_ENV_UBI_VOLUME_REDUND)
  98 #  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
  99 # endif
 100 # ifndef CONFIG_ENV_SIZE
 101 #  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
 102 # endif
 103 # ifndef CONFIG_CMD_UBI
 104 #  error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
 105 # endif
 106 #endif /* CONFIG_ENV_IS_IN_UBI */
 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
 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 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
 147 extern char *env_name_spec;
 148 #endif
 149
 150 #ifdef CONFIG_ENV_AES
 151 /* Make sure the payload is multiple of AES block size */
 152 #define ENV_SIZE ((CONFIG_ENV_SIZE - ENV_HEADER_SIZE) & ~(16 - 1))
 153 #else
 154 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
 155 #endif
 156
 157 typedef struct environment_s {
 158         uint32_t        crc;            /* CRC32 over data bytes        */
 159 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 160         unsigned char   flags;          /* active/obsolete flags        */
 161 #endif
 162         unsigned char   data[ENV_SIZE]; /* Environment data             */
 163 } env_t
 164 #ifdef CONFIG_ENV_AES
 165 /* Make sure the env is aligned to block size. */
 166 __attribute__((aligned(16)))
 167 #endif
 168 ;
 169
 170 #ifdef ENV_IS_EMBEDDED
 171 extern env_t environment;
 172 #endif /* ENV_IS_EMBEDDED */
 173
 174 extern const unsigned char default_environment[];
 175 extern env_t *env_ptr;
 176
 177 extern void env_relocate_spec(void);
 178 extern unsigned char env_get_char_spec(int);
 179
 180 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 181 extern void env_reloc(void);
 182 #endif
 183
 184 #ifdef CONFIG_ENV_IS_IN_MMC
 185 #include <mmc.h>
 186
 187 extern int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
 188 # ifdef CONFIG_SYS_MMC_ENV_PART
 189 extern uint mmc_get_env_part(struct mmc *mmc);
 190 # endif
 191 #endif
 192
 193 #ifndef DO_DEPS_ONLY
 194
 195 #include <env_attr.h>
 196 #include <env_callback.h>
 197 #include <env_flags.h>
 198 #include <search.h>
 199
 200 extern struct hsearch_data env_htab;
 201
 202 /* Function that returns a character from the environment */
 203 unsigned char env_get_char(int);
 204
 205 /* Function that returns a pointer to a value from the environment */
 206 const unsigned char *env_get_addr(int);
 207 unsigned char env_get_char_memory(int index);
 208
 209 /* Function that updates CRC of the enironment */
 210 void env_crc_update(void);
 211
 212 /* Look up the variable from the default environment */
 213 char *getenv_default(const char *name);
 214
 215 /* [re]set to the default environment */
 216 void set_default_env(const char *s);
 217
 218 /* [re]set individual variables to their value in the default environment */
 219 int set_default_vars(int nvars, char * const vars[]);
 220
 221 /* Import from binary representation into hash table */
 222 int env_import(const char *buf, int check);
 223
 224 /* Export from hash table into binary representation */
 225 int env_export(env_t *env_out);
 226
 227 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 228 /* Select and import one of two redundant environments */
 229 int env_import_redund(const char *buf1, const char *buf2);
 230 #endif
 231
 232 #endif /* DO_DEPS_ONLY */
 233
 234 #endif /* _ENVIRONMENT_H_ */