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 <fdtdec.h>
  14 #include <linux/stddef.h>
  15 #include <malloc.h>
  16 #include <memalign.h>
  17 #include <mmc.h>
  18 #include <search.h>
  19 #include <errno.h>
  20
  21 #if defined(CONFIG_ENV_SIZE_REDUND) &&  \
  22         (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
  23 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
  24 #endif
  25
  26 char *env_name_spec = "MMC";
  27
  28 #ifdef ENV_IS_EMBEDDED
  29 env_t *env_ptr = &environment;
  30 #else /* ! ENV_IS_EMBEDDED */
  31 env_t *env_ptr;
  32 #endif /* ENV_IS_EMBEDDED */
  33
  34 DECLARE_GLOBAL_DATA_PTR;
  35
  36 #if !defined(CONFIG_ENV_OFFSET)
  37 #define CONFIG_ENV_OFFSET 0
  38 #endif
  39
  40 #if CONFIG_IS_ENABLED(OF_CONTROL)
  41 static inline s64 mmc_offset(int copy)
  42 {
  43         const char *propname = "u-boot,mmc-env-offset";
  44         s64 defvalue = CONFIG_ENV_OFFSET;
  45
  46 #if defined(CONFIG_ENV_OFFSET_REDUND)
  47         if (copy) {
  48                 propname = "u-boot,mmc-env-offset-redundant";
  49                 defvalue = CONFIG_ENV_OFFSET_REDUND;
  50         }
  51 #endif
  52
  53         return fdtdec_get_config_int(gd->fdt_blob, propname, defvalue);
  54 }
  55 #else
  56 static inline s64 mmc_offset(int copy)
  57 {
  58         s64 offset = CONFIG_ENV_OFFSET;
  59
  60 #if defined(CONFIG_ENV_OFFSET_REDUND)
  61         if (copy)
  62                 offset = CONFIG_ENV_OFFSET_REDUND;
  63 #endif
  64         return offset;
  65 }
  66 #endif
  67
  68 __weak int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr)
  69 {
  70         s64 offset = mmc_offset(copy);
  71
  72         if (offset < 0)
  73                 offset += mmc->capacity;
  74
  75         *env_addr = offset;
  76
  77         return 0;
  78 }
  79
  80 __weak int mmc_get_env_dev(void)
  81 {
  82         return CONFIG_SYS_MMC_ENV_DEV;
  83 }
  84
  85 int env_init(void)
  86 {
  87         /* use default */
  88         gd->env_addr    = (ulong)&default_environment[0];
  89         gd->env_valid   = 1;
  90
  91         return 0;
  92 }
  93
  94 #ifdef CONFIG_SYS_MMC_ENV_PART
  95 __weak uint mmc_get_env_part(struct mmc *mmc)
  96 {
  97         return CONFIG_SYS_MMC_ENV_PART;
  98 }
  99
 100 static unsigned char env_mmc_orig_hwpart;
 101
 102 static int mmc_set_env_part(struct mmc *mmc)
 103 {
 104         uint part = mmc_get_env_part(mmc);
 105         int dev = mmc_get_env_dev();
 106         int ret = 0;
 107
 108         env_mmc_orig_hwpart = mmc_get_blk_desc(mmc)->hwpart;
 109         ret = blk_select_hwpart_devnum(IF_TYPE_MMC, dev, part);
 110         if (ret)
 111                 puts("MMC partition switch failed\n");
 112
 113         return ret;
 114 }
 115 #else
 116 static inline int mmc_set_env_part(struct mmc *mmc) {return 0; };
 117 #endif
 118
 119 static const char *init_mmc_for_env(struct mmc *mmc)
 120 {
 121         if (!mmc)
 122                 return "!No MMC card found";
 123
 124 #ifndef CONFIG_BLK
 125         if (mmc_init(mmc))
 126                 return "!MMC init failed";
 127 #endif
 128         if (mmc_set_env_part(mmc))
 129                 return "!MMC partition switch failed";
 130
 131         return NULL;
 132 }
 133
 134 static void fini_mmc_for_env(struct mmc *mmc)
 135 {
 136 #ifdef CONFIG_SYS_MMC_ENV_PART
 137         int dev = mmc_get_env_dev();
 138
 139         blk_select_hwpart_devnum(IF_TYPE_MMC, dev, env_mmc_orig_hwpart);
 140 #endif
 141 }
 142
 143 #ifdef CONFIG_CMD_SAVEENV
 144 static inline int write_env(struct mmc *mmc, unsigned long size,
 145                             unsigned long offset, const void *buffer)
 146 {
 147         uint blk_start, blk_cnt, n;
 148         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 149
 150         blk_start       = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
 151         blk_cnt         = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
 152
 153         n = blk_dwrite(desc, blk_start, blk_cnt, (u_char *)buffer);
 154
 155         return (n == blk_cnt) ? 0 : -1;
 156 }
 157
 158 #ifdef CONFIG_ENV_OFFSET_REDUND
 159 static unsigned char env_flags;
 160 #endif
 161
 162 int saveenv(void)
 163 {
 164         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
 165         int dev = mmc_get_env_dev();
 166         struct mmc *mmc = find_mmc_device(dev);
 167         u32     offset;
 168         int     ret, copy = 0;
 169         const char *errmsg;
 170
 171         errmsg = init_mmc_for_env(mmc);
 172         if (errmsg) {
 173                 printf("%s\n", errmsg);
 174                 return 1;
 175         }
 176
 177         ret = env_export(env_new);
 178         if (ret)
 179                 goto fini;
 180
 181 #ifdef CONFIG_ENV_OFFSET_REDUND
 182         env_new->flags  = ++env_flags; /* increase the serial */
 183
 184         if (gd->env_valid == 1)
 185                 copy = 1;
 186 #endif
 187
 188         if (mmc_get_env_addr(mmc, copy, &offset)) {
 189                 ret = 1;
 190                 goto fini;
 191         }
 192
 193         printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "", dev);
 194         if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
 195                 puts("failed\n");
 196                 ret = 1;
 197                 goto fini;
 198         }
 199
 200         puts("done\n");
 201         ret = 0;
 202
 203 #ifdef CONFIG_ENV_OFFSET_REDUND
 204         gd->env_valid = gd->env_valid == 2 ? 1 : 2;
 205 #endif
 206
 207 fini:
 208         fini_mmc_for_env(mmc);
 209         return ret;
 210 }
 211 #endif /* CONFIG_CMD_SAVEENV */
 212
 213 static inline int read_env(struct mmc *mmc, unsigned long size,
 214                            unsigned long offset, const void *buffer)
 215 {
 216         uint blk_start, blk_cnt, n;
 217         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 218
 219         blk_start       = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
 220         blk_cnt         = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
 221
 222         n = blk_dread(desc, blk_start, blk_cnt, (uchar *)buffer);
 223
 224         return (n == blk_cnt) ? 0 : -1;
 225 }
 226
 227 #ifdef CONFIG_ENV_OFFSET_REDUND
 228 void env_relocate_spec(void)
 229 {
 230 #if !defined(ENV_IS_EMBEDDED)
 231         struct mmc *mmc;
 232         u32 offset1, offset2;
 233         int read1_fail = 0, read2_fail = 0;
 234         int crc1_ok = 0, crc2_ok = 0;
 235         env_t *ep;
 236         int ret;
 237         int dev = mmc_get_env_dev();
 238         const char *errmsg = NULL;
 239
 240         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env1, 1);
 241         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env2, 1);
 242
 243         mmc = find_mmc_device(dev);
 244
 245         errmsg = init_mmc_for_env(mmc);
 246         if (errmsg) {
 247                 ret = 1;
 248                 goto err;
 249         }
 250
 251         if (mmc_get_env_addr(mmc, 0, &offset1) ||
 252             mmc_get_env_addr(mmc, 1, &offset2)) {
 253                 ret = 1;
 254                 goto fini;
 255         }
 256
 257         read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
 258         read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
 259
 260         if (read1_fail && read2_fail)
 261                 puts("*** Error - No Valid Environment Area found\n");
 262         else if (read1_fail || read2_fail)
 263                 puts("*** Warning - some problems detected "
 264                      "reading environment; recovered successfully\n");
 265
 266         crc1_ok = !read1_fail &&
 267                 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
 268         crc2_ok = !read2_fail &&
 269                 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
 270
 271         if (!crc1_ok && !crc2_ok) {
 272                 errmsg = "!bad CRC";
 273                 ret = 1;
 274                 goto fini;
 275         } else if (crc1_ok && !crc2_ok) {
 276                 gd->env_valid = 1;
 277         } else if (!crc1_ok && crc2_ok) {
 278                 gd->env_valid = 2;
 279         } else {
 280                 /* both ok - check serial */
 281                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
 282                         gd->env_valid = 2;
 283                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
 284                         gd->env_valid = 1;
 285                 else if (tmp_env1->flags > tmp_env2->flags)
 286                         gd->env_valid = 1;
 287                 else if (tmp_env2->flags > tmp_env1->flags)
 288                         gd->env_valid = 2;
 289                 else /* flags are equal - almost impossible */
 290                         gd->env_valid = 1;
 291         }
 292
 293         free(env_ptr);
 294
 295         if (gd->env_valid == 1)
 296                 ep = tmp_env1;
 297         else
 298                 ep = tmp_env2;
 299
 300         env_flags = ep->flags;
 301         env_import((char *)ep, 0);
 302         ret = 0;
 303
 304 fini:
 305         fini_mmc_for_env(mmc);
 306 err:
 307         if (ret)
 308                 set_default_env(errmsg);
 309 #endif
 310 }
 311 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 312 void env_relocate_spec(void)
 313 {
 314 #if !defined(ENV_IS_EMBEDDED)
 315         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
 316         struct mmc *mmc;
 317         u32 offset;
 318         int ret;
 319         int dev = mmc_get_env_dev();
 320         const char *errmsg;
 321
 322         mmc = find_mmc_device(dev);
 323
 324         errmsg = init_mmc_for_env(mmc);
 325         if (errmsg) {
 326                 ret = 1;
 327                 goto err;
 328         }
 329
 330         if (mmc_get_env_addr(mmc, 0, &offset)) {
 331                 ret = 1;
 332                 goto fini;
 333         }
 334
 335         if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
 336                 errmsg = "!read failed";
 337                 ret = 1;
 338                 goto fini;
 339         }
 340
 341         env_import(buf, 1);
 342         ret = 0;
 343
 344 fini:
 345         fini_mmc_for_env(mmc);
 346 err:
 347         if (ret)
 348                 set_default_env(errmsg);
 349 #endif
 350 }
 351 #endif /* CONFIG_ENV_OFFSET_REDUND */