kernel: make uImage.FIT partition parser work on MBR partitions
[openwrt/openwrt.git] / target / linux / generic / files / block / partitions / fit.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * fs/partitions/fit.c
4 * Copyright (C) 2021 Daniel Golle
5 *
6 * headers extracted from U-Boot mkimage sources
7 * (C) Copyright 2008 Semihalf
8 * (C) Copyright 2000-2005
9 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
10 *
11 * based on existing partition parsers
12 * Copyright (C) 1991-1998 Linus Torvalds
13 * Re-organised Feb 1998 Russell King
14 */
15
16 #define pr_fmt(fmt) fmt
17
18 #include <linux/types.h>
19 #include <linux/of.h>
20 #include <linux/of_device.h>
21 #include <linux/of_fdt.h>
22 #include <linux/libfdt.h>
23
24 #include "check.h"
25
26 #define FIT_IMAGES_PATH "/images"
27 #define FIT_CONFS_PATH "/configurations"
28
29 /* hash/signature/key node */
30 #define FIT_HASH_NODENAME "hash"
31 #define FIT_ALGO_PROP "algo"
32 #define FIT_VALUE_PROP "value"
33 #define FIT_IGNORE_PROP "uboot-ignore"
34 #define FIT_SIG_NODENAME "signature"
35 #define FIT_KEY_REQUIRED "required"
36 #define FIT_KEY_HINT "key-name-hint"
37
38 /* cipher node */
39 #define FIT_CIPHER_NODENAME "cipher"
40 #define FIT_ALGO_PROP "algo"
41
42 /* image node */
43 #define FIT_DATA_PROP "data"
44 #define FIT_DATA_POSITION_PROP "data-position"
45 #define FIT_DATA_OFFSET_PROP "data-offset"
46 #define FIT_DATA_SIZE_PROP "data-size"
47 #define FIT_TIMESTAMP_PROP "timestamp"
48 #define FIT_DESC_PROP "description"
49 #define FIT_ARCH_PROP "arch"
50 #define FIT_TYPE_PROP "type"
51 #define FIT_OS_PROP "os"
52 #define FIT_COMP_PROP "compression"
53 #define FIT_ENTRY_PROP "entry"
54 #define FIT_LOAD_PROP "load"
55
56 /* configuration node */
57 #define FIT_KERNEL_PROP "kernel"
58 #define FIT_FILESYSTEM_PROP "filesystem"
59 #define FIT_RAMDISK_PROP "ramdisk"
60 #define FIT_FDT_PROP "fdt"
61 #define FIT_LOADABLE_PROP "loadables"
62 #define FIT_DEFAULT_PROP "default"
63 #define FIT_SETUP_PROP "setup"
64 #define FIT_FPGA_PROP "fpga"
65 #define FIT_FIRMWARE_PROP "firmware"
66 #define FIT_STANDALONE_PROP "standalone"
67
68 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
69
70 #define MIN_FREE_SECT 16
71 #define REMAIN_VOLNAME "rootfs_data"
72
73 int parse_fit_partitions(struct parsed_partitions *state, u64 fit_start_sector, u64 sectors, int *slot, int add_remain)
74 {
75 struct address_space *mapping = state->bdev->bd_inode->i_mapping;
76 struct page *page;
77 void *fit, *init_fit;
78 struct partition_meta_info *info;
79 char tmp[sizeof(info->volname)];
80 u64 dsize, dsectors, imgmaxsect = 0;
81 u32 size, image_pos, image_len;
82 const u32 *image_offset_be, *image_len_be, *image_pos_be;
83 int ret = 1, node, images, config;
84 const char *image_name, *image_type, *image_description, *config_default,
85 *config_description, *config_loadables;
86 int image_name_len, image_type_len, image_description_len, config_default_len,
87 config_description_len, config_loadables_len;
88 sector_t start_sect, nr_sects;
89 size_t label_min;
90
91 if (fit_start_sector % (1<<(PAGE_SHIFT - SECTOR_SHIFT)))
92 return -ERANGE;
93
94 page = read_mapping_page(mapping, fit_start_sector >> (PAGE_SHIFT - SECTOR_SHIFT), NULL);
95 if (!page)
96 return -ENOMEM;
97
98 init_fit = page_address(page);
99
100 if (!init_fit) {
101 put_page(page);
102 return -EFAULT;
103 }
104
105 if (fdt_check_header(init_fit)) {
106 put_page(page);
107 return 0;
108 }
109
110 dsectors = get_capacity(state->bdev->bd_disk);
111 if (sectors)
112 dsectors = (dsectors>sectors)?sectors:dsectors;
113
114 dsize = dsectors << SECTOR_SHIFT;
115
116 size = fdt_totalsize(init_fit);
117
118 /* silently skip non-external-data legacy FIT images */
119 if (size > PAGE_SIZE) {
120 put_page(page);
121 return 0;
122 }
123
124 if (size >= dsize) {
125 state->access_beyond_eod = 1;
126 put_page(page);
127 return -EFBIG;
128 }
129
130 fit = kmemdup(init_fit, size, GFP_KERNEL);
131 put_page(page);
132 if (!fit)
133 return -ENOMEM;
134
135 config = fdt_path_offset(fit, FIT_CONFS_PATH);
136 if (config < 0) {
137 printk(KERN_ERR "FIT: Cannot find %s node: %d\n", FIT_CONFS_PATH, images);
138 ret = -ENOENT;
139 goto ret_out;
140 }
141
142 config_default = fdt_getprop(fit, config, FIT_DEFAULT_PROP, &config_default_len);
143
144 if (!config_default) {
145 printk(KERN_ERR "FIT: Cannot find default configuration\n");
146 ret = -ENOENT;
147 goto ret_out;
148 }
149
150 node = fdt_subnode_offset(fit, config, config_default);
151 if (node < 0) {
152 printk(KERN_ERR "FIT: Cannot find %s node: %d\n", config_default, node);
153 ret = -ENOENT;
154 goto ret_out;
155 }
156
157 config_description = fdt_getprop(fit, node, FIT_DESC_PROP, &config_description_len);
158 config_loadables = fdt_getprop(fit, node, FIT_LOADABLE_PROP, &config_loadables_len);
159
160 printk(KERN_DEBUG "FIT: Default configuration: \"%s\"%s%s%s\n", config_default,
161 config_description?" (":"", config_description?:"", config_description?")":"");
162
163 images = fdt_path_offset(fit, FIT_IMAGES_PATH);
164 if (images < 0) {
165 printk(KERN_ERR "FIT: Cannot find %s node: %d\n", FIT_IMAGES_PATH, images);
166 ret = -EINVAL;
167 goto ret_out;
168 }
169
170 fdt_for_each_subnode(node, fit, images) {
171 image_name = fdt_get_name(fit, node, &image_name_len);
172 image_type = fdt_getprop(fit, node, FIT_TYPE_PROP, &image_type_len);
173 image_offset_be = fdt_getprop(fit, node, FIT_DATA_OFFSET_PROP, NULL);
174 image_pos_be = fdt_getprop(fit, node, FIT_DATA_POSITION_PROP, NULL);
175 image_len_be = fdt_getprop(fit, node, FIT_DATA_SIZE_PROP, NULL);
176 if (!image_name || !image_type || !image_len_be)
177 continue;
178
179 image_len = be32_to_cpu(*image_len_be);
180 if (!image_len)
181 continue;
182
183 if (image_offset_be)
184 image_pos = be32_to_cpu(*image_offset_be) + size;
185 else if (image_pos_be)
186 image_pos = be32_to_cpu(*image_pos_be);
187 else
188 continue;
189
190 image_description = fdt_getprop(fit, node, FIT_DESC_PROP, &image_description_len);
191
192 printk(KERN_DEBUG "FIT: %16s sub-image 0x%08x..0x%08x \"%s\" %s%s%s\n",
193 image_type, image_pos, image_pos + image_len - 1, image_name,
194 image_description?"(":"", image_description?:"", image_description?") ":"");
195
196 if (strcmp(image_type, FIT_FILESYSTEM_PROP))
197 continue;
198
199 if (image_pos & ((1 << PAGE_SHIFT)-1)) {
200 printk(KERN_ERR "FIT: image %s start not aligned to page boundaries, skipping\n", image_name);
201 continue;
202 }
203
204 if (image_len & ((1 << PAGE_SHIFT)-1)) {
205 printk(KERN_ERR "FIT: sub-image %s end not aligned to page boundaries, skipping\n", image_name);
206 continue;
207 }
208
209 start_sect = image_pos >> SECTOR_SHIFT;
210 nr_sects = image_len >> SECTOR_SHIFT;
211 imgmaxsect = (imgmaxsect < (start_sect + nr_sects))?(start_sect + nr_sects):imgmaxsect;
212
213 if (start_sect + nr_sects > dsectors) {
214 state->access_beyond_eod = 1;
215 continue;
216 }
217
218 put_partition(state, ++(*slot), fit_start_sector + start_sect, nr_sects);
219 state->parts[*slot].flags = 0;
220 info = &state->parts[*slot].info;
221
222 label_min = min_t(int, sizeof(info->volname) - 1, image_name_len);
223 strncpy(info->volname, image_name, label_min);
224 info->volname[label_min] = '\0';
225
226 snprintf(tmp, sizeof(tmp), "(%s)", info->volname);
227 strlcat(state->pp_buf, tmp, PAGE_SIZE);
228
229 state->parts[*slot].has_info = true;
230
231 if (config_loadables && !strcmp(image_name, config_loadables)) {
232 printk(KERN_DEBUG "FIT: selecting configured loadable \"%s\" to be root filesystem\n", image_name);
233 state->parts[*slot].flags |= ADDPART_FLAG_ROOTDEV;
234 }
235 }
236
237 if (add_remain && (imgmaxsect + MIN_FREE_SECT) < dsectors) {
238 put_partition(state, ++(*slot), fit_start_sector + imgmaxsect, dsectors - imgmaxsect);
239 state->parts[*slot].flags = 0;
240 info = &state->parts[*slot].info;
241 strcpy(info->volname, REMAIN_VOLNAME);
242 snprintf(tmp, sizeof(tmp), "(%s)", REMAIN_VOLNAME);
243 strlcat(state->pp_buf, tmp, PAGE_SIZE);
244 }
245 ret_out:
246 kfree(fit);
247 return ret;
248 }
249
250 int fit_partition(struct parsed_partitions *state) {
251 int slot = 0;
252 return parse_fit_partitions(state, 0, 0, &slot, 0);
253 }