common/spl/spl_mmc.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2010
   4  * Texas Instruments, <www.ti.com>
   5  *
   6  * Aneesh V <aneesh@ti.com>
   7  */
   8 #include <common.h>
   9 #include <dm.h>
  10 #include <log.h>
  11 #include <part.h>
  12 #include <spl.h>
  13 #include <linux/compiler.h>
  14 #include <errno.h>
  15 #include <asm/u-boot.h>
  16 #include <errno.h>
  17 #include <mmc.h>
  18 #include <image.h>
  19
  20 static int mmc_load_legacy(struct spl_image_info *spl_image,
  21                            struct spl_boot_device *bootdev,
  22                            struct mmc *mmc,
  23                            ulong sector, struct image_header *header)
  24 {
  25         u32 image_offset_sectors;
  26         u32 image_size_sectors;
  27         unsigned long count;
  28         u32 image_offset;
  29         int ret;
  30
  31         ret = spl_parse_image_header(spl_image, bootdev, header);
  32         if (ret)
  33                 return ret;
  34
  35         /* convert offset to sectors - round down */
  36         image_offset_sectors = spl_image->offset / mmc->read_bl_len;
  37         /* calculate remaining offset */
  38         image_offset = spl_image->offset % mmc->read_bl_len;
  39
  40         /* convert size to sectors - round up */
  41         image_size_sectors = (spl_image->size + mmc->read_bl_len - 1) /
  42                              mmc->read_bl_len;
  43
  44         /* Read the header too to avoid extra memcpy */
  45         count = blk_dread(mmc_get_blk_desc(mmc),
  46                           sector + image_offset_sectors,
  47                           image_size_sectors,
  48                           (void *)(ulong)spl_image->load_addr);
  49         debug("read %x sectors to %lx\n", image_size_sectors,
  50               spl_image->load_addr);
  51         if (count != image_size_sectors)
  52                 return -EIO;
  53
  54         if (image_offset)
  55                 memmove((void *)(ulong)spl_image->load_addr,
  56                         (void *)(ulong)spl_image->load_addr + image_offset,
  57                         spl_image->size);
  58
  59         return 0;
  60 }
  61
  62 static ulong h_spl_load_read(struct spl_load_info *load, ulong sector,
  63                              ulong count, void *buf)
  64 {
  65         struct mmc *mmc = load->dev;
  66
  67         return blk_dread(mmc_get_blk_desc(mmc), sector, count, buf);
  68 }
  69
  70 static __maybe_unused unsigned long spl_mmc_raw_uboot_offset(int part)
  71 {
  72 #if IS_ENABLED(CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_SECTOR)
  73         if (part == 0)
  74                 return CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_DATA_PART_OFFSET;
  75 #endif
  76
  77         return 0;
  78 }
  79
  80 static __maybe_unused
  81 int mmc_load_image_raw_sector(struct spl_image_info *spl_image,
  82                               struct spl_boot_device *bootdev,
  83                               struct mmc *mmc, unsigned long sector)
  84 {
  85         unsigned long count;
  86         struct image_header *header;
  87         struct blk_desc *bd = mmc_get_blk_desc(mmc);
  88         int ret = 0;
  89
  90         header = spl_get_load_buffer(-sizeof(*header), bd->blksz);
  91
  92         /* read image header to find the image size & load address */
  93         count = blk_dread(bd, sector, 1, header);
  94         debug("hdr read sector %lx, count=%lu\n", sector, count);
  95         if (count == 0) {
  96                 ret = -EIO;
  97                 goto end;
  98         }
  99
 100         if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
 101             image_get_magic(header) == FDT_MAGIC) {
 102                 struct spl_load_info load;
 103
 104                 debug("Found FIT\n");
 105                 load.dev = mmc;
 106                 load.priv = NULL;
 107                 load.filename = NULL;
 108                 load.bl_len = mmc->read_bl_len;
 109                 load.read = h_spl_load_read;
 110                 ret = spl_load_simple_fit(spl_image, &load, sector, header);
 111         } else if (IS_ENABLED(CONFIG_SPL_LOAD_IMX_CONTAINER)) {
 112                 struct spl_load_info load;
 113
 114                 load.dev = mmc;
 115                 load.priv = NULL;
 116                 load.filename = NULL;
 117                 load.bl_len = mmc->read_bl_len;
 118                 load.read = h_spl_load_read;
 119
 120                 ret = spl_load_imx_container(spl_image, &load, sector);
 121         } else {
 122                 ret = mmc_load_legacy(spl_image, bootdev, mmc, sector, header);
 123         }
 124
 125 end:
 126         if (ret) {
 127 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 128                 puts("mmc_load_image_raw_sector: mmc block read error\n");
 129 #endif
 130                 return -1;
 131         }
 132
 133         return 0;
 134 }
 135
 136 static int spl_mmc_get_device_index(u32 boot_device)
 137 {
 138         switch (boot_device) {
 139         case BOOT_DEVICE_MMC1:
 140                 return 0;
 141         case BOOT_DEVICE_MMC2:
 142         case BOOT_DEVICE_MMC2_2:
 143                 return 1;
 144         }
 145
 146 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 147         printf("spl: unsupported mmc boot device.\n");
 148 #endif
 149
 150         return -ENODEV;
 151 }
 152
 153 static int spl_mmc_find_device(struct mmc **mmcp, u32 boot_device)
 154 {
 155         int err, mmc_dev;
 156
 157         mmc_dev = spl_mmc_get_device_index(boot_device);
 158         if (mmc_dev < 0)
 159                 return mmc_dev;
 160
 161 #if CONFIG_IS_ENABLED(DM_MMC)
 162         err = mmc_init_device(mmc_dev);
 163 #else
 164         err = mmc_initialize(NULL);
 165 #endif /* DM_MMC */
 166         if (err) {
 167 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 168                 printf("spl: could not initialize mmc. error: %d\n", err);
 169 #endif
 170                 return err;
 171         }
 172         *mmcp = find_mmc_device(mmc_dev);
 173         err = *mmcp ? 0 : -ENODEV;
 174         if (err) {
 175 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 176                 printf("spl: could not find mmc device %d. error: %d\n",
 177                        mmc_dev, err);
 178 #endif
 179                 return err;
 180         }
 181
 182         return 0;
 183 }
 184
 185 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION
 186 static int mmc_load_image_raw_partition(struct spl_image_info *spl_image,
 187                                         struct spl_boot_device *bootdev,
 188                                         struct mmc *mmc, int partition,
 189                                         unsigned long sector)
 190 {
 191         struct disk_partition info;
 192         int err;
 193
 194 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION_TYPE
 195         int type_part;
 196         /* Only support MBR so DOS_ENTRY_NUMBERS */
 197         for (type_part = 1; type_part <= DOS_ENTRY_NUMBERS; type_part++) {
 198                 err = part_get_info(mmc_get_blk_desc(mmc), type_part, &info);
 199                 if (err)
 200                         continue;
 201                 if (info.sys_ind ==
 202                         CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION_TYPE) {
 203                         partition = type_part;
 204                         break;
 205                 }
 206         }
 207 #endif
 208
 209         err = part_get_info(mmc_get_blk_desc(mmc), partition, &info);
 210         if (err) {
 211 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 212                 puts("spl: partition error\n");
 213 #endif
 214                 return -1;
 215         }
 216
 217 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_SECTOR
 218         return mmc_load_image_raw_sector(spl_image, bootdev, mmc, info.start + sector);
 219 #else
 220         return mmc_load_image_raw_sector(spl_image, bootdev, mmc, info.start);
 221 #endif
 222 }
 223 #endif
 224
 225 #if CONFIG_IS_ENABLED(FALCON_BOOT_MMCSD)
 226 static int mmc_load_image_raw_os(struct spl_image_info *spl_image,
 227                                  struct spl_boot_device *bootdev,
 228                                  struct mmc *mmc)
 229 {
 230         int ret;
 231
 232 #if defined(CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR)
 233         unsigned long count;
 234
 235         count = blk_dread(mmc_get_blk_desc(mmc),
 236                 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
 237                 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS,
 238                 (void *) CONFIG_SYS_SPL_ARGS_ADDR);
 239         if (count != CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS) {
 240 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 241                 puts("mmc_load_image_raw_os: mmc block read error\n");
 242 #endif
 243                 return -1;
 244         }
 245 #endif  /* CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR */
 246
 247         ret = mmc_load_image_raw_sector(spl_image, bootdev, mmc,
 248                 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR);
 249         if (ret)
 250                 return ret;
 251
 252         if (spl_image->os != IH_OS_LINUX && spl_image->os != IH_OS_TEE) {
 253                 puts("Expected image is not found. Trying to start U-boot\n");
 254                 return -ENOENT;
 255         }
 256
 257         return 0;
 258 }
 259 #else
 260 static int mmc_load_image_raw_os(struct spl_image_info *spl_image,
 261                                  struct spl_boot_device *bootdev,
 262                                  struct mmc *mmc)
 263 {
 264         return -ENOSYS;
 265 }
 266 #endif
 267
 268 #ifndef CONFIG_SPL_OS_BOOT
 269 int spl_start_uboot(void)
 270 {
 271         return 1;
 272 }
 273 #endif
 274
 275 #ifdef CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
 276 static int spl_mmc_do_fs_boot(struct spl_image_info *spl_image,
 277                               struct spl_boot_device *bootdev,
 278                               struct mmc *mmc,
 279                               const char *filename)
 280 {
 281         int err = -ENOSYS;
 282
 283 #ifdef CONFIG_SPL_FS_FAT
 284         if (!spl_start_uboot()) {
 285                 err = spl_load_image_fat_os(spl_image, bootdev, mmc_get_blk_desc(mmc),
 286                         CONFIG_SYS_MMCSD_FS_BOOT_PARTITION);
 287                 if (!err)
 288                         return err;
 289         }
 290 #ifdef CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
 291         err = spl_load_image_fat(spl_image, bootdev, mmc_get_blk_desc(mmc),
 292                                  CONFIG_SYS_MMCSD_FS_BOOT_PARTITION,
 293                                  filename);
 294         if (!err)
 295                 return err;
 296 #endif
 297 #endif
 298 #ifdef CONFIG_SPL_FS_EXT4
 299         if (!spl_start_uboot()) {
 300                 err = spl_load_image_ext_os(spl_image, bootdev, mmc_get_blk_desc(mmc),
 301                         CONFIG_SYS_MMCSD_FS_BOOT_PARTITION);
 302                 if (!err)
 303                         return err;
 304         }
 305 #ifdef CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
 306         err = spl_load_image_ext(spl_image, bootdev, mmc_get_blk_desc(mmc),
 307                                  CONFIG_SYS_MMCSD_FS_BOOT_PARTITION,
 308                                  filename);
 309         if (!err)
 310                 return err;
 311 #endif
 312 #endif
 313
 314 #if defined(CONFIG_SPL_FS_FAT) || defined(CONFIG_SPL_FS_EXT4)
 315         err = -ENOENT;
 316 #endif
 317
 318         return err;
 319 }
 320 #else
 321 static int spl_mmc_do_fs_boot(struct spl_image_info *spl_image,
 322                               struct spl_boot_device *bootdev,
 323                               struct mmc *mmc,
 324                               const char *filename)
 325 {
 326         return -ENOSYS;
 327 }
 328 #endif
 329
 330 u32 __weak spl_mmc_boot_mode(struct mmc *mmc, const u32 boot_device)
 331 {
 332 #if defined(CONFIG_SPL_FS_FAT) || defined(CONFIG_SPL_FS_EXT4)
 333         return MMCSD_MODE_FS;
 334 #elif defined(CONFIG_SUPPORT_EMMC_BOOT)
 335         return MMCSD_MODE_EMMCBOOT;
 336 #else
 337         return MMCSD_MODE_RAW;
 338 #endif
 339 }
 340
 341 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION
 342 int __weak spl_mmc_boot_partition(const u32 boot_device)
 343 {
 344         return CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION;
 345 }
 346 #endif
 347
 348 unsigned long __weak spl_mmc_get_uboot_raw_sector(struct mmc *mmc,
 349                                                   unsigned long raw_sect)
 350 {
 351         return raw_sect;
 352 }
 353
 354 int default_spl_mmc_emmc_boot_partition(struct mmc *mmc)
 355 {
 356         int part;
 357 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_EMMC_BOOT_PARTITION
 358         part = CONFIG_SYS_MMCSD_RAW_MODE_EMMC_BOOT_PARTITION;
 359 #else
 360         /*
 361          * We need to check what the partition is configured to.
 362          * 1 and 2 match up to boot0 / boot1 and 7 is user data
 363          * which is the first physical partition (0).
 364          */
 365         part = (mmc->part_config >> 3) & PART_ACCESS_MASK;
 366         if (part == 7)
 367                 part = 0;
 368 #endif
 369         return part;
 370 }
 371
 372 int __weak spl_mmc_emmc_boot_partition(struct mmc *mmc)
 373 {
 374         return default_spl_mmc_emmc_boot_partition(mmc);
 375 }
 376
 377 int spl_mmc_load(struct spl_image_info *spl_image,
 378                  struct spl_boot_device *bootdev,
 379                  const char *filename,
 380                  int raw_part,
 381                  unsigned long raw_sect)
 382 {
 383         static struct mmc *mmc;
 384         u32 boot_mode;
 385         int err = 0;
 386         __maybe_unused int part = 0;
 387
 388         /* Perform peripheral init only once */
 389         if (!mmc) {
 390                 err = spl_mmc_find_device(&mmc, bootdev->boot_device);
 391                 if (err)
 392                         return err;
 393
 394                 err = mmc_init(mmc);
 395                 if (err) {
 396                         mmc = NULL;
 397 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 398                         printf("spl: mmc init failed with error: %d\n", err);
 399 #endif
 400                         return err;
 401                 }
 402         }
 403
 404         boot_mode = spl_mmc_boot_mode(mmc, bootdev->boot_device);
 405         err = -EINVAL;
 406         switch (boot_mode) {
 407         case MMCSD_MODE_EMMCBOOT:
 408                 part = spl_mmc_emmc_boot_partition(mmc);
 409
 410                 if (CONFIG_IS_ENABLED(MMC_TINY))
 411                         err = mmc_switch_part(mmc, part);
 412                 else
 413                         err = blk_dselect_hwpart(mmc_get_blk_desc(mmc), part);
 414
 415                 if (err) {
 416 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 417                         puts("spl: mmc partition switch failed\n");
 418 #endif
 419                         return err;
 420                 }
 421                 /* Fall through */
 422         case MMCSD_MODE_RAW:
 423                 debug("spl: mmc boot mode: raw\n");
 424
 425                 if (!spl_start_uboot()) {
 426                         err = mmc_load_image_raw_os(spl_image, bootdev, mmc);
 427                         if (!err)
 428                                 return err;
 429                 }
 430
 431                 raw_sect = spl_mmc_get_uboot_raw_sector(mmc, raw_sect);
 432
 433 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION
 434                 err = mmc_load_image_raw_partition(spl_image, bootdev,
 435                                                    mmc, raw_part,
 436                                                    raw_sect);
 437                 if (!err)
 438                         return err;
 439 #endif
 440 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_USE_SECTOR
 441                 err = mmc_load_image_raw_sector(spl_image, bootdev, mmc,
 442                                 raw_sect + spl_mmc_raw_uboot_offset(part));
 443                 if (!err)
 444                         return err;
 445 #endif
 446                 /* If RAW mode fails, try FS mode. */
 447         case MMCSD_MODE_FS:
 448                 debug("spl: mmc boot mode: fs\n");
 449
 450                 err = spl_mmc_do_fs_boot(spl_image, bootdev, mmc, filename);
 451                 if (!err)
 452                         return err;
 453
 454                 break;
 455 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
 456         default:
 457                 puts("spl: mmc: wrong boot mode\n");
 458 #endif
 459         }
 460
 461         return err;
 462 }
 463
 464 int spl_mmc_load_image(struct spl_image_info *spl_image,
 465                        struct spl_boot_device *bootdev)
 466 {
 467         return spl_mmc_load(spl_image, bootdev,
 468 #ifdef CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
 469                             CONFIG_SPL_FS_LOAD_PAYLOAD_NAME,
 470 #else
 471                             NULL,
 472 #endif
 473 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
 474                             spl_mmc_boot_partition(bootdev->boot_device),
 475 #else
 476                             0,
 477 #endif
 478 #ifdef CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR
 479                             CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR);
 480 #else
 481                             0);
 482 #endif
 483 }
 484
 485 SPL_LOAD_IMAGE_METHOD("MMC1", 0, BOOT_DEVICE_MMC1, spl_mmc_load_image);
 486 SPL_LOAD_IMAGE_METHOD("MMC2", 0, BOOT_DEVICE_MMC2, spl_mmc_load_image);
 487 SPL_LOAD_IMAGE_METHOD("MMC2_2", 0, BOOT_DEVICE_MMC2_2, spl_mmc_load_image);