2 * mtd - simple memory technology device manipulation tool
4 * Copyright (C) 2005 Waldemar Brodkorb <wbx@dass-it.de>,
5 * Copyright (C) 2005-2009 Felix Fietkau <nbd@openwrt.org>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License v2
9 * as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 * The code is based on the linux-mtd examples.
30 #include <sys/ioctl.h>
31 #include <sys/syscall.h>
36 #include <sys/ioctl.h>
37 #include <sys/types.h>
38 #include <sys/param.h>
39 #include <sys/mount.h>
41 #include <sys/reboot.h>
42 #include <linux/reboot.h>
43 #include <mtd/mtd-user.h>
47 #include <libubox/md5.h>
50 #define JFFS2_DEFAULT_DIR "" /* directory name without /, empty means root dir */
52 static char *buf = NULL;
53 static char *imagefile = NULL;
54 static char *jffs2file = NULL, *jffs2dir = JFFS2_DEFAULT_DIR;
55 static int buflen = 0;
60 int jffs2_skip_bytes=0;
62 int mtd_open(const char *mtd, bool block)
68 int flags = O_RDWR | O_SYNC;
70 if ((fp = fopen("/proc/mtd", "r"))) {
71 while (fgets(dev, sizeof(dev), fp)) {
72 if (sscanf(dev, "mtd%d:", &i) && strstr(dev, mtd)) {
73 snprintf(dev, sizeof(dev), "/dev/mtd%s/%d", (block ? "block" : ""), i);
74 if ((ret=open(dev, flags))<0) {
75 snprintf(dev, sizeof(dev), "/dev/mtd%s%d", (block ? "block" : ""), i);
85 return open(mtd, flags);
88 int mtd_check_open(const char *mtd)
90 struct mtd_info_user mtdInfo;
93 fd = mtd_open(mtd, false);
95 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
99 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
100 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
104 mtdsize = mtdInfo.size;
105 erasesize = mtdInfo.erasesize;
110 int mtd_erase_block(int fd, int offset)
112 struct erase_info_user mtdEraseInfo;
114 mtdEraseInfo.start = offset;
115 mtdEraseInfo.length = erasesize;
116 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
117 if (ioctl (fd, MEMERASE, &mtdEraseInfo) < 0)
123 int mtd_write_buffer(int fd, const char *buf, int offset, int length)
125 lseek(fd, offset, SEEK_SET);
126 write(fd, buf, length);
132 image_check(int imagefd, const char *mtd)
136 ret = trx_check(imagefd, mtd, buf, &buflen);
142 static int mtd_check(const char *mtd)
148 if (strchr(mtd, ':')) {
154 next = strchr(mtd, ':');
160 fd = mtd_check_open(mtd);
165 buf = malloc(erasesize);
178 mtd_unlock(const char *mtd)
180 struct erase_info_user mtdLockInfo;
185 if (strchr(mtd, ':')) {
191 next = strchr(mtd, ':');
197 fd = mtd_check_open(mtd);
199 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
204 fprintf(stderr, "Unlocking %s ...\n", mtd);
206 mtdLockInfo.start = 0;
207 mtdLockInfo.length = mtdsize;
208 ioctl(fd, MEMUNLOCK, &mtdLockInfo);
220 mtd_erase(const char *mtd)
223 struct erase_info_user mtdEraseInfo;
226 fprintf(stderr, "Erasing %s ...\n", mtd);
228 fd = mtd_check_open(mtd);
230 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
234 mtdEraseInfo.length = erasesize;
236 for (mtdEraseInfo.start = 0;
237 mtdEraseInfo.start < mtdsize;
238 mtdEraseInfo.start += erasesize) {
240 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
241 if(ioctl(fd, MEMERASE, &mtdEraseInfo))
242 fprintf(stderr, "Failed to erase block on %s at 0x%x\n", mtd, mtdEraseInfo.start);
251 mtd_verify(const char *mtd, char *file)
253 uint32_t f_md5[4], m_md5[4];
260 fprintf(stderr, "Verifying %s against %s ...\n", mtd, file);
262 if (stat(file, &s) || md5sum(file, f_md5)) {
263 fprintf(stderr, "Failed to hash %s\n", file);
267 fd = mtd_check_open(mtd);
269 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
276 int len = (s.st_size > sizeof(buf)) ? (sizeof(buf)) : (s.st_size);
277 int rlen = read(fd, buf, len);
287 md5_hash(buf, rlen, &ctx);
289 } while (s.st_size > 0);
291 md5_end(m_md5, &ctx);
293 fprintf(stderr, "%08x%08x%08x%08x - %s\n", m_md5[0], m_md5[1], m_md5[2], m_md5[3], mtd);
294 fprintf(stderr, "%08x%08x%08x%08x - %s\n", f_md5[0], f_md5[1], f_md5[2], f_md5[3], file);
296 ret = memcmp(f_md5, m_md5, sizeof(m_md5));
298 fprintf(stderr, "Success\n");
300 fprintf(stderr, "Failed\n");
308 indicate_writing(const char *mtd)
311 fprintf(stderr, "\nWriting from %s to %s ... ", imagefile, mtd);
314 fprintf(stderr, " [ ]");
318 mtd_write(int imagefd, const char *mtd, char *fis_layout, size_t part_offset)
326 int jffs2_replaced = 0;
329 static struct fis_part new_parts[MAX_ARGS];
330 static struct fis_part old_parts[MAX_ARGS];
331 int n_new = 0, n_old = 0;
334 const char *tmp = mtd;
338 memset(&old_parts, 0, sizeof(old_parts));
339 memset(&new_parts, 0, sizeof(new_parts));
342 next = strchr(tmp, ':');
344 next = (char *) tmp + strlen(tmp);
346 memcpy(old_parts[n_old].name, tmp, next - tmp);
352 for (word = strtok_r(fis_layout, ",", &brkt);
354 word = strtok_r(NULL, ",", &brkt)) {
356 tmp = strtok(word, ":");
357 strncpy((char *) new_parts[n_new].name, tmp, sizeof(new_parts[n_new].name) - 1);
359 tmp = strtok(NULL, ":");
363 new_parts[n_new].size = strtoul(tmp, NULL, 0);
365 tmp = strtok(NULL, ":");
369 new_parts[n_new].loadaddr = strtoul(tmp, NULL, 16);
373 ret = fis_validate(old_parts, n_old, new_parts, n_new);
375 fprintf(stderr, "Failed to validate the new FIS partition table\n");
383 if (strchr(mtd, ':')) {
391 next = strchr(mtd, ':');
397 fd = mtd_check_open(mtd);
399 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
402 if (part_offset > 0) {
403 fprintf(stderr, "Seeking on mtd device '%s' to: %zu\n", mtd, part_offset);
404 lseek(fd, part_offset, SEEK_SET);
407 indicate_writing(mtd);
411 /* buffer may contain data already (from trx check or last mtd partition write attempt) */
412 while (buflen < erasesize) {
413 r = read(imagefd, buf + buflen, erasesize - buflen);
415 if ((errno == EINTR) || (errno == EAGAIN))
436 indicate_writing(mtd);
441 if (jffs2file && w >= jffs2_skip_bytes) {
442 if (memcmp(buf, JFFS2_EOF, sizeof(JFFS2_EOF) - 1) == 0) {
444 fprintf(stderr, "\b\b\b ");
446 fprintf(stderr, "\nAppending jffs2 data from %s to %s...", jffs2file, mtd);
447 /* got an EOF marker - this is the place to add some jffs2 data */
448 skip = mtd_replace_jffs2(mtd, fd, e, jffs2file);
451 /* don't add it again */
461 /* no EOF marker, make sure we figure out the last inode number
462 * before appending some data */
463 mtd_parse_jffs2data(buf, jffs2dir);
466 /* need to erase the next block before writing data to it */
469 while (w + buflen > e) {
471 fprintf(stderr, "\b\b\b[e]");
474 if (mtd_erase_block(fd, e) < 0) {
477 write(fd, buf + offset, e - w);
484 fprintf(stderr, "\b\b\b \n");
487 fprintf(stderr, "Failed to erase block\n");
492 /* erase the chunk */
498 fprintf(stderr, "\b\b\b[w]");
500 if ((result = write(fd, buf + offset, buflen)) < buflen) {
502 fprintf(stderr, "Error writing image.\n");
505 fprintf(stderr, "Insufficient space.\n");
515 if (jffs2_replaced && trx_fixup) {
520 fprintf(stderr, "\b\b\b\b ");
524 fprintf(stderr, "\n");
528 if (fis_remap(old_parts, n_old, new_parts, n_new) < 0)
529 fprintf(stderr, "Failed to update the FIS partition table\n");
537 static void usage(void)
539 fprintf(stderr, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>[:<device>...]\n\n"
540 "The device is in the format of mtdX (eg: mtd4) or its label.\n"
541 "mtd recognizes these commands:\n"
542 " unlock unlock the device\n"
543 " refresh refresh mtd partition\n"
544 " erase erase all data on device\n"
545 " verify <imagefile>|- verify <imagefile> (use - for stdin) to device\n"
546 " write <imagefile>|- write <imagefile> (use - for stdin) to device\n"
547 " jffs2write <file> append <file> to the jffs2 partition on the device\n");
550 " fixtrx fix the checksum in a trx header on first boot\n");
554 " fixseama fix the checksum in a seama header on first boot\n");
557 "Following options are available:\n"
558 " -q quiet mode (once: no [w] on writing,\n"
559 " twice: no status messages)\n"
560 " -n write without first erasing the blocks\n"
561 " -r reboot after successful command\n"
562 " -f force write without trx checks\n"
563 " -e <device> erase <device> before executing the command\n"
564 " -d <name> directory for jffs2write, defaults to \"tmp\"\n"
565 " -j <name> integrate <file> into jffs2 data when writing an image\n"
566 " -s <number> skip the first n bytes when appending data to the jffs2 partiton, defaults to \"0\"\n"
567 " -p write beginning at partition offset\n");
570 " -o offset offset of the image header in the partition(for fixtrx)\n");
574 " -F <part>[:<size>[:<entrypoint>]][,<part>...]\n"
575 " alter the fis partition table to create new partitions replacing\n"
576 " the partitions provided as argument to the write command\n"
577 " (only valid together with the write command)\n"
580 "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
581 " mtd -r write linux.trx linux\n\n");
585 static void do_reboot(void)
587 fprintf(stderr, "Rebooting ...\n");
590 /* try regular reboot method first */
591 system("/sbin/reboot");
594 /* if we're still alive at this point, force the kernel to reboot */
595 syscall(SYS_reboot,LINUX_REBOOT_MAGIC1,LINUX_REBOOT_MAGIC2,LINUX_REBOOT_CMD_RESTART,NULL);
598 int main (int argc, char **argv)
600 int ch, i, boot, imagefd = 0, force, unlocked;
601 char *erase[MAX_ARGS], *device = NULL;
602 char *fis_layout = NULL;
603 size_t offset = 0, part_offset = 0;
621 while ((ch = getopt(argc, argv,
625 "frnqe:d:s:j:p:o:")) != -1)
641 jffs2_skip_bytes = strtoul(optarg, 0, 0);
643 fprintf(stderr, "-s: illegal numeric string\n");
652 while ((erase[i] != NULL) && ((i + 1) < MAX_ARGS))
663 part_offset = strtoul(optarg, 0, 0);
665 fprintf(stderr, "-p: illegal numeric string\n");
671 fprintf(stderr, "-o: is not available on this platform\n");
675 offset = strtoul(optarg, 0, 0);
677 fprintf(stderr, "-o: illegal numeric string\n");
696 if ((strcmp(argv[0], "unlock") == 0) && (argc == 2)) {
699 } else if ((strcmp(argv[0], "erase") == 0) && (argc == 2)) {
702 } else if (((strcmp(argv[0], "fixtrx") == 0) && (argc == 2)) && mtd_fixtrx) {
705 } else if (((strcmp(argv[0], "fixseama") == 0) && (argc == 2)) && mtd_fixseama) {
708 } else if ((strcmp(argv[0], "verify") == 0) && (argc == 3)) {
712 } else if ((strcmp(argv[0], "write") == 0) && (argc == 3)) {
716 if (strcmp(argv[1], "-") == 0) {
717 imagefile = "<stdin>";
721 if ((imagefd = open(argv[1], O_RDONLY)) < 0) {
722 fprintf(stderr, "Couldn't open image file: %s!\n", imagefile);
727 if (!mtd_check(device)) {
728 fprintf(stderr, "Can't open device for writing!\n");
731 /* check trx file before erasing or writing anything */
732 if (!image_check(imagefd, device) && !force) {
733 fprintf(stderr, "Image check failed.\n");
736 } else if ((strcmp(argv[0], "jffs2write") == 0) && (argc == 3)) {
737 cmd = CMD_JFFS2WRITE;
741 if (!mtd_check(device)) {
742 fprintf(stderr, "Can't open device for writing!\n");
753 while (erase[i] != NULL) {
754 mtd_unlock(erase[i]);
756 if (strcmp(erase[i], device) == 0)
767 mtd_verify(device, imagefile);
777 mtd_write(imagefd, device, fis_layout, part_offset);
782 mtd_write_jffs2(device, imagefile, jffs2dir);
786 mtd_fixtrx(device, offset);
790 mtd_fixseama(device, 0);