environment.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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. #ifndef _ENVIRONMENT_H_
  24. #define _ENVIRONMENT_H_ 1
  25. /**************************************************************************
  26. *
  27. * The "environment" is stored as a list of '\0' terminated
  28. * "name=value" strings. The end of the list is marked by a double
  29. * '\0'. New entries are always added at the end. Deleting an entry
  30. * shifts the remaining entries to the front. Replacing an entry is a
  31. * combination of deleting the old value and adding the new one.
  32. *
  33. * The environment is preceeded by a 32 bit CRC over the data part.
  34. *
  35. **************************************************************************
  36. */
  37. #if defined(CONFIG_ENV_IS_IN_FLASH)
  38. # ifndef CONFIG_ENV_ADDR
  39. # define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
  40. # endif
  41. # ifndef CONFIG_ENV_OFFSET
  42. # define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
  43. # endif
  44. # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
  45. # define CONFIG_ENV_ADDR_REDUND (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
  46. # endif
  47. # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
  48. # ifndef CONFIG_ENV_SECT_SIZE
  49. # define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
  50. # endif
  51. # ifndef CONFIG_ENV_SIZE
  52. # define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
  53. # endif
  54. # else
  55. # error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
  56. # endif
  57. # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
  58. # define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE
  59. # endif
  60. # if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
  61. (CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) <= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
  62. # define ENV_IS_EMBEDDED 1
  63. # endif
  64. # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
  65. # define CONFIG_SYS_REDUNDAND_ENVIRONMENT 1
  66. # endif
  67. # ifdef CONFIG_ENV_IS_EMBEDDED
  68. # error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
  69. # error "it is calculated automatically for you"
  70. # endif
  71. #endif /* CONFIG_ENV_IS_IN_FLASH */
  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. #endif /* CONFIG_ENV_IS_IN_NAND */
  83. #if defined(CONFIG_ENV_IS_IN_MG_DISK)
  84. # ifndef CONFIG_ENV_ADDR
  85. # error "Need to define CONFIG_ENV_ADDR when using CONFIG_ENV_IS_IN_MG_DISK"
  86. # endif
  87. # ifndef CONFIG_ENV_SIZE
  88. # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_MG_DISK"
  89. # endif
  90. #endif /* CONFIG_ENV_IS_IN_MG_DISK */
  91. /* Embedded env is only supported for some flash types */
  92. #ifdef CONFIG_ENV_IS_EMBEDDED
  93. # if !defined(CONFIG_ENV_IS_IN_FLASH) && \
  94. !defined(CONFIG_ENV_IS_IN_NAND) && \
  95. !defined(CONFIG_ENV_IS_IN_ONENAND)
  96. # error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
  97. # endif
  98. #endif
  99. /*
  100. * For the flash types where embedded env is supported, but it cannot be
  101. * calculated automatically (i.e. NAND), take the board opt-in.
  102. */
  103. #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
  104. # define ENV_IS_EMBEDDED 1
  105. #endif
  106. /* The build system likes to know if the env is embedded */
  107. #ifdef DO_DEPS_ONLY
  108. # ifdef ENV_IS_EMBEDDED
  109. # define CONFIG_ENV_IS_EMBEDDED
  110. # endif
  111. #endif
  112. #include "compiler.h"
  113. #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
  114. # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
  115. #else
  116. # define ENV_HEADER_SIZE (sizeof(uint32_t))
  117. #endif
  118. #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
  119. typedef struct environment_s {
  120. uint32_t crc; /* CRC32 over data bytes */
  121. #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
  122. unsigned char flags; /* active/obsolete flags */
  123. #endif
  124. unsigned char data[ENV_SIZE]; /* Environment data */
  125. } env_t;
  126. /* Function that returns a character from the environment */
  127. unsigned char env_get_char (int);
  128. /* Function that returns a pointer to a value from the environment */
  129. unsigned char *env_get_addr(int);
  130. unsigned char env_get_char_memory (int index);
  131. /* Function that updates CRC of the enironment */
  132. void env_crc_update (void);
  133. /* [re]set to the default environment */
  134. void set_default_env(void);
  135. #endif /* _ENVIRONMENT_H_ */