c99fc750fa0a0b95db379b673423866d71b77a82
[karo-tx-uboot.git] / common / env_mmc.c
1 /*
2  * (C) Copyright 2008-2011 Freescale Semiconductor, Inc.
3  *
4  * SPDX-License-Identifier:     GPL-2.0+
5  */
6
7 /* #define DEBUG */
8
9 #include <common.h>
10
11 #include <command.h>
12 #include <environment.h>
13 #include <linux/stddef.h>
14 #include <malloc.h>
15 #include <mmc.h>
16 #include <search.h>
17 #include <errno.h>
18
19 #if defined(CONFIG_ENV_SIZE_REDUND) &&  \
20         (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
21 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
22 #endif
23
24 char *env_name_spec = "MMC";
25
26 #ifdef ENV_IS_EMBEDDED
27 env_t *env_ptr = &environment;
28 #else /* ! ENV_IS_EMBEDDED */
29 env_t *env_ptr;
30 #endif /* ENV_IS_EMBEDDED */
31
32 DECLARE_GLOBAL_DATA_PTR;
33
34 #if !defined(CONFIG_ENV_OFFSET)
35 #define CONFIG_ENV_OFFSET 0
36 #endif
37
38 __weak int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr)
39 {
40         s64 offset;
41
42         offset = CONFIG_ENV_OFFSET;
43 #ifdef CONFIG_ENV_OFFSET_REDUND
44         if (copy)
45                 offset = CONFIG_ENV_OFFSET_REDUND;
46 #endif
47
48         if (offset < 0)
49                 offset += mmc->capacity;
50
51         *env_addr = offset;
52
53         return 0;
54 }
55
56 int env_init(void)
57 {
58         /* use default */
59         gd->env_addr    = (ulong)&default_environment[0];
60         gd->env_valid   = 1;
61
62         return 0;
63 }
64
65 static int init_mmc_for_env(struct mmc *mmc)
66 {
67         if (!mmc) {
68                 puts("No MMC card found\n");
69                 return -1;
70         }
71
72         if (mmc_init(mmc)) {
73                 puts("MMC init failed\n");
74                 return -1;
75         }
76
77 #ifdef CONFIG_SYS_MMC_ENV_PART
78         if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num) {
79                 if (mmc_switch_part(CONFIG_SYS_MMC_ENV_DEV,
80                                     CONFIG_SYS_MMC_ENV_PART)) {
81                         puts("MMC partition switch failed\n");
82                         return -1;
83                 }
84         }
85 #endif
86
87         return 0;
88 }
89
90 static void fini_mmc_for_env(struct mmc *mmc)
91 {
92 #ifdef CONFIG_SYS_MMC_ENV_PART
93         if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num)
94                 mmc_switch_part(CONFIG_SYS_MMC_ENV_DEV,
95                                 mmc->part_num);
96 #endif
97 }
98
99 #ifdef CONFIG_CMD_SAVEENV
100 static inline int write_env(struct mmc *mmc, unsigned long size,
101                             unsigned long offset, const void *buffer)
102 {
103         uint blk_start, blk_cnt, n;
104
105         blk_start       = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
106         blk_cnt         = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
107
108         n = mmc->block_dev.block_write(CONFIG_SYS_MMC_ENV_DEV, blk_start,
109                                         blk_cnt, (u_char *)buffer);
110
111         return (n == blk_cnt) ? 0 : -1;
112 }
113
114 #ifdef CONFIG_ENV_OFFSET_REDUND
115 static unsigned char env_flags;
116 #endif
117
118 int saveenv(void)
119 {
120         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
121         struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
122         u32     offset;
123         int     ret, copy = 0;
124
125         if (init_mmc_for_env(mmc))
126                 return 1;
127
128         ret = env_export(env_new);
129         if (ret)
130                 goto fini;
131
132 #ifdef CONFIG_ENV_OFFSET_REDUND
133         env_new->flags  = ++env_flags; /* increase the serial */
134
135         if (gd->env_valid == 1)
136                 copy = 1;
137 #endif
138
139         if (mmc_get_env_addr(mmc, copy, &offset)) {
140                 ret = 1;
141                 goto fini;
142         }
143
144         printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "",
145                CONFIG_SYS_MMC_ENV_DEV);
146         if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
147                 puts("failed\n");
148                 ret = 1;
149                 goto fini;
150         }
151
152         puts("done\n");
153         ret = 0;
154
155 #ifdef CONFIG_ENV_OFFSET_REDUND
156         gd->env_valid = gd->env_valid == 2 ? 1 : 2;
157 #endif
158
159 fini:
160         fini_mmc_for_env(mmc);
161         return ret;
162 }
163 #endif /* CONFIG_CMD_SAVEENV */
164
165 static inline int read_env(struct mmc *mmc, unsigned long size,
166                            unsigned long offset, const void *buffer)
167 {
168         uint blk_start, blk_cnt, n;
169
170         blk_start       = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
171         blk_cnt         = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
172
173         n = mmc->block_dev.block_read(CONFIG_SYS_MMC_ENV_DEV, blk_start,
174                                         blk_cnt, (uchar *)buffer);
175
176         return (n == blk_cnt) ? 0 : -1;
177 }
178
179 #ifdef CONFIG_ENV_OFFSET_REDUND
180 void env_relocate_spec(void)
181 {
182 #if !defined(ENV_IS_EMBEDDED)
183         struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
184         u32 offset1, offset2;
185         int read1_fail = 0, read2_fail = 0;
186         int crc1_ok = 0, crc2_ok = 0;
187         env_t *ep;
188         int ret;
189
190         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env1, 1);
191         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env2, 1);
192
193         if (tmp_env1 == NULL || tmp_env2 == NULL) {
194                 puts("Can't allocate buffers for environment\n");
195                 ret = 1;
196                 goto err;
197         }
198
199         if (init_mmc_for_env(mmc)) {
200                 ret = 1;
201                 goto err;
202         }
203
204         if (mmc_get_env_addr(mmc, 0, &offset1) ||
205             mmc_get_env_addr(mmc, 1, &offset2)) {
206                 ret = 1;
207                 goto fini;
208         }
209
210         read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
211         read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
212
213         if (read1_fail && read2_fail)
214                 puts("*** Error - No Valid Environment Area found\n");
215         else if (read1_fail || read2_fail)
216                 puts("*** Warning - some problems detected "
217                      "reading environment; recovered successfully\n");
218
219         crc1_ok = !read1_fail &&
220                 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
221         crc2_ok = !read2_fail &&
222                 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
223
224         if (!crc1_ok && !crc2_ok) {
225                 ret = 1;
226                 goto fini;
227         } else if (crc1_ok && !crc2_ok) {
228                 gd->env_valid = 1;
229         } else if (!crc1_ok && crc2_ok) {
230                 gd->env_valid = 2;
231         } else {
232                 /* both ok - check serial */
233                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
234                         gd->env_valid = 2;
235                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
236                         gd->env_valid = 1;
237                 else if (tmp_env1->flags > tmp_env2->flags)
238                         gd->env_valid = 1;
239                 else if (tmp_env2->flags > tmp_env1->flags)
240                         gd->env_valid = 2;
241                 else /* flags are equal - almost impossible */
242                         gd->env_valid = 1;
243         }
244
245         free(env_ptr);
246
247         if (gd->env_valid == 1)
248                 ep = tmp_env1;
249         else
250                 ep = tmp_env2;
251
252         env_flags = ep->flags;
253         env_import((char *)ep, 0);
254         ret = 0;
255
256 fini:
257         fini_mmc_for_env(mmc);
258 err:
259         if (ret)
260                 set_default_env(NULL);
261
262 #endif
263 }
264 #else /* ! CONFIG_ENV_OFFSET_REDUND */
265 void env_relocate_spec(void)
266 {
267 #if !defined(ENV_IS_EMBEDDED)
268         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
269         struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
270         u32 offset;
271         int ret;
272
273         if (init_mmc_for_env(mmc)) {
274                 ret = 1;
275                 goto err;
276         }
277
278         if (mmc_get_env_addr(mmc, 0, &offset)) {
279                 ret = 1;
280                 goto fini;
281         }
282
283         if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
284                 ret = 1;
285                 goto fini;
286         }
287
288         env_import(buf, 1);
289         ret = 0;
290
291 fini:
292         fini_mmc_for_env(mmc);
293 err:
294         if (ret)
295                 set_default_env(NULL);
296 #endif
297 }
298 #endif /* CONFIG_ENV_OFFSET_REDUND */