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 #ifdef CONFIG_SYS_MMC_ENV_PART
  86 __weak uint mmc_get_env_part(struct mmc *mmc)
  87 {
  88         return CONFIG_SYS_MMC_ENV_PART;
  89 }
  90
  91 static unsigned char env_mmc_orig_hwpart;
  92
  93 static int mmc_set_env_part(struct mmc *mmc)
  94 {
  95         uint part = mmc_get_env_part(mmc);
  96         int dev = mmc_get_env_dev();
  97         int ret = 0;
  98
  99         env_mmc_orig_hwpart = mmc_get_blk_desc(mmc)->hwpart;
 100         ret = blk_select_hwpart_devnum(IF_TYPE_MMC, dev, part);
 101         if (ret)
 102                 puts("MMC partition switch failed\n");
 103
 104         return ret;
 105 }
 106 #else
 107 static inline int mmc_set_env_part(struct mmc *mmc) {return 0; };
 108 #endif
 109
 110 static const char *init_mmc_for_env(struct mmc *mmc)
 111 {
 112         if (!mmc)
 113                 return "!No MMC card found";
 114
 115 #ifdef CONFIG_BLK
 116         struct udevice *dev;
 117
 118         if (blk_get_from_parent(mmc->dev, &dev))
 119                 return "!No block device";
 120 #else
 121         if (mmc_init(mmc))
 122                 return "!MMC init failed";
 123 #endif
 124         if (mmc_set_env_part(mmc))
 125                 return "!MMC partition switch failed";
 126
 127         return NULL;
 128 }
 129
 130 static void fini_mmc_for_env(struct mmc *mmc)
 131 {
 132 #ifdef CONFIG_SYS_MMC_ENV_PART
 133         int dev = mmc_get_env_dev();
 134
 135         blk_select_hwpart_devnum(IF_TYPE_MMC, dev, env_mmc_orig_hwpart);
 136 #endif
 137 }
 138
 139 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_SPL_BUILD)
 140 static inline int write_env(struct mmc *mmc, unsigned long size,
 141                             unsigned long offset, const void *buffer)
 142 {
 143         uint blk_start, blk_cnt, n;
 144         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 145
 146         blk_start       = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
 147         blk_cnt         = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
 148
 149         n = blk_dwrite(desc, blk_start, blk_cnt, (u_char *)buffer);
 150
 151         return (n == blk_cnt) ? 0 : -1;
 152 }
 153
 154 static int env_mmc_save(void)
 155 {
 156         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
 157         int dev = mmc_get_env_dev();
 158         struct mmc *mmc = find_mmc_device(dev);
 159         u32     offset;
 160         int     ret, copy = 0;
 161         const char *errmsg;
 162
 163         errmsg = init_mmc_for_env(mmc);
 164         if (errmsg) {
 165                 printf("%s\n", errmsg);
 166                 return 1;
 167         }
 168
 169         ret = env_export(env_new);
 170         if (ret)
 171                 goto fini;
 172
 173 #ifdef CONFIG_ENV_OFFSET_REDUND
 174         if (gd->env_valid == ENV_VALID)
 175                 copy = 1;
 176 #endif
 177
 178         if (mmc_get_env_addr(mmc, copy, &offset)) {
 179                 ret = 1;
 180                 goto fini;
 181         }
 182
 183         printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "", dev);
 184         if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
 185                 puts("failed\n");
 186                 ret = 1;
 187                 goto fini;
 188         }
 189
 190         puts("done\n");
 191         ret = 0;
 192
 193 #ifdef CONFIG_ENV_OFFSET_REDUND
 194         gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
 195 #endif
 196
 197 fini:
 198         fini_mmc_for_env(mmc);
 199         return ret;
 200 }
 201 #endif /* CONFIG_CMD_SAVEENV && !CONFIG_SPL_BUILD */
 202
 203 static inline int read_env(struct mmc *mmc, unsigned long size,
 204                            unsigned long offset, const void *buffer)
 205 {
 206         uint blk_start, blk_cnt, n;
 207         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 208
 209         blk_start       = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
 210         blk_cnt         = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
 211
 212         n = blk_dread(desc, blk_start, blk_cnt, (uchar *)buffer);
 213
 214         return (n == blk_cnt) ? 0 : -1;
 215 }
 216
 217 #ifdef CONFIG_ENV_OFFSET_REDUND
 218 static void env_mmc_load(void)
 219 {
 220 #if !defined(ENV_IS_EMBEDDED)
 221         struct mmc *mmc;
 222         u32 offset1, offset2;
 223         int read1_fail = 0, read2_fail = 0;
 224         int ret;
 225         int dev = mmc_get_env_dev();
 226         const char *errmsg = NULL;
 227
 228         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env1, 1);
 229         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env2, 1);
 230
 231         mmc = find_mmc_device(dev);
 232
 233         errmsg = init_mmc_for_env(mmc);
 234         if (errmsg) {
 235                 ret = 1;
 236                 goto err;
 237         }
 238
 239         if (mmc_get_env_addr(mmc, 0, &offset1) ||
 240             mmc_get_env_addr(mmc, 1, &offset2)) {
 241                 ret = 1;
 242                 goto fini;
 243         }
 244
 245         read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
 246         read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
 247
 248         if (read1_fail && read2_fail)
 249                 puts("*** Error - No Valid Environment Area found\n");
 250         else if (read1_fail || read2_fail)
 251                 puts("*** Warning - some problems detected "
 252                      "reading environment; recovered successfully\n");
 253
 254         if (read1_fail && read2_fail) {
 255                 errmsg = "!bad CRC";
 256                 ret = 1;
 257                 goto fini;
 258         } else if (!read1_fail && read2_fail) {
 259                 gd->env_valid = ENV_VALID;
 260                 env_import((char *)tmp_env1, 1);
 261         } else if (read1_fail && !read2_fail) {
 262                 gd->env_valid = ENV_REDUND;
 263                 env_import((char *)tmp_env2, 1);
 264         } else {
 265                 env_import_redund((char *)tmp_env1, (char *)tmp_env2);
 266         }
 267
 268         ret = 0;
 269
 270 fini:
 271         fini_mmc_for_env(mmc);
 272 err:
 273         if (ret)
 274                 set_default_env(errmsg);
 275 #endif
 276 }
 277 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 278 static void env_mmc_load(void)
 279 {
 280 #if !defined(ENV_IS_EMBEDDED)
 281         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
 282         struct mmc *mmc;
 283         u32 offset;
 284         int ret;
 285         int dev = mmc_get_env_dev();
 286         const char *errmsg;
 287
 288         mmc = find_mmc_device(dev);
 289
 290         errmsg = init_mmc_for_env(mmc);
 291         if (errmsg) {
 292                 ret = 1;
 293                 goto err;
 294         }
 295
 296         if (mmc_get_env_addr(mmc, 0, &offset)) {
 297                 ret = 1;
 298                 goto fini;
 299         }
 300
 301         if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
 302                 errmsg = "!read failed";
 303                 ret = 1;
 304                 goto fini;
 305         }
 306
 307         env_import(buf, 1);
 308         ret = 0;
 309
 310 fini:
 311         fini_mmc_for_env(mmc);
 312 err:
 313         if (ret)
 314                 set_default_env(errmsg);
 315 #endif
 316 }
 317 #endif /* CONFIG_ENV_OFFSET_REDUND */
 318
 319 U_BOOT_ENV_LOCATION(mmc) = {
 320         .location       = ENVL_MMC,
 321         .load           = env_mmc_load,
 322 #ifndef CONFIG_SPL_BUILD
 323         .save           = env_save_ptr(env_mmc_save),
 324 #endif
 325 };