2 * Copyright (C) 2013 Gabor Juhos <juhosg@openwrt.org>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published
6 * by the Free Software Foundation.
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/kernel.h>
15 #include <linux/slab.h>
16 #include <linux/vmalloc.h>
17 #include <linux/mtd/mtd.h>
18 #include <linux/mtd/partitions.h>
19 #include <linux/byteorder/generic.h>
23 #define IH_MAGIC 0x27051956 /* Image Magic Number */
24 #define IH_NMLEN 32 /* Image Name Length */
26 #define IH_OS_LINUX 5 /* Linux */
28 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */
29 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image */
32 * Legacy format image header,
33 * all data in network byte order (aka natural aka bigendian).
35 struct uimage_header {
36 uint32_t ih_magic; /* Image Header Magic Number */
37 uint32_t ih_hcrc; /* Image Header CRC Checksum */
38 uint32_t ih_time; /* Image Creation Timestamp */
39 uint32_t ih_size; /* Image Data Size */
40 uint32_t ih_load; /* Data Load Address */
41 uint32_t ih_ep; /* Entry Point Address */
42 uint32_t ih_dcrc; /* Image Data CRC Checksum */
43 uint8_t ih_os; /* Operating System */
44 uint8_t ih_arch; /* CPU architecture */
45 uint8_t ih_type; /* Image Type */
46 uint8_t ih_comp; /* Compression Type */
47 uint8_t ih_name[IH_NMLEN]; /* Image Name */
51 read_uimage_header(struct mtd_info *mtd, size_t offset,
52 struct uimage_header *header)
58 header_len = sizeof(*header);
59 ret = mtd_read(mtd, offset, header_len, &retlen,
60 (unsigned char *) header);
62 pr_debug("read error in \"%s\"\n", mtd->name);
66 if (retlen != header_len) {
67 pr_debug("short read in \"%s\"\n", mtd->name);
74 static int __mtdsplit_parse_uimage(struct mtd_info *master,
75 struct mtd_partition **pparts,
76 struct mtd_part_parser_data *data,
77 bool (*verify)(struct uimage_header *hdr))
79 struct mtd_partition *parts;
80 struct uimage_header *header;
84 size_t uimage_size = 0;
86 size_t rootfs_size = 0;
87 int uimage_part, rf_part;
91 parts = kzalloc(nr_parts * sizeof(*parts), GFP_KERNEL);
95 header = vmalloc(sizeof(*header));
101 /* find uImage on erase block boundaries */
102 for (offset = 0; offset < master->size; offset += master->erasesize) {
105 ret = read_uimage_header(master, offset, header);
109 if (!verify(header)) {
110 pr_debug("no valid uImage found in \"%s\" at offset %llx\n",
111 master->name, (unsigned long long) offset);
115 uimage_size = sizeof(*header) + be32_to_cpu(header->ih_size);
116 if ((offset + uimage_size) > master->size) {
117 pr_debug("uImage exceeds MTD device \"%s\"\n",
124 if (uimage_size == 0) {
125 pr_debug("no uImage found in \"%s\"\n", master->name);
127 goto err_free_header;
130 uimage_offset = offset;
132 if (uimage_offset == 0) {
136 /* find the roots after the uImage */
137 ret = mtd_find_rootfs_from(master,
138 uimage_offset + uimage_size,
142 pr_debug("no rootfs after uImage in \"%s\"\n",
144 goto err_free_header;
147 rootfs_size = master->size - rootfs_offset;
148 uimage_size = rootfs_offset - uimage_offset;
153 /* check rootfs presence at offset 0 */
154 ret = mtd_check_rootfs_magic(master, 0);
156 pr_debug("no rootfs before uImage in \"%s\"\n",
158 goto err_free_header;
162 rootfs_size = uimage_offset;
165 if (rootfs_size == 0) {
166 pr_debug("no rootfs found in \"%s\"\n", master->name);
168 goto err_free_header;
171 parts[uimage_part].name = KERNEL_PART_NAME;
172 parts[uimage_part].offset = uimage_offset;
173 parts[uimage_part].size = uimage_size;
175 parts[rf_part].name = ROOTFS_PART_NAME;
176 parts[rf_part].offset = rootfs_offset;
177 parts[rf_part].size = rootfs_size;
192 static bool uimage_verify_default(struct uimage_header *header)
194 /* default sanity checks */
195 if (be32_to_cpu(header->ih_magic) != IH_MAGIC) {
196 pr_debug("invalid uImage magic: %08x\n",
197 be32_to_cpu(header->ih_magic));
201 if (header->ih_os != IH_OS_LINUX) {
202 pr_debug("invalid uImage OS: %08x\n",
203 be32_to_cpu(header->ih_os));
207 if (header->ih_type != IH_TYPE_KERNEL) {
208 pr_debug("invalid uImage type: %08x\n",
209 be32_to_cpu(header->ih_type));
217 mtdsplit_uimage_parse_generic(struct mtd_info *master,
218 struct mtd_partition **pparts,
219 struct mtd_part_parser_data *data)
221 return __mtdsplit_parse_uimage(master, pparts, data,
222 uimage_verify_default);
225 static struct mtd_part_parser uimage_generic_parser = {
226 .owner = THIS_MODULE,
228 .parse_fn = mtdsplit_uimage_parse_generic,
229 .type = MTD_PARSER_TYPE_FIRMWARE,
232 #define FW_MAGIC_WNR2000V3 0x32303033
233 #define FW_MAGIC_WNR2200 0x32323030
234 #define FW_MAGIC_WNR612V2 0x32303631
235 #define FW_MAGIC_WNDR3700 0x33373030
236 #define FW_MAGIC_WNDR3700V2 0x33373031
238 static bool uimage_verify_wndr3700(struct uimage_header *header)
240 switch be32_to_cpu(header->ih_magic) {
241 case FW_MAGIC_WNR612V2:
242 case FW_MAGIC_WNR2000V3:
243 case FW_MAGIC_WNR2200:
244 case FW_MAGIC_WNDR3700:
245 case FW_MAGIC_WNDR3700V2:
251 if (header->ih_os != IH_OS_LINUX ||
252 header->ih_type != IH_TYPE_FILESYSTEM)
259 mtdsplit_uimage_parse_netgear(struct mtd_info *master,
260 struct mtd_partition **pparts,
261 struct mtd_part_parser_data *data)
263 return __mtdsplit_parse_uimage(master, pparts, data,
264 uimage_verify_wndr3700);
267 static struct mtd_part_parser uimage_netgear_parser = {
268 .owner = THIS_MODULE,
269 .name = "netgear-fw",
270 .parse_fn = mtdsplit_uimage_parse_netgear,
271 .type = MTD_PARSER_TYPE_FIRMWARE,
274 static int mtdsplit_uimage_init(void)
278 ret = register_mtd_parser(&uimage_generic_parser);
282 ret = register_mtd_parser(&uimage_netgear_parser);
284 goto err_unregister_generic;
288 err_unregister_generic:
289 deregister_mtd_parser(&uimage_generic_parser);
293 module_init(mtdsplit_uimage_init);