Complete migration of MTDPARTS_DEFAULT / MTDIDS_DEFAULT, include in environment
[platform/kernel/u-boot.git] / cmd / gpt.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * cmd_gpt.c -- GPT (GUID Partition Table) handling command
4  *
5  * Copyright (C) 2015
6  * Lukasz Majewski <l.majewski@majess.pl>
7  *
8  * Copyright (C) 2012 Samsung Electronics
9  * author: Lukasz Majewski <l.majewski@samsung.com>
10  * author: Piotr Wilczek <p.wilczek@samsung.com>
11  */
12
13 #include <common.h>
14 #include <blk.h>
15 #include <env.h>
16 #include <log.h>
17 #include <malloc.h>
18 #include <command.h>
19 #include <part.h>
20 #include <part_efi.h>
21 #include <part.h>
22 #include <exports.h>
23 #include <uuid.h>
24 #include <linux/ctype.h>
25 #include <div64.h>
26 #include <memalign.h>
27 #include <linux/compat.h>
28 #include <linux/err.h>
29 #include <linux/sizes.h>
30 #include <stdlib.h>
31
32 static LIST_HEAD(disk_partitions);
33
34 /**
35  * extract_env(): Expand env name from string format '&{env_name}'
36  *                and return pointer to the env (if the env is set)
37  *
38  * @param str - pointer to string
39  * @param env - pointer to pointer to extracted env
40  *
41  * Return: - zero on successful expand and env is set
42  */
43 static int extract_env(const char *str, char **env)
44 {
45         int ret = -1;
46         char *e, *s;
47 #ifdef CONFIG_RANDOM_UUID
48         char uuid_str[UUID_STR_LEN + 1];
49 #endif
50
51         if (!str || strlen(str) < 4)
52                 return -1;
53
54         if (!((strncmp(str, "${", 2) == 0) && (str[strlen(str) - 1] == '}')))
55                 return -1;
56
57         s = strdup(str);
58         if (s == NULL)
59                 return -1;
60
61         memset(s + strlen(s) - 1, '\0', 1);
62         memmove(s, s + 2, strlen(s) - 1);
63
64         e = env_get(s);
65         if (e == NULL) {
66 #ifdef CONFIG_RANDOM_UUID
67                 debug("%s unset. ", str);
68                 gen_rand_uuid_str(uuid_str, UUID_STR_FORMAT_GUID);
69                 env_set(s, uuid_str);
70
71                 e = env_get(s);
72                 if (e) {
73                         debug("Set to random.\n");
74                         ret = 0;
75                 } else {
76                         debug("Can't get random UUID.\n");
77                 }
78 #else
79                 debug("%s unset.\n", str);
80 #endif
81         } else {
82                 debug("%s get from environment.\n", str);
83                 ret = 0;
84         }
85
86         *env = e;
87         free(s);
88
89         return ret;
90 }
91
92 /**
93  * extract_val(): Extract value from a key=value pair list (comma separated).
94  *                Only value for the given key is returend.
95  *                Function allocates memory for the value, remember to free!
96  *
97  * @param str - pointer to string with key=values pairs
98  * @param key - pointer to the key to search for
99  *
100  * Return: - pointer to allocated string with the value
101  */
102 static char *extract_val(const char *str, const char *key)
103 {
104         char *v, *k;
105         char *s, *strcopy;
106         char *new = NULL;
107
108         strcopy = strdup(str);
109         if (strcopy == NULL)
110                 return NULL;
111
112         s = strcopy;
113         while (s) {
114                 v = strsep(&s, ",");
115                 if (!v)
116                         break;
117                 k = strsep(&v, "=");
118                 if (!k)
119                         break;
120                 if  (strcmp(k, key) == 0) {
121                         new = strdup(v);
122                         break;
123                 }
124         }
125
126         free(strcopy);
127
128         return new;
129 }
130
131 /**
132  * found_key(): Found key without value in parameter list (comma separated).
133  *
134  * @param str - pointer to string with key
135  * @param key - pointer to the key to search for
136  *
137  * Return: - true on found key
138  */
139 static bool found_key(const char *str, const char *key)
140 {
141         char *k;
142         char *s, *strcopy;
143         bool result = false;
144
145         strcopy = strdup(str);
146         if (!strcopy)
147                 return NULL;
148
149         s = strcopy;
150         while (s) {
151                 k = strsep(&s, ",");
152                 if (!k)
153                         break;
154                 if  (strcmp(k, key) == 0) {
155                         result = true;
156                         break;
157                 }
158         }
159
160         free(strcopy);
161
162         return result;
163 }
164
165 static int calc_parts_list_len(int numparts)
166 {
167         int partlistlen = UUID_STR_LEN + 1 + strlen("uuid_disk=");
168         /* for the comma */
169         partlistlen++;
170
171         /* per-partition additions; numparts starts at 1, so this should be correct */
172         partlistlen += numparts * (strlen("name=,") + PART_NAME_LEN + 1);
173         /* see part.h for definition of struct disk_partition */
174         partlistlen += numparts * (strlen("start=MiB,") + sizeof(lbaint_t) + 1);
175         partlistlen += numparts * (strlen("size=MiB,") + sizeof(lbaint_t) + 1);
176         partlistlen += numparts * (strlen("uuid=;") + UUID_STR_LEN + 1);
177         /* for the terminating null */
178         partlistlen++;
179         debug("Length of partitions_list is %d for %d partitions\n", partlistlen,
180               numparts);
181         return partlistlen;
182 }
183
184 #ifdef CONFIG_CMD_GPT_RENAME
185 static void del_gpt_info(void)
186 {
187         struct list_head *pos = &disk_partitions;
188         struct disk_part *curr;
189         while (!list_empty(pos)) {
190                 curr = list_entry(pos->next, struct disk_part, list);
191                 list_del(pos->next);
192                 free(curr);
193         }
194 }
195
196 static struct disk_part *allocate_disk_part(struct disk_partition *info,
197                                             int partnum)
198 {
199         struct disk_part *newpart;
200         newpart = calloc(1, sizeof(struct disk_part));
201         if (!newpart)
202                 return ERR_PTR(-ENOMEM);
203
204         newpart->gpt_part_info.start = info->start;
205         newpart->gpt_part_info.size = info->size;
206         newpart->gpt_part_info.blksz = info->blksz;
207         strncpy((char *)newpart->gpt_part_info.name, (const char *)info->name,
208                 PART_NAME_LEN);
209         newpart->gpt_part_info.name[PART_NAME_LEN - 1] = '\0';
210         strncpy((char *)newpart->gpt_part_info.type, (const char *)info->type,
211                 PART_TYPE_LEN);
212         newpart->gpt_part_info.type[PART_TYPE_LEN - 1] = '\0';
213         newpart->gpt_part_info.bootable = info->bootable;
214 #ifdef CONFIG_PARTITION_UUIDS
215         strncpy(newpart->gpt_part_info.uuid, (const char *)info->uuid,
216                 UUID_STR_LEN);
217         /* UUID_STR_LEN is correct, as uuid[]'s length is UUID_STR_LEN+1 chars */
218         newpart->gpt_part_info.uuid[UUID_STR_LEN] = '\0';
219 #endif
220         newpart->partnum = partnum;
221
222         return newpart;
223 }
224
225 static void prettyprint_part_size(char *sizestr, lbaint_t partsize,
226                                   lbaint_t blksize)
227 {
228         unsigned long long partbytes, partmegabytes;
229
230         partbytes = partsize * blksize;
231         partmegabytes = lldiv(partbytes, SZ_1M);
232         snprintf(sizestr, 16, "%lluMiB", partmegabytes);
233 }
234
235 static void print_gpt_info(void)
236 {
237         struct list_head *pos;
238         struct disk_part *curr;
239         char partstartstr[16];
240         char partsizestr[16];
241
242         list_for_each(pos, &disk_partitions) {
243                 curr = list_entry(pos, struct disk_part, list);
244                 prettyprint_part_size(partstartstr, curr->gpt_part_info.start,
245                                       curr->gpt_part_info.blksz);
246                 prettyprint_part_size(partsizestr, curr->gpt_part_info.size,
247                                       curr->gpt_part_info.blksz);
248
249                 printf("Partition %d:\n", curr->partnum);
250                 printf("Start %s, size %s\n", partstartstr, partsizestr);
251                 printf("Block size %lu, name %s\n", curr->gpt_part_info.blksz,
252                        curr->gpt_part_info.name);
253                 printf("Type %s, bootable %d\n", curr->gpt_part_info.type,
254                        curr->gpt_part_info.bootable & PART_BOOTABLE);
255 #ifdef CONFIG_PARTITION_UUIDS
256                 printf("UUID %s\n", curr->gpt_part_info.uuid);
257 #endif
258                 printf("\n");
259         }
260 }
261
262 /*
263  * create the string that upstream 'gpt write' command will accept as an
264  * argument
265  *
266  * From doc/README.gpt, Format of partitions layout:
267  *    "uuid_disk=...;name=u-boot,size=60MiB,uuid=...;
268  *      name=kernel,size=60MiB,uuid=...;"
269  * The fields 'name' and 'size' are mandatory for every partition.
270  * The field 'start' is optional. The fields 'uuid' and 'uuid_disk'
271  * are optional if CONFIG_RANDOM_UUID is enabled.
272  */
273 static int create_gpt_partitions_list(int numparts, const char *guid,
274                                       char *partitions_list)
275 {
276         struct list_head *pos;
277         struct disk_part *curr;
278         char partstr[PART_NAME_LEN + 1];
279
280         if (!partitions_list)
281                 return -EINVAL;
282
283         strcpy(partitions_list, "uuid_disk=");
284         strncat(partitions_list, guid, UUID_STR_LEN + 1);
285         strcat(partitions_list, ";");
286
287         list_for_each(pos, &disk_partitions) {
288                 curr = list_entry(pos, struct disk_part, list);
289                 strcat(partitions_list, "name=");
290                 strncat(partitions_list, (const char *)curr->gpt_part_info.name,
291                         PART_NAME_LEN + 1);
292                 sprintf(partstr, ",start=0x%llx",
293                         (unsigned long long)curr->gpt_part_info.start *
294                                             curr->gpt_part_info.blksz);
295                 /* one extra byte for NULL */
296                 strncat(partitions_list, partstr, PART_NAME_LEN + 1);
297                 sprintf(partstr, ",size=0x%llx",
298                         (unsigned long long)curr->gpt_part_info.size *
299                                             curr->gpt_part_info.blksz);
300                 strncat(partitions_list, partstr, PART_NAME_LEN + 1);
301
302                 strcat(partitions_list, ",uuid=");
303                 strncat(partitions_list, curr->gpt_part_info.uuid,
304                         UUID_STR_LEN + 1);
305                 strcat(partitions_list, ";");
306         }
307         return 0;
308 }
309
310 /*
311  * read partition info into disk_partitions list where
312  * it can be printed or modified
313  */
314 static int get_gpt_info(struct blk_desc *dev_desc)
315 {
316         /* start partition numbering at 1, as U-Boot does */
317         int valid_parts = 0, p, ret;
318         struct disk_partition info;
319         struct disk_part *new_disk_part;
320
321         /*
322          * Always re-read partition info from device, in case
323          * it has changed
324          */
325         INIT_LIST_HEAD(&disk_partitions);
326
327         for (p = 1; p <= MAX_SEARCH_PARTITIONS; p++) {
328                 ret = part_get_info(dev_desc, p, &info);
329                 if (ret)
330                         continue;
331
332                 /* Add 1 here because counter is zero-based but p1 is
333                    the first partition */
334                 new_disk_part = allocate_disk_part(&info, valid_parts+1);
335                 if (IS_ERR(new_disk_part))
336                         goto out;
337
338                 list_add_tail(&new_disk_part->list, &disk_partitions);
339                 valid_parts++;
340         }
341         if (valid_parts == 0) {
342                 printf("** No valid partitions found **\n");
343                 goto out;
344         }
345         return valid_parts;
346  out:
347         if (valid_parts >= 1)
348                 del_gpt_info();
349         return -ENODEV;
350 }
351
352 /* a wrapper to test get_gpt_info */
353 static int do_get_gpt_info(struct blk_desc *dev_desc, char * const namestr)
354 {
355         int numparts;
356
357         numparts = get_gpt_info(dev_desc);
358
359         if (numparts > 0) {
360                 if (namestr) {
361                         char disk_guid[UUID_STR_LEN + 1];
362                         char *partitions_list;
363                         int partlistlen;
364                         int ret = -1;
365
366                         ret = get_disk_guid(dev_desc, disk_guid);
367                         if (ret < 0)
368                                 return ret;
369
370                         partlistlen = calc_parts_list_len(numparts);
371                         partitions_list = malloc(partlistlen);
372                         if (!partitions_list) {
373                                 del_gpt_info();
374                                 return -ENOMEM;
375                         }
376                         memset(partitions_list, '\0', partlistlen);
377
378                         ret = create_gpt_partitions_list(numparts, disk_guid,
379                                                          partitions_list);
380                         if (ret < 0)
381                                 printf("Error: Could not create partition list string!\n");
382                         else
383                                 env_set(namestr, partitions_list);
384
385                         free(partitions_list);
386                 } else {
387                         print_gpt_info();
388                 }
389                 del_gpt_info();
390                 return 0;
391         }
392         return numparts;
393 }
394 #endif
395
396 /**
397  * set_gpt_info(): Fill partition information from string
398  *              function allocates memory, remember to free!
399  *
400  * @param dev_desc - pointer block device descriptor
401  * @param str_part - pointer to string with partition information
402  * @param str_disk_guid - pointer to pointer to allocated string with disk guid
403  * @param partitions - pointer to pointer to allocated partitions array
404  * @param parts_count - number of partitions
405  *
406  * Return: - zero on success, otherwise error
407  *
408  */
409 static int set_gpt_info(struct blk_desc *dev_desc,
410                         const char *str_part,
411                         char **str_disk_guid,
412                         struct disk_partition **partitions,
413                         u8 *parts_count)
414 {
415         char *tok, *str, *s;
416         int i;
417         char *val, *p;
418         int p_count;
419         struct disk_partition *parts;
420         int errno = 0;
421         uint64_t size_ll, start_ll;
422         lbaint_t offset = 0;
423         int max_str_part = calc_parts_list_len(MAX_SEARCH_PARTITIONS);
424
425         debug("%s:  lba num: 0x%x %d\n", __func__,
426               (unsigned int)dev_desc->lba, (unsigned int)dev_desc->lba);
427
428         if (str_part == NULL)
429                 return -1;
430
431         str = strdup(str_part);
432         if (str == NULL)
433                 return -ENOMEM;
434
435         /* extract disk guid */
436         s = str;
437         val = extract_val(str, "uuid_disk");
438         if (!val) {
439 #ifdef CONFIG_RANDOM_UUID
440                 *str_disk_guid = malloc(UUID_STR_LEN + 1);
441                 if (*str_disk_guid == NULL)
442                         return -ENOMEM;
443                 gen_rand_uuid_str(*str_disk_guid, UUID_STR_FORMAT_STD);
444 #else
445                 free(str);
446                 return -2;
447 #endif
448         } else {
449                 val = strsep(&val, ";");
450                 if (extract_env(val, &p))
451                         p = val;
452                 *str_disk_guid = strdup(p);
453                 free(val);
454                 /* Move s to first partition */
455                 strsep(&s, ";");
456         }
457         if (s == NULL) {
458                 printf("Error: is the partitions string NULL-terminated?\n");
459                 return -EINVAL;
460         }
461         if (strnlen(s, max_str_part) == 0)
462                 return -3;
463
464         i = strnlen(s, max_str_part) - 1;
465         if (s[i] == ';')
466                 s[i] = '\0';
467
468         /* calculate expected number of partitions */
469         p_count = 1;
470         p = s;
471         while (*p) {
472                 if (*p++ == ';')
473                         p_count++;
474         }
475
476         /* allocate memory for partitions */
477         parts = calloc(sizeof(struct disk_partition), p_count);
478         if (parts == NULL)
479                 return -ENOMEM;
480
481         /* retrieve partitions data from string */
482         for (i = 0; i < p_count; i++) {
483                 tok = strsep(&s, ";");
484
485                 if (tok == NULL)
486                         break;
487
488                 /* uuid */
489                 val = extract_val(tok, "uuid");
490                 if (!val) {
491                         /* 'uuid' is optional if random uuid's are enabled */
492 #ifdef CONFIG_RANDOM_UUID
493                         gen_rand_uuid_str(parts[i].uuid, UUID_STR_FORMAT_STD);
494 #else
495                         errno = -4;
496                         goto err;
497 #endif
498                 } else {
499                         if (extract_env(val, &p))
500                                 p = val;
501                         if (strnlen(p, max_str_part) >= sizeof(parts[i].uuid)) {
502                                 printf("Wrong uuid format for partition %d\n", i);
503                                 errno = -4;
504                                 goto err;
505                         }
506                         strncpy((char *)parts[i].uuid, p, max_str_part);
507                         free(val);
508                 }
509 #ifdef CONFIG_PARTITION_TYPE_GUID
510                 /* guid */
511                 val = extract_val(tok, "type");
512                 if (val) {
513                         /* 'type' is optional */
514                         if (extract_env(val, &p))
515                                 p = val;
516                         if (strnlen(p, max_str_part) >= sizeof(parts[i].type_guid)) {
517                                 printf("Wrong type guid format for partition %d\n",
518                                        i);
519                                 errno = -4;
520                                 goto err;
521                         }
522                         strncpy((char *)parts[i].type_guid, p, max_str_part);
523                         free(val);
524                 }
525 #endif
526                 /* name */
527                 val = extract_val(tok, "name");
528                 if (!val) { /* name is mandatory */
529                         errno = -4;
530                         goto err;
531                 }
532                 if (extract_env(val, &p))
533                         p = val;
534                 if (strnlen(p, max_str_part) >= sizeof(parts[i].name)) {
535                         errno = -4;
536                         goto err;
537                 }
538                 strncpy((char *)parts[i].name, p, max_str_part);
539                 free(val);
540
541                 /* size */
542                 val = extract_val(tok, "size");
543                 if (!val) { /* 'size' is mandatory */
544                         errno = -4;
545                         goto err;
546                 }
547                 if (extract_env(val, &p))
548                         p = val;
549                 if ((strcmp(p, "-") == 0)) {
550                         /* Let part efi module to auto extend the size */
551                         parts[i].size = 0;
552                 } else {
553                         size_ll = ustrtoull(p, &p, 0);
554                         parts[i].size = lldiv(size_ll, dev_desc->blksz);
555                 }
556
557                 free(val);
558
559                 /* start address */
560                 val = extract_val(tok, "start");
561                 if (val) { /* start address is optional */
562                         if (extract_env(val, &p))
563                                 p = val;
564                         start_ll = ustrtoull(p, &p, 0);
565                         parts[i].start = lldiv(start_ll, dev_desc->blksz);
566                         free(val);
567                 }
568
569                 offset += parts[i].size + parts[i].start;
570
571                 /* bootable */
572                 if (found_key(tok, "bootable"))
573                         parts[i].bootable = PART_BOOTABLE;
574         }
575
576         *parts_count = p_count;
577         *partitions = parts;
578         free(str);
579
580         return 0;
581 err:
582         free(str);
583         free(*str_disk_guid);
584         free(parts);
585
586         return errno;
587 }
588
589 static int gpt_repair(struct blk_desc *blk_dev_desc)
590 {
591         int ret = 0;
592
593         ret = gpt_repair_headers(blk_dev_desc);
594
595         return ret;
596 }
597
598 static int gpt_default(struct blk_desc *blk_dev_desc, const char *str_part)
599 {
600         int ret;
601         char *str_disk_guid;
602         u8 part_count = 0;
603         struct disk_partition *partitions = NULL;
604
605         /* fill partitions */
606         ret = set_gpt_info(blk_dev_desc, str_part,
607                         &str_disk_guid, &partitions, &part_count);
608         if (ret) {
609                 if (ret == -1)
610                         printf("No partition list provided\n");
611                 if (ret == -2)
612                         printf("Missing disk guid\n");
613                 if ((ret == -3) || (ret == -4))
614                         printf("Partition list incomplete\n");
615                 return -1;
616         }
617
618         /* save partitions layout to disk */
619         ret = gpt_restore(blk_dev_desc, str_disk_guid, partitions, part_count);
620         free(str_disk_guid);
621         free(partitions);
622
623         return ret;
624 }
625
626 static int gpt_verify(struct blk_desc *blk_dev_desc, const char *str_part)
627 {
628         ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1,
629                                      blk_dev_desc->blksz);
630         struct disk_partition *partitions = NULL;
631         gpt_entry *gpt_pte = NULL;
632         char *str_disk_guid;
633         u8 part_count = 0;
634         int ret = 0;
635
636         /* fill partitions */
637         ret = set_gpt_info(blk_dev_desc, str_part,
638                         &str_disk_guid, &partitions, &part_count);
639         if (ret) {
640                 if (ret == -1) {
641                         printf("No partition list provided - only basic check\n");
642                         ret = gpt_verify_headers(blk_dev_desc, gpt_head,
643                                                  &gpt_pte);
644                         goto out;
645                 }
646                 if (ret == -2)
647                         printf("Missing disk guid\n");
648                 if ((ret == -3) || (ret == -4))
649                         printf("Partition list incomplete\n");
650                 return -1;
651         }
652
653         /* Check partition layout with provided pattern */
654         ret = gpt_verify_partitions(blk_dev_desc, partitions, part_count,
655                                     gpt_head, &gpt_pte);
656         free(str_disk_guid);
657         free(partitions);
658  out:
659         free(gpt_pte);
660         return ret;
661 }
662
663 /**
664  * gpt_enumerate() - Enumerate partition names into environment variable.
665  *
666  * Enumerate partition names. Partition names are stored in gpt_partition_list
667  * environment variable. Each partition name is delimited by space.
668  *
669  * @desc: block device descriptor
670  *
671  * @Return: '0' on success and -ve error on failure
672  */
673 static int gpt_enumerate(struct blk_desc *desc)
674 {
675         struct part_driver *first_drv, *part_drv;
676         int str_len = 0, tmp_len;
677         char part_list[2048];
678         int n_drvs;
679         char *ptr;
680
681         part_list[0] = 0;
682         n_drvs = part_driver_get_count();
683         if (!n_drvs) {
684                 printf("Failed to get partition driver count\n");
685                 return -ENOENT;
686         }
687
688         first_drv = part_driver_get_first();
689         for (part_drv = first_drv; part_drv != first_drv + n_drvs; part_drv++) {
690                 struct disk_partition pinfo;
691                 int ret;
692                 int i;
693
694                 for (i = 1; i < part_drv->max_entries; i++) {
695                         ret = part_drv->get_info(desc, i, &pinfo);
696                         if (ret) {
697                                 /* no more entries in table */
698                                 break;
699                         }
700
701                         ptr = &part_list[str_len];
702                         tmp_len = strlen((const char *)pinfo.name);
703                         str_len += tmp_len;
704                         /* +1 for space */
705                         str_len++;
706                         if (str_len > sizeof(part_list)) {
707                                 printf("Error insufficient memory\n");
708                                 return -ENOMEM;
709                         }
710                         strcpy(ptr, (const char *)pinfo.name);
711                         /* One byte for space(" ") delimiter */
712                         ptr[tmp_len] = ' ';
713                 }
714         }
715         if (*part_list)
716                 part_list[strlen(part_list) - 1] = 0;
717         debug("setenv gpt_partition_list %s\n", part_list);
718
719         return env_set("gpt_partition_list", part_list);
720 }
721
722 /**
723  * gpt_setenv_part_variables() - setup partition environmental variables
724  *
725  * Setup the gpt_partition_name, gpt_partition_entry, gpt_partition_addr
726  * and gpt_partition_size environment variables.
727  *
728  * @pinfo: pointer to disk partition
729  * @i: partition entry
730  *
731  * @Return: '0' on success and -ENOENT on failure
732  */
733 static int gpt_setenv_part_variables(struct disk_partition *pinfo, int i)
734 {
735         int ret;
736
737         ret = env_set_hex("gpt_partition_addr", pinfo->start);
738         if (ret)
739                 goto fail;
740
741         ret = env_set_hex("gpt_partition_size", pinfo->size);
742         if (ret)
743                 goto fail;
744
745         ret = env_set_ulong("gpt_partition_entry", i);
746         if (ret)
747                 goto fail;
748
749         ret = env_set("gpt_partition_name", (const char *)pinfo->name);
750         if (ret)
751                 goto fail;
752
753         return 0;
754
755 fail:
756         return -ENOENT;
757 }
758
759 /**
760  * gpt_setenv() - Dynamically setup environment variables.
761  *
762  * Dynamically setup environment variables for name, index, offset and size
763  * for partition in GPT table after running "gpt setenv" for a partition name.
764  *
765  * @desc: block device descriptor
766  * @name: partition name
767  *
768  * @Return: '0' on success and -ve err on failure
769  */
770 static int gpt_setenv(struct blk_desc *desc, const char *name)
771 {
772         struct part_driver *first_drv, *part_drv;
773         int n_drvs;
774         int ret = -1;
775
776         n_drvs = part_driver_get_count();
777         if (!n_drvs) {
778                 printf("Failed to get partition driver count\n");
779                 goto fail;
780         }
781
782         first_drv = part_driver_get_first();
783         for (part_drv = first_drv; part_drv != first_drv + n_drvs; part_drv++) {
784                 struct disk_partition pinfo;
785                 int i;
786
787                 for (i = 1; i < part_drv->max_entries; i++) {
788                         ret = part_drv->get_info(desc, i, &pinfo);
789                         if (ret) {
790                                 /* no more entries in table */
791                                 break;
792                         }
793
794                         if (!strcmp(name, (const char *)pinfo.name)) {
795                                 /* match found, setup environment variables */
796                                 ret = gpt_setenv_part_variables(&pinfo, i);
797                                 if (ret)
798                                         goto fail;
799
800                                 return 0;
801                         }
802                 }
803         }
804
805 fail:
806         return ret;
807 }
808
809 static int do_disk_guid(struct blk_desc *dev_desc, char * const namestr)
810 {
811         int ret;
812         char disk_guid[UUID_STR_LEN + 1];
813
814         ret = get_disk_guid(dev_desc, disk_guid);
815         if (ret < 0)
816                 return CMD_RET_FAILURE;
817
818         if (namestr)
819                 env_set(namestr, disk_guid);
820         else
821                 printf("%s\n", disk_guid);
822
823         return ret;
824 }
825
826 #ifdef CONFIG_CMD_GPT_RENAME
827 static int do_rename_gpt_parts(struct blk_desc *dev_desc, char *subcomm,
828                                char *name1, char *name2)
829 {
830         struct list_head *pos;
831         struct disk_part *curr;
832         struct disk_partition *new_partitions = NULL;
833         char disk_guid[UUID_STR_LEN + 1];
834         char *partitions_list, *str_disk_guid = NULL;
835         u8 part_count = 0;
836         int partlistlen, ret, numparts = 0, partnum, i = 1, ctr1 = 0, ctr2 = 0;
837
838         if ((subcomm == NULL) || (name1 == NULL) || (name2 == NULL) ||
839             (strcmp(subcomm, "swap") && (strcmp(subcomm, "rename"))))
840                 return -EINVAL;
841
842         ret = get_disk_guid(dev_desc, disk_guid);
843         if (ret < 0)
844                 return ret;
845         /*
846          * Allocates disk_partitions, requiring matching call to del_gpt_info()
847          * if successful.
848          */
849         numparts = get_gpt_info(dev_desc);
850         if (numparts <=  0)
851                 return numparts ? numparts : -ENODEV;
852
853         partlistlen = calc_parts_list_len(numparts);
854         partitions_list = malloc(partlistlen);
855         if (!partitions_list) {
856                 del_gpt_info();
857                 return -ENOMEM;
858         }
859         memset(partitions_list, '\0', partlistlen);
860
861         ret = create_gpt_partitions_list(numparts, disk_guid, partitions_list);
862         if (ret < 0) {
863                 free(partitions_list);
864                 return ret;
865         }
866         /*
867          * Uncomment the following line to print a string that 'gpt write'
868          * or 'gpt verify' will accept as input.
869          */
870         debug("OLD partitions_list is %s with %u chars\n", partitions_list,
871               (unsigned)strlen(partitions_list));
872
873         /* set_gpt_info allocates new_partitions and str_disk_guid */
874         ret = set_gpt_info(dev_desc, partitions_list, &str_disk_guid,
875                            &new_partitions, &part_count);
876         if (ret < 0)
877                 goto out;
878
879         if (!strcmp(subcomm, "swap")) {
880                 if ((strlen(name1) > PART_NAME_LEN) || (strlen(name2) > PART_NAME_LEN)) {
881                         printf("Names longer than %d characters are truncated.\n", PART_NAME_LEN);
882                         ret = -EINVAL;
883                         goto out;
884                 }
885                 list_for_each(pos, &disk_partitions) {
886                         curr = list_entry(pos, struct disk_part, list);
887                         if (!strcmp((char *)curr->gpt_part_info.name, name1)) {
888                                 strcpy((char *)curr->gpt_part_info.name, name2);
889                                 ctr1++;
890                         } else if (!strcmp((char *)curr->gpt_part_info.name, name2)) {
891                                 strcpy((char *)curr->gpt_part_info.name, name1);
892                                 ctr2++;
893                         }
894                 }
895                 if ((ctr1 + ctr2 < 2) || (ctr1 != ctr2)) {
896                         printf("Cannot swap partition names except in pairs.\n");
897                         ret = -EINVAL;
898                         goto out;
899                 }
900         } else { /* rename */
901                 if (strlen(name2) > PART_NAME_LEN) {
902                         printf("Names longer than %d characters are truncated.\n", PART_NAME_LEN);
903                         ret = -EINVAL;
904                         goto out;
905                 }
906                 partnum = (int)simple_strtol(name1, NULL, 10);
907                 if ((partnum < 0) || (partnum > numparts)) {
908                         printf("Illegal partition number %s\n", name1);
909                         ret = -EINVAL;
910                         goto out;
911                 }
912                 ret = part_get_info(dev_desc, partnum, new_partitions);
913                 if (ret < 0)
914                         goto out;
915
916                 /* U-Boot partition numbering starts at 1 */
917                 list_for_each(pos, &disk_partitions) {
918                         curr = list_entry(pos, struct disk_part, list);
919                         if (i == partnum) {
920                                 strcpy((char *)curr->gpt_part_info.name, name2);
921                                 break;
922                         }
923                         i++;
924                 }
925         }
926
927         ret = create_gpt_partitions_list(numparts, disk_guid, partitions_list);
928         if (ret < 0)
929                 goto out;
930         debug("NEW partitions_list is %s with %u chars\n", partitions_list,
931               (unsigned)strlen(partitions_list));
932
933         ret = set_gpt_info(dev_desc, partitions_list, &str_disk_guid,
934                            &new_partitions, &part_count);
935         /*
936          * Even though valid pointers are here passed into set_gpt_info(),
937          * it mallocs again, and there's no way to tell which failed.
938          */
939         if (ret < 0)
940                 goto out;
941
942         debug("Writing new partition table\n");
943         ret = gpt_restore(dev_desc, disk_guid, new_partitions, numparts);
944         if (ret < 0) {
945                 printf("Writing new partition table failed\n");
946                 goto out;
947         }
948
949         debug("Reading back new partition table\n");
950         /*
951          * Empty the existing disk_partitions list, as otherwise the memory in
952          * the original list is unreachable.
953          */
954         del_gpt_info();
955         numparts = get_gpt_info(dev_desc);
956         if (numparts <=  0) {
957                 ret = numparts ? numparts : -ENODEV;
958                 goto out;
959         }
960         printf("new partition table with %d partitions is:\n", numparts);
961         print_gpt_info();
962  out:
963         del_gpt_info();
964 #ifdef CONFIG_RANDOM_UUID
965         free(str_disk_guid);
966 #endif
967         free(new_partitions);
968         free(partitions_list);
969         return ret;
970 }
971 #endif
972
973 /**
974  * do_gpt(): Perform GPT operations
975  *
976  * @param cmdtp - command name
977  * @param flag
978  * @param argc
979  * @param argv
980  *
981  * Return: zero on success; otherwise error
982  */
983 static int do_gpt(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
984 {
985         int ret = CMD_RET_SUCCESS;
986         int dev = 0;
987         char *ep;
988         struct blk_desc *blk_dev_desc = NULL;
989
990 #ifndef CONFIG_CMD_GPT_RENAME
991         if (argc < 4 || argc > 5)
992 #else
993         if (argc < 4 || argc > 6)
994 #endif
995                 return CMD_RET_USAGE;
996
997         dev = (int)dectoul(argv[3], &ep);
998         if (!ep || ep[0] != '\0') {
999                 printf("'%s' is not a number\n", argv[3]);
1000                 return CMD_RET_USAGE;
1001         }
1002         blk_dev_desc = blk_get_dev(argv[2], dev);
1003         if (!blk_dev_desc) {
1004                 printf("%s: %s dev %d NOT available\n",
1005                        __func__, argv[2], dev);
1006                 return CMD_RET_FAILURE;
1007         }
1008
1009         if (strcmp(argv[1], "repair") == 0) {
1010                 printf("Repairing GPT: ");
1011                 ret = gpt_repair(blk_dev_desc);
1012         } else if ((strcmp(argv[1], "write") == 0) && (argc == 5)) {
1013                 printf("Writing GPT: ");
1014                 ret = gpt_default(blk_dev_desc, argv[4]);
1015         } else if ((strcmp(argv[1], "verify") == 0)) {
1016                 ret = gpt_verify(blk_dev_desc, argv[4]);
1017                 printf("Verify GPT: ");
1018         } else if ((strcmp(argv[1], "setenv") == 0)) {
1019                 ret = gpt_setenv(blk_dev_desc, argv[4]);
1020         } else if ((strcmp(argv[1], "enumerate") == 0)) {
1021                 ret = gpt_enumerate(blk_dev_desc);
1022         } else if (strcmp(argv[1], "guid") == 0) {
1023                 ret = do_disk_guid(blk_dev_desc, argv[4]);
1024 #ifdef CONFIG_CMD_GPT_RENAME
1025         } else if (strcmp(argv[1], "read") == 0) {
1026                 ret = do_get_gpt_info(blk_dev_desc, (argc == 5) ? argv[4] : NULL);
1027         } else if ((strcmp(argv[1], "swap") == 0) ||
1028                    (strcmp(argv[1], "rename") == 0)) {
1029                 ret = do_rename_gpt_parts(blk_dev_desc, argv[1], argv[4], argv[5]);
1030 #endif
1031         } else {
1032                 return CMD_RET_USAGE;
1033         }
1034
1035         if (ret) {
1036                 printf("error!\n");
1037                 return CMD_RET_FAILURE;
1038         }
1039
1040         printf("success!\n");
1041         return CMD_RET_SUCCESS;
1042 }
1043
1044 U_BOOT_CMD(gpt, CONFIG_SYS_MAXARGS, 1, do_gpt,
1045         "GUID Partition Table",
1046         "<command> <interface> <dev> <partitions_list>\n"
1047         " - GUID partition table restoration and validity check\n"
1048         " Restore or verify GPT information on a device connected\n"
1049         " to interface\n"
1050         " Example usage:\n"
1051         " gpt repair mmc 0\n"
1052         "    - repair the GPT on the device\n"
1053         " gpt write mmc 0 $partitions\n"
1054         "    - write the GPT to device\n"
1055         " gpt verify mmc 0 $partitions\n"
1056         "    - verify the GPT on device against $partitions\n"
1057         " gpt setenv mmc 0 $name\n"
1058         "    - setup environment variables for partition $name:\n"
1059         "      gpt_partition_addr, gpt_partition_size,\n"
1060         "      gpt_partition_name, gpt_partition_entry\n"
1061         " gpt enumerate mmc 0\n"
1062         "    - store list of partitions to gpt_partition_list environment variable\n"
1063         " read <interface> <dev>\n"
1064         "    - read GPT into a data structure for manipulation\n"
1065         " gpt guid <interface> <dev>\n"
1066         "    - print disk GUID\n"
1067         " gpt guid <interface> <dev> <varname>\n"
1068         "    - set environment variable to disk GUID\n"
1069         " Example usage:\n"
1070         " gpt guid mmc 0\n"
1071         " gpt guid mmc 0 varname\n"
1072 #ifdef CONFIG_CMD_GPT_RENAME
1073         "gpt partition renaming commands:\n"
1074         " gpt read <interface> <dev> [<varname>]\n"
1075         "    - read GPT into a data structure for manipulation\n"
1076         "    - read GPT partitions into environment variable\n"
1077         " gpt swap <interface> <dev> <name1> <name2>\n"
1078         "    - change all partitions named name1 to name2\n"
1079         "      and vice-versa\n"
1080         " gpt rename <interface> <dev> <part> <name>\n"
1081         "    - rename the specified partition\n"
1082         " Example usage:\n"
1083         " gpt swap mmc 0 foo bar\n"
1084         " gpt rename mmc 0 3 foo\n"
1085 #endif
1086 );