]> git.sur5r.net Git - u-boot/blob - drivers/fastboot/fb_mmc.c
fastboot: Refactor fastboot_okay/fail to take response
[u-boot] / drivers / fastboot / fb_mmc.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright 2014 Broadcom Corporation.
4  */
5
6 #include <config.h>
7 #include <common.h>
8 #include <blk.h>
9 #include <fastboot.h>
10 #include <fb_mmc.h>
11 #include <image-sparse.h>
12 #include <part.h>
13 #include <mmc.h>
14 #include <div64.h>
15 #include <linux/compat.h>
16 #include <android_image.h>
17
18 /*
19  * FIXME: Ensure we always set these names via Kconfig once xxx_PARTITION is
20  * migrated
21  */
22 #ifndef CONFIG_FASTBOOT_GPT_NAME
23 #define CONFIG_FASTBOOT_GPT_NAME "gpt"
24 #endif
25
26
27 #ifndef CONFIG_FASTBOOT_MBR_NAME
28 #define CONFIG_FASTBOOT_MBR_NAME "mbr"
29 #endif
30
31 #define BOOT_PARTITION_NAME "boot"
32
33 struct fb_mmc_sparse {
34         struct blk_desc *dev_desc;
35 };
36
37 static int part_get_info_by_name_or_alias(struct blk_desc *dev_desc,
38                 const char *name, disk_partition_t *info)
39 {
40         int ret;
41
42         ret = part_get_info_by_name(dev_desc, name, info);
43         if (ret < 0) {
44                 /* strlen("fastboot_partition_alias_") + 32(part_name) + 1 */
45                 char env_alias_name[25 + 32 + 1];
46                 char *aliased_part_name;
47
48                 /* check for alias */
49                 strcpy(env_alias_name, "fastboot_partition_alias_");
50                 strncat(env_alias_name, name, 32);
51                 aliased_part_name = env_get(env_alias_name);
52                 if (aliased_part_name != NULL)
53                         ret = part_get_info_by_name(dev_desc,
54                                         aliased_part_name, info);
55         }
56         return ret;
57 }
58
59 static lbaint_t fb_mmc_sparse_write(struct sparse_storage *info,
60                 lbaint_t blk, lbaint_t blkcnt, const void *buffer)
61 {
62         struct fb_mmc_sparse *sparse = info->priv;
63         struct blk_desc *dev_desc = sparse->dev_desc;
64
65         return blk_dwrite(dev_desc, blk, blkcnt, buffer);
66 }
67
68 static lbaint_t fb_mmc_sparse_reserve(struct sparse_storage *info,
69                 lbaint_t blk, lbaint_t blkcnt)
70 {
71         return blkcnt;
72 }
73
74 static void write_raw_image(struct blk_desc *dev_desc, disk_partition_t *info,
75                 const char *part_name, void *buffer,
76                 unsigned int download_bytes, char *response)
77 {
78         lbaint_t blkcnt;
79         lbaint_t blks;
80
81         /* determine number of blocks to write */
82         blkcnt = ((download_bytes + (info->blksz - 1)) & ~(info->blksz - 1));
83         blkcnt = lldiv(blkcnt, info->blksz);
84
85         if (blkcnt > info->size) {
86                 pr_err("too large for partition: '%s'\n", part_name);
87                 fastboot_fail("too large for partition", response);
88                 return;
89         }
90
91         puts("Flashing Raw Image\n");
92
93         blks = blk_dwrite(dev_desc, info->start, blkcnt, buffer);
94         if (blks != blkcnt) {
95                 pr_err("failed writing to device %d\n", dev_desc->devnum);
96                 fastboot_fail("failed writing to device", response);
97                 return;
98         }
99
100         printf("........ wrote " LBAFU " bytes to '%s'\n", blkcnt * info->blksz,
101                part_name);
102         fastboot_okay(NULL, response);
103 }
104
105 #ifdef CONFIG_ANDROID_BOOT_IMAGE
106 /**
107  * Read Android boot image header from boot partition.
108  *
109  * @param[in] dev_desc MMC device descriptor
110  * @param[in] info Boot partition info
111  * @param[out] hdr Where to store read boot image header
112  *
113  * @return Boot image header sectors count or 0 on error
114  */
115 static lbaint_t fb_mmc_get_boot_header(struct blk_desc *dev_desc,
116                                        disk_partition_t *info,
117                                        struct andr_img_hdr *hdr,
118                                        char *response)
119 {
120         ulong sector_size;              /* boot partition sector size */
121         lbaint_t hdr_sectors;           /* boot image header sectors count */
122         int res;
123
124         /* Calculate boot image sectors count */
125         sector_size = info->blksz;
126         hdr_sectors = DIV_ROUND_UP(sizeof(struct andr_img_hdr), sector_size);
127         if (hdr_sectors == 0) {
128                 pr_err("invalid number of boot sectors: 0");
129                 fastboot_fail("invalid number of boot sectors: 0", response);
130                 return 0;
131         }
132
133         /* Read the boot image header */
134         res = blk_dread(dev_desc, info->start, hdr_sectors, (void *)hdr);
135         if (res != hdr_sectors) {
136                 pr_err("cannot read header from boot partition");
137                 fastboot_fail("cannot read header from boot partition",
138                               response);
139                 return 0;
140         }
141
142         /* Check boot header magic string */
143         res = android_image_check_header(hdr);
144         if (res != 0) {
145                 pr_err("bad boot image magic");
146                 fastboot_fail("boot partition not initialized", response);
147                 return 0;
148         }
149
150         return hdr_sectors;
151 }
152
153 /**
154  * Write downloaded zImage to boot partition and repack it properly.
155  *
156  * @param dev_desc MMC device descriptor
157  * @param download_buffer Address to fastboot buffer with zImage in it
158  * @param download_bytes Size of fastboot buffer, in bytes
159  *
160  * @return 0 on success or -1 on error
161  */
162 static int fb_mmc_update_zimage(struct blk_desc *dev_desc,
163                                 void *download_buffer,
164                                 unsigned int download_bytes,
165                                 char *response)
166 {
167         uintptr_t hdr_addr;                     /* boot image header address */
168         struct andr_img_hdr *hdr;               /* boot image header */
169         lbaint_t hdr_sectors;                   /* boot image header sectors */
170         u8 *ramdisk_buffer;
171         u32 ramdisk_sector_start;
172         u32 ramdisk_sectors;
173         u32 kernel_sector_start;
174         u32 kernel_sectors;
175         u32 sectors_per_page;
176         disk_partition_t info;
177         int res;
178
179         puts("Flashing zImage\n");
180
181         /* Get boot partition info */
182         res = part_get_info_by_name(dev_desc, BOOT_PARTITION_NAME, &info);
183         if (res < 0) {
184                 pr_err("cannot find boot partition");
185                 fastboot_fail("cannot find boot partition", response);
186                 return -1;
187         }
188
189         /* Put boot image header in fastboot buffer after downloaded zImage */
190         hdr_addr = (uintptr_t)download_buffer + ALIGN(download_bytes, PAGE_SIZE);
191         hdr = (struct andr_img_hdr *)hdr_addr;
192
193         /* Read boot image header */
194         hdr_sectors = fb_mmc_get_boot_header(dev_desc, &info, hdr, response);
195         if (hdr_sectors == 0) {
196                 pr_err("unable to read boot image header");
197                 fastboot_fail("unable to read boot image header", response);
198                 return -1;
199         }
200
201         /* Check if boot image has second stage in it (we don't support it) */
202         if (hdr->second_size > 0) {
203                 pr_err("moving second stage is not supported yet");
204                 fastboot_fail("moving second stage is not supported yet",
205                               response);
206                 return -1;
207         }
208
209         /* Extract ramdisk location */
210         sectors_per_page = hdr->page_size / info.blksz;
211         ramdisk_sector_start = info.start + sectors_per_page;
212         ramdisk_sector_start += DIV_ROUND_UP(hdr->kernel_size, hdr->page_size) *
213                                              sectors_per_page;
214         ramdisk_sectors = DIV_ROUND_UP(hdr->ramdisk_size, hdr->page_size) *
215                                        sectors_per_page;
216
217         /* Read ramdisk and put it in fastboot buffer after boot image header */
218         ramdisk_buffer = (u8 *)hdr + (hdr_sectors * info.blksz);
219         res = blk_dread(dev_desc, ramdisk_sector_start, ramdisk_sectors,
220                         ramdisk_buffer);
221         if (res != ramdisk_sectors) {
222                 pr_err("cannot read ramdisk from boot partition");
223                 fastboot_fail("cannot read ramdisk from boot partition",
224                               response);
225                 return -1;
226         }
227
228         /* Write new kernel size to boot image header */
229         hdr->kernel_size = download_bytes;
230         res = blk_dwrite(dev_desc, info.start, hdr_sectors, (void *)hdr);
231         if (res == 0) {
232                 pr_err("cannot writeback boot image header");
233                 fastboot_fail("cannot write back boot image header", response);
234                 return -1;
235         }
236
237         /* Write the new downloaded kernel */
238         kernel_sector_start = info.start + sectors_per_page;
239         kernel_sectors = DIV_ROUND_UP(hdr->kernel_size, hdr->page_size) *
240                                       sectors_per_page;
241         res = blk_dwrite(dev_desc, kernel_sector_start, kernel_sectors,
242                          download_buffer);
243         if (res == 0) {
244                 pr_err("cannot write new kernel");
245                 fastboot_fail("cannot write new kernel", response);
246                 return -1;
247         }
248
249         /* Write the saved ramdisk back */
250         ramdisk_sector_start = info.start + sectors_per_page;
251         ramdisk_sector_start += DIV_ROUND_UP(hdr->kernel_size, hdr->page_size) *
252                                              sectors_per_page;
253         res = blk_dwrite(dev_desc, ramdisk_sector_start, ramdisk_sectors,
254                          ramdisk_buffer);
255         if (res == 0) {
256                 pr_err("cannot write back original ramdisk");
257                 fastboot_fail("cannot write back original ramdisk", response);
258                 return -1;
259         }
260
261         puts("........ zImage was updated in boot partition\n");
262         fastboot_okay(NULL, response);
263         return 0;
264 }
265 #endif
266
267 void fb_mmc_flash_write(const char *cmd, void *download_buffer,
268                         unsigned int download_bytes, char *response)
269 {
270         struct blk_desc *dev_desc;
271         disk_partition_t info;
272
273         dev_desc = blk_get_dev("mmc", CONFIG_FASTBOOT_FLASH_MMC_DEV);
274         if (!dev_desc || dev_desc->type == DEV_TYPE_UNKNOWN) {
275                 pr_err("invalid mmc device\n");
276                 fastboot_fail("invalid mmc device", response);
277                 return;
278         }
279
280 #if CONFIG_IS_ENABLED(EFI_PARTITION)
281         if (strcmp(cmd, CONFIG_FASTBOOT_GPT_NAME) == 0) {
282                 printf("%s: updating MBR, Primary and Backup GPT(s)\n",
283                        __func__);
284                 if (is_valid_gpt_buf(dev_desc, download_buffer)) {
285                         printf("%s: invalid GPT - refusing to write to flash\n",
286                                __func__);
287                         fastboot_fail("invalid GPT partition", response);
288                         return;
289                 }
290                 if (write_mbr_and_gpt_partitions(dev_desc, download_buffer)) {
291                         printf("%s: writing GPT partitions failed\n", __func__);
292                         fastboot_fail("writing GPT partitions failed",
293                                       response);
294                         return;
295                 }
296                 printf("........ success\n");
297                 fastboot_okay(NULL, response);
298                 return;
299         }
300 #endif
301
302 #if CONFIG_IS_ENABLED(DOS_PARTITION)
303         if (strcmp(cmd, CONFIG_FASTBOOT_MBR_NAME) == 0) {
304                 printf("%s: updating MBR\n", __func__);
305                 if (is_valid_dos_buf(download_buffer)) {
306                         printf("%s: invalid MBR - refusing to write to flash\n",
307                                __func__);
308                         fastboot_fail("invalid MBR partition", response);
309                         return;
310                 }
311                 if (write_mbr_partition(dev_desc, download_buffer)) {
312                         printf("%s: writing MBR partition failed\n", __func__);
313                         fastboot_fail("writing MBR partition failed",
314                                       response);
315                         return;
316                 }
317                 printf("........ success\n");
318                 fastboot_okay(NULL, response);
319                 return;
320         }
321 #endif
322
323 #ifdef CONFIG_ANDROID_BOOT_IMAGE
324         if (strncasecmp(cmd, "zimage", 6) == 0) {
325                 fb_mmc_update_zimage(dev_desc, download_buffer,
326                                      download_bytes, response);
327                 return;
328         }
329 #endif
330
331         if (part_get_info_by_name_or_alias(dev_desc, cmd, &info) < 0) {
332                 pr_err("cannot find partition: '%s'\n", cmd);
333                 fastboot_fail("cannot find partition", response);
334                 return;
335         }
336
337         if (is_sparse_image(download_buffer)) {
338                 struct fb_mmc_sparse sparse_priv;
339                 struct sparse_storage sparse;
340                 int err;
341
342                 sparse_priv.dev_desc = dev_desc;
343
344                 sparse.blksz = info.blksz;
345                 sparse.start = info.start;
346                 sparse.size = info.size;
347                 sparse.write = fb_mmc_sparse_write;
348                 sparse.reserve = fb_mmc_sparse_reserve;
349                 sparse.mssg = fastboot_fail;
350
351                 printf("Flashing sparse image at offset " LBAFU "\n",
352                        sparse.start);
353
354                 sparse.priv = &sparse_priv;
355                 err = write_sparse_image(&sparse, cmd, download_buffer,
356                                          response);
357                 if (!err)
358                         fastboot_okay(NULL, response);
359         } else {
360                 write_raw_image(dev_desc, &info, cmd, download_buffer,
361                                 download_bytes, response);
362         }
363 }
364
365 void fb_mmc_erase(const char *cmd, char *response)
366 {
367         int ret;
368         struct blk_desc *dev_desc;
369         disk_partition_t info;
370         lbaint_t blks, blks_start, blks_size, grp_size;
371         struct mmc *mmc = find_mmc_device(CONFIG_FASTBOOT_FLASH_MMC_DEV);
372
373         if (mmc == NULL) {
374                 pr_err("invalid mmc device");
375                 fastboot_fail("invalid mmc device", response);
376                 return;
377         }
378
379         dev_desc = blk_get_dev("mmc", CONFIG_FASTBOOT_FLASH_MMC_DEV);
380         if (!dev_desc || dev_desc->type == DEV_TYPE_UNKNOWN) {
381                 pr_err("invalid mmc device");
382                 fastboot_fail("invalid mmc device", response);
383                 return;
384         }
385
386         ret = part_get_info_by_name_or_alias(dev_desc, cmd, &info);
387         if (ret < 0) {
388                 pr_err("cannot find partition: '%s'", cmd);
389                 fastboot_fail("cannot find partition", response);
390                 return;
391         }
392
393         /* Align blocks to erase group size to avoid erasing other partitions */
394         grp_size = mmc->erase_grp_size;
395         blks_start = (info.start + grp_size - 1) & ~(grp_size - 1);
396         if (info.size >= grp_size)
397                 blks_size = (info.size - (blks_start - info.start)) &
398                                 (~(grp_size - 1));
399         else
400                 blks_size = 0;
401
402         printf("Erasing blocks " LBAFU " to " LBAFU " due to alignment\n",
403                blks_start, blks_start + blks_size);
404
405         blks = blk_derase(dev_desc, blks_start, blks_size);
406         if (blks != blks_size) {
407                 pr_err("failed erasing from device %d", dev_desc->devnum);
408                 fastboot_fail("failed erasing from device", response);
409                 return;
410         }
411
412         printf("........ erased " LBAFU " bytes from '%s'\n",
413                blks_size * info.blksz, cmd);
414         fastboot_okay(NULL, response);
415 }