LXR uboot/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        (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
  49# endif
  50# if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
  51#  ifndef  CONFIG_ENV_SECT_SIZE
  52#   define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
  53#  endif
  54#  ifndef  CONFIG_ENV_SIZE
  55#   define CONFIG_ENV_SIZE      CONFIG_ENV_SECT_SIZE
  56#  endif
  57# else
  58#  error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
  59# endif
  60# if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
  61#  define CONFIG_ENV_SIZE_REDUND        CONFIG_ENV_SIZE
  62# endif
  63# if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
  64     (CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) <= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
  65#  define ENV_IS_EMBEDDED       1
  66# endif
  67# if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
  68#  define CONFIG_SYS_REDUNDAND_ENVIRONMENT      1
  69# endif
  70#endif  /* CONFIG_ENV_IS_IN_FLASH */
  71
  72#if defined(CONFIG_ENV_IS_IN_NAND)
  73# ifndef CONFIG_ENV_OFFSET
  74#  error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
  75# endif
  76# ifndef CONFIG_ENV_SIZE
  77#  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
  78# endif
  79# ifdef CONFIG_ENV_OFFSET_REDUND
  80#  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
  81# endif
  82# ifdef CONFIG_ENV_IS_EMBEDDED
  83#  define ENV_IS_EMBEDDED       1
  84# endif
  85#endif /* CONFIG_ENV_IS_IN_NAND */
  86
  87#ifdef USE_HOSTCC
  88# include <stdint.h>
  89#else
  90# include <linux/types.h>
  91#endif
  92
  93#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
  94# define ENV_HEADER_SIZE        (sizeof(uint32_t) + 1)
  95#else
  96# define ENV_HEADER_SIZE        (sizeof(uint32_t))
  97#endif
  98
  99
 100#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
 101
 102typedef struct environment_s {
 103        uint32_t        crc;            /* CRC32 over data bytes        */
 104#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 105        unsigned char   flags;          /* active/obsolete flags        */
 106#endif
 107        unsigned char   data[ENV_SIZE]; /* Environment data             */
 108} env_t;
 109
 110/* Function that returns a character from the environment */
 111unsigned char env_get_char (int);
 112
 113/* Function that returns a pointer to a value from the environment */
 114unsigned char *env_get_addr(int);
 115unsigned char env_get_char_memory (int index);
 116
 117/* Function that updates CRC of the enironment */
 118void env_crc_update (void);
 119
 120/* [re]set to the default environment */
 121void set_default_env(void);
 122
 123#endif  /* _ENVIRONMENT_H_ */
 124