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 #ifdef CONFIG_SYS_MMC_ENV_PART
  68         int dev = CONFIG_SYS_MMC_ENV_DEV;
  69
  70 #ifdef CONFIG_SPL_BUILD
  71         dev = 0;
  72 #endif
  73 #endif
  74
  75         if (!mmc) {
  76                 puts("No MMC card found\n");
  77                 return -1;
  78         }
  79
  80         if (mmc_init(mmc)) {
  81                 puts("MMC init failed\n");
  82                 return -1;
  83         }
  84
  85 #ifdef CONFIG_SYS_MMC_ENV_PART
  86         if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num) {
  87                 if (mmc_switch_part(dev, CONFIG_SYS_MMC_ENV_PART)) {
  88                         puts("MMC partition switch failed\n");
  89                         return -1;
  90                 }
  91         }
  92 #endif
  93
  94         return 0;
  95 }
  96
  97 static void fini_mmc_for_env(struct mmc *mmc)
  98 {
  99 #ifdef CONFIG_SYS_MMC_ENV_PART
 100         int dev = CONFIG_SYS_MMC_ENV_DEV;
 101
 102 #ifdef CONFIG_SPL_BUILD
 103         dev = 0;
 104 #endif
 105         if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num)
 106                 mmc_switch_part(dev, mmc->part_num);
 107 #endif
 108 }
 109
 110 #ifdef CONFIG_CMD_SAVEENV
 111 static inline int write_env(struct mmc *mmc, unsigned long size,
 112                             unsigned long offset, const void *buffer)
 113 {
 114         uint blk_start, blk_cnt, n;
 115
 116         blk_start       = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
 117         blk_cnt         = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
 118
 119         n = mmc->block_dev.block_write(CONFIG_SYS_MMC_ENV_DEV, blk_start,
 120                                         blk_cnt, (u_char *)buffer);
 121
 122         return (n == blk_cnt) ? 0 : -1;
 123 }
 124
 125 #ifdef CONFIG_ENV_OFFSET_REDUND
 126 static unsigned char env_flags;
 127 #endif
 128
 129 int saveenv(void)
 130 {
 131         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
 132         ssize_t len;
 133         char    *res;
 134         struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
 135         u32     offset;
 136         int     ret, copy = 0;
 137
 138         if (init_mmc_for_env(mmc))
 139                 return 1;
 140
 141         res = (char *)&env_new->data;
 142         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
 143         if (len < 0) {
 144                 error("Cannot export environment: errno = %d\n", errno);
 145                 ret = 1;
 146                 goto fini;
 147         }
 148
 149         env_new->crc = crc32(0, &env_new->data[0], ENV_SIZE);
 150
 151 #ifdef CONFIG_ENV_OFFSET_REDUND
 152         env_new->flags  = ++env_flags; /* increase the serial */
 153
 154         if (gd->env_valid == 1)
 155                 copy = 1;
 156 #endif
 157
 158         if (mmc_get_env_addr(mmc, copy, &offset)) {
 159                 ret = 1;
 160                 goto fini;
 161         }
 162
 163         printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "",
 164                CONFIG_SYS_MMC_ENV_DEV);
 165         if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
 166                 puts("failed\n");
 167                 ret = 1;
 168                 goto fini;
 169         }
 170
 171         puts("done\n");
 172         ret = 0;
 173
 174 #ifdef CONFIG_ENV_OFFSET_REDUND
 175         gd->env_valid = gd->env_valid == 2 ? 1 : 2;
 176 #endif
 177
 178 fini:
 179         fini_mmc_for_env(mmc);
 180         return ret;
 181 }
 182 #endif /* CONFIG_CMD_SAVEENV */
 183
 184 static inline int read_env(struct mmc *mmc, unsigned long size,
 185                            unsigned long offset, const void *buffer)
 186 {
 187         uint blk_start, blk_cnt, n;
 188         int dev = CONFIG_SYS_MMC_ENV_DEV;
 189
 190 #ifdef CONFIG_SPL_BUILD
 191         dev = 0;
 192 #endif
 193
 194         blk_start       = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
 195         blk_cnt         = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
 196
 197         n = mmc->block_dev.block_read(dev, blk_start, blk_cnt, (uchar *)buffer);
 198
 199         return (n == blk_cnt) ? 0 : -1;
 200 }
 201
 202 #ifdef CONFIG_ENV_OFFSET_REDUND
 203 void env_relocate_spec(void)
 204 {
 205 #if !defined(ENV_IS_EMBEDDED)
 206         struct mmc *mmc;
 207         u32 offset1, offset2;
 208         int read1_fail = 0, read2_fail = 0;
 209         int crc1_ok = 0, crc2_ok = 0;
 210         env_t *ep;
 211         int ret;
 212         int dev = CONFIG_SYS_MMC_ENV_DEV;
 213
 214         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env1, 1);
 215         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env2, 1);
 216
 217 #ifdef CONFIG_SPL_BUILD
 218         dev = 0;
 219 #endif
 220
 221         mmc = find_mmc_device(dev);
 222
 223         if (init_mmc_for_env(mmc)) {
 224                 ret = 1;
 225                 goto err;
 226         }
 227
 228         if (mmc_get_env_addr(mmc, 0, &offset1) ||
 229             mmc_get_env_addr(mmc, 1, &offset2)) {
 230                 ret = 1;
 231                 goto fini;
 232         }
 233
 234         read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
 235         read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
 236
 237         if (read1_fail && read2_fail)
 238                 puts("*** Error - No Valid Environment Area found\n");
 239         else if (read1_fail || read2_fail)
 240                 puts("*** Warning - some problems detected "
 241                      "reading environment; recovered successfully\n");
 242
 243         crc1_ok = !read1_fail &&
 244                 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
 245         crc2_ok = !read2_fail &&
 246                 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
 247
 248         if (!crc1_ok && !crc2_ok) {
 249                 ret = 1;
 250                 goto fini;
 251         } else if (crc1_ok && !crc2_ok) {
 252                 gd->env_valid = 1;
 253         } else if (!crc1_ok && crc2_ok) {
 254                 gd->env_valid = 2;
 255         } else {
 256                 /* both ok - check serial */
 257                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
 258                         gd->env_valid = 2;
 259                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
 260                         gd->env_valid = 1;
 261                 else if (tmp_env1->flags > tmp_env2->flags)
 262                         gd->env_valid = 1;
 263                 else if (tmp_env2->flags > tmp_env1->flags)
 264                         gd->env_valid = 2;
 265                 else /* flags are equal - almost impossible */
 266                         gd->env_valid = 1;
 267         }
 268
 269         free(env_ptr);
 270
 271         if (gd->env_valid == 1)
 272                 ep = tmp_env1;
 273         else
 274                 ep = tmp_env2;
 275
 276         env_flags = ep->flags;
 277         env_import((char *)ep, 0);
 278         ret = 0;
 279
 280 fini:
 281         fini_mmc_for_env(mmc);
 282 err:
 283         if (ret)
 284                 set_default_env(NULL);
 285
 286 #endif
 287 }
 288 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 289 void env_relocate_spec(void)
 290 {
 291 #if !defined(ENV_IS_EMBEDDED)
 292         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
 293         struct mmc *mmc;
 294         u32 offset;
 295         int ret;
 296         int dev = CONFIG_SYS_MMC_ENV_DEV;
 297
 298 #ifdef CONFIG_SPL_BUILD
 299         dev = 0;
 300 #endif
 301
 302         mmc = find_mmc_device(dev);
 303
 304         if (init_mmc_for_env(mmc)) {
 305                 ret = 1;
 306                 goto err;
 307         }
 308
 309         if (mmc_get_env_addr(mmc, 0, &offset)) {
 310                 ret = 1;
 311                 goto fini;
 312         }
 313
 314         if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
 315                 ret = 1;
 316                 goto fini;
 317         }
 318
 319         env_import(buf, 1);
 320         ret = 0;
 321
 322 fini:
 323         fini_mmc_for_env(mmc);
 324 err:
 325         if (ret)
 326                 set_default_env(NULL);
 327 #endif
 328 }
 329 #endif /* CONFIG_ENV_OFFSET_REDUND */