mtd: allow writing Seama files to "firmware" on Broadcom targets
[openwrt/openwrt.git] / package / system / mtd / src / trx.c
1 /*
2 * trx.c
3 *
4 * Copyright (C) 2005 Mike Baker
5 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 */
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <stddef.h>
25 #include <unistd.h>
26 #include <fcntl.h>
27 #include <sys/mman.h>
28 #include <sys/stat.h>
29 #include <endian.h>
30 #include <string.h>
31 #include <errno.h>
32
33 #include <sys/ioctl.h>
34 #include <mtd/mtd-user.h>
35 #include "mtd.h"
36 #include "crc32.h"
37
38 #define TRX_MAGIC 0x30524448 /* "HDR0" */
39 struct trx_header {
40 uint32_t magic; /* "HDR0" */
41 uint32_t len; /* Length of file including header */
42 uint32_t crc32; /* 32-bit CRC from flag_version to end of file */
43 uint32_t flag_version; /* 0:15 flags, 16:31 version */
44 uint32_t offsets[3]; /* Offsets of partitions from start of header */
45 };
46
47 #define SEAMA_MAGIC 0x17a4a35e
48
49 #if __BYTE_ORDER == __BIG_ENDIAN
50 #define STORE32_LE(X) ((((X) & 0x000000FF) << 24) | (((X) & 0x0000FF00) << 8) | (((X) & 0x00FF0000) >> 8) | (((X) & 0xFF000000) >> 24))
51 #elif __BYTE_ORDER == __LITTLE_ENDIAN
52 #define STORE32_LE(X) (X)
53 #else
54 #error unknown endianness!
55 #endif
56
57 ssize_t pread(int fd, void *buf, size_t count, off_t offset);
58 ssize_t pwrite(int fd, const void *buf, size_t count, off_t offset);
59
60 int
61 trx_fixup(int fd, const char *name)
62 {
63 struct mtd_info_user mtdInfo;
64 unsigned long len;
65 struct trx_header *trx;
66 void *ptr, *scan;
67 int bfd;
68
69 if (ioctl(fd, MEMGETINFO, &mtdInfo) < 0) {
70 fprintf(stderr, "Failed to get mtd info\n");
71 goto err;
72 }
73
74 len = mtdInfo.size;
75 if (mtdInfo.size <= 0) {
76 fprintf(stderr, "Invalid MTD device size\n");
77 goto err;
78 }
79
80 bfd = mtd_open(name, true);
81 ptr = mmap(NULL, len, PROT_READ|PROT_WRITE, MAP_SHARED, bfd, 0);
82 if (!ptr || (ptr == (void *) -1)) {
83 perror("mmap");
84 goto err1;
85 }
86
87 trx = ptr;
88 if (trx->magic != TRX_MAGIC) {
89 fprintf(stderr, "TRX header not found\n");
90 goto err;
91 }
92
93 scan = ptr + offsetof(struct trx_header, flag_version);
94 trx->crc32 = crc32buf(scan, trx->len - (scan - ptr));
95 msync(ptr, sizeof(struct trx_header), MS_SYNC|MS_INVALIDATE);
96 munmap(ptr, len);
97 close(bfd);
98 return 0;
99
100 err1:
101 close(bfd);
102 err:
103 fprintf(stderr, "Error fixing up TRX header\n");
104 return -1;
105 }
106
107 #ifndef target_ar71xx
108 int
109 trx_check(int imagefd, const char *mtd, char *buf, int *len)
110 {
111 const struct trx_header *trx = (const struct trx_header *) buf;
112 int fd;
113
114 if (strcmp(mtd, "firmware") != 0)
115 return 1;
116
117 *len = read(imagefd, buf, 32);
118 if (*len < 32) {
119 fprintf(stdout, "Could not get image header, file too small (%d bytes)\n", *len);
120 return 0;
121 }
122
123 /* Allow writing Seama files to firmware without an extra validation */
124 if (trx->magic == SEAMA_MAGIC)
125 return 1;
126
127 if (trx->magic != TRX_MAGIC || trx->len < sizeof(struct trx_header)) {
128 if (quiet < 2) {
129 fprintf(stderr, "Bad trx header\n");
130 fprintf(stderr, "This is not the correct file format; refusing to flash.\n"
131 "Please specify the correct file or use -f to force.\n");
132 }
133 return 0;
134 }
135
136 /* check if image fits to mtd device */
137 fd = mtd_check_open(mtd);
138 if(fd < 0) {
139 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
140 exit(1);
141 }
142
143 if(mtdsize < trx->len) {
144 fprintf(stderr, "Image too big for partition: %s\n", mtd);
145 close(fd);
146 return 0;
147 }
148
149 close(fd);
150 return 1;
151 }
152 #endif
153
154 int
155 mtd_fixtrx(const char *mtd, size_t offset)
156 {
157 int fd;
158 struct trx_header *trx;
159 char *buf;
160 ssize_t res;
161 size_t block_offset;
162
163 if (quiet < 2)
164 fprintf(stderr, "Trying to fix trx header in %s at 0x%x...\n", mtd, offset);
165
166 fd = mtd_check_open(mtd);
167 if(fd < 0) {
168 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
169 exit(1);
170 }
171
172 block_offset = offset & ~(erasesize - 1);
173 offset -= block_offset;
174
175 if (block_offset + erasesize > mtdsize) {
176 fprintf(stderr, "Offset too large, device size 0x%x\n", mtdsize);
177 exit(1);
178 }
179
180 buf = malloc(erasesize);
181 if (!buf) {
182 perror("malloc");
183 exit(1);
184 }
185
186 res = pread(fd, buf, erasesize, block_offset);
187 if (res != erasesize) {
188 perror("pread");
189 exit(1);
190 }
191
192 trx = (struct trx_header *) (buf + offset);
193 if (trx->magic != STORE32_LE(0x30524448)) {
194 fprintf(stderr, "No trx magic found\n");
195 exit(1);
196 }
197
198 if (trx->len == STORE32_LE(erasesize - offset)) {
199 if (quiet < 2)
200 fprintf(stderr, "Header already fixed, exiting\n");
201 close(fd);
202 return 0;
203 }
204
205 trx->len = STORE32_LE(erasesize - offset);
206
207 trx->crc32 = STORE32_LE(crc32buf((char*) &trx->flag_version, erasesize - offset - 3*4));
208 if (mtd_erase_block(fd, block_offset)) {
209 fprintf(stderr, "Can't erease block at 0x%x (%s)\n", block_offset, strerror(errno));
210 exit(1);
211 }
212
213 if (quiet < 2)
214 fprintf(stderr, "New crc32: 0x%x, rewriting block\n", trx->crc32);
215
216 if (pwrite(fd, buf, erasesize, block_offset) != erasesize) {
217 fprintf(stderr, "Error writing block (%s)\n", strerror(errno));
218 exit(1);
219 }
220
221 if (quiet < 2)
222 fprintf(stderr, "Done.\n");
223
224 close (fd);
225 sync();
226 return 0;
227
228 }
229