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