1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2014 Broadcom Corporation.
11 #include <fastboot-internal.h>
14 #include <image-sparse.h>
20 #include <linux/compat.h>
21 #include <android_image.h>
23 #define FASTBOOT_MAX_BLK_WRITE 16384
25 #define BOOT_PARTITION_NAME "boot"
27 struct fb_mmc_sparse {
28 struct blk_desc *dev_desc;
31 static int part_get_info_by_name_or_alias(struct blk_desc *dev_desc,
32 const char *name, struct disk_partition *info)
36 ret = part_get_info_by_name(dev_desc, name, info);
38 /* strlen("fastboot_partition_alias_") + PART_NAME_LEN + 1 */
39 char env_alias_name[25 + PART_NAME_LEN + 1];
40 char *aliased_part_name;
43 strcpy(env_alias_name, "fastboot_partition_alias_");
44 strncat(env_alias_name, name, PART_NAME_LEN);
45 aliased_part_name = env_get(env_alias_name);
46 if (aliased_part_name != NULL)
47 ret = part_get_info_by_name(dev_desc,
48 aliased_part_name, info);
53 static int raw_part_get_info_by_name(struct blk_desc *dev_desc,
54 const char *name, struct disk_partition *info, int *mmcpart)
56 /* strlen("fastboot_raw_partition_") + PART_NAME_LEN + 1 */
57 char env_desc_name[23 + PART_NAME_LEN + 1];
60 const char **parg = argv;
62 /* check for raw partition descriptor */
63 strcpy(env_desc_name, "fastboot_raw_partition_");
64 strncat(env_desc_name, name, PART_NAME_LEN);
65 raw_part_desc = strdup(env_get(env_desc_name));
66 if (raw_part_desc == NULL)
70 * parse partition descriptor
72 * <lba_start> <lba_size> [mmcpart <num>]
74 for (; parg < argv + sizeof(argv) / sizeof(*argv); ++parg) {
75 *parg = strsep(&raw_part_desc, " ");
77 pr_err("Invalid number of arguments.\n");
82 info->start = simple_strtoul(argv[0], NULL, 0);
83 info->size = simple_strtoul(argv[1], NULL, 0);
84 info->blksz = dev_desc->blksz;
85 strncpy((char *)info->name, name, PART_NAME_LEN);
88 if (strcmp(strsep(&raw_part_desc, " "), "mmcpart") == 0)
89 *mmcpart = simple_strtoul(raw_part_desc, NULL, 0);
96 * fb_mmc_blk_write() - Write/erase MMC in chunks of FASTBOOT_MAX_BLK_WRITE
98 * @block_dev: Pointer to block device
99 * @start: First block to write/erase
100 * @blkcnt: Count of blocks
101 * @buffer: Pointer to data buffer for write or NULL for erase
103 static lbaint_t fb_mmc_blk_write(struct blk_desc *block_dev, lbaint_t start,
104 lbaint_t blkcnt, const void *buffer)
106 lbaint_t blk = start;
107 lbaint_t blks_written;
112 for (i = 0; i < blkcnt; i += FASTBOOT_MAX_BLK_WRITE) {
113 cur_blkcnt = min((int)blkcnt - i, FASTBOOT_MAX_BLK_WRITE);
115 if (fastboot_progress_callback)
116 fastboot_progress_callback("writing");
117 blks_written = blk_dwrite(block_dev, blk, cur_blkcnt,
118 buffer + (i * block_dev->blksz));
120 if (fastboot_progress_callback)
121 fastboot_progress_callback("erasing");
122 blks_written = blk_derase(block_dev, blk, cur_blkcnt);
125 blks += blks_written;
130 static lbaint_t fb_mmc_sparse_write(struct sparse_storage *info,
131 lbaint_t blk, lbaint_t blkcnt, const void *buffer)
133 struct fb_mmc_sparse *sparse = info->priv;
134 struct blk_desc *dev_desc = sparse->dev_desc;
136 return fb_mmc_blk_write(dev_desc, blk, blkcnt, buffer);
139 static lbaint_t fb_mmc_sparse_reserve(struct sparse_storage *info,
140 lbaint_t blk, lbaint_t blkcnt)
145 static void write_raw_image(struct blk_desc *dev_desc,
146 struct disk_partition *info, const char *part_name,
147 void *buffer, u32 download_bytes, char *response)
152 /* determine number of blocks to write */
153 blkcnt = ((download_bytes + (info->blksz - 1)) & ~(info->blksz - 1));
154 blkcnt = lldiv(blkcnt, info->blksz);
156 if (blkcnt > info->size) {
157 pr_err("too large for partition: '%s'\n", part_name);
158 fastboot_fail("too large for partition", response);
162 puts("Flashing Raw Image\n");
164 blks = fb_mmc_blk_write(dev_desc, info->start, blkcnt, buffer);
166 if (blks != blkcnt) {
167 pr_err("failed writing to device %d\n", dev_desc->devnum);
168 fastboot_fail("failed writing to device", response);
172 printf("........ wrote " LBAFU " bytes to '%s'\n", blkcnt * info->blksz,
174 fastboot_okay(NULL, response);
177 #if defined(CONFIG_FASTBOOT_MMC_BOOT_SUPPORT) || \
178 defined(CONFIG_FASTBOOT_MMC_USER_SUPPORT)
179 static int fb_mmc_erase_mmc_hwpart(struct blk_desc *dev_desc)
183 debug("Start Erasing mmc hwpart[%u]...\n", dev_desc->hwpart);
185 blks = fb_mmc_blk_write(dev_desc, 0, dev_desc->lba, NULL);
187 if (blks != dev_desc->lba) {
188 pr_err("Failed to erase mmc hwpart[%u]\n", dev_desc->hwpart);
192 printf("........ erased %lu bytes from mmc hwpart[%u]\n",
193 dev_desc->lba * dev_desc->blksz, dev_desc->hwpart);
199 #ifdef CONFIG_FASTBOOT_MMC_BOOT_SUPPORT
200 static void fb_mmc_boot_ops(struct blk_desc *dev_desc, void *buffer,
201 int hwpart, u32 buff_sz, char *response)
207 // To operate on EMMC_BOOT1/2 (mmc0boot0/1) we first change the hwpart
208 if (blk_dselect_hwpart(dev_desc, hwpart)) {
209 pr_err("Failed to select hwpart\n");
210 fastboot_fail("Failed to select hwpart", response);
214 if (buffer) { /* flash */
216 /* determine number of blocks to write */
217 blksz = dev_desc->blksz;
218 blkcnt = ((buff_sz + (blksz - 1)) & ~(blksz - 1));
219 blkcnt = lldiv(blkcnt, blksz);
221 if (blkcnt > dev_desc->lba) {
222 pr_err("Image size too large\n");
223 fastboot_fail("Image size too large", response);
227 debug("Start Flashing Image to EMMC_BOOT%d...\n", hwpart);
229 blks = fb_mmc_blk_write(dev_desc, 0, blkcnt, buffer);
231 if (blks != blkcnt) {
232 pr_err("Failed to write EMMC_BOOT%d\n", hwpart);
233 fastboot_fail("Failed to write EMMC_BOOT part",
238 printf("........ wrote %lu bytes to EMMC_BOOT%d\n",
239 blkcnt * blksz, hwpart);
241 if (fb_mmc_erase_mmc_hwpart(dev_desc)) {
242 pr_err("Failed to erase EMMC_BOOT%d\n", hwpart);
243 fastboot_fail("Failed to erase EMMC_BOOT part",
249 fastboot_okay(NULL, response);
253 #ifdef CONFIG_ANDROID_BOOT_IMAGE
255 * Read Android boot image header from boot partition.
257 * @param[in] dev_desc MMC device descriptor
258 * @param[in] info Boot partition info
259 * @param[out] hdr Where to store read boot image header
261 * @return Boot image header sectors count or 0 on error
263 static lbaint_t fb_mmc_get_boot_header(struct blk_desc *dev_desc,
264 struct disk_partition *info,
265 struct andr_img_hdr *hdr,
268 ulong sector_size; /* boot partition sector size */
269 lbaint_t hdr_sectors; /* boot image header sectors count */
272 /* Calculate boot image sectors count */
273 sector_size = info->blksz;
274 hdr_sectors = DIV_ROUND_UP(sizeof(struct andr_img_hdr), sector_size);
275 if (hdr_sectors == 0) {
276 pr_err("invalid number of boot sectors: 0\n");
277 fastboot_fail("invalid number of boot sectors: 0", response);
281 /* Read the boot image header */
282 res = blk_dread(dev_desc, info->start, hdr_sectors, (void *)hdr);
283 if (res != hdr_sectors) {
284 pr_err("cannot read header from boot partition\n");
285 fastboot_fail("cannot read header from boot partition",
290 /* Check boot header magic string */
291 res = android_image_check_header(hdr);
293 pr_err("bad boot image magic\n");
294 fastboot_fail("boot partition not initialized", response);
302 * Write downloaded zImage to boot partition and repack it properly.
304 * @param dev_desc MMC device descriptor
305 * @param download_buffer Address to fastboot buffer with zImage in it
306 * @param download_bytes Size of fastboot buffer, in bytes
308 * @return 0 on success or -1 on error
310 static int fb_mmc_update_zimage(struct blk_desc *dev_desc,
311 void *download_buffer,
315 uintptr_t hdr_addr; /* boot image header address */
316 struct andr_img_hdr *hdr; /* boot image header */
317 lbaint_t hdr_sectors; /* boot image header sectors */
319 u32 ramdisk_sector_start;
321 u32 kernel_sector_start;
323 u32 sectors_per_page;
324 struct disk_partition info;
327 puts("Flashing zImage\n");
329 /* Get boot partition info */
330 res = part_get_info_by_name(dev_desc, BOOT_PARTITION_NAME, &info);
332 pr_err("cannot find boot partition\n");
333 fastboot_fail("cannot find boot partition", response);
337 /* Put boot image header in fastboot buffer after downloaded zImage */
338 hdr_addr = (uintptr_t)download_buffer + ALIGN(download_bytes, PAGE_SIZE);
339 hdr = (struct andr_img_hdr *)hdr_addr;
341 /* Read boot image header */
342 hdr_sectors = fb_mmc_get_boot_header(dev_desc, &info, hdr, response);
343 if (hdr_sectors == 0) {
344 pr_err("unable to read boot image header\n");
345 fastboot_fail("unable to read boot image header", response);
349 /* Check if boot image has second stage in it (we don't support it) */
350 if (hdr->second_size > 0) {
351 pr_err("moving second stage is not supported yet\n");
352 fastboot_fail("moving second stage is not supported yet",
357 /* Extract ramdisk location */
358 sectors_per_page = hdr->page_size / info.blksz;
359 ramdisk_sector_start = info.start + sectors_per_page;
360 ramdisk_sector_start += DIV_ROUND_UP(hdr->kernel_size, hdr->page_size) *
362 ramdisk_sectors = DIV_ROUND_UP(hdr->ramdisk_size, hdr->page_size) *
365 /* Read ramdisk and put it in fastboot buffer after boot image header */
366 ramdisk_buffer = (u8 *)hdr + (hdr_sectors * info.blksz);
367 res = blk_dread(dev_desc, ramdisk_sector_start, ramdisk_sectors,
369 if (res != ramdisk_sectors) {
370 pr_err("cannot read ramdisk from boot partition\n");
371 fastboot_fail("cannot read ramdisk from boot partition",
376 /* Write new kernel size to boot image header */
377 hdr->kernel_size = download_bytes;
378 res = blk_dwrite(dev_desc, info.start, hdr_sectors, (void *)hdr);
380 pr_err("cannot writeback boot image header\n");
381 fastboot_fail("cannot write back boot image header", response);
385 /* Write the new downloaded kernel */
386 kernel_sector_start = info.start + sectors_per_page;
387 kernel_sectors = DIV_ROUND_UP(hdr->kernel_size, hdr->page_size) *
389 res = blk_dwrite(dev_desc, kernel_sector_start, kernel_sectors,
392 pr_err("cannot write new kernel\n");
393 fastboot_fail("cannot write new kernel", response);
397 /* Write the saved ramdisk back */
398 ramdisk_sector_start = info.start + sectors_per_page;
399 ramdisk_sector_start += DIV_ROUND_UP(hdr->kernel_size, hdr->page_size) *
401 res = blk_dwrite(dev_desc, ramdisk_sector_start, ramdisk_sectors,
404 pr_err("cannot write back original ramdisk\n");
405 fastboot_fail("cannot write back original ramdisk", response);
409 puts("........ zImage was updated in boot partition\n");
410 fastboot_okay(NULL, response);
416 * fastboot_mmc_get_part_info() - Lookup eMMC partion by name
418 * @part_name: Named partition to lookup
419 * @dev_desc: Pointer to returned blk_desc pointer
420 * @part_info: Pointer to returned struct disk_partition
421 * @response: Pointer to fastboot response buffer
423 int fastboot_mmc_get_part_info(const char *part_name,
424 struct blk_desc **dev_desc,
425 struct disk_partition *part_info, char *response)
430 *dev_desc = blk_get_dev("mmc", CONFIG_FASTBOOT_FLASH_MMC_DEV);
432 fastboot_fail("block device not found", response);
435 if (!part_name || !strcmp(part_name, "")) {
436 fastboot_fail("partition not given", response);
440 if (raw_part_get_info_by_name(*dev_desc, part_name, part_info, &mmcpart) < 0) {
441 r = part_get_info_by_name_or_alias(*dev_desc, part_name, part_info);
443 fastboot_fail("partition not found", response);
452 * fastboot_mmc_flash_write() - Write image to eMMC for fastboot
454 * @cmd: Named partition to write image to
455 * @download_buffer: Pointer to image data
456 * @download_bytes: Size of image data
457 * @response: Pointer to fastboot response buffer
459 void fastboot_mmc_flash_write(const char *cmd, void *download_buffer,
460 u32 download_bytes, char *response)
462 struct blk_desc *dev_desc;
463 struct disk_partition info;
466 dev_desc = blk_get_dev("mmc", CONFIG_FASTBOOT_FLASH_MMC_DEV);
467 if (!dev_desc || dev_desc->type == DEV_TYPE_UNKNOWN) {
468 pr_err("invalid mmc device\n");
469 fastboot_fail("invalid mmc device", response);
473 #ifdef CONFIG_FASTBOOT_MMC_BOOT_SUPPORT
474 if (strcmp(cmd, CONFIG_FASTBOOT_MMC_BOOT1_NAME) == 0) {
475 fb_mmc_boot_ops(dev_desc, download_buffer, 1,
476 download_bytes, response);
479 if (strcmp(cmd, CONFIG_FASTBOOT_MMC_BOOT2_NAME) == 0) {
480 fb_mmc_boot_ops(dev_desc, download_buffer, 2,
481 download_bytes, response);
486 #if CONFIG_IS_ENABLED(EFI_PARTITION)
487 #ifndef CONFIG_FASTBOOT_MMC_USER_SUPPORT
488 if (strcmp(cmd, CONFIG_FASTBOOT_GPT_NAME) == 0) {
490 if (strcmp(cmd, CONFIG_FASTBOOT_GPT_NAME) == 0 ||
491 strcmp(cmd, CONFIG_FASTBOOT_MMC_USER_NAME) == 0) {
493 printf("%s: updating MBR, Primary and Backup GPT(s)\n",
495 if (is_valid_gpt_buf(dev_desc, download_buffer)) {
496 printf("%s: invalid GPT - refusing to write to flash\n",
498 fastboot_fail("invalid GPT partition", response);
501 if (write_mbr_and_gpt_partitions(dev_desc, download_buffer)) {
502 printf("%s: writing GPT partitions failed\n", __func__);
503 fastboot_fail("writing GPT partitions failed",
508 printf("........ success\n");
509 fastboot_okay(NULL, response);
514 #if CONFIG_IS_ENABLED(DOS_PARTITION)
515 if (strcmp(cmd, CONFIG_FASTBOOT_MBR_NAME) == 0) {
516 printf("%s: updating MBR\n", __func__);
517 if (is_valid_dos_buf(download_buffer)) {
518 printf("%s: invalid MBR - refusing to write to flash\n",
520 fastboot_fail("invalid MBR partition", response);
523 if (write_mbr_sector(dev_desc, download_buffer)) {
524 printf("%s: writing MBR partition failed\n", __func__);
525 fastboot_fail("writing MBR partition failed",
530 printf("........ success\n");
531 fastboot_okay(NULL, response);
536 #ifdef CONFIG_ANDROID_BOOT_IMAGE
537 if (strncasecmp(cmd, "zimage", 6) == 0) {
538 fb_mmc_update_zimage(dev_desc, download_buffer,
539 download_bytes, response);
544 if (raw_part_get_info_by_name(dev_desc, cmd, &info, &mmcpart) == 0) {
545 if (blk_dselect_hwpart(dev_desc, mmcpart)) {
546 pr_err("Failed to select hwpart\n");
547 fastboot_fail("Failed to select hwpart", response);
550 } else if (part_get_info_by_name_or_alias(dev_desc, cmd, &info) < 0) {
551 pr_err("cannot find partition: '%s'\n", cmd);
552 fastboot_fail("cannot find partition", response);
556 if (is_sparse_image(download_buffer)) {
557 struct fb_mmc_sparse sparse_priv;
558 struct sparse_storage sparse;
561 sparse_priv.dev_desc = dev_desc;
563 sparse.blksz = info.blksz;
564 sparse.start = info.start;
565 sparse.size = info.size;
566 sparse.write = fb_mmc_sparse_write;
567 sparse.reserve = fb_mmc_sparse_reserve;
568 sparse.mssg = fastboot_fail;
570 printf("Flashing sparse image at offset " LBAFU "\n",
573 sparse.priv = &sparse_priv;
574 err = write_sparse_image(&sparse, cmd, download_buffer,
577 fastboot_okay(NULL, response);
579 write_raw_image(dev_desc, &info, cmd, download_buffer,
580 download_bytes, response);
585 * fastboot_mmc_flash_erase() - Erase eMMC for fastboot
587 * @cmd: Named partition to erase
588 * @response: Pointer to fastboot response buffer
590 void fastboot_mmc_erase(const char *cmd, char *response)
592 struct blk_desc *dev_desc;
593 struct disk_partition info;
594 lbaint_t blks, blks_start, blks_size, grp_size;
595 struct mmc *mmc = find_mmc_device(CONFIG_FASTBOOT_FLASH_MMC_DEV);
599 pr_err("invalid mmc device\n");
600 fastboot_fail("invalid mmc device", response);
604 dev_desc = blk_get_dev("mmc", CONFIG_FASTBOOT_FLASH_MMC_DEV);
605 if (!dev_desc || dev_desc->type == DEV_TYPE_UNKNOWN) {
606 pr_err("invalid mmc device\n");
607 fastboot_fail("invalid mmc device", response);
611 #ifdef CONFIG_FASTBOOT_MMC_BOOT_SUPPORT
612 if (strcmp(cmd, CONFIG_FASTBOOT_MMC_BOOT1_NAME) == 0) {
613 /* erase EMMC boot1 */
614 fb_mmc_boot_ops(dev_desc, NULL, 1, 0, response);
617 if (strcmp(cmd, CONFIG_FASTBOOT_MMC_BOOT2_NAME) == 0) {
618 /* erase EMMC boot2 */
619 fb_mmc_boot_ops(dev_desc, NULL, 2, 0, response);
624 #ifdef CONFIG_FASTBOOT_MMC_USER_SUPPORT
625 if (strcmp(cmd, CONFIG_FASTBOOT_MMC_USER_NAME) == 0) {
626 /* erase EMMC userdata */
627 if (fb_mmc_erase_mmc_hwpart(dev_desc))
628 fastboot_fail("Failed to erase EMMC_USER", response);
630 fastboot_okay(NULL, response);
635 if (raw_part_get_info_by_name(dev_desc, cmd, &info, &mmcpart) == 0) {
636 if (blk_dselect_hwpart(dev_desc, mmcpart)) {
637 pr_err("Failed to select hwpart\n");
638 fastboot_fail("Failed to select hwpart", response);
641 } else if (part_get_info_by_name_or_alias(dev_desc, cmd, &info) < 0) {
642 pr_err("cannot find partition: '%s'\n", cmd);
643 fastboot_fail("cannot find partition", response);
647 /* Align blocks to erase group size to avoid erasing other partitions */
648 grp_size = mmc->erase_grp_size;
649 blks_start = (info.start + grp_size - 1) & ~(grp_size - 1);
650 if (info.size >= grp_size)
651 blks_size = (info.size - (blks_start - info.start)) &
656 printf("Erasing blocks " LBAFU " to " LBAFU " due to alignment\n",
657 blks_start, blks_start + blks_size);
659 blks = fb_mmc_blk_write(dev_desc, blks_start, blks_size, NULL);
661 if (blks != blks_size) {
662 pr_err("failed erasing from device %d\n", dev_desc->devnum);
663 fastboot_fail("failed erasing from device", response);
667 printf("........ erased " LBAFU " bytes from '%s'\n",
668 blks_size * info.blksz, cmd);
669 fastboot_okay(NULL, response);