blob: 8ffaef30f568bd807669b93090eb8b3a802aa891 [file] [log] [blame]
Piotr Wilczek8b096232012-12-11 11:09:47 +01001/*
2 * cmd_gpt.c -- GPT (GUID Partition Table) handling command
3 *
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +01004 * Copyright (C) 2015
5 * Lukasz Majewski <l.majewski@majess.pl>
6 *
Piotr Wilczek8b096232012-12-11 11:09:47 +01007 * Copyright (C) 2012 Samsung Electronics
8 * author: Lukasz Majewski <l.majewski@samsung.com>
9 * author: Piotr Wilczek <p.wilczek@samsung.com>
10 *
Wolfgang Denk1a459662013-07-08 09:37:19 +020011 * SPDX-License-Identifier: GPL-2.0+
Piotr Wilczek8b096232012-12-11 11:09:47 +010012 */
13
14#include <common.h>
15#include <malloc.h>
16#include <command.h>
Piotr Wilczek8b096232012-12-11 11:09:47 +010017#include <part_efi.h>
18#include <exports.h>
19#include <linux/ctype.h>
Piotr Wilczek3e34cf72013-01-27 22:59:25 +000020#include <div64.h>
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +010021#include <memalign.h>
Piotr Wilczek8b096232012-12-11 11:09:47 +010022
23#ifndef CONFIG_PARTITION_UUIDS
24#error CONFIG_PARTITION_UUIDS must be enabled for CONFIG_CMD_GPT to be enabled
25#endif
26
27/**
28 * extract_env(): Expand env name from string format '&{env_name}'
29 * and return pointer to the env (if the env is set)
30 *
31 * @param str - pointer to string
32 * @param env - pointer to pointer to extracted env
33 *
34 * @return - zero on successful expand and env is set
35 */
Przemyslaw Marczak39206382014-04-02 10:20:06 +020036static int extract_env(const char *str, char **env)
Piotr Wilczek8b096232012-12-11 11:09:47 +010037{
Przemyslaw Marczak39206382014-04-02 10:20:06 +020038 int ret = -1;
Piotr Wilczek8b096232012-12-11 11:09:47 +010039 char *e, *s;
Przemyslaw Marczak39206382014-04-02 10:20:06 +020040#ifdef CONFIG_RANDOM_UUID
41 char uuid_str[UUID_STR_LEN + 1];
42#endif
Piotr Wilczek8b096232012-12-11 11:09:47 +010043
44 if (!str || strlen(str) < 4)
45 return -1;
46
Przemyslaw Marczak39206382014-04-02 10:20:06 +020047 if (!((strncmp(str, "${", 2) == 0) && (str[strlen(str) - 1] == '}')))
48 return -1;
49
50 s = strdup(str);
51 if (s == NULL)
52 return -1;
53
54 memset(s + strlen(s) - 1, '\0', 1);
55 memmove(s, s + 2, strlen(s) - 1);
56
57 e = getenv(s);
58 if (e == NULL) {
59#ifdef CONFIG_RANDOM_UUID
60 debug("%s unset. ", str);
61 gen_rand_uuid_str(uuid_str, UUID_STR_FORMAT_STD);
62 setenv(s, uuid_str);
63
Piotr Wilczek8b096232012-12-11 11:09:47 +010064 e = getenv(s);
Przemyslaw Marczak39206382014-04-02 10:20:06 +020065 if (e) {
66 debug("Set to random.\n");
67 ret = 0;
68 } else {
69 debug("Can't get random UUID.\n");
Piotr Wilczek8b096232012-12-11 11:09:47 +010070 }
Przemyslaw Marczak39206382014-04-02 10:20:06 +020071#else
72 debug("%s unset.\n", str);
73#endif
74 } else {
75 debug("%s get from environment.\n", str);
76 ret = 0;
Piotr Wilczek8b096232012-12-11 11:09:47 +010077 }
78
Przemyslaw Marczak39206382014-04-02 10:20:06 +020079 *env = e;
80 free(s);
81
82 return ret;
Piotr Wilczek8b096232012-12-11 11:09:47 +010083}
84
85/**
86 * extract_val(): Extract value from a key=value pair list (comma separated).
87 * Only value for the given key is returend.
88 * Function allocates memory for the value, remember to free!
89 *
90 * @param str - pointer to string with key=values pairs
91 * @param key - pointer to the key to search for
92 *
93 * @return - pointer to allocated string with the value
94 */
95static char *extract_val(const char *str, const char *key)
96{
97 char *v, *k;
98 char *s, *strcopy;
99 char *new = NULL;
100
101 strcopy = strdup(str);
102 if (strcopy == NULL)
103 return NULL;
104
105 s = strcopy;
106 while (s) {
107 v = strsep(&s, ",");
108 if (!v)
109 break;
110 k = strsep(&v, "=");
111 if (!k)
112 break;
113 if (strcmp(k, key) == 0) {
114 new = strdup(v);
115 break;
116 }
117 }
118
119 free(strcopy);
120
121 return new;
122}
123
124/**
Patrick Delaunaycfdaf4c2015-11-17 11:36:52 +0100125 * found_key(): Found key without value in parameter list (comma separated).
126 *
127 * @param str - pointer to string with key
128 * @param key - pointer to the key to search for
129 *
130 * @return - true on found key
131 */
132static bool found_key(const char *str, const char *key)
133{
134 char *k;
135 char *s, *strcopy;
136 bool result = false;
137
138 strcopy = strdup(str);
139 if (!strcopy)
140 return NULL;
141
142 s = strcopy;
143 while (s) {
144 k = strsep(&s, ",");
145 if (!k)
146 break;
147 if (strcmp(k, key) == 0) {
148 result = true;
149 break;
150 }
151 }
152
153 free(strcopy);
154
155 return result;
156}
157
158/**
Piotr Wilczek8b096232012-12-11 11:09:47 +0100159 * set_gpt_info(): Fill partition information from string
160 * function allocates memory, remember to free!
161 *
162 * @param dev_desc - pointer block device descriptor
163 * @param str_part - pointer to string with partition information
164 * @param str_disk_guid - pointer to pointer to allocated string with disk guid
165 * @param partitions - pointer to pointer to allocated partitions array
166 * @param parts_count - number of partitions
167 *
168 * @return - zero on success, otherwise error
169 *
170 */
Simon Glass4101f682016-02-29 15:25:34 -0700171static int set_gpt_info(struct blk_desc *dev_desc,
Piotr Wilczek8b096232012-12-11 11:09:47 +0100172 const char *str_part,
173 char **str_disk_guid,
174 disk_partition_t **partitions,
175 u8 *parts_count)
176{
177 char *tok, *str, *s;
178 int i;
179 char *val, *p;
180 int p_count;
181 disk_partition_t *parts;
182 int errno = 0;
Piotr Wilczek3e34cf72013-01-27 22:59:25 +0000183 uint64_t size_ll, start_ll;
Piotr Wilczek8b096232012-12-11 11:09:47 +0100184
Egbert Eich619f0fd2013-10-04 18:53:04 +0200185 debug("%s: lba num: 0x%x %d\n", __func__,
Piotr Wilczek8b096232012-12-11 11:09:47 +0100186 (unsigned int)dev_desc->lba, (unsigned int)dev_desc->lba);
187
188 if (str_part == NULL)
189 return -1;
190
191 str = strdup(str_part);
192
193 /* extract disk guid */
194 s = str;
Rob Herring0c7e8d12015-01-26 09:44:18 -0600195 val = extract_val(str, "uuid_disk");
Piotr Wilczek8b096232012-12-11 11:09:47 +0100196 if (!val) {
Rob Herring0c7e8d12015-01-26 09:44:18 -0600197#ifdef CONFIG_RANDOM_UUID
198 *str_disk_guid = malloc(UUID_STR_LEN + 1);
199 gen_rand_uuid_str(*str_disk_guid, UUID_STR_FORMAT_STD);
200#else
Piotr Wilczek8b096232012-12-11 11:09:47 +0100201 free(str);
202 return -2;
Rob Herring0c7e8d12015-01-26 09:44:18 -0600203#endif
204 } else {
205 val = strsep(&val, ";");
206 if (extract_env(val, &p))
207 p = val;
208 *str_disk_guid = strdup(p);
209 free(val);
210 /* Move s to first partition */
211 strsep(&s, ";");
Piotr Wilczek8b096232012-12-11 11:09:47 +0100212 }
Piotr Wilczek8b096232012-12-11 11:09:47 +0100213 if (strlen(s) == 0)
214 return -3;
215
216 i = strlen(s) - 1;
217 if (s[i] == ';')
218 s[i] = '\0';
219
220 /* calculate expected number of partitions */
221 p_count = 1;
222 p = s;
223 while (*p) {
224 if (*p++ == ';')
225 p_count++;
226 }
227
228 /* allocate memory for partitions */
229 parts = calloc(sizeof(disk_partition_t), p_count);
230
Robert P. J. Day1f8b5462013-08-21 11:39:19 -0400231 /* retrieve partitions data from string */
Piotr Wilczek8b096232012-12-11 11:09:47 +0100232 for (i = 0; i < p_count; i++) {
233 tok = strsep(&s, ";");
234
235 if (tok == NULL)
236 break;
237
238 /* uuid */
239 val = extract_val(tok, "uuid");
Rob Herring0c7e8d12015-01-26 09:44:18 -0600240 if (!val) {
241 /* 'uuid' is optional if random uuid's are enabled */
242#ifdef CONFIG_RANDOM_UUID
243 gen_rand_uuid_str(parts[i].uuid, UUID_STR_FORMAT_STD);
244#else
Piotr Wilczek8b096232012-12-11 11:09:47 +0100245 errno = -4;
246 goto err;
Rob Herring0c7e8d12015-01-26 09:44:18 -0600247#endif
248 } else {
249 if (extract_env(val, &p))
250 p = val;
251 if (strlen(p) >= sizeof(parts[i].uuid)) {
252 printf("Wrong uuid format for partition %d\n", i);
253 errno = -4;
254 goto err;
255 }
256 strcpy((char *)parts[i].uuid, p);
257 free(val);
Piotr Wilczek8b096232012-12-11 11:09:47 +0100258 }
Patrick Delaunay7561b252015-10-27 11:00:27 +0100259#ifdef CONFIG_PARTITION_TYPE_GUID
260 /* guid */
261 val = extract_val(tok, "type");
262 if (val) {
263 /* 'type' is optional */
264 if (extract_env(val, &p))
265 p = val;
266 if (strlen(p) >= sizeof(parts[i].type_guid)) {
267 printf("Wrong type guid format for partition %d\n",
268 i);
269 errno = -4;
270 goto err;
271 }
272 strcpy((char *)parts[i].type_guid, p);
273 free(val);
274 }
275#endif
Piotr Wilczek8b096232012-12-11 11:09:47 +0100276 /* name */
277 val = extract_val(tok, "name");
278 if (!val) { /* name is mandatory */
279 errno = -4;
280 goto err;
281 }
282 if (extract_env(val, &p))
283 p = val;
284 if (strlen(p) >= sizeof(parts[i].name)) {
285 errno = -4;
286 goto err;
287 }
288 strcpy((char *)parts[i].name, p);
289 free(val);
290
291 /* size */
292 val = extract_val(tok, "size");
293 if (!val) { /* 'size' is mandatory */
294 errno = -4;
295 goto err;
296 }
297 if (extract_env(val, &p))
298 p = val;
Piotr Wilczek3e34cf72013-01-27 22:59:25 +0000299 size_ll = ustrtoull(p, &p, 0);
300 parts[i].size = lldiv(size_ll, dev_desc->blksz);
Piotr Wilczek8b096232012-12-11 11:09:47 +0100301 free(val);
302
303 /* start address */
304 val = extract_val(tok, "start");
305 if (val) { /* start address is optional */
306 if (extract_env(val, &p))
307 p = val;
Piotr Wilczek3e34cf72013-01-27 22:59:25 +0000308 start_ll = ustrtoull(p, &p, 0);
309 parts[i].start = lldiv(start_ll, dev_desc->blksz);
Piotr Wilczek8b096232012-12-11 11:09:47 +0100310 free(val);
311 }
Patrick Delaunaycfdaf4c2015-11-17 11:36:52 +0100312
313 /* bootable */
314 if (found_key(tok, "bootable"))
315 parts[i].bootable = 1;
Piotr Wilczek8b096232012-12-11 11:09:47 +0100316 }
317
318 *parts_count = p_count;
319 *partitions = parts;
320 free(str);
321
322 return 0;
323err:
324 free(str);
325 free(*str_disk_guid);
326 free(parts);
327
328 return errno;
329}
330
Simon Glass4101f682016-02-29 15:25:34 -0700331static int gpt_default(struct blk_desc *blk_dev_desc, const char *str_part)
Piotr Wilczek8b096232012-12-11 11:09:47 +0100332{
333 int ret;
334 char *str_disk_guid;
335 u8 part_count = 0;
336 disk_partition_t *partitions = NULL;
337
Piotr Wilczek8b096232012-12-11 11:09:47 +0100338 /* fill partitions */
Egbert Eich619f0fd2013-10-04 18:53:04 +0200339 ret = set_gpt_info(blk_dev_desc, str_part,
Piotr Wilczek8b096232012-12-11 11:09:47 +0100340 &str_disk_guid, &partitions, &part_count);
341 if (ret) {
342 if (ret == -1)
343 printf("No partition list provided\n");
344 if (ret == -2)
345 printf("Missing disk guid\n");
346 if ((ret == -3) || (ret == -4))
347 printf("Partition list incomplete\n");
348 return -1;
349 }
350
351 /* save partitions layout to disk */
Rob Herringa150e6c2015-01-26 09:43:15 -0600352 ret = gpt_restore(blk_dev_desc, str_disk_guid, partitions, part_count);
Piotr Wilczek8b096232012-12-11 11:09:47 +0100353 free(str_disk_guid);
354 free(partitions);
355
Rob Herringa150e6c2015-01-26 09:43:15 -0600356 return ret;
Piotr Wilczek8b096232012-12-11 11:09:47 +0100357}
358
Simon Glass4101f682016-02-29 15:25:34 -0700359static int gpt_verify(struct blk_desc *blk_dev_desc, const char *str_part)
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +0100360{
361 ALLOC_CACHE_ALIGN_BUFFER_PAD(gpt_header, gpt_head, 1,
362 blk_dev_desc->blksz);
363 disk_partition_t *partitions = NULL;
364 gpt_entry *gpt_pte = NULL;
365 char *str_disk_guid;
366 u8 part_count = 0;
367 int ret = 0;
368
369 /* fill partitions */
370 ret = set_gpt_info(blk_dev_desc, str_part,
371 &str_disk_guid, &partitions, &part_count);
372 if (ret) {
373 if (ret == -1) {
374 printf("No partition list provided - only basic check\n");
375 ret = gpt_verify_headers(blk_dev_desc, gpt_head,
376 &gpt_pte);
377 goto out;
378 }
379 if (ret == -2)
380 printf("Missing disk guid\n");
381 if ((ret == -3) || (ret == -4))
382 printf("Partition list incomplete\n");
383 return -1;
384 }
385
386 /* Check partition layout with provided pattern */
387 ret = gpt_verify_partitions(blk_dev_desc, partitions, part_count,
388 gpt_head, &gpt_pte);
389 free(str_disk_guid);
390 free(partitions);
391 out:
392 free(gpt_pte);
393 return ret;
394}
395
Piotr Wilczek8b096232012-12-11 11:09:47 +0100396/**
397 * do_gpt(): Perform GPT operations
398 *
399 * @param cmdtp - command name
400 * @param flag
401 * @param argc
402 * @param argv
403 *
404 * @return zero on success; otherwise error
405 */
406static int do_gpt(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
407{
408 int ret = CMD_RET_SUCCESS;
409 int dev = 0;
Egbert Eich619f0fd2013-10-04 18:53:04 +0200410 char *ep;
Simon Glass4101f682016-02-29 15:25:34 -0700411 struct blk_desc *blk_dev_desc = NULL;
Piotr Wilczek8b096232012-12-11 11:09:47 +0100412
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +0100413 if (argc < 4 || argc > 5)
Piotr Wilczek8b096232012-12-11 11:09:47 +0100414 return CMD_RET_USAGE;
415
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +0100416 dev = (int)simple_strtoul(argv[3], &ep, 10);
417 if (!ep || ep[0] != '\0') {
418 printf("'%s' is not a number\n", argv[3]);
419 return CMD_RET_USAGE;
420 }
Simon Glassdb1d9e72016-02-29 15:25:42 -0700421 blk_dev_desc = blk_get_dev(argv[2], dev);
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +0100422 if (!blk_dev_desc) {
423 printf("%s: %s dev %d NOT available\n",
424 __func__, argv[2], dev);
425 return CMD_RET_FAILURE;
426 }
427
Piotr Wilczek8b096232012-12-11 11:09:47 +0100428 if ((strcmp(argv[1], "write") == 0) && (argc == 5)) {
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +0100429 printf("Writing GPT: ");
Przemyslaw Marczak39206382014-04-02 10:20:06 +0200430 ret = gpt_default(blk_dev_desc, argv[4]);
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +0100431 } else if ((strcmp(argv[1], "verify") == 0)) {
432 ret = gpt_verify(blk_dev_desc, argv[4]);
433 printf("Verify GPT: ");
Piotr Wilczek8b096232012-12-11 11:09:47 +0100434 } else {
435 return CMD_RET_USAGE;
436 }
Lukasz Majewskibbb9ffa2015-11-20 08:06:17 +0100437
438 if (ret) {
439 printf("error!\n");
440 return CMD_RET_FAILURE;
441 }
442
443 printf("success!\n");
444 return CMD_RET_SUCCESS;
Piotr Wilczek8b096232012-12-11 11:09:47 +0100445}
446
447U_BOOT_CMD(gpt, CONFIG_SYS_MAXARGS, 1, do_gpt,
448 "GUID Partition Table",
Robert P. J. Day1f8b5462013-08-21 11:39:19 -0400449 "<command> <interface> <dev> <partitions_list>\n"
Lukasz Majewski74f889b2015-11-13 07:42:10 +0100450 " - GUID partition table restoration and validity check\n"
451 " Restore or verify GPT information on a device connected\n"
Piotr Wilczek8b096232012-12-11 11:09:47 +0100452 " to interface\n"
Lukasz Majewski74f889b2015-11-13 07:42:10 +0100453 " Example usage:\n"
454 " gpt write mmc 0 $partitions\n"
455 " gpt verify mmc 0 $partitions\n"
Piotr Wilczek8b096232012-12-11 11:09:47 +0100456);