LXR uboot/include/env

   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# if    defined(CONFIG_ENV_ADDR_REDUND) && \
  34        ((CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) &&                \
  35        (CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SIZE) <=           \
  36        (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN))
  37#  define ENV_IS_EMBEDDED
  38# endif
  39# if    (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) &&         \
  40        (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <=                  \
  41        (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
  42#  define ENV_IS_EMBEDDED
  43# endif
  44# ifdef CONFIG_ENV_IS_EMBEDDED
  45#  error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
  46#  error "it is calculated automatically for you"
  47# endif
  48#endif  /* CONFIG_ENV_IS_IN_FLASH */
  49
  50#if defined(CONFIG_ENV_IS_IN_NAND)
  51# if defined(CONFIG_ENV_OFFSET_OOB)
  52#  ifdef CONFIG_ENV_OFFSET_REDUND
  53#   error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
  54#   error "is set"
  55#  endif
  56extern unsigned long nand_env_oob_offset;
  57# endif /* CONFIG_ENV_OFFSET_OOB */
  58#endif /* CONFIG_ENV_IS_IN_NAND */
  59
  60/*
  61 * For the flash types where embedded env is supported, but it cannot be
  62 * calculated automatically (i.e. NAND), take the board opt-in.
  63 */
  64#if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
  65# define ENV_IS_EMBEDDED
  66#endif
  67
  68/* The build system likes to know if the env is embedded */
  69#ifdef DO_DEPS_ONLY
  70# ifdef ENV_IS_EMBEDDED
  71#  ifndef CONFIG_ENV_IS_EMBEDDED
  72#   define CONFIG_ENV_IS_EMBEDDED
  73#  endif
  74# endif
  75#endif
  76
  77#include "compiler.h"
  78
  79#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
  80# define ENV_HEADER_SIZE        (sizeof(uint32_t) + 1)
  81#else
  82# define ENV_HEADER_SIZE        (sizeof(uint32_t))
  83#endif
  84
  85#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
  86
  87/*
  88 * If the environment is in RAM, allocate extra space for it in the malloc
  89 * region.
  90 */
  91#if defined(CONFIG_ENV_IS_EMBEDDED)
  92#define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
  93#elif (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE < CONFIG_SYS_MONITOR_BASE) || \
  94      (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) || \
  95      defined(CONFIG_ENV_IS_IN_NVRAM)
  96#define TOTAL_MALLOC_LEN        (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
  97#else
  98#define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
  99#endif
 100
 101typedef struct environment_s {
 102        uint32_t        crc;            /* CRC32 over data bytes        */
 103#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 104        unsigned char   flags;          /* active/obsolete flags ENVF_REDUND_ */
 105#endif
 106        unsigned char   data[ENV_SIZE]; /* Environment data             */
 107} env_t;
 108
 109#ifdef ENV_IS_EMBEDDED
 110extern env_t embedded_environment;
 111#endif /* ENV_IS_EMBEDDED */
 112
 113#ifdef DEFAULT_ENV_IS_RW
 114extern char default_environment[];
 115#else
 116extern const char default_environment[];
 117#endif
 118
 119#ifndef DO_DEPS_ONLY
 120
 121#include <env_attr.h>
 122#include <env_callback.h>
 123#include <env_flags.h>
 124#include <search.h>
 125
 126enum env_location {
 127        ENVL_UNKNOWN,
 128        ENVL_EEPROM,
 129        ENVL_EXT4,
 130        ENVL_FAT,
 131        ENVL_FLASH,
 132        ENVL_MMC,
 133        ENVL_NAND,
 134        ENVL_NVRAM,
 135        ENVL_ONENAND,
 136        ENVL_REMOTE,
 137        ENVL_SPI_FLASH,
 138        ENVL_UBI,
 139        ENVL_NOWHERE,
 140
 141        ENVL_COUNT,
 142};
 143
 144/* value for the various operations we want to perform on the env */
 145enum env_operation {
 146        ENVOP_GET_CHAR, /* we want to call the get_char function */
 147        ENVOP_INIT,     /* we want to call the init function */
 148        ENVOP_LOAD,     /* we want to call the load function */
 149        ENVOP_SAVE,     /* we want to call the save function */
 150        ENVOP_ERASE,    /* we want to call the erase function */
 151};
 152
 153struct env_driver {
 154        const char *name;
 155        enum env_location location;
 156
 157        /**
 158         * load() - Load the environment from storage
 159         *
 160         * This method is required for loading environment
 161         *
 162         * @return 0 if OK, -ve on error
 163         */
 164        int (*load)(void);
 165
 166        /**
 167         * save() - Save the environment to storage
 168         *
 169         * This method is required for 'saveenv' to work.
 170         *
 171         * @return 0 if OK, -ve on error
 172         */
 173        int (*save)(void);
 174
 175        /**
 176         * erase() - Erase the environment on storage
 177         *
 178         * This method is optional and required for 'eraseenv' to work.
 179         *
 180         * @return 0 if OK, -ve on error
 181         */
 182        int (*erase)(void);
 183
 184        /**
 185         * init() - Set up the initial pre-relocation environment
 186         *
 187         * This method is optional.
 188         *
 189         * @return 0 if OK, -ENOENT if no initial environment could be found,
 190         * other -ve on error
 191         */
 192        int (*init)(void);
 193};
 194
 195/* Declare a new environment location driver */
 196#define U_BOOT_ENV_LOCATION(__name)                                     \
 197        ll_entry_declare(struct env_driver, __name, env_driver)
 198
 199/* Declare the name of a location */
 200#ifdef CONFIG_CMD_SAVEENV
 201#define ENV_NAME(_name) .name = _name,
 202#else
 203#define ENV_NAME(_name)
 204#endif
 205
 206#ifdef CONFIG_CMD_SAVEENV
 207#define env_save_ptr(x) x
 208#else
 209#define env_save_ptr(x) NULL
 210#endif
 211
 212#define ENV_SAVE_PTR(x) (CONFIG_IS_ENABLED(SAVEENV) ? (x) : NULL)
 213#define ENV_ERASE_PTR(x) (CONFIG_IS_ENABLED(CMD_ERASEENV) ? (x) : NULL)
 214
 215extern struct hsearch_data env_htab;
 216
 217/**
 218 * env_ext4_get_intf() - Provide the interface for env in EXT4
 219 *
 220 * It is a weak function allowing board to overidde the default interface for
 221 * U-Boot env in EXT4: CONFIG_ENV_EXT4_INTERFACE
 222 *
 223 * @return string of interface, empty if not supported
 224 */
 225const char *env_ext4_get_intf(void);
 226
 227/**
 228 * env_ext4_get_dev_part() - Provide the device and partition for env in EXT4
 229 *
 230 * It is a weak function allowing board to overidde the default device and
 231 * partition used for U-Boot env in EXT4: CONFIG_ENV_EXT4_DEVICE_AND_PART
 232 *
 233 * @return string of device and partition
 234 */
 235const char *env_ext4_get_dev_part(void);
 236
 237/**
 238 * env_get_location()- Provide the best location for the U-Boot environment
 239 *
 240 * It is a weak function allowing board to overidde the environment location
 241 *
 242 * @op: operations performed on the environment
 243 * @prio: priority between the multiple environments, 0 being the
 244 *        highest priority
 245 * @return  an enum env_location value on success, or -ve error code.
 246 */
 247enum env_location env_get_location(enum env_operation op, int prio);
 248#endif /* DO_DEPS_ONLY */
 249
 250#endif /* _ENV_INTERNAL_H_ */
 251