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.
32 #include <sys/ioctl.h>
33 #include <sys/syscall.h>
38 #include <sys/ioctl.h>
39 #include <sys/types.h>
40 #include <sys/param.h>
41 #include <sys/mount.h>
43 #include <sys/reboot.h>
44 #include <linux/reboot.h>
45 #include <mtd/mtd-user.h>
49 #include <libubox/md5.h>
52 #define JFFS2_DEFAULT_DIR "" /* directory name without /, empty means root dir */
54 #define TRX_MAGIC 0x48445230 /* "HDR0" */
55 #define SEAMA_MAGIC 0x5ea3a417
57 #if !defined(__BYTE_ORDER)
58 #error "Unknown byte order"
61 #if __BYTE_ORDER == __BIG_ENDIAN
62 #define cpu_to_be32(x) (x)
63 #define be32_to_cpu(x) (x)
64 #elif __BYTE_ORDER == __LITTLE_ENDIAN
65 #define cpu_to_be32(x) bswap_32(x)
66 #define be32_to_cpu(x) bswap_32(x)
68 #error "Unsupported endianness"
71 enum mtd_image_format
{
72 MTD_IMAGE_FORMAT_UNKNOWN
,
74 MTD_IMAGE_FORMAT_SEAMA
,
77 static char *buf
= NULL
;
78 static char *imagefile
= NULL
;
79 static enum mtd_image_format imageformat
= MTD_IMAGE_FORMAT_UNKNOWN
;
80 static char *jffs2file
= NULL
, *jffs2dir
= JFFS2_DEFAULT_DIR
;
81 static int buflen
= 0;
86 int jffs2_skip_bytes
=0;
89 int mtd_open(const char *mtd
, bool block
)
95 int flags
= O_RDWR
| O_SYNC
;
98 snprintf(name
, sizeof(name
), "\"%s\"", mtd
);
99 if ((fp
= fopen("/proc/mtd", "r"))) {
100 while (fgets(dev
, sizeof(dev
), fp
)) {
101 if (sscanf(dev
, "mtd%d:", &i
) && strstr(dev
, name
)) {
102 snprintf(dev
, sizeof(dev
), "/dev/mtd%s/%d", (block
? "block" : ""), i
);
103 if ((ret
=open(dev
, flags
))<0) {
104 snprintf(dev
, sizeof(dev
), "/dev/mtd%s%d", (block
? "block" : ""), i
);
105 ret
=open(dev
, flags
);
114 return open(mtd
, flags
);
117 int mtd_check_open(const char *mtd
)
119 struct mtd_info_user mtdInfo
;
122 fd
= mtd_open(mtd
, false);
124 fprintf(stderr
, "Could not open mtd device: %s\n", mtd
);
128 if(ioctl(fd
, MEMGETINFO
, &mtdInfo
)) {
129 fprintf(stderr
, "Could not get MTD device info from %s\n", mtd
);
133 mtdsize
= mtdInfo
.size
;
134 erasesize
= mtdInfo
.erasesize
;
135 mtdtype
= mtdInfo
.type
;
140 int mtd_block_is_bad(int fd
, int offset
)
145 if (mtdtype
== MTD_NANDFLASH
)
147 r
= ioctl(fd
, MEMGETBADBLOCK
, &o
);
150 fprintf(stderr
, "Failed to get erase block status\n");
157 int mtd_erase_block(int fd
, int offset
)
159 struct erase_info_user mtdEraseInfo
;
161 mtdEraseInfo
.start
= offset
;
162 mtdEraseInfo
.length
= erasesize
;
163 ioctl(fd
, MEMUNLOCK
, &mtdEraseInfo
);
164 if (ioctl (fd
, MEMERASE
, &mtdEraseInfo
) < 0)
170 int mtd_write_buffer(int fd
, const char *buf
, int offset
, int length
)
172 lseek(fd
, offset
, SEEK_SET
);
173 write(fd
, buf
, length
);
178 image_check(int imagefd
, const char *mtd
)
183 if (buflen
< sizeof(magic
)) {
184 buflen
+= read(imagefd
, buf
+ buflen
, sizeof(magic
) - buflen
);
185 if (buflen
< sizeof(magic
)) {
186 fprintf(stdout
, "Could not get image magic\n");
190 magic
= ((uint32_t *)buf
)[0];
192 if (be32_to_cpu(magic
) == TRX_MAGIC
)
193 imageformat
= MTD_IMAGE_FORMAT_TRX
;
194 else if (be32_to_cpu(magic
) == SEAMA_MAGIC
)
195 imageformat
= MTD_IMAGE_FORMAT_SEAMA
;
197 switch (imageformat
) {
198 case MTD_IMAGE_FORMAT_TRX
:
200 ret
= trx_check(imagefd
, mtd
, buf
, &buflen
);
202 case MTD_IMAGE_FORMAT_SEAMA
:
206 if (!strcmp(mtd
, "firmware"))
215 static int mtd_check(const char *mtd
)
221 if (strchr(mtd
, ':')) {
227 next
= strchr(mtd
, ':');
233 fd
= mtd_check_open(mtd
);
238 buf
= malloc(erasesize
);
251 mtd_unlock(const char *mtd
)
253 struct erase_info_user mtdLockInfo
;
258 if (strchr(mtd
, ':')) {
264 next
= strchr(mtd
, ':');
270 fd
= mtd_check_open(mtd
);
272 fprintf(stderr
, "Could not open mtd device: %s\n", mtd
);
277 fprintf(stderr
, "Unlocking %s ...\n", mtd
);
279 mtdLockInfo
.start
= 0;
280 mtdLockInfo
.length
= mtdsize
;
281 ioctl(fd
, MEMUNLOCK
, &mtdLockInfo
);
293 mtd_erase(const char *mtd
)
296 struct erase_info_user mtdEraseInfo
;
299 fprintf(stderr
, "Erasing %s ...\n", mtd
);
301 fd
= mtd_check_open(mtd
);
303 fprintf(stderr
, "Could not open mtd device: %s\n", mtd
);
307 mtdEraseInfo
.length
= erasesize
;
309 for (mtdEraseInfo
.start
= 0;
310 mtdEraseInfo
.start
< mtdsize
;
311 mtdEraseInfo
.start
+= erasesize
) {
312 if (mtd_block_is_bad(fd
, mtdEraseInfo
.start
)) {
314 fprintf(stderr
, "\nSkipping bad block at 0x%x ", mtdEraseInfo
.start
);
316 ioctl(fd
, MEMUNLOCK
, &mtdEraseInfo
);
317 if(ioctl(fd
, MEMERASE
, &mtdEraseInfo
))
318 fprintf(stderr
, "Failed to erase block on %s at 0x%x\n", mtd
, mtdEraseInfo
.start
);
328 mtd_dump(const char *mtd
, int part_offset
, int size
)
330 int ret
= 0, offset
= 0;
335 fprintf(stderr
, "Dumping %s ...\n", mtd
);
337 fd
= mtd_check_open(mtd
);
339 fprintf(stderr
, "Could not open mtd device: %s\n", mtd
);
347 lseek(fd
, part_offset
, SEEK_SET
);
349 buf
= malloc(erasesize
);
354 int len
= (size
> erasesize
) ? (erasesize
) : (size
);
355 int rlen
= read(fd
, buf
, len
);
363 if (!rlen
|| rlen
!= len
)
365 if (mtd_block_is_bad(fd
, offset
)) {
366 fprintf(stderr
, "skipping bad block at 0x%08x\n", offset
);
380 mtd_verify(const char *mtd
, char *file
)
382 uint32_t f_md5
[4], m_md5
[4];
389 fprintf(stderr
, "Verifying %s against %s ...\n", mtd
, file
);
391 if (stat(file
, &s
) || md5sum(file
, f_md5
) < 0) {
392 fprintf(stderr
, "Failed to hash %s\n", file
);
396 fd
= mtd_check_open(mtd
);
398 fprintf(stderr
, "Could not open mtd device: %s\n", mtd
);
405 int len
= (s
.st_size
> sizeof(buf
)) ? (sizeof(buf
)) : (s
.st_size
);
406 int rlen
= read(fd
, buf
, len
);
416 md5_hash(buf
, rlen
, &ctx
);
418 } while (s
.st_size
> 0);
420 md5_end(m_md5
, &ctx
);
422 fprintf(stderr
, "%08x%08x%08x%08x - %s\n", m_md5
[0], m_md5
[1], m_md5
[2], m_md5
[3], mtd
);
423 fprintf(stderr
, "%08x%08x%08x%08x - %s\n", f_md5
[0], f_md5
[1], f_md5
[2], f_md5
[3], file
);
425 ret
= memcmp(f_md5
, m_md5
, sizeof(m_md5
));
427 fprintf(stderr
, "Success\n");
429 fprintf(stderr
, "Failed\n");
437 indicate_writing(const char *mtd
)
440 fprintf(stderr
, "\nWriting from %s to %s ... ", imagefile
, mtd
);
443 fprintf(stderr
, " [ ]");
447 mtd_write(int imagefd
, const char *mtd
, char *fis_layout
, size_t part_offset
)
455 int jffs2_replaced
= 0;
456 int skip_bad_blocks
= 0;
459 static struct fis_part new_parts
[MAX_ARGS
];
460 static struct fis_part old_parts
[MAX_ARGS
];
461 int n_new
= 0, n_old
= 0;
464 const char *tmp
= mtd
;
468 memset(&old_parts
, 0, sizeof(old_parts
));
469 memset(&new_parts
, 0, sizeof(new_parts
));
472 next
= strchr(tmp
, ':');
474 next
= (char *) tmp
+ strlen(tmp
);
476 memcpy(old_parts
[n_old
].name
, tmp
, next
- tmp
);
482 for (word
= strtok_r(fis_layout
, ",", &brkt
);
484 word
= strtok_r(NULL
, ",", &brkt
)) {
486 tmp
= strtok(word
, ":");
487 strncpy((char *) new_parts
[n_new
].name
, tmp
, sizeof(new_parts
[n_new
].name
) - 1);
489 tmp
= strtok(NULL
, ":");
493 new_parts
[n_new
].size
= strtoul(tmp
, NULL
, 0);
495 tmp
= strtok(NULL
, ":");
499 new_parts
[n_new
].loadaddr
= strtoul(tmp
, NULL
, 16);
503 ret
= fis_validate(old_parts
, n_old
, new_parts
, n_new
);
505 fprintf(stderr
, "Failed to validate the new FIS partition table\n");
513 if (strchr(mtd
, ':')) {
521 next
= strchr(mtd
, ':');
527 fd
= mtd_check_open(mtd
);
529 fprintf(stderr
, "Could not open mtd device: %s\n", mtd
);
532 if (part_offset
> 0) {
533 fprintf(stderr
, "Seeking on mtd device '%s' to: %zu\n", mtd
, part_offset
);
534 lseek(fd
, part_offset
, SEEK_SET
);
537 indicate_writing(mtd
);
541 /* buffer may contain data already (from trx check or last mtd partition write attempt) */
542 while (buflen
< erasesize
) {
543 r
= read(imagefd
, buf
+ buflen
, erasesize
- buflen
);
545 if ((errno
== EINTR
) || (errno
== EAGAIN
))
562 if (buflen
< erasesize
) {
563 /* Pad block to eraseblock size */
564 memset(&buf
[buflen
], 0xff, erasesize
- buflen
);
572 indicate_writing(mtd
);
577 if (jffs2file
&& w
>= jffs2_skip_bytes
) {
578 if (memcmp(buf
, JFFS2_EOF
, sizeof(JFFS2_EOF
) - 1) == 0) {
580 fprintf(stderr
, "\b\b\b ");
582 fprintf(stderr
, "\nAppending jffs2 data from %s to %s...", jffs2file
, mtd
);
583 /* got an EOF marker - this is the place to add some jffs2 data */
584 skip
= mtd_replace_jffs2(mtd
, fd
, e
, jffs2file
);
587 /* don't add it again */
597 /* no EOF marker, make sure we figure out the last inode number
598 * before appending some data */
599 mtd_parse_jffs2data(buf
, jffs2dir
);
602 /* need to erase the next block before writing data to it */
605 while (w
+ buflen
> e
- skip_bad_blocks
) {
607 fprintf(stderr
, "\b\b\b[e]");
609 if (mtd_block_is_bad(fd
, e
)) {
611 fprintf(stderr
, "\nSkipping bad block at 0x%08zx ", e
);
613 skip_bad_blocks
+= erasesize
;
616 // Move the file pointer along over the bad block.
617 lseek(fd
, erasesize
, SEEK_CUR
);
621 if (mtd_erase_block(fd
, e
) < 0) {
624 write(fd
, buf
+ offset
, e
- w
);
631 fprintf(stderr
, "\b\b\b \n");
634 fprintf(stderr
, "Failed to erase block\n");
639 /* erase the chunk */
645 fprintf(stderr
, "\b\b\b[w]");
647 if ((result
= write(fd
, buf
+ offset
, buflen
)) < buflen
) {
649 fprintf(stderr
, "Error writing image.\n");
652 fprintf(stderr
, "Insufficient space.\n");
662 if (jffs2_replaced
&& trx_fixup
) {
667 fprintf(stderr
, "\b\b\b\b ");
670 fprintf(stderr
, "\n");
674 if (fis_remap(old_parts
, n_old
, new_parts
, n_new
) < 0)
675 fprintf(stderr
, "Failed to update the FIS partition table\n");
683 static void usage(void)
685 fprintf(stderr
, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>[:<device>...]\n\n"
686 "The device is in the format of mtdX (eg: mtd4) or its label.\n"
687 "mtd recognizes these commands:\n"
688 " unlock unlock the device\n"
689 " refresh refresh mtd partition\n"
690 " erase erase all data on device\n"
691 " verify <imagefile>|- verify <imagefile> (use - for stdin) to device\n"
692 " write <imagefile>|- write <imagefile> (use - for stdin) to device\n"
693 " jffs2write <file> append <file> to the jffs2 partition on the device\n");
696 " resetbc <device> reset the uboot boot counter\n");
700 " fixtrx fix the checksum in a trx header on first boot\n");
704 " fixseama fix the checksum in a seama header on first boot\n");
707 "Following options are available:\n"
708 " -q quiet mode (once: no [w] on writing,\n"
709 " twice: no status messages)\n"
710 " -n write without first erasing the blocks\n"
711 " -r reboot after successful command\n"
712 " -f force write without trx checks\n"
713 " -e <device> erase <device> before executing the command\n"
714 " -d <name> directory for jffs2write, defaults to \"tmp\"\n"
715 " -j <name> integrate <file> into jffs2 data when writing an image\n"
716 " -s <number> skip the first n bytes when appending data to the jffs2 partiton, defaults to \"0\"\n"
717 " -p write beginning at partition offset\n"
718 " -l <length> the length of data that we want to dump\n");
721 " -o offset offset of the image header in the partition(for fixtrx)\n");
725 " -F <part>[:<size>[:<entrypoint>]][,<part>...]\n"
726 " alter the fis partition table to create new partitions replacing\n"
727 " the partitions provided as argument to the write command\n"
728 " (only valid together with the write command)\n"
731 "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
732 " mtd -r write linux.trx linux\n\n");
736 static void do_reboot(void)
738 fprintf(stderr
, "Rebooting ...\n");
741 /* try regular reboot method first */
742 system("/sbin/reboot");
745 /* if we're still alive at this point, force the kernel to reboot */
746 syscall(SYS_reboot
,LINUX_REBOOT_MAGIC1
,LINUX_REBOOT_MAGIC2
,LINUX_REBOOT_CMD_RESTART
,NULL
);
749 int main (int argc
, char **argv
)
751 int ch
, i
, boot
, imagefd
= 0, force
, unlocked
;
752 char *erase
[MAX_ARGS
], *device
= NULL
;
753 char *fis_layout
= NULL
;
754 size_t offset
= 0, part_offset
= 0, dump_len
= 0;
774 while ((ch
= getopt(argc
, argv
,
778 "frnqe:d:s:j:p:o:l:")) != -1)
794 jffs2_skip_bytes
= strtoul(optarg
, 0, 0);
796 fprintf(stderr
, "-s: illegal numeric string\n");
805 while ((erase
[i
] != NULL
) && ((i
+ 1) < MAX_ARGS
))
816 part_offset
= strtoul(optarg
, 0, 0);
818 fprintf(stderr
, "-p: illegal numeric string\n");
824 dump_len
= strtoul(optarg
, 0, 0);
826 fprintf(stderr
, "-l: illegal numeric string\n");
832 offset
= strtoul(optarg
, 0, 0);
834 fprintf(stderr
, "-o: illegal numeric string\n");
853 if ((strcmp(argv
[0], "unlock") == 0) && (argc
== 2)) {
856 } else if ((strcmp(argv
[0], "erase") == 0) && (argc
== 2)) {
859 } else if (((strcmp(argv
[0], "resetbc") == 0) && (argc
== 2)) && mtd_resetbc
) {
862 } else if (((strcmp(argv
[0], "fixtrx") == 0) && (argc
== 2)) && mtd_fixtrx
) {
865 } else if (((strcmp(argv
[0], "fixseama") == 0) && (argc
== 2)) && mtd_fixseama
) {
868 } else if ((strcmp(argv
[0], "verify") == 0) && (argc
== 3)) {
872 } else if ((strcmp(argv
[0], "dump") == 0) && (argc
== 2)) {
875 } else if ((strcmp(argv
[0], "write") == 0) && (argc
== 3)) {
879 if (strcmp(argv
[1], "-") == 0) {
880 imagefile
= "<stdin>";
884 if ((imagefd
= open(argv
[1], O_RDONLY
)) < 0) {
885 fprintf(stderr
, "Couldn't open image file: %s!\n", imagefile
);
890 if (!mtd_check(device
)) {
891 fprintf(stderr
, "Can't open device for writing!\n");
894 /* check trx file before erasing or writing anything */
895 if (!image_check(imagefd
, device
) && !force
) {
896 fprintf(stderr
, "Image check failed.\n");
899 } else if ((strcmp(argv
[0], "jffs2write") == 0) && (argc
== 3)) {
900 cmd
= CMD_JFFS2WRITE
;
904 if (!mtd_check(device
)) {
905 fprintf(stderr
, "Can't open device for writing!\n");
916 while (erase
[i
] != NULL
) {
917 mtd_unlock(erase
[i
]);
919 if (strcmp(erase
[i
], device
) == 0)
930 mtd_verify(device
, imagefile
);
933 mtd_dump(device
, offset
, dump_len
);
943 mtd_write(imagefd
, device
, fis_layout
, part_offset
);
948 mtd_write_jffs2(device
, imagefile
, jffs2dir
);
952 mtd_fixtrx(device
, offset
);
960 mtd_fixseama(device
, 0);