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 #ifdef CONFIG_BLK
 125         struct udevice *dev;
 126
 127         if (blk_get_from_parent(mmc->dev, &dev))
 128                 return "!No block device";
 129 #else
 130         if (mmc_init(mmc))
 131                 return "!MMC init failed";
 132 #endif
 133         if (mmc_set_env_part(mmc))
 134                 return "!MMC partition switch failed";
 135
 136         return NULL;
 137 }
 138
 139 static void fini_mmc_for_env(struct mmc *mmc)
 140 {
 141 #ifdef CONFIG_SYS_MMC_ENV_PART
 142         int dev = mmc_get_env_dev();
 143
 144         blk_select_hwpart_devnum(IF_TYPE_MMC, dev, env_mmc_orig_hwpart);
 145 #endif
 146 }
 147
 148 #ifdef CONFIG_CMD_SAVEENV
 149 static inline int write_env(struct mmc *mmc, unsigned long size,
 150                             unsigned long offset, const void *buffer)
 151 {
 152         uint blk_start, blk_cnt, n;
 153         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 154
 155         blk_start       = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
 156         blk_cnt         = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
 157
 158         n = blk_dwrite(desc, blk_start, blk_cnt, (u_char *)buffer);
 159
 160         return (n == blk_cnt) ? 0 : -1;
 161 }
 162
 163 #ifdef CONFIG_ENV_OFFSET_REDUND
 164 static unsigned char env_flags;
 165 #endif
 166
 167 int saveenv(void)
 168 {
 169         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
 170         int dev = mmc_get_env_dev();
 171         struct mmc *mmc = find_mmc_device(dev);
 172         u32     offset;
 173         int     ret, copy = 0;
 174         const char *errmsg;
 175
 176         errmsg = init_mmc_for_env(mmc);
 177         if (errmsg) {
 178                 printf("%s\n", errmsg);
 179                 return 1;
 180         }
 181
 182         ret = env_export(env_new);
 183         if (ret)
 184                 goto fini;
 185
 186 #ifdef CONFIG_ENV_OFFSET_REDUND
 187         env_new->flags  = ++env_flags; /* increase the serial */
 188
 189         if (gd->env_valid == 1)
 190                 copy = 1;
 191 #endif
 192
 193         if (mmc_get_env_addr(mmc, copy, &offset)) {
 194                 ret = 1;
 195                 goto fini;
 196         }
 197
 198         printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "", dev);
 199         if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
 200                 puts("failed\n");
 201                 ret = 1;
 202                 goto fini;
 203         }
 204
 205         puts("done\n");
 206         ret = 0;
 207
 208 #ifdef CONFIG_ENV_OFFSET_REDUND
 209         gd->env_valid = gd->env_valid == 2 ? 1 : 2;
 210 #endif
 211
 212 fini:
 213         fini_mmc_for_env(mmc);
 214         return ret;
 215 }
 216 #endif /* CONFIG_CMD_SAVEENV */
 217
 218 static inline int read_env(struct mmc *mmc, unsigned long size,
 219                            unsigned long offset, const void *buffer)
 220 {
 221         uint blk_start, blk_cnt, n;
 222         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 223
 224         blk_start       = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
 225         blk_cnt         = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
 226
 227         n = blk_dread(desc, blk_start, blk_cnt, (uchar *)buffer);
 228
 229         return (n == blk_cnt) ? 0 : -1;
 230 }
 231
 232 #ifdef CONFIG_ENV_OFFSET_REDUND
 233 void env_relocate_spec(void)
 234 {
 235 #if !defined(ENV_IS_EMBEDDED)
 236         struct mmc *mmc;
 237         u32 offset1, offset2;
 238         int read1_fail = 0, read2_fail = 0;
 239         int crc1_ok = 0, crc2_ok = 0;
 240         env_t *ep;
 241         int ret;
 242         int dev = mmc_get_env_dev();
 243         const char *errmsg = NULL;
 244
 245         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env1, 1);
 246         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env2, 1);
 247
 248         mmc = find_mmc_device(dev);
 249
 250         errmsg = init_mmc_for_env(mmc);
 251         if (errmsg) {
 252                 ret = 1;
 253                 goto err;
 254         }
 255
 256         if (mmc_get_env_addr(mmc, 0, &offset1) ||
 257             mmc_get_env_addr(mmc, 1, &offset2)) {
 258                 ret = 1;
 259                 goto fini;
 260         }
 261
 262         read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
 263         read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
 264
 265         if (read1_fail && read2_fail)
 266                 puts("*** Error - No Valid Environment Area found\n");
 267         else if (read1_fail || read2_fail)
 268                 puts("*** Warning - some problems detected "
 269                      "reading environment; recovered successfully\n");
 270
 271         crc1_ok = !read1_fail &&
 272                 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
 273         crc2_ok = !read2_fail &&
 274                 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
 275
 276         if (!crc1_ok && !crc2_ok) {
 277                 errmsg = "!bad CRC";
 278                 ret = 1;
 279                 goto fini;
 280         } else if (crc1_ok && !crc2_ok) {
 281                 gd->env_valid = 1;
 282         } else if (!crc1_ok && crc2_ok) {
 283                 gd->env_valid = 2;
 284         } else {
 285                 /* both ok - check serial */
 286                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
 287                         gd->env_valid = 2;
 288                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
 289                         gd->env_valid = 1;
 290                 else if (tmp_env1->flags > tmp_env2->flags)
 291                         gd->env_valid = 1;
 292                 else if (tmp_env2->flags > tmp_env1->flags)
 293                         gd->env_valid = 2;
 294                 else /* flags are equal - almost impossible */
 295                         gd->env_valid = 1;
 296         }
 297
 298         free(env_ptr);
 299
 300         if (gd->env_valid == 1)
 301                 ep = tmp_env1;
 302         else
 303                 ep = tmp_env2;
 304
 305         env_flags = ep->flags;
 306         env_import((char *)ep, 0);
 307         ret = 0;
 308
 309 fini:
 310         fini_mmc_for_env(mmc);
 311 err:
 312         if (ret)
 313                 set_default_env(errmsg);
 314 #endif
 315 }
 316 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 317 void env_relocate_spec(void)
 318 {
 319 #if !defined(ENV_IS_EMBEDDED)
 320         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
 321         struct mmc *mmc;
 322         u32 offset;
 323         int ret;
 324         int dev = mmc_get_env_dev();
 325         const char *errmsg;
 326
 327         mmc = find_mmc_device(dev);
 328
 329         errmsg = init_mmc_for_env(mmc);
 330         if (errmsg) {
 331                 ret = 1;
 332                 goto err;
 333         }
 334
 335         if (mmc_get_env_addr(mmc, 0, &offset)) {
 336                 ret = 1;
 337                 goto fini;
 338         }
 339
 340         if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
 341                 errmsg = "!read failed";
 342                 ret = 1;
 343                 goto fini;
 344         }
 345
 346         env_import(buf, 1);
 347         ret = 0;
 348
 349 fini:
 350         fini_mmc_for_env(mmc);
 351 err:
 352         if (ret)
 353                 set_default_env(errmsg);
 354 #endif
 355 }
 356 #endif /* CONFIG_ENV_OFFSET_REDUND */