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 (tmp_env1 == NULL || tmp_env2 == NULL) {
 224                 puts("Can't allocate buffers for environment\n");
 225                 ret = 1;
 226                 goto err;
 227         }
 228
 229         if (init_mmc_for_env(mmc)) {
 230                 ret = 1;
 231                 goto err;
 232         }
 233
 234         if (mmc_get_env_addr(mmc, 0, &offset1) ||
 235             mmc_get_env_addr(mmc, 1, &offset2)) {
 236                 ret = 1;
 237                 goto fini;
 238         }
 239
 240         read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
 241         read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
 242
 243         if (read1_fail && read2_fail)
 244                 puts("*** Error - No Valid Environment Area found\n");
 245         else if (read1_fail || read2_fail)
 246                 puts("*** Warning - some problems detected "
 247                      "reading environment; recovered successfully\n");
 248
 249         crc1_ok = !read1_fail &&
 250                 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
 251         crc2_ok = !read2_fail &&
 252                 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
 253
 254         if (!crc1_ok && !crc2_ok) {
 255                 ret = 1;
 256                 goto fini;
 257         } else if (crc1_ok && !crc2_ok) {
 258                 gd->env_valid = 1;
 259         } else if (!crc1_ok && crc2_ok) {
 260                 gd->env_valid = 2;
 261         } else {
 262                 /* both ok - check serial */
 263                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
 264                         gd->env_valid = 2;
 265                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
 266                         gd->env_valid = 1;
 267                 else if (tmp_env1->flags > tmp_env2->flags)
 268                         gd->env_valid = 1;
 269                 else if (tmp_env2->flags > tmp_env1->flags)
 270                         gd->env_valid = 2;
 271                 else /* flags are equal - almost impossible */
 272                         gd->env_valid = 1;
 273         }
 274
 275         free(env_ptr);
 276
 277         if (gd->env_valid == 1)
 278                 ep = tmp_env1;
 279         else
 280                 ep = tmp_env2;
 281
 282         env_flags = ep->flags;
 283         env_import((char *)ep, 0);
 284         ret = 0;
 285
 286 fini:
 287         fini_mmc_for_env(mmc);
 288 err:
 289         if (ret)
 290                 set_default_env(NULL);
 291
 292 #endif
 293 }
 294 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 295 void env_relocate_spec(void)
 296 {
 297 #if !defined(ENV_IS_EMBEDDED)
 298         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
 299         struct mmc *mmc;
 300         u32 offset;
 301         int ret;
 302         int dev = CONFIG_SYS_MMC_ENV_DEV;
 303
 304 #ifdef CONFIG_SPL_BUILD
 305         dev = 0;
 306 #endif
 307
 308         mmc = find_mmc_device(dev);
 309
 310         if (init_mmc_for_env(mmc)) {
 311                 ret = 1;
 312                 goto err;
 313         }
 314
 315         if (mmc_get_env_addr(mmc, 0, &offset)) {
 316                 ret = 1;
 317                 goto fini;
 318         }
 319
 320         if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
 321                 ret = 1;
 322                 goto fini;
 323         }
 324
 325         env_import(buf, 1);
 326         ret = 0;
 327
 328 fini:
 329         fini_mmc_for_env(mmc);
 330 err:
 331         if (ret)
 332                 set_default_env(NULL);
 333 #endif
 334 }
 335 #endif /* CONFIG_ENV_OFFSET_REDUND */