xref: /rk3399_ARM-atf/drivers/partition/partition.c (revision f8631f51392f0688c70cfd53dc66422404e00e16)
1201b66b7SHaojian Zhuang /*
28aabea33SPaul Beesley  * Copyright (c) 2016-2019, ARM Limited and Contributors. All rights reserved.
3201b66b7SHaojian Zhuang  *
482cb2c1aSdp-arm  * SPDX-License-Identifier: BSD-3-Clause
5201b66b7SHaojian Zhuang  */
6201b66b7SHaojian Zhuang 
7201b66b7SHaojian Zhuang #include <assert.h>
839b6cc66SAntonio Nino Diaz #include <stdio.h>
9201b66b7SHaojian Zhuang #include <string.h>
10201b66b7SHaojian Zhuang 
1109d40e0eSAntonio Nino Diaz #include <common/debug.h>
1209d40e0eSAntonio Nino Diaz #include <drivers/io/io_storage.h>
1309d40e0eSAntonio Nino Diaz #include <drivers/partition/partition.h>
1409d40e0eSAntonio Nino Diaz #include <drivers/partition/gpt.h>
1509d40e0eSAntonio Nino Diaz #include <drivers/partition/mbr.h>
1609d40e0eSAntonio Nino Diaz #include <plat/common/platform.h>
1709d40e0eSAntonio Nino Diaz 
18*f8631f51SHaojian Zhuang static uint8_t mbr_sector[PLAT_PARTITION_BLOCK_SIZE];
1998228529SFlorian La Roche static partition_entry_list_t list;
20201b66b7SHaojian Zhuang 
21201b66b7SHaojian Zhuang #if LOG_LEVEL >= LOG_LEVEL_VERBOSE
22201b66b7SHaojian Zhuang static void dump_entries(int num)
23201b66b7SHaojian Zhuang {
24201b66b7SHaojian Zhuang 	char name[EFI_NAMELEN];
25201b66b7SHaojian Zhuang 	int i, j, len;
26201b66b7SHaojian Zhuang 
27201b66b7SHaojian Zhuang 	VERBOSE("Partition table with %d entries:\n", num);
28201b66b7SHaojian Zhuang 	for (i = 0; i < num; i++) {
2939b6cc66SAntonio Nino Diaz 		len = snprintf(name, EFI_NAMELEN, "%s", list.list[i].name);
30201b66b7SHaojian Zhuang 		for (j = 0; j < EFI_NAMELEN - len - 1; j++) {
31201b66b7SHaojian Zhuang 			name[len + j] = ' ';
32201b66b7SHaojian Zhuang 		}
33201b66b7SHaojian Zhuang 		name[EFI_NAMELEN - 1] = '\0';
34e7f9ab4eSYann Gautier 		VERBOSE("%d: %s %llx-%llx\n", i + 1, name, list.list[i].start,
35201b66b7SHaojian Zhuang 			list.list[i].start + list.list[i].length - 4);
36201b66b7SHaojian Zhuang 	}
37201b66b7SHaojian Zhuang }
38201b66b7SHaojian Zhuang #else
39201b66b7SHaojian Zhuang #define dump_entries(num)	((void)num)
40201b66b7SHaojian Zhuang #endif
41201b66b7SHaojian Zhuang 
42201b66b7SHaojian Zhuang /*
43201b66b7SHaojian Zhuang  * Load the first sector that carries MBR header.
44201b66b7SHaojian Zhuang  * The MBR boot signature should be always valid whether it's MBR or GPT.
45201b66b7SHaojian Zhuang  */
46201b66b7SHaojian Zhuang static int load_mbr_header(uintptr_t image_handle, mbr_entry_t *mbr_entry)
47201b66b7SHaojian Zhuang {
48201b66b7SHaojian Zhuang 	size_t bytes_read;
49201b66b7SHaojian Zhuang 	uintptr_t offset;
50201b66b7SHaojian Zhuang 	int result;
51201b66b7SHaojian Zhuang 
52201b66b7SHaojian Zhuang 	assert(mbr_entry != NULL);
53201b66b7SHaojian Zhuang 	/* MBR partition table is in LBA0. */
54201b66b7SHaojian Zhuang 	result = io_seek(image_handle, IO_SEEK_SET, MBR_OFFSET);
55201b66b7SHaojian Zhuang 	if (result != 0) {
56201b66b7SHaojian Zhuang 		WARN("Failed to seek (%i)\n", result);
57201b66b7SHaojian Zhuang 		return result;
58201b66b7SHaojian Zhuang 	}
59201b66b7SHaojian Zhuang 	result = io_read(image_handle, (uintptr_t)&mbr_sector,
60*f8631f51SHaojian Zhuang 			 PLAT_PARTITION_BLOCK_SIZE, &bytes_read);
61201b66b7SHaojian Zhuang 	if (result != 0) {
62201b66b7SHaojian Zhuang 		WARN("Failed to read data (%i)\n", result);
63201b66b7SHaojian Zhuang 		return result;
64201b66b7SHaojian Zhuang 	}
65201b66b7SHaojian Zhuang 
66201b66b7SHaojian Zhuang 	/* Check MBR boot signature. */
67*f8631f51SHaojian Zhuang 	if ((mbr_sector[LEGACY_PARTITION_BLOCK_SIZE - 2] != MBR_SIGNATURE_FIRST) ||
68*f8631f51SHaojian Zhuang 	    (mbr_sector[LEGACY_PARTITION_BLOCK_SIZE - 1] != MBR_SIGNATURE_SECOND)) {
69201b66b7SHaojian Zhuang 		return -ENOENT;
70201b66b7SHaojian Zhuang 	}
71201b66b7SHaojian Zhuang 	offset = (uintptr_t)&mbr_sector + MBR_PRIMARY_ENTRY_OFFSET;
72201b66b7SHaojian Zhuang 	memcpy(mbr_entry, (void *)offset, sizeof(mbr_entry_t));
73201b66b7SHaojian Zhuang 	return 0;
74201b66b7SHaojian Zhuang }
75201b66b7SHaojian Zhuang 
76201b66b7SHaojian Zhuang /*
77201b66b7SHaojian Zhuang  * Load GPT header and check the GPT signature.
788aabea33SPaul Beesley  * If partition numbers could be found, check & update it.
79201b66b7SHaojian Zhuang  */
80201b66b7SHaojian Zhuang static int load_gpt_header(uintptr_t image_handle)
81201b66b7SHaojian Zhuang {
82201b66b7SHaojian Zhuang 	gpt_header_t header;
83201b66b7SHaojian Zhuang 	size_t bytes_read;
84201b66b7SHaojian Zhuang 	int result;
85201b66b7SHaojian Zhuang 
86201b66b7SHaojian Zhuang 	result = io_seek(image_handle, IO_SEEK_SET, GPT_HEADER_OFFSET);
87201b66b7SHaojian Zhuang 	if (result != 0) {
88201b66b7SHaojian Zhuang 		return result;
89201b66b7SHaojian Zhuang 	}
90201b66b7SHaojian Zhuang 	result = io_read(image_handle, (uintptr_t)&header,
91201b66b7SHaojian Zhuang 			 sizeof(gpt_header_t), &bytes_read);
92201b66b7SHaojian Zhuang 	if ((result != 0) || (sizeof(gpt_header_t) != bytes_read)) {
93201b66b7SHaojian Zhuang 		return result;
94201b66b7SHaojian Zhuang 	}
95201b66b7SHaojian Zhuang 	if (memcmp(header.signature, GPT_SIGNATURE,
96201b66b7SHaojian Zhuang 		   sizeof(header.signature)) != 0) {
97201b66b7SHaojian Zhuang 		return -EINVAL;
98201b66b7SHaojian Zhuang 	}
99201b66b7SHaojian Zhuang 
100201b66b7SHaojian Zhuang 	/* partition numbers can't exceed PLAT_PARTITION_MAX_ENTRIES */
101201b66b7SHaojian Zhuang 	list.entry_count = header.list_num;
102201b66b7SHaojian Zhuang 	if (list.entry_count > PLAT_PARTITION_MAX_ENTRIES) {
103201b66b7SHaojian Zhuang 		list.entry_count = PLAT_PARTITION_MAX_ENTRIES;
104201b66b7SHaojian Zhuang 	}
105201b66b7SHaojian Zhuang 	return 0;
106201b66b7SHaojian Zhuang }
107201b66b7SHaojian Zhuang 
10830f833caSLoh Tien Hock static int load_mbr_entry(uintptr_t image_handle, mbr_entry_t *mbr_entry,
10930f833caSLoh Tien Hock 			int part_number)
11030f833caSLoh Tien Hock {
11130f833caSLoh Tien Hock 	size_t bytes_read;
11230f833caSLoh Tien Hock 	uintptr_t offset;
11330f833caSLoh Tien Hock 	int result;
11430f833caSLoh Tien Hock 
11530f833caSLoh Tien Hock 	assert(mbr_entry != NULL);
11630f833caSLoh Tien Hock 	/* MBR partition table is in LBA0. */
11730f833caSLoh Tien Hock 	result = io_seek(image_handle, IO_SEEK_SET, MBR_OFFSET);
11830f833caSLoh Tien Hock 	if (result != 0) {
11930f833caSLoh Tien Hock 		WARN("Failed to seek (%i)\n", result);
12030f833caSLoh Tien Hock 		return result;
12130f833caSLoh Tien Hock 	}
12230f833caSLoh Tien Hock 	result = io_read(image_handle, (uintptr_t)&mbr_sector,
123*f8631f51SHaojian Zhuang 			 PLAT_PARTITION_BLOCK_SIZE, &bytes_read);
12430f833caSLoh Tien Hock 	if (result != 0) {
12530f833caSLoh Tien Hock 		WARN("Failed to read data (%i)\n", result);
12630f833caSLoh Tien Hock 		return result;
12730f833caSLoh Tien Hock 	}
12830f833caSLoh Tien Hock 
12930f833caSLoh Tien Hock 	/* Check MBR boot signature. */
130*f8631f51SHaojian Zhuang 	if ((mbr_sector[LEGACY_PARTITION_BLOCK_SIZE - 2] != MBR_SIGNATURE_FIRST) ||
131*f8631f51SHaojian Zhuang 	    (mbr_sector[LEGACY_PARTITION_BLOCK_SIZE - 1] != MBR_SIGNATURE_SECOND)) {
13230f833caSLoh Tien Hock 		return -ENOENT;
13330f833caSLoh Tien Hock 	}
13430f833caSLoh Tien Hock 	offset = (uintptr_t)&mbr_sector +
13530f833caSLoh Tien Hock 		MBR_PRIMARY_ENTRY_OFFSET +
13630f833caSLoh Tien Hock 		MBR_PRIMARY_ENTRY_SIZE * part_number;
13730f833caSLoh Tien Hock 	memcpy(mbr_entry, (void *)offset, sizeof(mbr_entry_t));
13830f833caSLoh Tien Hock 
13930f833caSLoh Tien Hock 	return 0;
14030f833caSLoh Tien Hock }
14130f833caSLoh Tien Hock 
14230f833caSLoh Tien Hock static int load_mbr_entries(uintptr_t image_handle)
14330f833caSLoh Tien Hock {
14430f833caSLoh Tien Hock 	mbr_entry_t mbr_entry;
14530f833caSLoh Tien Hock 	int i;
14630f833caSLoh Tien Hock 
14730f833caSLoh Tien Hock 	list.entry_count = MBR_PRIMARY_ENTRY_NUMBER;
14830f833caSLoh Tien Hock 
14930f833caSLoh Tien Hock 	for (i = 0; i < list.entry_count; i++) {
15030f833caSLoh Tien Hock 		load_mbr_entry(image_handle, &mbr_entry, i);
15130f833caSLoh Tien Hock 		list.list[i].start = mbr_entry.first_lba * 512;
15230f833caSLoh Tien Hock 		list.list[i].length = mbr_entry.sector_nums * 512;
15330f833caSLoh Tien Hock 		list.list[i].name[0] = mbr_entry.type;
15430f833caSLoh Tien Hock 	}
15530f833caSLoh Tien Hock 
15630f833caSLoh Tien Hock 	return 0;
15730f833caSLoh Tien Hock }
15830f833caSLoh Tien Hock 
159201b66b7SHaojian Zhuang static int load_gpt_entry(uintptr_t image_handle, gpt_entry_t *entry)
160201b66b7SHaojian Zhuang {
161201b66b7SHaojian Zhuang 	size_t bytes_read;
162201b66b7SHaojian Zhuang 	int result;
163201b66b7SHaojian Zhuang 
164201b66b7SHaojian Zhuang 	assert(entry != NULL);
165201b66b7SHaojian Zhuang 	result = io_read(image_handle, (uintptr_t)entry, sizeof(gpt_entry_t),
166201b66b7SHaojian Zhuang 			 &bytes_read);
167201b66b7SHaojian Zhuang 	if (sizeof(gpt_entry_t) != bytes_read)
168201b66b7SHaojian Zhuang 		return -EINVAL;
169201b66b7SHaojian Zhuang 	return result;
170201b66b7SHaojian Zhuang }
171201b66b7SHaojian Zhuang 
172201b66b7SHaojian Zhuang static int verify_partition_gpt(uintptr_t image_handle)
173201b66b7SHaojian Zhuang {
174201b66b7SHaojian Zhuang 	gpt_entry_t entry;
175201b66b7SHaojian Zhuang 	int result, i;
176201b66b7SHaojian Zhuang 
177201b66b7SHaojian Zhuang 	for (i = 0; i < list.entry_count; i++) {
178201b66b7SHaojian Zhuang 		result = load_gpt_entry(image_handle, &entry);
179201b66b7SHaojian Zhuang 		assert(result == 0);
180201b66b7SHaojian Zhuang 		result = parse_gpt_entry(&entry, &list.list[i]);
181201b66b7SHaojian Zhuang 		if (result != 0) {
182201b66b7SHaojian Zhuang 			break;
183201b66b7SHaojian Zhuang 		}
184201b66b7SHaojian Zhuang 	}
185201b66b7SHaojian Zhuang 	if (i == 0) {
186201b66b7SHaojian Zhuang 		return -EINVAL;
187201b66b7SHaojian Zhuang 	}
188201b66b7SHaojian Zhuang 	/*
189201b66b7SHaojian Zhuang 	 * Only records the valid partition number that is loaded from
190201b66b7SHaojian Zhuang 	 * partition table.
191201b66b7SHaojian Zhuang 	 */
192201b66b7SHaojian Zhuang 	list.entry_count = i;
193201b66b7SHaojian Zhuang 	dump_entries(list.entry_count);
194201b66b7SHaojian Zhuang 
195201b66b7SHaojian Zhuang 	return 0;
196201b66b7SHaojian Zhuang }
197201b66b7SHaojian Zhuang 
198201b66b7SHaojian Zhuang int load_partition_table(unsigned int image_id)
199201b66b7SHaojian Zhuang {
200201b66b7SHaojian Zhuang 	uintptr_t dev_handle, image_handle, image_spec = 0;
201201b66b7SHaojian Zhuang 	mbr_entry_t mbr_entry;
202201b66b7SHaojian Zhuang 	int result;
203201b66b7SHaojian Zhuang 
204201b66b7SHaojian Zhuang 	result = plat_get_image_source(image_id, &dev_handle, &image_spec);
205201b66b7SHaojian Zhuang 	if (result != 0) {
206201b66b7SHaojian Zhuang 		WARN("Failed to obtain reference to image id=%u (%i)\n",
207201b66b7SHaojian Zhuang 			image_id, result);
208201b66b7SHaojian Zhuang 		return result;
209201b66b7SHaojian Zhuang 	}
210201b66b7SHaojian Zhuang 
211201b66b7SHaojian Zhuang 	result = io_open(dev_handle, image_spec, &image_handle);
212201b66b7SHaojian Zhuang 	if (result != 0) {
213201b66b7SHaojian Zhuang 		WARN("Failed to access image id=%u (%i)\n", image_id, result);
214201b66b7SHaojian Zhuang 		return result;
215201b66b7SHaojian Zhuang 	}
216201b66b7SHaojian Zhuang 
217201b66b7SHaojian Zhuang 	result = load_mbr_header(image_handle, &mbr_entry);
218201b66b7SHaojian Zhuang 	if (result != 0) {
219201b66b7SHaojian Zhuang 		WARN("Failed to access image id=%u (%i)\n", image_id, result);
220201b66b7SHaojian Zhuang 		return result;
221201b66b7SHaojian Zhuang 	}
222201b66b7SHaojian Zhuang 	if (mbr_entry.type == PARTITION_TYPE_GPT) {
223201b66b7SHaojian Zhuang 		result = load_gpt_header(image_handle);
224201b66b7SHaojian Zhuang 		assert(result == 0);
225201b66b7SHaojian Zhuang 		result = io_seek(image_handle, IO_SEEK_SET, GPT_ENTRY_OFFSET);
226201b66b7SHaojian Zhuang 		assert(result == 0);
227201b66b7SHaojian Zhuang 		result = verify_partition_gpt(image_handle);
228201b66b7SHaojian Zhuang 	} else {
22930f833caSLoh Tien Hock 		result = load_mbr_entries(image_handle);
230201b66b7SHaojian Zhuang 	}
23130f833caSLoh Tien Hock 
232201b66b7SHaojian Zhuang 	io_close(image_handle);
233201b66b7SHaojian Zhuang 	return result;
234201b66b7SHaojian Zhuang }
235201b66b7SHaojian Zhuang 
236201b66b7SHaojian Zhuang const partition_entry_t *get_partition_entry(const char *name)
237201b66b7SHaojian Zhuang {
238201b66b7SHaojian Zhuang 	int i;
239201b66b7SHaojian Zhuang 
240201b66b7SHaojian Zhuang 	for (i = 0; i < list.entry_count; i++) {
241201b66b7SHaojian Zhuang 		if (strcmp(name, list.list[i].name) == 0) {
242201b66b7SHaojian Zhuang 			return &list.list[i];
243201b66b7SHaojian Zhuang 		}
244201b66b7SHaojian Zhuang 	}
245201b66b7SHaojian Zhuang 	return NULL;
246201b66b7SHaojian Zhuang }
247201b66b7SHaojian Zhuang 
248201b66b7SHaojian Zhuang const partition_entry_list_t *get_partition_entry_list(void)
249201b66b7SHaojian Zhuang {
250201b66b7SHaojian Zhuang 	return &list;
251201b66b7SHaojian Zhuang }
252201b66b7SHaojian Zhuang 
253201b66b7SHaojian Zhuang void partition_init(unsigned int image_id)
254201b66b7SHaojian Zhuang {
255201b66b7SHaojian Zhuang 	load_partition_table(image_id);
256201b66b7SHaojian Zhuang }
257