9025240e1e85059517211d0be71a8a6b0ee209ed
[openwrt/svn-archive/archive.git] / package / mtd / src / mtd.c
1 /*
2 * mtd - simple memory technology device manipulation tool
3 *
4 * Copyright (C) 2005 Waldemar Brodkorb <wbx@dass-it.de>,
5 * 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 * $Id$
22 *
23 * The code is based on the linux-mtd examples.
24 */
25
26 #include <limits.h>
27 #include <unistd.h>
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <stdint.h>
31 #include <sys/ioctl.h>
32 #include <sys/syscall.h>
33 #include <fcntl.h>
34 #include <errno.h>
35 #include <error.h>
36 #include <time.h>
37 #include <string.h>
38 #include <sys/ioctl.h>
39 #include <sys/types.h>
40 #include <sys/param.h>
41 #include <sys/mount.h>
42 #include <sys/stat.h>
43 #include <sys/reboot.h>
44 #include <linux/reboot.h>
45
46 #include "mtd.h"
47
48 #define TRX_MAGIC 0x30524448 /* "HDR0" */
49 #define BUFSIZE (16 * 1024)
50 #define MAX_ARGS 8
51
52 #define DEBUG
53
54 #define SYSTYPE_UNKNOWN 0
55 #define SYSTYPE_BROADCOM 1
56 /* to be continued */
57
58 struct trx_header {
59 uint32_t magic; /* "HDR0" */
60 uint32_t len; /* Length of file including header */
61 uint32_t crc32; /* 32-bit CRC from flag_version to end of file */
62 uint32_t flag_version; /* 0:15 flags, 16:31 version */
63 uint32_t offsets[3]; /* Offsets of partitions from start of header */
64 };
65
66 char buf[BUFSIZE];
67 int buflen;
68 int quiet;
69
70 #ifdef target_brcm
71 int
72 image_check_brcm(int imagefd, const char *mtd)
73 {
74 struct trx_header *trx = (struct trx_header *) buf;
75 struct mtd_info_user mtdInfo;
76 int fd;
77
78 if (strcmp(mtd, "linux") != 0)
79 return 1;
80
81 buflen = read(imagefd, buf, 32);
82 if (buflen < 32) {
83 fprintf(stdout, "Could not get image header, file too small (%ld bytes)\n", buflen);
84 return 0;
85 }
86
87 if (trx->magic != TRX_MAGIC || trx->len < sizeof(struct trx_header)) {
88 if (quiet < 2) {
89 fprintf(stderr, "Bad trx header\n");
90 fprintf(stderr, "This is not the correct file format; refusing to flash.\n"
91 "Please specify the correct file or use -f to force.\n");
92 }
93 return 0;
94 }
95
96 /* check if image fits to mtd device */
97 fd = mtd_open(mtd, O_RDWR | O_SYNC);
98 if(fd < 0) {
99 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
100 exit(1);
101 }
102
103 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
104 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
105 exit(1);
106 }
107
108 if(mtdInfo.size < trx->len) {
109 fprintf(stderr, "Image too big for partition: %s\n", mtd);
110 close(fd);
111 return 0;
112 }
113
114 close(fd);
115 return 1;
116 }
117 #endif /* target_brcm */
118
119 int
120 image_check(int imagefd, const char *mtd)
121 {
122 int fd, systype;
123 size_t count;
124 char *c;
125 FILE *f;
126
127 #ifdef target_brcm
128 return image_check_brcm(imagefd, mtd);
129 #endif
130 }
131
132 int mtd_check(char *mtd)
133 {
134 struct mtd_info_user mtdInfo;
135 int fd;
136
137 fd = mtd_open(mtd, O_RDWR | O_SYNC);
138 if(fd < 0) {
139 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
140 return 0;
141 }
142
143 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
144 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
145 close(fd);
146 return 0;
147 }
148
149 close(fd);
150 return 1;
151 }
152
153 int
154 mtd_unlock(const char *mtd)
155 {
156 int fd;
157 struct mtd_info_user mtdInfo;
158 struct erase_info_user mtdLockInfo;
159
160 fd = mtd_open(mtd, O_RDWR | O_SYNC);
161 if(fd < 0) {
162 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
163 exit(1);
164 }
165
166 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
167 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
168 close(fd);
169 exit(1);
170 }
171
172 mtdLockInfo.start = 0;
173 mtdLockInfo.length = mtdInfo.size;
174 if(ioctl(fd, MEMUNLOCK, &mtdLockInfo)) {
175 close(fd);
176 return 0;
177 }
178
179 close(fd);
180 return 0;
181 }
182
183 int
184 mtd_open(const char *mtd, int flags)
185 {
186 FILE *fp;
187 char dev[PATH_MAX];
188 int i;
189 int ret;
190
191 if ((fp = fopen("/proc/mtd", "r"))) {
192 while (fgets(dev, sizeof(dev), fp)) {
193 if (sscanf(dev, "mtd%d:", &i) && strstr(dev, mtd)) {
194 snprintf(dev, sizeof(dev), "/dev/mtd/%d", i);
195 if ((ret=open(dev, flags))<0) {
196 snprintf(dev, sizeof(dev), "/dev/mtd%d", i);
197 ret=open(dev, flags);
198 }
199 fclose(fp);
200 return ret;
201 }
202 }
203 fclose(fp);
204 }
205
206 return open(mtd, flags);
207 }
208
209 int
210 mtd_erase(const char *mtd)
211 {
212 int fd;
213 struct mtd_info_user mtdInfo;
214 struct erase_info_user mtdEraseInfo;
215
216 fd = mtd_open(mtd, O_RDWR | O_SYNC);
217 if(fd < 0) {
218 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
219 exit(1);
220 }
221
222 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
223 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
224 close(fd);
225 exit(1);
226 }
227
228 mtdEraseInfo.length = mtdInfo.erasesize;
229
230 for (mtdEraseInfo.start = 0;
231 mtdEraseInfo.start < mtdInfo.size;
232 mtdEraseInfo.start += mtdInfo.erasesize) {
233
234 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
235 if(ioctl(fd, MEMERASE, &mtdEraseInfo))
236 fprintf(stderr, "Failed to erase block on %s at 0x%x\n", mtd, mtdEraseInfo.start);
237 }
238
239 close(fd);
240 return 0;
241
242 }
243
244 int
245 mtd_write(int imagefd, const char *mtd)
246 {
247 int fd, i, result;
248 size_t r, w, e;
249 struct mtd_info_user mtdInfo;
250 struct erase_info_user mtdEraseInfo;
251 int ret = 0;
252
253 fd = mtd_open(mtd, O_RDWR | O_SYNC);
254 if(fd < 0) {
255 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
256 exit(1);
257 }
258
259 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
260 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
261 close(fd);
262 exit(1);
263 }
264
265 r = w = e = 0;
266 if (!quiet)
267 fprintf(stderr, " [ ]");
268
269 for (;;) {
270 /* buffer may contain data already (from trx check) */
271 r = buflen;
272 r += read(imagefd, buf + buflen, BUFSIZE - buflen);
273 w += r;
274
275 /* EOF */
276 if (r <= 0) break;
277
278 /* need to erase the next block before writing data to it */
279 while (w > e) {
280 mtdEraseInfo.start = e;
281 mtdEraseInfo.length = mtdInfo.erasesize;
282
283 if (!quiet)
284 fprintf(stderr, "\b\b\b[e]");
285 /* erase the chunk */
286 if (ioctl (fd,MEMERASE,&mtdEraseInfo) < 0) {
287 fprintf(stderr, "Erasing mtd failed: %s\n", mtd);
288 exit(1);
289 }
290 e += mtdInfo.erasesize;
291 }
292
293 if (!quiet)
294 fprintf(stderr, "\b\b\b[w]");
295
296 if ((result = write(fd, buf, r)) < r) {
297 if (result < 0) {
298 fprintf(stderr, "Error writing image.\n");
299 exit(1);
300 } else {
301 fprintf(stderr, "Insufficient space.\n");
302 exit(1);
303 }
304 }
305
306 buflen = 0;
307 }
308 if (!quiet)
309 fprintf(stderr, "\b\b\b\b");
310
311 close(fd);
312 return 0;
313 }
314
315 void usage(void)
316 {
317 fprintf(stderr, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>\n\n"
318 "The device is in the format of mtdX (eg: mtd4) or its label.\n"
319 "mtd recognizes these commands:\n"
320 " unlock unlock the device\n"
321 " erase erase all data on device\n"
322 " write <imagefile>|- write <imagefile> (use - for stdin) to device\n"
323 "Following options are available:\n"
324 " -q quiet mode (once: no [w] on writing,\n"
325 " twice: no status messages)\n"
326 " -r reboot after successful command\n"
327 " -f force write without trx checks\n"
328 " -e <device> erase <device> before executing the command\n\n"
329 "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
330 " mtd -r write linux.trx linux\n\n");
331 exit(1);
332 }
333
334 int main (int argc, char **argv)
335 {
336 int ch, i, boot, unlock, imagefd, force, unlocked;
337 char *erase[MAX_ARGS], *device, *imagefile;
338 enum {
339 CMD_ERASE,
340 CMD_WRITE,
341 CMD_UNLOCK
342 } cmd;
343
344 erase[0] = NULL;
345 boot = 0;
346 force = 0;
347 buflen = 0;
348 quiet = 0;
349
350 while ((ch = getopt(argc, argv, "frqe:")) != -1)
351 switch (ch) {
352 case 'f':
353 force = 1;
354 break;
355 case 'r':
356 boot = 1;
357 break;
358 case 'q':
359 quiet++;
360 break;
361 case 'e':
362 i = 0;
363 while ((erase[i] != NULL) && ((i + 1) < MAX_ARGS))
364 i++;
365
366 erase[i++] = optarg;
367 erase[i] = NULL;
368 break;
369
370 case '?':
371 default:
372 usage();
373 }
374 argc -= optind;
375 argv += optind;
376
377 if (argc < 2)
378 usage();
379
380 if ((strcmp(argv[0], "unlock") == 0) && (argc == 2)) {
381 cmd = CMD_UNLOCK;
382 device = argv[1];
383 } else if ((strcmp(argv[0], "erase") == 0) && (argc == 2)) {
384 cmd = CMD_ERASE;
385 device = argv[1];
386 } else if ((strcmp(argv[0], "write") == 0) && (argc == 3)) {
387 cmd = CMD_WRITE;
388 device = argv[2];
389
390 if (strcmp(argv[1], "-") == 0) {
391 imagefile = "<stdin>";
392 imagefd = 0;
393 } else {
394 imagefile = argv[1];
395 if ((imagefd = open(argv[1], O_RDONLY)) < 0) {
396 fprintf(stderr, "Couldn't open image file: %s!\n", imagefile);
397 exit(1);
398 }
399 }
400
401 /* check trx file before erasing or writing anything */
402 if (!image_check(imagefd, device)) {
403 if (!force) {
404 fprintf(stderr, "Image check failed.\n");
405 exit(1);
406 }
407 } else {
408 if (!mtd_check(device)) {
409 fprintf(stderr, "Can't open device for writing!\n");
410 exit(1);
411 }
412 }
413 } else {
414 usage();
415 }
416
417 sync();
418
419 i = 0;
420 unlocked = 0;
421 while (erase[i] != NULL) {
422 if (quiet < 2)
423 fprintf(stderr, "Unlocking %s ...\n", erase[i]);
424 mtd_unlock(erase[i]);
425 if (quiet < 2)
426 fprintf(stderr, "Erasing %s ...\n", erase[i]);
427 mtd_erase(erase[i]);
428 if (strcmp(erase[i], device) == 0)
429 unlocked = 1;
430 i++;
431 }
432
433 if (!unlocked) {
434 if (quiet < 2)
435 fprintf(stderr, "Unlocking %s ...\n", device);
436 mtd_unlock(device);
437 }
438
439 switch (cmd) {
440 case CMD_UNLOCK:
441 break;
442 case CMD_ERASE:
443 if (quiet < 2)
444 fprintf(stderr, "Erasing %s ...\n", device);
445 mtd_erase(device);
446 break;
447 case CMD_WRITE:
448 if (quiet < 2)
449 fprintf(stderr, "Writing from %s to %s ... ", imagefile, device);
450 mtd_write(imagefd, device);
451 if (quiet < 2)
452 fprintf(stderr, "\n");
453 break;
454 }
455
456 sync();
457
458 if (boot) {
459 fprintf(stderr, "Rebooting ...\n");
460 fflush(stderr);
461 syscall(SYS_reboot,LINUX_REBOOT_MAGIC1,LINUX_REBOOT_MAGIC2,LINUX_REBOOT_CMD_RESTART,NULL);
462 }
463 return 0;
464 }