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.
31 #include <sys/ioctl.h>
32 #include <sys/syscall.h>
37 #include <sys/ioctl.h>
38 #include <sys/types.h>
39 #include <sys/param.h>
40 #include <sys/mount.h>
42 #include <sys/reboot.h>
43 #include <linux/reboot.h>
44 #include <mtd/mtd-user.h>
48 #include <libubox/md5.h>
51 #define JFFS2_DEFAULT_DIR "" /* directory name without /, empty means root dir */
53 static char *buf = NULL;
54 static char *imagefile = NULL;
55 static char *jffs2file = NULL, *jffs2dir = JFFS2_DEFAULT_DIR;
56 static int buflen = 0;
61 int jffs2_skip_bytes=0;
64 int mtd_open(const char *mtd, bool block)
70 int flags = O_RDWR | O_SYNC;
73 snprintf(name, sizeof(name), "\"%s\"", mtd);
74 if ((fp = fopen("/proc/mtd", "r"))) {
75 while (fgets(dev, sizeof(dev), fp)) {
76 if (sscanf(dev, "mtd%d:", &i) && strstr(dev, name)) {
77 snprintf(dev, sizeof(dev), "/dev/mtd%s/%d", (block ? "block" : ""), i);
78 if ((ret=open(dev, flags))<0) {
79 snprintf(dev, sizeof(dev), "/dev/mtd%s%d", (block ? "block" : ""), i);
89 return open(mtd, flags);
92 int mtd_check_open(const char *mtd)
94 struct mtd_info_user mtdInfo;
97 fd = mtd_open(mtd, false);
99 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
103 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
104 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
108 mtdsize = mtdInfo.size;
109 erasesize = mtdInfo.erasesize;
110 mtdtype = mtdInfo.type;
115 int mtd_block_is_bad(int fd, int offset)
120 if (mtdtype == MTD_NANDFLASH)
122 r = ioctl(fd, MEMGETBADBLOCK, &o);
125 fprintf(stderr, "Failed to get erase block status\n");
132 int mtd_erase_block(int fd, int offset)
134 struct erase_info_user mtdEraseInfo;
136 mtdEraseInfo.start = offset;
137 mtdEraseInfo.length = erasesize;
138 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
139 if (ioctl (fd, MEMERASE, &mtdEraseInfo) < 0)
145 int mtd_write_buffer(int fd, const char *buf, int offset, int length)
147 lseek(fd, offset, SEEK_SET);
148 write(fd, buf, length);
154 image_check(int imagefd, const char *mtd)
158 ret = trx_check(imagefd, mtd, buf, &buflen);
164 static int mtd_check(const char *mtd)
170 if (strchr(mtd, ':')) {
176 next = strchr(mtd, ':');
182 fd = mtd_check_open(mtd);
187 buf = malloc(erasesize);
200 mtd_unlock(const char *mtd)
202 struct erase_info_user mtdLockInfo;
207 if (strchr(mtd, ':')) {
213 next = strchr(mtd, ':');
219 fd = mtd_check_open(mtd);
221 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
226 fprintf(stderr, "Unlocking %s ...\n", mtd);
228 mtdLockInfo.start = 0;
229 mtdLockInfo.length = mtdsize;
230 ioctl(fd, MEMUNLOCK, &mtdLockInfo);
242 mtd_erase(const char *mtd)
245 struct erase_info_user mtdEraseInfo;
248 fprintf(stderr, "Erasing %s ...\n", mtd);
250 fd = mtd_check_open(mtd);
252 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
256 mtdEraseInfo.length = erasesize;
258 for (mtdEraseInfo.start = 0;
259 mtdEraseInfo.start < mtdsize;
260 mtdEraseInfo.start += erasesize) {
261 if (mtd_block_is_bad(fd, mtdEraseInfo.start)) {
263 fprintf(stderr, "\nSkipping bad block at 0x%x ", mtdEraseInfo.start);
265 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
266 if(ioctl(fd, MEMERASE, &mtdEraseInfo))
267 fprintf(stderr, "Failed to erase block on %s at 0x%x\n", mtd, mtdEraseInfo.start);
277 mtd_dump(const char *mtd, int size)
283 fprintf(stderr, "Dumping %s ...\n", mtd);
285 fd = mtd_check_open(mtd);
287 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
293 int len = (size > sizeof(buf)) ? (sizeof(buf)) : (size);
294 int rlen = read(fd, buf, len);
313 mtd_verify(const char *mtd, char *file)
315 uint32_t f_md5[4], m_md5[4];
322 fprintf(stderr, "Verifying %s against %s ...\n", mtd, file);
324 if (stat(file, &s) || md5sum(file, f_md5)) {
325 fprintf(stderr, "Failed to hash %s\n", file);
329 fd = mtd_check_open(mtd);
331 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
338 int len = (s.st_size > sizeof(buf)) ? (sizeof(buf)) : (s.st_size);
339 int rlen = read(fd, buf, len);
349 md5_hash(buf, rlen, &ctx);
351 } while (s.st_size > 0);
353 md5_end(m_md5, &ctx);
355 fprintf(stderr, "%08x%08x%08x%08x - %s\n", m_md5[0], m_md5[1], m_md5[2], m_md5[3], mtd);
356 fprintf(stderr, "%08x%08x%08x%08x - %s\n", f_md5[0], f_md5[1], f_md5[2], f_md5[3], file);
358 ret = memcmp(f_md5, m_md5, sizeof(m_md5));
360 fprintf(stderr, "Success\n");
362 fprintf(stderr, "Failed\n");
370 indicate_writing(const char *mtd)
373 fprintf(stderr, "\nWriting from %s to %s ... ", imagefile, mtd);
376 fprintf(stderr, " [ ]");
380 mtd_write(int imagefd, const char *mtd, char *fis_layout, size_t part_offset)
388 int jffs2_replaced = 0;
389 int skip_bad_blocks = 0;
392 static struct fis_part new_parts[MAX_ARGS];
393 static struct fis_part old_parts[MAX_ARGS];
394 int n_new = 0, n_old = 0;
397 const char *tmp = mtd;
401 memset(&old_parts, 0, sizeof(old_parts));
402 memset(&new_parts, 0, sizeof(new_parts));
405 next = strchr(tmp, ':');
407 next = (char *) tmp + strlen(tmp);
409 memcpy(old_parts[n_old].name, tmp, next - tmp);
415 for (word = strtok_r(fis_layout, ",", &brkt);
417 word = strtok_r(NULL, ",", &brkt)) {
419 tmp = strtok(word, ":");
420 strncpy((char *) new_parts[n_new].name, tmp, sizeof(new_parts[n_new].name) - 1);
422 tmp = strtok(NULL, ":");
426 new_parts[n_new].size = strtoul(tmp, NULL, 0);
428 tmp = strtok(NULL, ":");
432 new_parts[n_new].loadaddr = strtoul(tmp, NULL, 16);
436 ret = fis_validate(old_parts, n_old, new_parts, n_new);
438 fprintf(stderr, "Failed to validate the new FIS partition table\n");
446 if (strchr(mtd, ':')) {
454 next = strchr(mtd, ':');
460 fd = mtd_check_open(mtd);
462 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
465 if (part_offset > 0) {
466 fprintf(stderr, "Seeking on mtd device '%s' to: %zu\n", mtd, part_offset);
467 lseek(fd, part_offset, SEEK_SET);
470 indicate_writing(mtd);
474 /* buffer may contain data already (from trx check or last mtd partition write attempt) */
475 while (buflen < erasesize) {
476 r = read(imagefd, buf + buflen, erasesize - buflen);
478 if ((errno == EINTR) || (errno == EAGAIN))
495 if (buflen < erasesize) {
496 /* Pad block to eraseblock size */
497 memset(&buf[buflen], 0xff, erasesize - buflen);
505 indicate_writing(mtd);
510 if (jffs2file && w >= jffs2_skip_bytes) {
511 if (memcmp(buf, JFFS2_EOF, sizeof(JFFS2_EOF) - 1) == 0) {
513 fprintf(stderr, "\b\b\b ");
515 fprintf(stderr, "\nAppending jffs2 data from %s to %s...", jffs2file, mtd);
516 /* got an EOF marker - this is the place to add some jffs2 data */
517 skip = mtd_replace_jffs2(mtd, fd, e, jffs2file);
520 /* don't add it again */
530 /* no EOF marker, make sure we figure out the last inode number
531 * before appending some data */
532 mtd_parse_jffs2data(buf, jffs2dir);
535 /* need to erase the next block before writing data to it */
538 while (w + buflen > e - skip_bad_blocks) {
540 fprintf(stderr, "\b\b\b[e]");
542 if (mtd_block_is_bad(fd, e)) {
544 fprintf(stderr, "\nSkipping bad block at 0x%08zx ", e);
546 skip_bad_blocks += erasesize;
549 // Move the file pointer along over the bad block.
550 lseek(fd, erasesize, SEEK_CUR);
554 if (mtd_erase_block(fd, e) < 0) {
557 write(fd, buf + offset, e - w);
564 fprintf(stderr, "\b\b\b \n");
567 fprintf(stderr, "Failed to erase block\n");
572 /* erase the chunk */
578 fprintf(stderr, "\b\b\b[w]");
580 if ((result = write(fd, buf + offset, buflen)) < buflen) {
582 fprintf(stderr, "Error writing image.\n");
585 fprintf(stderr, "Insufficient space.\n");
595 if (jffs2_replaced && trx_fixup) {
600 fprintf(stderr, "\b\b\b\b ");
603 fprintf(stderr, "\n");
607 if (fis_remap(old_parts, n_old, new_parts, n_new) < 0)
608 fprintf(stderr, "Failed to update the FIS partition table\n");
616 static void usage(void)
618 fprintf(stderr, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>[:<device>...]\n\n"
619 "The device is in the format of mtdX (eg: mtd4) or its label.\n"
620 "mtd recognizes these commands:\n"
621 " unlock unlock the device\n"
622 " refresh refresh mtd partition\n"
623 " erase erase all data on device\n"
624 " verify <imagefile>|- verify <imagefile> (use - for stdin) to device\n"
625 " write <imagefile>|- write <imagefile> (use - for stdin) to device\n"
626 " jffs2write <file> append <file> to the jffs2 partition on the device\n");
629 " fixtrx fix the checksum in a trx header on first boot\n");
633 " fixseama fix the checksum in a seama header on first boot\n");
636 "Following options are available:\n"
637 " -q quiet mode (once: no [w] on writing,\n"
638 " twice: no status messages)\n"
639 " -n write without first erasing the blocks\n"
640 " -r reboot after successful command\n"
641 " -f force write without trx checks\n"
642 " -e <device> erase <device> before executing the command\n"
643 " -d <name> directory for jffs2write, defaults to \"tmp\"\n"
644 " -j <name> integrate <file> into jffs2 data when writing an image\n"
645 " -s <number> skip the first n bytes when appending data to the jffs2 partiton, defaults to \"0\"\n"
646 " -p write beginning at partition offset\n"
647 " -l <length> the length of data that we want to dump\n");
650 " -o offset offset of the image header in the partition(for fixtrx)\n");
654 " -F <part>[:<size>[:<entrypoint>]][,<part>...]\n"
655 " alter the fis partition table to create new partitions replacing\n"
656 " the partitions provided as argument to the write command\n"
657 " (only valid together with the write command)\n"
660 "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
661 " mtd -r write linux.trx linux\n\n");
665 static void do_reboot(void)
667 fprintf(stderr, "Rebooting ...\n");
670 /* try regular reboot method first */
671 system("/sbin/reboot");
674 /* if we're still alive at this point, force the kernel to reboot */
675 syscall(SYS_reboot,LINUX_REBOOT_MAGIC1,LINUX_REBOOT_MAGIC2,LINUX_REBOOT_CMD_RESTART,NULL);
678 int main (int argc, char **argv)
680 int ch, i, boot, imagefd = 0, force, unlocked;
681 char *erase[MAX_ARGS], *device = NULL;
682 char *fis_layout = NULL;
683 size_t offset = 0, part_offset = 0, dump_len = 0;
702 while ((ch = getopt(argc, argv,
706 "frnqe:d:s:j:p:o:l:")) != -1)
722 jffs2_skip_bytes = strtoul(optarg, 0, 0);
724 fprintf(stderr, "-s: illegal numeric string\n");
733 while ((erase[i] != NULL) && ((i + 1) < MAX_ARGS))
744 part_offset = strtoul(optarg, 0, 0);
746 fprintf(stderr, "-p: illegal numeric string\n");
752 dump_len = strtoul(optarg, 0, 0);
754 fprintf(stderr, "-l: illegal numeric string\n");
760 fprintf(stderr, "-o: is not available on this platform\n");
764 offset = strtoul(optarg, 0, 0);
766 fprintf(stderr, "-o: illegal numeric string\n");
785 if ((strcmp(argv[0], "unlock") == 0) && (argc == 2)) {
788 } else if ((strcmp(argv[0], "erase") == 0) && (argc == 2)) {
791 } else if (((strcmp(argv[0], "fixtrx") == 0) && (argc == 2)) && mtd_fixtrx) {
794 } else if (((strcmp(argv[0], "fixseama") == 0) && (argc == 2)) && mtd_fixseama) {
797 } else if ((strcmp(argv[0], "verify") == 0) && (argc == 3)) {
801 } else if ((strcmp(argv[0], "dump") == 0) && (argc == 2)) {
804 } else if ((strcmp(argv[0], "write") == 0) && (argc == 3)) {
808 if (strcmp(argv[1], "-") == 0) {
809 imagefile = "<stdin>";
813 if ((imagefd = open(argv[1], O_RDONLY)) < 0) {
814 fprintf(stderr, "Couldn't open image file: %s!\n", imagefile);
819 if (!mtd_check(device)) {
820 fprintf(stderr, "Can't open device for writing!\n");
823 /* check trx file before erasing or writing anything */
824 if (!image_check(imagefd, device) && !force) {
825 fprintf(stderr, "Image check failed.\n");
828 } else if ((strcmp(argv[0], "jffs2write") == 0) && (argc == 3)) {
829 cmd = CMD_JFFS2WRITE;
833 if (!mtd_check(device)) {
834 fprintf(stderr, "Can't open device for writing!\n");
845 while (erase[i] != NULL) {
846 mtd_unlock(erase[i]);
848 if (strcmp(erase[i], device) == 0)
859 mtd_verify(device, imagefile);
862 mtd_dump(device, dump_len);
872 mtd_write(imagefd, device, fis_layout, part_offset);
877 mtd_write_jffs2(device, imagefile, jffs2dir);
881 mtd_fixtrx(device, offset);
885 mtd_fixseama(device, 0);