xref: /openbmc/u-boot/disk/part.c (revision 9ecb0c41)
1 /*
2  * (C) Copyright 2001
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #include <common.h>
9 #include <command.h>
10 #include <errno.h>
11 #include <ide.h>
12 #include <malloc.h>
13 #include <part.h>
14 #include <ubifs_uboot.h>
15 
16 #undef	PART_DEBUG
17 
18 #ifdef	PART_DEBUG
19 #define	PRINTF(fmt,args...)	printf (fmt ,##args)
20 #else
21 #define PRINTF(fmt,args...)
22 #endif
23 
24 const struct block_drvr block_drvr[] = {
25 #if defined(CONFIG_CMD_IDE)
26 	{ .name = "ide", .get_dev = ide_get_dev, },
27 #endif
28 #if defined(CONFIG_CMD_SATA)
29 	{.name = "sata", .get_dev = sata_get_dev, },
30 #endif
31 #if defined(CONFIG_CMD_SCSI)
32 	{ .name = "scsi", .get_dev = scsi_get_dev, },
33 #endif
34 #if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
35 	{ .name = "usb", .get_dev = usb_stor_get_dev, },
36 #endif
37 #if defined(CONFIG_MMC)
38 	{
39 		.name = "mmc",
40 		.get_dev = mmc_get_dev,
41 		.select_hwpart = mmc_select_hwpart,
42 	},
43 #endif
44 #if defined(CONFIG_SYSTEMACE)
45 	{ .name = "ace", .get_dev = systemace_get_dev, },
46 #endif
47 #if defined(CONFIG_SANDBOX)
48 	{ .name = "host", .get_dev = host_get_dev, },
49 #endif
50 	{ },
51 };
52 
53 DECLARE_GLOBAL_DATA_PTR;
54 
55 #ifdef HAVE_BLOCK_DEVICE
56 static struct part_driver *part_driver_lookup_type(int part_type)
57 {
58 	struct part_driver *drv =
59 		ll_entry_start(struct part_driver, part_driver);
60 	const int n_ents = ll_entry_count(struct part_driver, part_driver);
61 	struct part_driver *entry;
62 
63 	for (entry = drv; entry != drv + n_ents; entry++) {
64 		if (part_type == entry->part_type)
65 			return entry;
66 	}
67 
68 	/* Not found */
69 	return NULL;
70 }
71 
72 static struct blk_desc *get_dev_hwpart(const char *ifname, int dev, int hwpart)
73 {
74 	const struct block_drvr *drvr = block_drvr;
75 	struct blk_desc* (*reloc_get_dev)(int dev);
76 	int (*select_hwpart)(int dev_num, int hwpart);
77 	char *name;
78 	int ret;
79 
80 	if (!ifname)
81 		return NULL;
82 
83 	name = drvr->name;
84 #ifdef CONFIG_NEEDS_MANUAL_RELOC
85 	name += gd->reloc_off;
86 #endif
87 	while (drvr->name) {
88 		name = drvr->name;
89 		reloc_get_dev = drvr->get_dev;
90 		select_hwpart = drvr->select_hwpart;
91 #ifdef CONFIG_NEEDS_MANUAL_RELOC
92 		name += gd->reloc_off;
93 		reloc_get_dev += gd->reloc_off;
94 		if (select_hwpart)
95 			select_hwpart += gd->reloc_off;
96 #endif
97 		if (strncmp(ifname, name, strlen(name)) == 0) {
98 			struct blk_desc *dev_desc = reloc_get_dev(dev);
99 			if (!dev_desc)
100 				return NULL;
101 			if (hwpart == 0 && !select_hwpart)
102 				return dev_desc;
103 			if (!select_hwpart)
104 				return NULL;
105 			ret = select_hwpart(dev_desc->devnum, hwpart);
106 			if (ret < 0)
107 				return NULL;
108 			return dev_desc;
109 		}
110 		drvr++;
111 	}
112 	return NULL;
113 }
114 
115 struct blk_desc *blk_get_dev(const char *ifname, int dev)
116 {
117 	return get_dev_hwpart(ifname, dev, 0);
118 }
119 #else
120 struct blk_desc *get_dev_hwpart(const char *ifname, int dev, int hwpart)
121 {
122 	return NULL;
123 }
124 
125 struct blk_desc *blk_get_dev(const char *ifname, int dev)
126 {
127 	return NULL;
128 }
129 #endif
130 
131 #ifdef HAVE_BLOCK_DEVICE
132 
133 /* ------------------------------------------------------------------------- */
134 /*
135  * reports device info to the user
136  */
137 
138 #ifdef CONFIG_LBA48
139 typedef uint64_t lba512_t;
140 #else
141 typedef lbaint_t lba512_t;
142 #endif
143 
144 /*
145  * Overflowless variant of (block_count * mul_by / div_by)
146  * when div_by > mul_by
147  */
148 static lba512_t lba512_muldiv(lba512_t block_count, lba512_t mul_by, lba512_t div_by)
149 {
150 	lba512_t bc_quot, bc_rem;
151 
152 	/* x * m / d == x / d * m + (x % d) * m / d */
153 	bc_quot = block_count / div_by;
154 	bc_rem  = block_count - div_by * bc_quot;
155 	return bc_quot * mul_by + (bc_rem * mul_by) / div_by;
156 }
157 
158 void dev_print (struct blk_desc *dev_desc)
159 {
160 	lba512_t lba512; /* number of blocks if 512bytes block size */
161 
162 	if (dev_desc->type == DEV_TYPE_UNKNOWN) {
163 		puts ("not available\n");
164 		return;
165 	}
166 
167 	switch (dev_desc->if_type) {
168 	case IF_TYPE_SCSI:
169 		printf ("(%d:%d) Vendor: %s Prod.: %s Rev: %s\n",
170 			dev_desc->target,dev_desc->lun,
171 			dev_desc->vendor,
172 			dev_desc->product,
173 			dev_desc->revision);
174 		break;
175 	case IF_TYPE_ATAPI:
176 	case IF_TYPE_IDE:
177 	case IF_TYPE_SATA:
178 		printf ("Model: %s Firm: %s Ser#: %s\n",
179 			dev_desc->vendor,
180 			dev_desc->revision,
181 			dev_desc->product);
182 		break;
183 	case IF_TYPE_SD:
184 	case IF_TYPE_MMC:
185 	case IF_TYPE_USB:
186 		printf ("Vendor: %s Rev: %s Prod: %s\n",
187 			dev_desc->vendor,
188 			dev_desc->revision,
189 			dev_desc->product);
190 		break;
191 	case IF_TYPE_DOC:
192 		puts("device type DOC\n");
193 		return;
194 	case IF_TYPE_UNKNOWN:
195 		puts("device type unknown\n");
196 		return;
197 	default:
198 		printf("Unhandled device type: %i\n", dev_desc->if_type);
199 		return;
200 	}
201 	puts ("            Type: ");
202 	if (dev_desc->removable)
203 		puts ("Removable ");
204 	switch (dev_desc->type & 0x1F) {
205 	case DEV_TYPE_HARDDISK:
206 		puts ("Hard Disk");
207 		break;
208 	case DEV_TYPE_CDROM:
209 		puts ("CD ROM");
210 		break;
211 	case DEV_TYPE_OPDISK:
212 		puts ("Optical Device");
213 		break;
214 	case DEV_TYPE_TAPE:
215 		puts ("Tape");
216 		break;
217 	default:
218 		printf ("# %02X #", dev_desc->type & 0x1F);
219 		break;
220 	}
221 	puts ("\n");
222 	if (dev_desc->lba > 0L && dev_desc->blksz > 0L) {
223 		ulong mb, mb_quot, mb_rem, gb, gb_quot, gb_rem;
224 		lbaint_t lba;
225 
226 		lba = dev_desc->lba;
227 
228 		lba512 = (lba * (dev_desc->blksz/512));
229 		/* round to 1 digit */
230 		/* 2048 = (1024 * 1024) / 512 MB */
231 		mb = lba512_muldiv(lba512, 10, 2048);
232 
233 		mb_quot	= mb / 10;
234 		mb_rem	= mb - (10 * mb_quot);
235 
236 		gb = mb / 1024;
237 		gb_quot	= gb / 10;
238 		gb_rem	= gb - (10 * gb_quot);
239 #ifdef CONFIG_LBA48
240 		if (dev_desc->lba48)
241 			printf ("            Supports 48-bit addressing\n");
242 #endif
243 #if defined(CONFIG_SYS_64BIT_LBA)
244 		printf ("            Capacity: %ld.%ld MB = %ld.%ld GB (%Ld x %ld)\n",
245 			mb_quot, mb_rem,
246 			gb_quot, gb_rem,
247 			lba,
248 			dev_desc->blksz);
249 #else
250 		printf ("            Capacity: %ld.%ld MB = %ld.%ld GB (%ld x %ld)\n",
251 			mb_quot, mb_rem,
252 			gb_quot, gb_rem,
253 			(ulong)lba,
254 			dev_desc->blksz);
255 #endif
256 	} else {
257 		puts ("            Capacity: not available\n");
258 	}
259 }
260 #endif
261 
262 #ifdef HAVE_BLOCK_DEVICE
263 
264 void part_init(struct blk_desc *dev_desc)
265 {
266 	struct part_driver *drv =
267 		ll_entry_start(struct part_driver, part_driver);
268 	const int n_ents = ll_entry_count(struct part_driver, part_driver);
269 	struct part_driver *entry;
270 
271 	dev_desc->part_type = PART_TYPE_UNKNOWN;
272 	for (entry = drv; entry != drv + n_ents; entry++) {
273 		int ret;
274 
275 		ret = entry->test(dev_desc);
276 		debug("%s: try '%s': ret=%d\n", __func__, entry->name, ret);
277 		if (!ret) {
278 			dev_desc->part_type = entry->part_type;
279 			break;
280 		}
281 	}
282 }
283 
284 static void print_part_header(const char *type, struct blk_desc *dev_desc)
285 {
286 #if defined(CONFIG_MAC_PARTITION) || \
287 	defined(CONFIG_DOS_PARTITION) || \
288 	defined(CONFIG_ISO_PARTITION) || \
289 	defined(CONFIG_AMIGA_PARTITION) || \
290 	defined(CONFIG_EFI_PARTITION)
291 	puts ("\nPartition Map for ");
292 	switch (dev_desc->if_type) {
293 	case IF_TYPE_IDE:
294 		puts ("IDE");
295 		break;
296 	case IF_TYPE_SATA:
297 		puts ("SATA");
298 		break;
299 	case IF_TYPE_SCSI:
300 		puts ("SCSI");
301 		break;
302 	case IF_TYPE_ATAPI:
303 		puts ("ATAPI");
304 		break;
305 	case IF_TYPE_USB:
306 		puts ("USB");
307 		break;
308 	case IF_TYPE_DOC:
309 		puts ("DOC");
310 		break;
311 	case IF_TYPE_MMC:
312 		puts ("MMC");
313 		break;
314 	case IF_TYPE_HOST:
315 		puts("HOST");
316 		break;
317 	default:
318 		puts ("UNKNOWN");
319 		break;
320 	}
321 	printf (" device %d  --   Partition Type: %s\n\n",
322 			dev_desc->devnum, type);
323 #endif /* any CONFIG_..._PARTITION */
324 }
325 
326 void part_print(struct blk_desc *dev_desc)
327 {
328 	struct part_driver *drv;
329 
330 	drv = part_driver_lookup_type(dev_desc->part_type);
331 	if (!drv) {
332 		printf("## Unknown partition table type %x\n",
333 		       dev_desc->part_type);
334 		return;
335 	}
336 
337 	PRINTF("## Testing for valid %s partition ##\n", drv->name);
338 	print_part_header(drv->name, dev_desc);
339 	if (drv->print)
340 		drv->print(dev_desc);
341 }
342 
343 #endif /* HAVE_BLOCK_DEVICE */
344 
345 int part_get_info(struct blk_desc *dev_desc, int part,
346 		       disk_partition_t *info)
347 {
348 #ifdef HAVE_BLOCK_DEVICE
349 	struct part_driver *drv;
350 
351 #ifdef CONFIG_PARTITION_UUIDS
352 	/* The common case is no UUID support */
353 	info->uuid[0] = 0;
354 #endif
355 #ifdef CONFIG_PARTITION_TYPE_GUID
356 	info->type_guid[0] = 0;
357 #endif
358 
359 	drv = part_driver_lookup_type(dev_desc->part_type);
360 	if (!drv) {
361 		debug("## Unknown partition table type %x\n",
362 		      dev_desc->part_type);
363 		return -EPROTONOSUPPORT;
364 	}
365 	if (!drv->get_info) {
366 		PRINTF("## Driver %s does not have the get_info() method\n");
367 		return -ENOSYS;
368 	}
369 	if (drv->get_info(dev_desc, part, info) == 0) {
370 		PRINTF("## Valid %s partition found ##\n", drv->name);
371 		return 0;
372 	}
373 #endif /* HAVE_BLOCK_DEVICE */
374 
375 	return -1;
376 }
377 
378 int blk_get_device_by_str(const char *ifname, const char *dev_hwpart_str,
379 			  struct blk_desc **dev_desc)
380 {
381 	char *ep;
382 	char *dup_str = NULL;
383 	const char *dev_str, *hwpart_str;
384 	int dev, hwpart;
385 
386 	hwpart_str = strchr(dev_hwpart_str, '.');
387 	if (hwpart_str) {
388 		dup_str = strdup(dev_hwpart_str);
389 		dup_str[hwpart_str - dev_hwpart_str] = 0;
390 		dev_str = dup_str;
391 		hwpart_str++;
392 	} else {
393 		dev_str = dev_hwpart_str;
394 		hwpart = 0;
395 	}
396 
397 	dev = simple_strtoul(dev_str, &ep, 16);
398 	if (*ep) {
399 		printf("** Bad device specification %s %s **\n",
400 		       ifname, dev_str);
401 		dev = -1;
402 		goto cleanup;
403 	}
404 
405 	if (hwpart_str) {
406 		hwpart = simple_strtoul(hwpart_str, &ep, 16);
407 		if (*ep) {
408 			printf("** Bad HW partition specification %s %s **\n",
409 			    ifname, hwpart_str);
410 			dev = -1;
411 			goto cleanup;
412 		}
413 	}
414 
415 	*dev_desc = get_dev_hwpart(ifname, dev, hwpart);
416 	if (!(*dev_desc) || ((*dev_desc)->type == DEV_TYPE_UNKNOWN)) {
417 		printf("** Bad device %s %s **\n", ifname, dev_hwpart_str);
418 		dev = -1;
419 		goto cleanup;
420 	}
421 
422 #ifdef HAVE_BLOCK_DEVICE
423 	/*
424 	 * Updates the partition table for the specified hw partition.
425 	 * Does not need to be done for hwpart 0 since it is default and
426 	 * already loaded.
427 	 */
428 	if(hwpart != 0)
429 		part_init(*dev_desc);
430 #endif
431 
432 cleanup:
433 	free(dup_str);
434 	return dev;
435 }
436 
437 #define PART_UNSPECIFIED -2
438 #define PART_AUTO -1
439 #define MAX_SEARCH_PARTITIONS 16
440 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
441 			     struct blk_desc **dev_desc,
442 			     disk_partition_t *info, int allow_whole_dev)
443 {
444 	int ret = -1;
445 	const char *part_str;
446 	char *dup_str = NULL;
447 	const char *dev_str;
448 	int dev;
449 	char *ep;
450 	int p;
451 	int part;
452 	disk_partition_t tmpinfo;
453 
454 #ifdef CONFIG_SANDBOX
455 	/*
456 	 * Special-case a pseudo block device "hostfs", to allow access to the
457 	 * host's own filesystem.
458 	 */
459 	if (0 == strcmp(ifname, "hostfs")) {
460 		*dev_desc = NULL;
461 		info->start = 0;
462 		info->size = 0;
463 		info->blksz = 0;
464 		info->bootable = 0;
465 		strcpy((char *)info->type, BOOT_PART_TYPE);
466 		strcpy((char *)info->name, "Sandbox host");
467 #ifdef CONFIG_PARTITION_UUIDS
468 		info->uuid[0] = 0;
469 #endif
470 #ifdef CONFIG_PARTITION_TYPE_GUID
471 		info->type_guid[0] = 0;
472 #endif
473 
474 		return 0;
475 	}
476 #endif
477 
478 #ifdef CONFIG_CMD_UBIFS
479 	/*
480 	 * Special-case ubi, ubi goes through a mtd, rathen then through
481 	 * a regular block device.
482 	 */
483 	if (0 == strcmp(ifname, "ubi")) {
484 		if (!ubifs_is_mounted()) {
485 			printf("UBIFS not mounted, use ubifsmount to mount volume first!\n");
486 			return -1;
487 		}
488 
489 		*dev_desc = NULL;
490 		memset(info, 0, sizeof(*info));
491 		strcpy((char *)info->type, BOOT_PART_TYPE);
492 		strcpy((char *)info->name, "UBI");
493 #ifdef CONFIG_PARTITION_UUIDS
494 		info->uuid[0] = 0;
495 #endif
496 		return 0;
497 	}
498 #endif
499 
500 	/* If no dev_part_str, use bootdevice environment variable */
501 	if (!dev_part_str || !strlen(dev_part_str) ||
502 	    !strcmp(dev_part_str, "-"))
503 		dev_part_str = getenv("bootdevice");
504 
505 	/* If still no dev_part_str, it's an error */
506 	if (!dev_part_str) {
507 		printf("** No device specified **\n");
508 		goto cleanup;
509 	}
510 
511 	/* Separate device and partition ID specification */
512 	part_str = strchr(dev_part_str, ':');
513 	if (part_str) {
514 		dup_str = strdup(dev_part_str);
515 		dup_str[part_str - dev_part_str] = 0;
516 		dev_str = dup_str;
517 		part_str++;
518 	} else {
519 		dev_str = dev_part_str;
520 	}
521 
522 	/* Look up the device */
523 	dev = blk_get_device_by_str(ifname, dev_str, dev_desc);
524 	if (dev < 0)
525 		goto cleanup;
526 
527 	/* Convert partition ID string to number */
528 	if (!part_str || !*part_str) {
529 		part = PART_UNSPECIFIED;
530 	} else if (!strcmp(part_str, "auto")) {
531 		part = PART_AUTO;
532 	} else {
533 		/* Something specified -> use exactly that */
534 		part = (int)simple_strtoul(part_str, &ep, 16);
535 		/*
536 		 * Less than whole string converted,
537 		 * or request for whole device, but caller requires partition.
538 		 */
539 		if (*ep || (part == 0 && !allow_whole_dev)) {
540 			printf("** Bad partition specification %s %s **\n",
541 			    ifname, dev_part_str);
542 			goto cleanup;
543 		}
544 	}
545 
546 	/*
547 	 * No partition table on device,
548 	 * or user requested partition 0 (entire device).
549 	 */
550 	if (((*dev_desc)->part_type == PART_TYPE_UNKNOWN) ||
551 	    (part == 0)) {
552 		if (!(*dev_desc)->lba) {
553 			printf("** Bad device size - %s %s **\n", ifname,
554 			       dev_str);
555 			goto cleanup;
556 		}
557 
558 		/*
559 		 * If user specified a partition ID other than 0,
560 		 * or the calling command only accepts partitions,
561 		 * it's an error.
562 		 */
563 		if ((part > 0) || (!allow_whole_dev)) {
564 			printf("** No partition table - %s %s **\n", ifname,
565 			       dev_str);
566 			goto cleanup;
567 		}
568 
569 		(*dev_desc)->log2blksz = LOG2((*dev_desc)->blksz);
570 
571 		info->start = 0;
572 		info->size = (*dev_desc)->lba;
573 		info->blksz = (*dev_desc)->blksz;
574 		info->bootable = 0;
575 		strcpy((char *)info->type, BOOT_PART_TYPE);
576 		strcpy((char *)info->name, "Whole Disk");
577 #ifdef CONFIG_PARTITION_UUIDS
578 		info->uuid[0] = 0;
579 #endif
580 #ifdef CONFIG_PARTITION_TYPE_GUID
581 		info->type_guid[0] = 0;
582 #endif
583 
584 		ret = 0;
585 		goto cleanup;
586 	}
587 
588 	/*
589 	 * Now there's known to be a partition table,
590 	 * not specifying a partition means to pick partition 1.
591 	 */
592 	if (part == PART_UNSPECIFIED)
593 		part = 1;
594 
595 	/*
596 	 * If user didn't specify a partition number, or did specify something
597 	 * other than "auto", use that partition number directly.
598 	 */
599 	if (part != PART_AUTO) {
600 		ret = part_get_info(*dev_desc, part, info);
601 		if (ret) {
602 			printf("** Invalid partition %d **\n", part);
603 			goto cleanup;
604 		}
605 	} else {
606 		/*
607 		 * Find the first bootable partition.
608 		 * If none are bootable, fall back to the first valid partition.
609 		 */
610 		part = 0;
611 		for (p = 1; p <= MAX_SEARCH_PARTITIONS; p++) {
612 			ret = part_get_info(*dev_desc, p, info);
613 			if (ret)
614 				continue;
615 
616 			/*
617 			 * First valid partition, or new better partition?
618 			 * If so, save partition ID.
619 			 */
620 			if (!part || info->bootable)
621 				part = p;
622 
623 			/* Best possible partition? Stop searching. */
624 			if (info->bootable)
625 				break;
626 
627 			/*
628 			 * We now need to search further for best possible.
629 			 * If we what we just queried was the best so far,
630 			 * save the info since we over-write it next loop.
631 			 */
632 			if (part == p)
633 				tmpinfo = *info;
634 		}
635 		/* If we found any acceptable partition */
636 		if (part) {
637 			/*
638 			 * If we searched all possible partition IDs,
639 			 * return the first valid partition we found.
640 			 */
641 			if (p == MAX_SEARCH_PARTITIONS + 1)
642 				*info = tmpinfo;
643 		} else {
644 			printf("** No valid partitions found **\n");
645 			ret = -1;
646 			goto cleanup;
647 		}
648 	}
649 	if (strncmp((char *)info->type, BOOT_PART_TYPE, sizeof(info->type)) != 0) {
650 		printf("** Invalid partition type \"%.32s\""
651 			" (expect \"" BOOT_PART_TYPE "\")\n",
652 			info->type);
653 		ret  = -1;
654 		goto cleanup;
655 	}
656 
657 	(*dev_desc)->log2blksz = LOG2((*dev_desc)->blksz);
658 
659 	ret = part;
660 	goto cleanup;
661 
662 cleanup:
663 	free(dup_str);
664 	return ret;
665 }
666