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