include/env_internal.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Internal environment header file. This includes direct access to environment
   4  * information such as its size and offset, direct access to the default
   5  * environment and embedded environment (if used). It also provides environment
   6  * drivers with various declarations.
   7  *
   8  * It should not be included by board files, drivers and code other than that
   9  * related to the environment implementation.
  10  *
  11  * (C) Copyright 2002
  12  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  13  */
  14
  15 #ifndef _ENV_INTERNAL_H_
  16 #define _ENV_INTERNAL_H_
  17
  18 #include <linux/kconfig.h>
  19
  20 /**************************************************************************
  21  *
  22  * The "environment" is stored as a list of '\0' terminated
  23  * "name=value" strings. The end of the list is marked by a double
  24  * '\0'. New entries are always added at the end. Deleting an entry
  25  * shifts the remaining entries to the front. Replacing an entry is a
  26  * combination of deleting the old value and adding the new one.
  27  *
  28  * The environment is preceded by a 32 bit CRC over the data part.
  29  *
  30  *************************************************************************/
  31
  32 #if defined(CONFIG_ENV_IS_IN_FLASH)
  33 # ifndef        CONFIG_ENV_ADDR
  34 #  define       CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
  35 # endif
  36 # ifndef        CONFIG_ENV_OFFSET
  37 #  define       CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
  38 # endif
  39 # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
  40 #  define       CONFIG_ENV_ADDR_REDUND  \
  41                 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
  42 # endif
  43 # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
  44 #  ifndef       CONFIG_ENV_SECT_SIZE
  45 #   define      CONFIG_ENV_SECT_SIZE    CONFIG_ENV_SIZE
  46 #  endif
  47 #  ifndef       CONFIG_ENV_SIZE
  48 #   define      CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
  49 #  endif
  50 # else
  51 #  error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
  52 # endif
  53 # if    defined(CONFIG_ENV_ADDR_REDUND) && \
  54         ((CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) &&                \
  55         (CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SIZE) <=           \
  56         (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN))
  57 #  define ENV_IS_EMBEDDED
  58 # endif
  59 # if    (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) &&         \
  60         (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <=                  \
  61         (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
  62 #  define ENV_IS_EMBEDDED
  63 # endif
  64 # ifdef CONFIG_ENV_IS_EMBEDDED
  65 #  error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
  66 #  error "it is calculated automatically for you"
  67 # endif
  68 #endif  /* CONFIG_ENV_IS_IN_FLASH */
  69
  70 #if defined(CONFIG_ENV_IS_IN_NAND)
  71 # if defined(CONFIG_ENV_OFFSET_OOB)
  72 #  ifdef CONFIG_ENV_OFFSET_REDUND
  73 #   error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
  74 #   error "is set"
  75 #  endif
  76 extern unsigned long nand_env_oob_offset;
  77 #  define CONFIG_ENV_OFFSET nand_env_oob_offset
  78 # else
  79 #  ifndef CONFIG_ENV_OFFSET
  80 #   error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
  81 #  endif
  82 # endif /* CONFIG_ENV_OFFSET_OOB */
  83 # ifndef CONFIG_ENV_SIZE
  84 #  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
  85 # endif
  86 #endif /* CONFIG_ENV_IS_IN_NAND */
  87
  88 #if defined(CONFIG_ENV_IS_IN_UBI)
  89 # ifndef CONFIG_ENV_UBI_PART
  90 #  error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI"
  91 # endif
  92 # ifndef CONFIG_ENV_UBI_VOLUME
  93 #  error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
  94 # endif
  95 # ifndef CONFIG_ENV_SIZE
  96 #  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
  97 # endif
  98 # ifndef CONFIG_CMD_UBI
  99 #  error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
 100 # endif
 101 #endif /* CONFIG_ENV_IS_IN_UBI */
 102
 103 /* Embedded env is only supported for some flash types */
 104 #ifdef CONFIG_ENV_IS_EMBEDDED
 105 # if    !defined(CONFIG_ENV_IS_IN_FLASH)        && \
 106         !defined(CONFIG_ENV_IS_IN_NAND)         && \
 107         !defined(CONFIG_ENV_IS_IN_ONENAND)      && \
 108         !defined(CONFIG_ENV_IS_IN_SPI_FLASH)
 109 #  error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
 110 # endif
 111 #endif
 112
 113 /*
 114  * For the flash types where embedded env is supported, but it cannot be
 115  * calculated automatically (i.e. NAND), take the board opt-in.
 116  */
 117 #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
 118 # define ENV_IS_EMBEDDED
 119 #endif
 120
 121 /* The build system likes to know if the env is embedded */
 122 #ifdef DO_DEPS_ONLY
 123 # ifdef ENV_IS_EMBEDDED
 124 #  ifndef CONFIG_ENV_IS_EMBEDDED
 125 #   define CONFIG_ENV_IS_EMBEDDED
 126 #  endif
 127 # endif
 128 #endif
 129
 130 #include "compiler.h"
 131
 132 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 133 # define ENV_HEADER_SIZE        (sizeof(uint32_t) + 1)
 134 #else
 135 # define ENV_HEADER_SIZE        (sizeof(uint32_t))
 136 #endif
 137
 138 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
 139
 140 /*
 141  * If the environment is in RAM, allocate extra space for it in the malloc
 142  * region.
 143  */
 144 #if defined(CONFIG_ENV_IS_EMBEDDED)
 145 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
 146 #elif (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE < CONFIG_SYS_MONITOR_BASE) || \
 147       (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) || \
 148       defined(CONFIG_ENV_IS_IN_NVRAM)
 149 #define TOTAL_MALLOC_LEN        (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
 150 #else
 151 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
 152 #endif
 153
 154 typedef struct environment_s {
 155         uint32_t        crc;            /* CRC32 over data bytes        */
 156 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 157         unsigned char   flags;          /* active/obsolete flags ENVF_REDUND_ */
 158 #endif
 159         unsigned char   data[ENV_SIZE]; /* Environment data             */
 160 } env_t;
 161
 162 #ifdef ENV_IS_EMBEDDED
 163 extern env_t embedded_environment;
 164 #endif /* ENV_IS_EMBEDDED */
 165
 166 extern const unsigned char default_environment[];
 167
 168 #ifndef DO_DEPS_ONLY
 169
 170 #include <env_attr.h>
 171 #include <env_callback.h>
 172 #include <env_flags.h>
 173 #include <search.h>
 174
 175 enum env_location {
 176         ENVL_UNKNOWN,
 177         ENVL_EEPROM,
 178         ENVL_EXT4,
 179         ENVL_FAT,
 180         ENVL_FLASH,
 181         ENVL_MMC,
 182         ENVL_NAND,
 183         ENVL_NVRAM,
 184         ENVL_ONENAND,
 185         ENVL_REMOTE,
 186         ENVL_SPI_FLASH,
 187         ENVL_UBI,
 188         ENVL_NOWHERE,
 189
 190         ENVL_COUNT,
 191 };
 192
 193 /* value for the various operations we want to perform on the env */
 194 enum env_operation {
 195         ENVOP_GET_CHAR, /* we want to call the get_char function */
 196         ENVOP_INIT,     /* we want to call the init function */
 197         ENVOP_LOAD,     /* we want to call the load function */
 198         ENVOP_SAVE,     /* we want to call the save function */
 199         ENVOP_ERASE,    /* we want to call the erase function */
 200 };
 201
 202 struct env_driver {
 203         const char *name;
 204         enum env_location location;
 205
 206         /**
 207          * load() - Load the environment from storage
 208          *
 209          * This method is optional. If not provided, no environment will be
 210          * loaded.
 211          *
 212          * @return 0 if OK, -ve on error
 213          */
 214         int (*load)(void);
 215
 216         /**
 217          * save() - Save the environment to storage
 218          *
 219          * This method is required for 'saveenv' to work.
 220          *
 221          * @return 0 if OK, -ve on error
 222          */
 223         int (*save)(void);
 224
 225         /**
 226          * erase() - Erase the environment on storage
 227          *
 228          * This method is optional and required for 'eraseenv' to work.
 229          *
 230          * @return 0 if OK, -ve on error
 231          */
 232         int (*erase)(void);
 233
 234         /**
 235          * init() - Set up the initial pre-relocation environment
 236          *
 237          * This method is optional.
 238          *
 239          * @return 0 if OK, -ENOENT if no initial environment could be found,
 240          * other -ve on error
 241          */
 242         int (*init)(void);
 243 };
 244
 245 /* Declare a new environment location driver */
 246 #define U_BOOT_ENV_LOCATION(__name)                                     \
 247         ll_entry_declare(struct env_driver, __name, env_driver)
 248
 249 /* Declare the name of a location */
 250 #ifdef CONFIG_CMD_SAVEENV
 251 #define ENV_NAME(_name) .name = _name,
 252 #else
 253 #define ENV_NAME(_name)
 254 #endif
 255
 256 #ifdef CONFIG_CMD_SAVEENV
 257 #define env_save_ptr(x) x
 258 #else
 259 #define env_save_ptr(x) NULL
 260 #endif
 261
 262 extern struct hsearch_data env_htab;
 263
 264 #endif /* DO_DEPS_ONLY */
 265
 266 #endif /* _ENV_INTERNAL_H_ */