env/mmc.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2008-2011 Freescale Semiconductor, Inc.
   4  */
   5
   6 /* #define DEBUG */
   7
   8 #include <common.h>
   9
  10 #include <command.h>
  11 #include <env.h>
  12 #include <env_internal.h>
  13 #include <fdtdec.h>
  14 #include <linux/stddef.h>
  15 #include <malloc.h>
  16 #include <memalign.h>
  17 #include <mmc.h>
  18 #include <part.h>
  19 #include <search.h>
  20 #include <errno.h>
  21
  22 #define __STR(X) #X
  23 #define STR(X) __STR(X)
  24
  25 DECLARE_GLOBAL_DATA_PTR;
  26
  27 #if CONFIG_IS_ENABLED(OF_CONTROL)
  28 static inline int mmc_offset_try_partition(const char *str, int copy, s64 *val)
  29 {
  30         struct disk_partition info;
  31         struct blk_desc *desc;
  32         int len, i, ret;
  33         char dev_str[4];
  34
  35         snprintf(dev_str, sizeof(dev_str), "%d", mmc_get_env_dev());
  36         ret = blk_get_device_by_str("mmc", dev_str, &desc);
  37         if (ret < 0)
  38                 return (ret);
  39
  40         for (i = 1;;i++) {
  41                 ret = part_get_info(desc, i, &info);
  42                 if (ret < 0)
  43                         return ret;
  44
  45                 if (!strncmp((const char *)info.name, str, sizeof(str)))
  46                         break;
  47         }
  48
  49         /* round up to info.blksz */
  50         len = DIV_ROUND_UP(CONFIG_ENV_SIZE, info.blksz);
  51
  52         /* use the top of the partion for the environment */
  53         *val = (info.start + info.size - (1 + copy) * len) * info.blksz;
  54
  55         return 0;
  56 }
  57
  58 static inline s64 mmc_offset(int copy)
  59 {
  60         const struct {
  61                 const char *offset_redund;
  62                 const char *partition;
  63                 const char *offset;
  64         } dt_prop = {
  65                 .offset_redund = "u-boot,mmc-env-offset-redundant",
  66                 .partition = "u-boot,mmc-env-partition",
  67                 .offset = "u-boot,mmc-env-offset",
  68         };
  69         s64 val = 0, defvalue;
  70         const char *propname;
  71         const char *str;
  72         int err;
  73
  74         /* look for the partition in mmc CONFIG_SYS_MMC_ENV_DEV */
  75         str = fdtdec_get_config_string(gd->fdt_blob, dt_prop.partition);
  76         if (str) {
  77                 /* try to place the environment at end of the partition */
  78                 err = mmc_offset_try_partition(str, copy, &val);
  79                 if (!err)
  80                         return val;
  81         }
  82
  83         defvalue = CONFIG_ENV_OFFSET;
  84         propname = dt_prop.offset;
  85
  86 #if defined(CONFIG_ENV_OFFSET_REDUND)
  87         if (copy) {
  88                 defvalue = CONFIG_ENV_OFFSET_REDUND;
  89                 propname = dt_prop.offset_redund;
  90         }
  91 #endif
  92         return fdtdec_get_config_int(gd->fdt_blob, propname, defvalue);
  93 }
  94 #else
  95 static inline s64 mmc_offset(int copy)
  96 {
  97         s64 offset = CONFIG_ENV_OFFSET;
  98
  99 #if defined(CONFIG_ENV_OFFSET_REDUND)
 100         if (copy)
 101                 offset = CONFIG_ENV_OFFSET_REDUND;
 102 #endif
 103         return offset;
 104 }
 105 #endif
 106
 107 __weak int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr)
 108 {
 109         s64 offset = mmc_offset(copy);
 110
 111         if (offset < 0)
 112                 offset += mmc->capacity;
 113
 114         *env_addr = offset;
 115
 116         return 0;
 117 }
 118
 119 #ifdef CONFIG_SYS_MMC_ENV_PART
 120 __weak uint mmc_get_env_part(struct mmc *mmc)
 121 {
 122         return CONFIG_SYS_MMC_ENV_PART;
 123 }
 124
 125 static unsigned char env_mmc_orig_hwpart;
 126
 127 static int mmc_set_env_part(struct mmc *mmc)
 128 {
 129         uint part = mmc_get_env_part(mmc);
 130         int dev = mmc_get_env_dev();
 131         int ret = 0;
 132
 133         env_mmc_orig_hwpart = mmc_get_blk_desc(mmc)->hwpart;
 134         ret = blk_select_hwpart_devnum(IF_TYPE_MMC, dev, part);
 135         if (ret)
 136                 puts("MMC partition switch failed\n");
 137
 138         return ret;
 139 }
 140 #else
 141 static inline int mmc_set_env_part(struct mmc *mmc) {return 0; };
 142 #endif
 143
 144 static const char *init_mmc_for_env(struct mmc *mmc)
 145 {
 146         if (!mmc)
 147                 return "No MMC card found";
 148
 149 #if CONFIG_IS_ENABLED(BLK)
 150         struct udevice *dev;
 151
 152         if (blk_get_from_parent(mmc->dev, &dev))
 153                 return "No block device";
 154 #else
 155         if (mmc_init(mmc))
 156                 return "MMC init failed";
 157 #endif
 158         if (mmc_set_env_part(mmc))
 159                 return "MMC partition switch failed";
 160
 161         return NULL;
 162 }
 163
 164 static void fini_mmc_for_env(struct mmc *mmc)
 165 {
 166 #ifdef CONFIG_SYS_MMC_ENV_PART
 167         int dev = mmc_get_env_dev();
 168
 169         blk_select_hwpart_devnum(IF_TYPE_MMC, dev, env_mmc_orig_hwpart);
 170 #endif
 171 }
 172
 173 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_SPL_BUILD)
 174 static inline int write_env(struct mmc *mmc, unsigned long size,
 175                             unsigned long offset, const void *buffer)
 176 {
 177         uint blk_start, blk_cnt, n;
 178         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 179
 180         blk_start       = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
 181         blk_cnt         = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
 182
 183         n = blk_dwrite(desc, blk_start, blk_cnt, (u_char *)buffer);
 184
 185         return (n == blk_cnt) ? 0 : -1;
 186 }
 187
 188 static int env_mmc_save(void)
 189 {
 190         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
 191         int dev = mmc_get_env_dev();
 192         struct mmc *mmc = find_mmc_device(dev);
 193         u32     offset;
 194         int     ret, copy = 0;
 195         const char *errmsg;
 196
 197         errmsg = init_mmc_for_env(mmc);
 198         if (errmsg) {
 199                 printf("%s\n", errmsg);
 200                 return 1;
 201         }
 202
 203         ret = env_export(env_new);
 204         if (ret)
 205                 goto fini;
 206
 207 #ifdef CONFIG_ENV_OFFSET_REDUND
 208         if (gd->env_valid == ENV_VALID)
 209                 copy = 1;
 210 #endif
 211
 212         if (mmc_get_env_addr(mmc, copy, &offset)) {
 213                 ret = 1;
 214                 goto fini;
 215         }
 216
 217         printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "", dev);
 218         if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
 219                 puts("failed\n");
 220                 ret = 1;
 221                 goto fini;
 222         }
 223
 224         ret = 0;
 225
 226 #ifdef CONFIG_ENV_OFFSET_REDUND
 227         gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
 228 #endif
 229
 230 fini:
 231         fini_mmc_for_env(mmc);
 232         return ret;
 233 }
 234
 235 #if defined(CONFIG_CMD_ERASEENV)
 236 static inline int erase_env(struct mmc *mmc, unsigned long size,
 237                             unsigned long offset)
 238 {
 239         uint blk_start, blk_cnt, n;
 240         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 241
 242         blk_start       = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
 243         blk_cnt         = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
 244
 245         n = blk_derase(desc, blk_start, blk_cnt);
 246         printf("%d blocks erased: %s\n", n, (n == blk_cnt) ? "OK" : "ERROR");
 247
 248         return (n == blk_cnt) ? 0 : 1;
 249 }
 250
 251 static int env_mmc_erase(void)
 252 {
 253         int dev = mmc_get_env_dev();
 254         struct mmc *mmc = find_mmc_device(dev);
 255         int     ret, copy = 0;
 256         u32     offset;
 257         const char *errmsg;
 258
 259         errmsg = init_mmc_for_env(mmc);
 260         if (errmsg) {
 261                 printf("%s\n", errmsg);
 262                 return 1;
 263         }
 264
 265         if (mmc_get_env_addr(mmc, copy, &offset))
 266                 return CMD_RET_FAILURE;
 267
 268         ret = erase_env(mmc, CONFIG_ENV_SIZE, offset);
 269
 270 #ifdef CONFIG_ENV_OFFSET_REDUND
 271         copy = 1;
 272
 273         if (mmc_get_env_addr(mmc, copy, &offset))
 274                 return CMD_RET_FAILURE;
 275
 276         ret |= erase_env(mmc, CONFIG_ENV_SIZE, offset);
 277 #endif
 278
 279         return ret;
 280 }
 281 #endif /* CONFIG_CMD_ERASEENV */
 282 #endif /* CONFIG_CMD_SAVEENV && !CONFIG_SPL_BUILD */
 283
 284 static inline int read_env(struct mmc *mmc, unsigned long size,
 285                            unsigned long offset, const void *buffer)
 286 {
 287         uint blk_start, blk_cnt, n;
 288         struct blk_desc *desc = mmc_get_blk_desc(mmc);
 289
 290         blk_start       = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
 291         blk_cnt         = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
 292
 293         n = blk_dread(desc, blk_start, blk_cnt, (uchar *)buffer);
 294
 295         return (n == blk_cnt) ? 0 : -1;
 296 }
 297
 298 #ifdef CONFIG_ENV_OFFSET_REDUND
 299 static int env_mmc_load(void)
 300 {
 301 #if !defined(ENV_IS_EMBEDDED)
 302         struct mmc *mmc;
 303         u32 offset1, offset2;
 304         int read1_fail = 0, read2_fail = 0;
 305         int ret;
 306         int dev = mmc_get_env_dev();
 307         const char *errmsg = NULL;
 308
 309         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env1, 1);
 310         ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env2, 1);
 311
 312         mmc_initialize(NULL);
 313
 314         mmc = find_mmc_device(dev);
 315
 316         errmsg = init_mmc_for_env(mmc);
 317         if (errmsg) {
 318                 ret = -EIO;
 319                 goto err;
 320         }
 321
 322         if (mmc_get_env_addr(mmc, 0, &offset1) ||
 323             mmc_get_env_addr(mmc, 1, &offset2)) {
 324                 ret = -EIO;
 325                 goto fini;
 326         }
 327
 328         read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
 329         read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
 330
 331         ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
 332                                 read2_fail, H_EXTERNAL);
 333
 334 fini:
 335         fini_mmc_for_env(mmc);
 336 err:
 337         if (ret)
 338                 env_set_default(errmsg, 0);
 339
 340 #endif
 341         return ret;
 342 }
 343 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 344 static int env_mmc_load(void)
 345 {
 346 #if !defined(ENV_IS_EMBEDDED)
 347         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
 348         struct mmc *mmc;
 349         u32 offset;
 350         int ret;
 351         int dev = mmc_get_env_dev();
 352         const char *errmsg;
 353         env_t *ep = NULL;
 354
 355         mmc = find_mmc_device(dev);
 356
 357         errmsg = init_mmc_for_env(mmc);
 358         if (errmsg) {
 359                 ret = -EIO;
 360                 goto err;
 361         }
 362
 363         if (mmc_get_env_addr(mmc, 0, &offset)) {
 364                 ret = -EIO;
 365                 goto fini;
 366         }
 367
 368         if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
 369                 errmsg = "!read failed";
 370                 ret = -EIO;
 371                 goto fini;
 372         }
 373
 374         ret = env_import(buf, 1, H_EXTERNAL);
 375         if (!ret) {
 376                 ep = (env_t *)buf;
 377                 gd->env_addr = (ulong)&ep->data;
 378         }
 379
 380 fini:
 381         fini_mmc_for_env(mmc);
 382 err:
 383         if (ret)
 384                 env_set_default(errmsg, 0);
 385 #endif
 386         return ret;
 387 }
 388 #endif /* CONFIG_ENV_OFFSET_REDUND */
 389
 390 U_BOOT_ENV_LOCATION(mmc) = {
 391         .location       = ENVL_MMC,
 392         ENV_NAME("MMC")
 393         .load           = env_mmc_load,
 394 #ifndef CONFIG_SPL_BUILD
 395         .save           = env_save_ptr(env_mmc_save),
 396 #if defined(CONFIG_CMD_ERASEENV)
 397         .erase          = env_mmc_erase,
 398 #endif
 399 #endif
 400 };