common.c 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * (C) Copyright 2000-2010
  4. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  5. *
  6. * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
  7. * Andreas Heppel <aheppel@sysgo.de>
  8. */
  9. #include <common.h>
  10. #include <command.h>
  11. #include <environment.h>
  12. #include <linux/stddef.h>
  13. #include <search.h>
  14. #include <errno.h>
  15. #include <malloc.h>
  16. DECLARE_GLOBAL_DATA_PTR;
  17. /************************************************************************
  18. * Default settings to be used when no valid environment is found
  19. */
  20. #include <env_default.h>
  21. struct hsearch_data env_htab = {
  22. .change_ok = env_flags_validate,
  23. };
  24. /*
  25. * Read an environment variable as a boolean
  26. * Return -1 if variable does not exist (default to true)
  27. */
  28. int env_get_yesno(const char *var)
  29. {
  30. char *s = env_get(var);
  31. if (s == NULL)
  32. return -1;
  33. return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
  34. 1 : 0;
  35. }
  36. /*
  37. * Look up the variable from the default environment
  38. */
  39. char *env_get_default(const char *name)
  40. {
  41. char *ret_val;
  42. unsigned long really_valid = gd->env_valid;
  43. unsigned long real_gd_flags = gd->flags;
  44. /* Pretend that the image is bad. */
  45. gd->flags &= ~GD_FLG_ENV_READY;
  46. gd->env_valid = ENV_INVALID;
  47. ret_val = env_get(name);
  48. gd->env_valid = really_valid;
  49. gd->flags = real_gd_flags;
  50. return ret_val;
  51. }
  52. void set_default_env(const char *s, int flags)
  53. {
  54. if (sizeof(default_environment) > ENV_SIZE) {
  55. puts("*** Error - default environment is too large\n\n");
  56. return;
  57. }
  58. if (s) {
  59. if ((flags & H_INTERACTIVE) == 0) {
  60. printf("*** Warning - %s, "
  61. "using default environment\n\n", s);
  62. } else {
  63. puts(s);
  64. }
  65. } else {
  66. debug("Using default environment\n");
  67. }
  68. if (himport_r(&env_htab, (char *)default_environment,
  69. sizeof(default_environment), '\0', flags, 0,
  70. 0, NULL) == 0)
  71. pr_err("## Error: Environment import failed: errno = %d\n",
  72. errno);
  73. gd->flags |= GD_FLG_ENV_READY;
  74. gd->flags |= GD_FLG_ENV_DEFAULT;
  75. }
  76. /* [re]set individual variables to their value in the default environment */
  77. int set_default_vars(int nvars, char * const vars[], int flags)
  78. {
  79. /*
  80. * Special use-case: import from default environment
  81. * (and use \0 as a separator)
  82. */
  83. flags |= H_NOCLEAR;
  84. return himport_r(&env_htab, (const char *)default_environment,
  85. sizeof(default_environment), '\0',
  86. flags, 0, nvars, vars);
  87. }
  88. /*
  89. * Check if CRC is valid and (if yes) import the environment.
  90. * Note that "buf" may or may not be aligned.
  91. */
  92. int env_import(const char *buf, int check)
  93. {
  94. env_t *ep = (env_t *)buf;
  95. if (check) {
  96. uint32_t crc;
  97. memcpy(&crc, &ep->crc, sizeof(crc));
  98. if (crc32(0, ep->data, ENV_SIZE) != crc) {
  99. set_default_env("bad CRC", 0);
  100. return -EIO;
  101. }
  102. }
  103. if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0, 0,
  104. 0, NULL)) {
  105. gd->flags |= GD_FLG_ENV_READY;
  106. return 0;
  107. }
  108. pr_err("Cannot import environment: errno = %d\n", errno);
  109. set_default_env("import failed", 0);
  110. return -EIO;
  111. }
  112. #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
  113. static unsigned char env_flags;
  114. int env_import_redund(const char *buf1, int buf1_read_fail,
  115. const char *buf2, int buf2_read_fail)
  116. {
  117. int crc1_ok, crc2_ok;
  118. env_t *ep, *tmp_env1, *tmp_env2;
  119. tmp_env1 = (env_t *)buf1;
  120. tmp_env2 = (env_t *)buf2;
  121. if (buf1_read_fail && buf2_read_fail) {
  122. puts("*** Error - No Valid Environment Area found\n");
  123. } else if (buf1_read_fail || buf2_read_fail) {
  124. puts("*** Warning - some problems detected ");
  125. puts("reading environment; recovered successfully\n");
  126. }
  127. if (buf1_read_fail && buf2_read_fail) {
  128. set_default_env("bad env area", 0);
  129. return -EIO;
  130. } else if (!buf1_read_fail && buf2_read_fail) {
  131. gd->env_valid = ENV_VALID;
  132. return env_import((char *)tmp_env1, 1);
  133. } else if (buf1_read_fail && !buf2_read_fail) {
  134. gd->env_valid = ENV_REDUND;
  135. return env_import((char *)tmp_env2, 1);
  136. }
  137. crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
  138. tmp_env1->crc;
  139. crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
  140. tmp_env2->crc;
  141. if (!crc1_ok && !crc2_ok) {
  142. set_default_env("bad CRC", 0);
  143. return -EIO;
  144. } else if (crc1_ok && !crc2_ok) {
  145. gd->env_valid = ENV_VALID;
  146. } else if (!crc1_ok && crc2_ok) {
  147. gd->env_valid = ENV_REDUND;
  148. } else {
  149. /* both ok - check serial */
  150. if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
  151. gd->env_valid = ENV_REDUND;
  152. else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
  153. gd->env_valid = ENV_VALID;
  154. else if (tmp_env1->flags > tmp_env2->flags)
  155. gd->env_valid = ENV_VALID;
  156. else if (tmp_env2->flags > tmp_env1->flags)
  157. gd->env_valid = ENV_REDUND;
  158. else /* flags are equal - almost impossible */
  159. gd->env_valid = ENV_VALID;
  160. }
  161. if (gd->env_valid == ENV_VALID)
  162. ep = tmp_env1;
  163. else
  164. ep = tmp_env2;
  165. env_flags = ep->flags;
  166. return env_import((char *)ep, 0);
  167. }
  168. #endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
  169. /* Export the environment and generate CRC for it. */
  170. int env_export(env_t *env_out)
  171. {
  172. char *res;
  173. ssize_t len;
  174. res = (char *)env_out->data;
  175. len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
  176. if (len < 0) {
  177. pr_err("Cannot export environment: errno = %d\n", errno);
  178. return 1;
  179. }
  180. env_out->crc = crc32(0, env_out->data, ENV_SIZE);
  181. #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
  182. env_out->flags = ++env_flags; /* increase the serial */
  183. #endif
  184. return 0;
  185. }
  186. void env_relocate(void)
  187. {
  188. #if defined(CONFIG_NEEDS_MANUAL_RELOC)
  189. env_reloc();
  190. env_fix_drivers();
  191. env_htab.change_ok += gd->reloc_off;
  192. #endif
  193. if (gd->env_valid == ENV_INVALID) {
  194. #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
  195. /* Environment not changable */
  196. set_default_env(NULL, 0);
  197. #else
  198. bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
  199. set_default_env("bad CRC", 0);
  200. #endif
  201. } else {
  202. env_load();
  203. }
  204. }
  205. #if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
  206. int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
  207. {
  208. ENTRY *match;
  209. int found, idx;
  210. idx = 0;
  211. found = 0;
  212. cmdv[0] = NULL;
  213. while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
  214. int vallen = strlen(match->key) + 1;
  215. if (found >= maxv - 2 || bufsz < vallen)
  216. break;
  217. cmdv[found++] = buf;
  218. memcpy(buf, match->key, vallen);
  219. buf += vallen;
  220. bufsz -= vallen;
  221. }
  222. qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
  223. if (idx)
  224. cmdv[found++] = "...";
  225. cmdv[found] = NULL;
  226. return found;
  227. }
  228. #endif