uboot env 环境变量解析注释

robe.zhang

本文基于 米尔  mys_y6ull  开发板 uboot 源码 2016.03 版本：

先写结论：
env 分两部分处理：
1，init_sequence_f
中添加 env 指针，添加 env_valid 标记
2，init_sequence_r
中创建 htab ，解析 env，并添加 env 到 htab 中
(并设置 load_addr (从环境变量获取值, kernel 需要用))

再看源码：代码比较简单，init_sequence_f 部分的 env_init 函数

1. init_sequence_f (uboot\common\board_f.c)
   
2. 
   
3. int env_init(void)
   
4. {
   
5.         /* use default */
   
6.         gd->env_addr        = (ulong)&default_environment[0];          // default_environment 是静态数组变量
   
7.         gd->env_valid        = 1;
   
8. 
   
9.         return 0;
   
10. }
    

复制代码

这个是静态变量，default_environment， 是个静态数组，可以往里面随意添加环境变量，但是往这里添加环境变量不是很方便，要注意格式。不过还有更方便的方法，看这个数组最后一个元素，CONFIG_EXTRA_ENV_SETTINGS，可以找找 这个宏，从这个宏里面添加环境变量更方便

1. // -----------------------------------------------
   
2. (uboot\include\env_default.h)
   
3. static char default_environment[] = {                          //
   
4. #else
   
5. const uchar default_environment[] = {
   
6. #endif
   
7. #ifdef        CONFIG_ENV_CALLBACK_LIST_DEFAULT
   
8.         ENV_CALLBACK_VAR "=" CONFIG_ENV_CALLBACK_LIST_DEFAULT "\0"
   
9. #endif
   
10. #ifdef        CONFIG_ENV_FLAGS_LIST_DEFAULT
    
11.         ENV_FLAGS_VAR "=" CONFIG_ENV_FLAGS_LIST_DEFAULT "\0"
    
12. #endif
    
13. #ifdef        CONFIG_BOOTARGS
    
14.         "bootargs="        CONFIG_BOOTARGS                        "\0"
    
15. #endif
    
16. #ifdef        CONFIG_BOOTCOMMAND
    
17.         "bootcmd="        CONFIG_BOOTCOMMAND                "\0"
    
18. #endif
    
19. #ifdef        CONFIG_RAMBOOTCOMMAND
    
20.         "ramboot="        CONFIG_RAMBOOTCOMMAND                "\0"
    
21. #endif
    
22. #ifdef        CONFIG_NFSBOOTCOMMAND
    
23.         "nfsboot="        CONFIG_NFSBOOTCOMMAND                "\0"
    
24. #endif
    
25. #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
    
26.         "bootdelay="        __stringify(CONFIG_BOOTDELAY)        "\0"
    
27. #endif
    
28. #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
    
29.         "baudrate="        __stringify(CONFIG_BAUDRATE)        "\0"
    
30. #endif
    
31. #ifdef        CONFIG_LOADS_ECHO
    
32.         "loads_echo="        __stringify(CONFIG_LOADS_ECHO)        "\0"
    
33. #endif
    
34. #ifdef        CONFIG_ETHPRIME
    
35.         "ethprime="        CONFIG_ETHPRIME                        "\0"
    
36. #endif
    
37. #ifdef        CONFIG_IPADDR
    
38.         "ipaddr="        __stringify(CONFIG_IPADDR)        "\0"
    
39. #endif
    
40. #ifdef        CONFIG_SERVERIP
    
41.         "serverip="        __stringify(CONFIG_SERVERIP)        "\0"
    
42. #endif
    
43. #ifdef        CONFIG_SYS_AUTOLOAD
    
44.         "autoload="        CONFIG_SYS_AUTOLOAD                "\0"
    
45. #endif
    
46. #ifdef        CONFIG_PREBOOT
    
47.         "preboot="        CONFIG_PREBOOT                        "\0"
    
48. #endif
    
49. #ifdef        CONFIG_ROOTPATH
    
50.         "rootpath="        CONFIG_ROOTPATH                        "\0"
    
51. #endif
    
52. #ifdef        CONFIG_GATEWAYIP
    
53.         "gatewayip="        __stringify(CONFIG_GATEWAYIP)        "\0"
    
54. #endif
    
55. #ifdef        CONFIG_NETMASK
    
56.         "netmask="        __stringify(CONFIG_NETMASK)        "\0"
    
57. #endif
    
58. #ifdef        CONFIG_HOSTNAME
    
59.         "hostname="        __stringify(CONFIG_HOSTNAME)        "\0"
    
60. #endif
    
61. #ifdef        CONFIG_BOOTFILE
    
62.         "bootfile="        CONFIG_BOOTFILE                        "\0"
    
63. #endif
    
64. #ifdef        CONFIG_LOADADDR
    
65.         "loadaddr="        __stringify(CONFIG_LOADADDR)        "\0"
    
66. #endif
    
67. #ifdef        CONFIG_CLOCKS_IN_MHZ
    
68.         "clocks_in_mhz=1\0"
    
69. #endif
    
70. #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
    
71.         "pcidelay="        __stringify(CONFIG_PCI_BOOTDELAY)"\0"
    
72. #endif
    
73. #ifdef        CONFIG_ENV_VARS_UBOOT_CONFIG
    
74.         "arch="                CONFIG_SYS_ARCH                        "\0"
    
75.         "cpu="                CONFIG_SYS_CPU                        "\0"
    
76.         "board="        CONFIG_SYS_BOARD                "\0"
    
77.         "board_name="        CONFIG_SYS_BOARD                "\0"
    
78. #ifdef CONFIG_SYS_VENDOR
    
79.         "vendor="        CONFIG_SYS_VENDOR                "\0"
    
80. #endif
    
81. #ifdef CONFIG_SYS_SOC
    
82.         "soc="                CONFIG_SYS_SOC                        "\0"
    
83. #endif
    
84. #endif
    
85. #ifdef        CONFIG_EXTRA_ENV_SETTINGS
    
86.         CONFIG_EXTRA_ENV_SETTINGS
    
87. #endif
    
88.         "\0"
    
89. #ifdef DEFAULT_ENV_INSTANCE_EMBEDDED
    
90.         }
    
91. #endif
    
92. };

复制代码

以上是环境变量数组，实际在 uboot 中以 hash 表的形式管理，数组到 hash 表，在 initr_env 函数中：

1. init_sequence_r(uboot\common\board_r.c)
   
2. static int initr_env(void)
   
3. {
   
4.         /* initialize environment */
   
5.         if (should_load_env())
   
6.                 env_relocate();
   
7.         else
   
8.                 set_default_env(NULL);                                  // 1111
   
9. #ifdef CONFIG_OF_CONTROL
   
10.         setenv_addr("fdtcontroladdr", gd->fdt_blob);
    
11. #endif
    
12. 
    
13.         /* Initialize from environment */
    
14.         load_addr = getenv_ulong("loadaddr", 16, load_addr);
    
15. #if defined(CONFIG_SYS_EXTBDINFO)
    
16. #if defined(CONFIG_405GP) || defined(CONFIG_405EP)
    
17. #if defined(CONFIG_I2CFAST)
    
18.         /*
    
19.          * set bi_iic_fast for linux taking environment variable
    
20.          * "i2cfast" into account
    
21.          */
    
22.         {
    
23.                 char *s = getenv("i2cfast");
    
24. 
    
25.                 if (s && ((*s == 'y') || (*s == 'Y'))) {
    
26.                         gd->bd->bi_iic_fast[0] = 1;
    
27.                         gd->bd->bi_iic_fast[1] = 1;
    
28.                 }
    
29.         }
    
30. #endif /* CONFIG_I2CFAST */
    
31. #endif /* CONFIG_405GP, CONFIG_405EP */
    
32. #endif /* CONFIG_SYS_EXTBDINFO */
    
33.         return 0;
    
34. }
    
35. 
    
36. // -----------------------------------------------
    
37. void set_default_env(const char *s)
    
38. {
    
39.         int flags = 0;
    
40. 
    
41.         if (sizeof(default_environment) > ENV_SIZE) {
    
42.                 puts("*** Error - default environment is too large\n\n");
    
43.                 return;
    
44.         }
    
45. 
    
46.         if (s) {
    
47.                 if (*s == '!') {
    
48.                         printf("*** Warning - %s, "
    
49.                                 "using default environment\n\n",
    
50.                                 s + 1);
    
51.                 } else {
    
52.                         flags = H_INTERACTIVE;
    
53.                         puts(s);
    
54.                 }
    
55.         } else {
    
56.                 puts("Using default environment\n\n");
    
57.         }
    
58. 
    
59.         if (himport_r(&env_htab, (char *)default_environment,                 // 创建 htab ，并添加 env 环境变量
    
60.                         sizeof(default_environment), '\0', flags, 0,
    
61.                         0, NULL) == 0)
    
62.                 error("Environment import failed: errno = %d\n", errno);
    
63. 
    
64.         gd->flags |= GD_FLG_ENV_READY;
    
65. }
    
66. 
    
67. // -----------------------------------------------
    
68. int himport_r(struct hsearch_data *htab,
    
69.                 const char *env, size_t size, const char sep, int flag,
    
70.                 int crlf_is_lf, int nvars, char * const vars[])
    
71. {
    
72.         char *data, *sp, *dp, *name, *value;
    
73.         char *localvars[nvars];
    
74.         int i;
    
75. 
    
76.         /* Test for correct arguments.  */
    
77.         if (htab == NULL) {
    
78.                 __set_errno(EINVAL);
    
79.                 return 0;
    
80.         }
    
81. 
    
82.         /* we allocate new space to make sure we can write to the array */
    
83.         if ((data = malloc(size + 1)) == NULL) {
    
84.                 debug("himport_r: can't malloc %zu bytes\n", size + 1);
    
85.                 __set_errno(ENOMEM);
    
86.                 return 0;
    
87.         }
    
88.         memcpy(data, env, size);
    
89.         data[size] = '\0';
    
90.         dp = data;
    
91. 
    
92.         /* make a local copy of the list of variables */
    
93.         if (nvars)
    
94.                 memcpy(localvars, vars, sizeof(vars[0]) * nvars);
    
95. 
    
96.         if ((flag & H_NOCLEAR) == 0) {
    
97.                 /* Destroy old hash table if one exists */
    
98.                 debug("Destroy Hash Table: %p table = %p\n", htab,
    
99.                        htab->table);
    
100.                 if (htab->table)
     
101.                         hdestroy_r(htab);
     
102.         }
     
103. 
     
104.         /*
     
105.          * Create new hash table (if needed).  The computation of the hash
     
106.          * table size is based on heuristics: in a sample of some 70+
     
107.          * existing systems we found an average size of 39+ bytes per entry
     
108.          * in the environment (for the whole key=value pair). Assuming a
     
109.          * size of 8 per entry (= safety factor of ~5) should provide enough
     
110.          * safety margin for any existing environment definitions and still
     
111.          * allow for more than enough dynamic additions. Note that the
     
112.          * "size" argument is supposed to give the maximum environment size
     
113.          * (CONFIG_ENV_SIZE).  This heuristics will result in
     
114.          * unreasonably large numbers (and thus memory footprint) for
     
115.          * big flash environments (>8,000 entries for 64 KB
     
116.          * envrionment size), so we clip it to a reasonable value.
     
117.          * On the other hand we need to add some more entries for free
     
118.          * space when importing very small buffers. Both boundaries can
     
119.          * be overwritten in the board config file if needed.
     
120.          */
     
121. 
     
122.         if (!htab->table) {
     
123.                 int nent = CONFIG_ENV_MIN_ENTRIES + size / 8;
     
124. 
     
125.                 if (nent > CONFIG_ENV_MAX_ENTRIES)
     
126.                         nent = CONFIG_ENV_MAX_ENTRIES;
     
127. 
     
128.                 debug("Create Hash Table: N=%d\n", nent);
     
129. 
     
130.                 if (hcreate_r(nent, htab) == 0) {
     
131.                         free(data);
     
132.                         return 0;
     
133.                 }
     
134.         }
     
135. 
     
136.         if (!size) {
     
137.                 free(data);
     
138.                 return 1;                /* everything OK */
     
139.         }
     
140.         if(crlf_is_lf) {
     
141.                 /* Remove Carriage Returns in front of Line Feeds */
     
142.                 unsigned ignored_crs = 0;
     
143.                 for(;dp < data + size && *dp; ++dp) {
     
144.                         if(*dp == '\r' &&
     
145.                            dp < data + size - 1 && *(dp+1) == '\n')
     
146.                                 ++ignored_crs;
     
147.                         else
     
148.                                 *(dp-ignored_crs) = *dp;
     
149.                 }
     
150.                 size -= ignored_crs;
     
151.                 dp = data;
     
152.         }
     
153.         /* Parse environment; allow for '\0' and 'sep' as separators */
     
154.         do {
     
155.                 ENTRY e, *rv;
     
156. 
     
157.                 /* skip leading white space */
     
158.                 while (isblank(*dp))
     
159.                         ++dp;
     
160. 
     
161.                 /* skip comment lines */
     
162.                 if (*dp == '#') {
     
163.                         while (*dp && (*dp != sep))
     
164.                                 ++dp;
     
165.                         ++dp;
     
166.                         continue;
     
167.                 }
     
168. 
     
169.                 /* parse name */
     
170.                 for (name = dp; *dp != '=' && *dp && *dp != sep; ++dp)
     
171.                         ;
     
172. 
     
173.                 /* deal with "name" and "name=" entries (delete var) */
     
174.                 if (*dp == '\0' || *(dp + 1) == '\0' ||
     
175.                     *dp == sep || *(dp + 1) == sep) {
     
176.                         if (*dp == '=')
     
177.                                 *dp++ = '\0';
     
178.                         *dp++ = '\0';        /* terminate name */
     
179. 
     
180.                         debug("DELETE CANDIDATE: "%s"\n", name);
     
181.                         if (!drop_var_from_set(name, nvars, localvars))
     
182.                                 continue;
     
183. 
     
184.                         if (hdelete_r(name, htab, flag) == 0)
     
185.                                 debug("DELETE ERROR ##############################\n");
     
186. 
     
187.                         continue;
     
188.                 }
     
189.                 *dp++ = '\0';        /* terminate name */
     
190. 
     
191.                 /* parse value; deal with escapes */
     
192.                 for (value = sp = dp; *dp && (*dp != sep); ++dp) {
     
193.                         if ((*dp == '\\') && *(dp + 1))
     
194.                                 ++dp;
     
195.                         *sp++ = *dp;
     
196.                 }
     
197.                 *sp++ = '\0';        /* terminate value */
     
198.                 ++dp;
     
199. 
     
200.                 if (*name == 0) {
     
201.                         debug("INSERT: unable to use an empty key\n");
     
202.                         __set_errno(EINVAL);
     
203.                         free(data);
     
204.                         return 0;
     
205.                 }
     
206. 
     
207.                 /* Skip variables which are not supposed to be processed */
     
208.                 if (!drop_var_from_set(name, nvars, localvars))
     
209.                         continue;
     
210. 
     
211.                 /* enter into hash table */
     
212.                 e.key = name;
     
213.                 e.data = value;
     
214. 
     
215.                 hsearch_r(e, ENTER, &rv, htab, flag);
     
216.                 if (rv == NULL)
     
217.                         printf("himport_r: can't insert "%s=%s" into hash table\n",
     
218.                                 name, value);
     
219. 
     
220.                 debug("INSERT: table %p, filled %d/%d rv %p ==> name="%s" value="%s"\n",
     
221.                         htab, htab->filled, htab->size,
     
222.                         rv, name, value);
     
223.         } while ((dp < data + size) && *dp);        /* size check needed for text */
     
224.                                                 /* without '\0' termination */
     
225.         debug("INSERT: free(data = %p)\n", data);
     
226.         free(data);
     
227. 
     
228.         /* process variables which were not considered */
     
229.         for (i = 0; i < nvars; i++) {
     
230.                 if (localvars[i] == NULL)
     
231.                         continue;
     
232.                 /*
     
233.                  * All variables which were not deleted from the variable list
     
234.                  * were not present in the imported env
     
235.                  * This could mean two things:
     
236.                  * a) if the variable was present in current env, we delete it
     
237.                  * b) if the variable was not present in current env, we notify
     
238.                  *    it might be a typo
     
239.                  */
     
240.                 if (hdelete_r(localvars[i], htab, flag) == 0)
     
241.                         printf("WARNING: '%s' neither in running nor in imported env!\n", localvars[i]);
     
242.                 else
     
243.                         printf("WARNING: '%s' not in imported env, deleting it!\n", localvars[i]);
     
244.         }
     
245. 
     
246.         debug("INSERT: done\n");
     
247.         return 1;                /* everything OK */
     
248. }
     
249. 
     

复制代码

以上内容更新到 github ：
笔记：https://github.com/robe-zhang/mys_y6ulx/blob/master/note_robe/note_uboot/note_uboot_env
源码：https://github.com/robe-zhang/mys_y6ulx/tree/master/MYiR-iMX-uboot

<完>