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