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@nbd.name>
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.
33 #include <sys/ioctl.h>
34 #include <sys/syscall.h>
39 #include <sys/ioctl.h>
40 #include <sys/types.h>
41 #include <sys/param.h>
42 #include <sys/mount.h>
44 #include <sys/reboot.h>
45 #include <linux/reboot.h>
46 #include <mtd/mtd-user.h>
50 #include <libubox/md5.h>
53 #define JFFS2_DEFAULT_DIR "" /* directory name without /, empty means root dir */
55 #define TRX_MAGIC 0x48445230 /* "HDR0" */
56 #define SEAMA_MAGIC 0x5ea3a417
57 #define WRGG03_MAGIC 0x20080321
59 #if !defined(__BYTE_ORDER)
60 #error "Unknown byte order"
63 #if __BYTE_ORDER == __BIG_ENDIAN
64 #define cpu_to_be32(x) (x)
65 #define be32_to_cpu(x) (x)
66 #define le32_to_cpu(x) bswap_32(x)
67 #elif __BYTE_ORDER == __LITTLE_ENDIAN
68 #define cpu_to_be32(x) bswap_32(x)
69 #define be32_to_cpu(x) bswap_32(x)
70 #define le32_to_cpu(x) (x)
72 #error "Unsupported endianness"
75 enum mtd_image_format {
76 MTD_IMAGE_FORMAT_UNKNOWN,
78 MTD_IMAGE_FORMAT_SEAMA,
79 MTD_IMAGE_FORMAT_WRGG03,
82 static char *buf = NULL;
83 static char *imagefile = NULL;
84 static enum mtd_image_format imageformat = MTD_IMAGE_FORMAT_UNKNOWN;
85 static char *jffs2file = NULL, *jffs2dir = JFFS2_DEFAULT_DIR;
86 static int buflen = 0;
91 int jffs2_skip_bytes=0;
94 int mtd_open(const char *mtd, bool block)
100 int flags = O_RDWR | O_SYNC;
103 snprintf(name, sizeof(name), "\"%s\"", mtd);
104 if ((fp = fopen("/proc/mtd", "r"))) {
105 while (fgets(dev, sizeof(dev), fp)) {
106 if (sscanf(dev, "mtd%d:", &i) && strstr(dev, name)) {
107 snprintf(dev, sizeof(dev), "/dev/mtd%s/%d", (block ? "block" : ""), i);
108 if ((ret=open(dev, flags))<0) {
109 snprintf(dev, sizeof(dev), "/dev/mtd%s%d", (block ? "block" : ""), i);
110 ret=open(dev, flags);
119 return open(mtd, flags);
122 int mtd_check_open(const char *mtd)
124 struct mtd_info_user mtdInfo;
127 fd = mtd_open(mtd, false);
129 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
133 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
134 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
138 mtdsize = mtdInfo.size;
139 erasesize = mtdInfo.erasesize;
140 mtdtype = mtdInfo.type;
145 int mtd_block_is_bad(int fd, int offset)
150 if (mtdtype == MTD_NANDFLASH)
152 r = ioctl(fd, MEMGETBADBLOCK, &o);
155 fprintf(stderr, "Failed to get erase block status\n");
162 int mtd_erase_block(int fd, int offset)
164 struct erase_info_user mtdEraseInfo;
166 mtdEraseInfo.start = offset;
167 mtdEraseInfo.length = erasesize;
168 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
169 if (ioctl (fd, MEMERASE, &mtdEraseInfo) < 0)
175 int mtd_write_buffer(int fd, const char *buf, int offset, int length)
177 lseek(fd, offset, SEEK_SET);
178 write(fd, buf, length);
183 image_check(int imagefd, const char *mtd)
189 while (buflen < sizeof(magic)) {
190 bufread = read(imagefd, buf + buflen, sizeof(magic) - buflen);
197 if (buflen < sizeof(magic)) {
198 fprintf(stdout, "Could not get image magic\n");
202 magic = ((uint32_t *)buf)[0];
204 if (be32_to_cpu(magic) == TRX_MAGIC)
205 imageformat = MTD_IMAGE_FORMAT_TRX;
206 else if (be32_to_cpu(magic) == SEAMA_MAGIC)
207 imageformat = MTD_IMAGE_FORMAT_SEAMA;
208 else if (le32_to_cpu(magic) == WRGG03_MAGIC)
209 imageformat = MTD_IMAGE_FORMAT_WRGG03;
211 switch (imageformat) {
212 case MTD_IMAGE_FORMAT_TRX:
214 ret = trx_check(imagefd, mtd, buf, &buflen);
216 case MTD_IMAGE_FORMAT_SEAMA:
218 case MTD_IMAGE_FORMAT_WRGG03:
222 if (!strcmp(mtd, "firmware"))
231 static int mtd_check(const char *mtd)
237 if (strchr(mtd, ':')) {
243 next = strchr(mtd, ':');
249 fd = mtd_check_open(mtd);
254 buf = malloc(erasesize);
267 mtd_unlock(const char *mtd)
269 struct erase_info_user mtdLockInfo;
274 if (strchr(mtd, ':')) {
280 next = strchr(mtd, ':');
286 fd = mtd_check_open(mtd);
288 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
293 fprintf(stderr, "Unlocking %s ...\n", mtd);
295 mtdLockInfo.start = 0;
296 mtdLockInfo.length = mtdsize;
297 ioctl(fd, MEMUNLOCK, &mtdLockInfo);
309 mtd_erase(const char *mtd)
312 struct erase_info_user mtdEraseInfo;
315 fprintf(stderr, "Erasing %s ...\n", mtd);
317 fd = mtd_check_open(mtd);
319 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
323 mtdEraseInfo.length = erasesize;
325 for (mtdEraseInfo.start = 0;
326 mtdEraseInfo.start < mtdsize;
327 mtdEraseInfo.start += erasesize) {
328 if (mtd_block_is_bad(fd, mtdEraseInfo.start)) {
330 fprintf(stderr, "\nSkipping bad block at 0x%x ", mtdEraseInfo.start);
332 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
333 if(ioctl(fd, MEMERASE, &mtdEraseInfo))
334 fprintf(stderr, "Failed to erase block on %s at 0x%x\n", mtd, mtdEraseInfo.start);
344 mtd_dump(const char *mtd, int part_offset, int size)
346 int ret = 0, offset = 0;
351 fprintf(stderr, "Dumping %s ...\n", mtd);
353 fd = mtd_check_open(mtd);
355 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
363 lseek(fd, part_offset, SEEK_SET);
365 buf = malloc(erasesize);
370 int len = (size > erasesize) ? (erasesize) : (size);
371 int rlen = read(fd, buf, len);
379 if (!rlen || rlen != len)
381 if (mtd_block_is_bad(fd, offset)) {
382 fprintf(stderr, "skipping bad block at 0x%08x\n", offset);
396 mtd_verify(const char *mtd, char *file)
398 uint32_t f_md5[4], m_md5[4];
405 fprintf(stderr, "Verifying %s against %s ...\n", mtd, file);
407 if (stat(file, &s) || md5sum(file, f_md5) < 0) {
408 fprintf(stderr, "Failed to hash %s\n", file);
412 fd = mtd_check_open(mtd);
414 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
421 int len = (s.st_size > sizeof(buf)) ? (sizeof(buf)) : (s.st_size);
422 int rlen = read(fd, buf, len);
432 md5_hash(buf, rlen, &ctx);
434 } while (s.st_size > 0);
436 md5_end(m_md5, &ctx);
438 fprintf(stderr, "%08x%08x%08x%08x - %s\n", m_md5[0], m_md5[1], m_md5[2], m_md5[3], mtd);
439 fprintf(stderr, "%08x%08x%08x%08x - %s\n", f_md5[0], f_md5[1], f_md5[2], f_md5[3], file);
441 ret = memcmp(f_md5, m_md5, sizeof(m_md5));
443 fprintf(stderr, "Success\n");
445 fprintf(stderr, "Failed\n");
453 indicate_writing(const char *mtd)
456 fprintf(stderr, "\nWriting from %s to %s ... ", imagefile, mtd);
459 fprintf(stderr, " [ ]");
463 mtd_write(int imagefd, const char *mtd, char *fis_layout, size_t part_offset)
471 int jffs2_replaced = 0;
472 int skip_bad_blocks = 0;
475 static struct fis_part new_parts[MAX_ARGS];
476 static struct fis_part old_parts[MAX_ARGS];
477 int n_new = 0, n_old = 0;
480 const char *tmp = mtd;
484 memset(&old_parts, 0, sizeof(old_parts));
485 memset(&new_parts, 0, sizeof(new_parts));
488 next = strchr(tmp, ':');
490 next = (char *) tmp + strlen(tmp);
492 memcpy(old_parts[n_old].name, tmp, next - tmp);
498 for (word = strtok_r(fis_layout, ",", &brkt);
500 word = strtok_r(NULL, ",", &brkt)) {
502 tmp = strtok(word, ":");
503 strncpy((char *) new_parts[n_new].name, tmp, sizeof(new_parts[n_new].name) - 1);
505 tmp = strtok(NULL, ":");
509 new_parts[n_new].size = strtoul(tmp, NULL, 0);
511 tmp = strtok(NULL, ":");
515 new_parts[n_new].loadaddr = strtoul(tmp, NULL, 16);
519 ret = fis_validate(old_parts, n_old, new_parts, n_new);
521 fprintf(stderr, "Failed to validate the new FIS partition table\n");
529 if (strchr(mtd, ':')) {
537 next = strchr(mtd, ':');
543 fd = mtd_check_open(mtd);
545 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
548 if (part_offset > 0) {
549 fprintf(stderr, "Seeking on mtd device '%s' to: %zu\n", mtd, part_offset);
550 lseek(fd, part_offset, SEEK_SET);
553 indicate_writing(mtd);
557 /* buffer may contain data already (from trx check or last mtd partition write attempt) */
558 while (buflen < erasesize) {
559 r = read(imagefd, buf + buflen, erasesize - buflen);
561 if ((errno == EINTR) || (errno == EAGAIN))
578 if (buflen < erasesize) {
579 /* Pad block to eraseblock size */
580 memset(&buf[buflen], 0xff, erasesize - buflen);
588 indicate_writing(mtd);
593 if (jffs2file && w >= jffs2_skip_bytes) {
594 if (memcmp(buf, JFFS2_EOF, sizeof(JFFS2_EOF) - 1) == 0) {
596 fprintf(stderr, "\b\b\b ");
598 fprintf(stderr, "\nAppending jffs2 data from %s to %s..\n.", jffs2file, mtd);
599 /* got an EOF marker - this is the place to add some jffs2 data */
600 skip = mtd_replace_jffs2(mtd, fd, e, jffs2file);
603 /* don't add it again */
613 /* no EOF marker, make sure we figure out the last inode number
614 * before appending some data */
615 mtd_parse_jffs2data(buf, jffs2dir);
618 /* need to erase the next block before writing data to it */
621 while (w + buflen > e - skip_bad_blocks) {
623 fprintf(stderr, "\b\b\b[e]");
625 if (mtd_block_is_bad(fd, e)) {
627 fprintf(stderr, "\nSkipping bad block at 0x%08zx ", e);
629 skip_bad_blocks += erasesize;
632 // Move the file pointer along over the bad block.
633 lseek(fd, erasesize, SEEK_CUR);
637 if (mtd_erase_block(fd, e) < 0) {
640 write(fd, buf + offset, e - w);
647 fprintf(stderr, "\b\b\b \n");
650 fprintf(stderr, "Failed to erase block\n");
655 /* erase the chunk */
661 fprintf(stderr, "\b\b\b[w]");
663 if ((result = write(fd, buf + offset, buflen)) < buflen) {
665 fprintf(stderr, "Error writing image.\n");
668 fprintf(stderr, "Insufficient space.\n");
678 if (jffs2_replaced) {
679 switch (imageformat) {
680 case MTD_IMAGE_FORMAT_TRX:
684 case MTD_IMAGE_FORMAT_SEAMA:
686 mtd_fixseama(mtd, 0, 0);
688 case MTD_IMAGE_FORMAT_WRGG03:
690 mtd_fixwrgg(mtd, 0, 0);
698 fprintf(stderr, "\b\b\b\b ");
701 fprintf(stderr, "\n");
705 if (fis_remap(old_parts, n_old, new_parts, n_new) < 0)
706 fprintf(stderr, "Failed to update the FIS partition table\n");
714 static void usage(void)
716 fprintf(stderr, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>[:<device>...]\n\n"
717 "The device is in the format of mtdX (eg: mtd4) or its label.\n"
718 "mtd recognizes these commands:\n"
719 " unlock unlock the device\n"
720 " refresh refresh mtd partition\n"
721 " erase erase all data on device\n"
722 " verify <imagefile>|- verify <imagefile> (use - for stdin) to device\n"
723 " write <imagefile>|- write <imagefile> (use - for stdin) to device\n"
724 " jffs2write <file> append <file> to the jffs2 partition on the device\n");
727 " resetbc <device> reset the uboot boot counter\n");
731 " fixtrx fix the checksum in a trx header on first boot\n");
735 " fixseama fix the checksum in a seama header on first boot\n");
739 " fixwrgg fix the checksum in a wrgg header on first boot\n");
742 "Following options are available:\n"
743 " -q quiet mode (once: no [w] on writing,\n"
744 " twice: no status messages)\n"
745 " -n write without first erasing the blocks\n"
746 " -r reboot after successful command\n"
747 " -f force write without trx checks\n"
748 " -e <device> erase <device> before executing the command\n"
749 " -d <name> directory for jffs2write, defaults to \"tmp\"\n"
750 " -j <name> integrate <file> into jffs2 data when writing an image\n"
751 " -s <number> skip the first n bytes when appending data to the jffs2 partiton, defaults to \"0\"\n"
752 " -p <number> write beginning at partition offset\n"
753 " -l <length> the length of data that we want to dump\n");
756 " -o offset offset of the image header in the partition(for fixtrx)\n");
758 if (mtd_fixtrx || mtd_fixseama || mtd_fixwrgg) {
760 " -c datasize amount of data to be used for checksum calculation (for fixtrx / fixseama / fixwrgg)\n");
764 " -F <part>[:<size>[:<entrypoint>]][,<part>...]\n"
765 " alter the fis partition table to create new partitions replacing\n"
766 " the partitions provided as argument to the write command\n"
767 " (only valid together with the write command)\n"
770 "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
771 " mtd -r write linux.trx linux\n\n");
775 static void do_reboot(void)
777 fprintf(stderr, "Rebooting ...\n");
780 /* try regular reboot method first */
781 system("/sbin/reboot");
784 /* if we're still alive at this point, force the kernel to reboot */
785 syscall(SYS_reboot,LINUX_REBOOT_MAGIC1,LINUX_REBOOT_MAGIC2,LINUX_REBOOT_CMD_RESTART,NULL);
788 int main (int argc, char **argv)
790 int ch, i, boot, imagefd = 0, force, unlocked;
791 char *erase[MAX_ARGS], *device = NULL;
792 char *fis_layout = NULL;
793 size_t offset = 0, data_size = 0, part_offset = 0, dump_len = 0;
814 while ((ch = getopt(argc, argv,
818 "frnqe:d:s:j:p:o:c:l:")) != -1)
834 jffs2_skip_bytes = strtoul(optarg, 0, 0);
836 fprintf(stderr, "-s: illegal numeric string\n");
845 while ((erase[i] != NULL) && ((i + 1) < MAX_ARGS))
856 part_offset = strtoul(optarg, 0, 0);
858 fprintf(stderr, "-p: illegal numeric string\n");
864 dump_len = strtoul(optarg, 0, 0);
866 fprintf(stderr, "-l: illegal numeric string\n");
872 offset = strtoul(optarg, 0, 0);
874 fprintf(stderr, "-o: illegal numeric string\n");
880 data_size = strtoul(optarg, 0, 0);
882 fprintf(stderr, "-c: illegal numeric string\n");
901 if ((strcmp(argv[0], "unlock") == 0) && (argc == 2)) {
904 } else if ((strcmp(argv[0], "erase") == 0) && (argc == 2)) {
907 } else if (((strcmp(argv[0], "resetbc") == 0) && (argc == 2)) && mtd_resetbc) {
910 } else if (((strcmp(argv[0], "fixtrx") == 0) && (argc == 2)) && mtd_fixtrx) {
913 } else if (((strcmp(argv[0], "fixseama") == 0) && (argc == 2)) && mtd_fixseama) {
916 } else if (((strcmp(argv[0], "fixwrgg") == 0) && (argc == 2)) && mtd_fixwrgg) {
919 } else if ((strcmp(argv[0], "verify") == 0) && (argc == 3)) {
923 } else if ((strcmp(argv[0], "dump") == 0) && (argc == 2)) {
926 } else if ((strcmp(argv[0], "write") == 0) && (argc == 3)) {
930 if (strcmp(argv[1], "-") == 0) {
931 imagefile = "<stdin>";
935 if ((imagefd = open(argv[1], O_RDONLY)) < 0) {
936 fprintf(stderr, "Couldn't open image file: %s!\n", imagefile);
941 if (!mtd_check(device)) {
942 fprintf(stderr, "Can't open device for writing!\n");
945 /* check trx file before erasing or writing anything */
946 if (!image_check(imagefd, device) && !force) {
947 fprintf(stderr, "Image check failed.\n");
950 } else if ((strcmp(argv[0], "jffs2write") == 0) && (argc == 3)) {
951 cmd = CMD_JFFS2WRITE;
955 if (!mtd_check(device)) {
956 fprintf(stderr, "Can't open device for writing!\n");
967 while (erase[i] != NULL) {
968 mtd_unlock(erase[i]);
970 if (strcmp(erase[i], device) == 0)
981 mtd_verify(device, imagefile);
984 mtd_dump(device, offset, dump_len);
994 mtd_write(imagefd, device, fis_layout, part_offset);
999 mtd_write_jffs2(device, imagefile, jffs2dir);
1003 mtd_fixtrx(device, offset, data_size);
1008 mtd_resetbc(device);
1013 mtd_fixseama(device, 0, data_size);
1017 mtd_fixwrgg(device, 0, data_size);