2 * mtd - simple memory technology device manipulation tool
4 * Copyright (C) 2005 Waldemar Brodkorb <wbx@dass-it.de>,
5 * 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
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
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.
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.
23 * The code is based on the linux-mtd examples.
32 #include <sys/ioctl.h>
33 #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>
49 #define TRX_MAGIC 0x30524448 /* "HDR0" */
54 #define JFFS2_DEFAULT_DIR "" /* directory name without /, empty means root dir */
56 #define SYSTYPE_UNKNOWN 0
57 #define SYSTYPE_BROADCOM 1
61 uint32_t magic; /* "HDR0" */
62 uint32_t len; /* Length of file including header */
63 uint32_t crc32; /* 32-bit CRC from flag_version to end of file */
64 uint32_t flag_version; /* 0:15 flags, 16:31 version */
65 uint32_t offsets[3]; /* Offsets of partitions from start of header */
68 static char *buf = NULL;
69 static char *imagefile = NULL;
70 static char *jffs2file = NULL, *jffs2dir = JFFS2_DEFAULT_DIR;
71 static int buflen = 0;
76 int mtd_open(const char *mtd)
82 int flags = O_RDWR | O_SYNC;
84 if ((fp = fopen("/proc/mtd", "r"))) {
85 while (fgets(dev, sizeof(dev), fp)) {
86 if (sscanf(dev, "mtd%d:", &i) && strstr(dev, mtd)) {
87 snprintf(dev, sizeof(dev), "/dev/mtd/%d", i);
88 if ((ret=open(dev, flags))<0) {
89 snprintf(dev, sizeof(dev), "/dev/mtd%d", i);
99 return open(mtd, flags);
102 int mtd_check_open(const char *mtd)
104 struct mtd_info_user mtdInfo;
109 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
113 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
114 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
118 mtdsize = mtdInfo.size;
119 erasesize = mtdInfo.erasesize;
124 int mtd_erase_block(int fd, int offset)
126 struct erase_info_user mtdEraseInfo;
128 mtdEraseInfo.start = offset;
129 mtdEraseInfo.length = erasesize;
130 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
131 if (ioctl (fd, MEMERASE, &mtdEraseInfo) < 0) {
132 fprintf(stderr, "Erasing mtd failed.\n");
137 int mtd_write_buffer(int fd, const char *buf, int offset, int length)
139 lseek(fd, offset, SEEK_SET);
140 write(fd, buf, length);
146 image_check_brcm(int imagefd, const char *mtd)
148 struct trx_header *trx = (struct trx_header *) buf;
151 if (strcmp(mtd, "linux") != 0)
154 buflen = read(imagefd, buf, 32);
156 fprintf(stdout, "Could not get image header, file too small (%ld bytes)\n", buflen);
160 if (trx->magic != TRX_MAGIC || trx->len < sizeof(struct trx_header)) {
162 fprintf(stderr, "Bad trx header\n");
163 fprintf(stderr, "This is not the correct file format; refusing to flash.\n"
164 "Please specify the correct file or use -f to force.\n");
169 /* check if image fits to mtd device */
170 fd = mtd_check_open(mtd);
172 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
176 if(mtdsize < trx->len) {
177 fprintf(stderr, "Image too big for partition: %s\n", mtd);
185 #endif /* target_brcm */
188 image_check(int imagefd, const char *mtd)
196 return image_check_brcm(imagefd, mtd);
200 static int mtd_check(const char *mtd)
204 fd = mtd_check_open(mtd);
209 buf = malloc(erasesize);
216 mtd_unlock(const char *mtd)
219 struct erase_info_user mtdLockInfo;
221 fd = mtd_check_open(mtd);
223 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
228 fprintf(stderr, "Unlocking %s ...\n", mtd);
230 mtdLockInfo.start = 0;
231 mtdLockInfo.length = mtdsize;
232 if(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) {
262 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
263 if(ioctl(fd, MEMERASE, &mtdEraseInfo))
264 fprintf(stderr, "Failed to erase block on %s at 0x%x\n", mtd, mtdEraseInfo.start);
273 mtd_refresh(const char *mtd)
278 fprintf(stderr, "Refreshing mtd partition %s ... ", mtd);
280 fd = mtd_check_open(mtd);
282 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
286 if (ioctl(fd, MTDREFRESH, NULL)) {
287 fprintf(stderr, "Failed to refresh the MTD device\n");
294 fprintf(stderr, "\n");
300 mtd_write(int imagefd, const char *mtd)
304 struct erase_info_user mtdEraseInfo;
307 fd = mtd_check_open(mtd);
309 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
314 fprintf(stderr, "Writing from %s to %s ... ", imagefile, mtd);
318 fprintf(stderr, " [ ]");
321 /* buffer may contain data already (from trx check) */
322 r = read(imagefd, buf + buflen, erasesize - buflen);
329 if (memcmp(buf, JFFS2_EOF, sizeof(JFFS2_EOF)) == 0) {
331 fprintf(stderr, "\b\b\b ");
333 fprintf(stderr, "\nAppending jffs2 data to from %s to %s...", jffs2file, mtd);
334 /* got an EOF marker - this is the place to add some jffs2 data */
335 mtd_replace_jffs2(fd, e, jffs2file);
338 /* no EOF marker, make sure we figure out the last inode number
339 * before appending some data */
340 mtd_parse_jffs2data(buf, jffs2dir);
343 /* need to erase the next block before writing data to it */
344 while (w + buflen > e) {
346 fprintf(stderr, "\b\b\b[e]");
348 mtd_erase_block(fd, e);
350 /* erase the chunk */
355 fprintf(stderr, "\b\b\b[w]");
357 if ((result = write(fd, buf, buflen)) < buflen) {
359 fprintf(stderr, "Error writing image.\n");
362 fprintf(stderr, "Insufficient space.\n");
368 /* not enough data - eof */
369 if (buflen < erasesize)
375 fprintf(stderr, "\b\b\b\b");
379 fprintf(stderr, "\n");
385 static void usage(void)
387 fprintf(stderr, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>\n\n"
388 "The device is in the format of mtdX (eg: mtd4) or its label.\n"
389 "mtd recognizes these commands:\n"
390 " unlock unlock the device\n"
391 " refresh refresh mtd partition\n"
392 " erase erase all data on device\n"
393 " write <imagefile>|- write <imagefile> (use - for stdin) to device\n"
394 " jffs2write <file> append <file> to the jffs2 partition on the device\n"
395 "Following options are available:\n"
396 " -q quiet mode (once: no [w] on writing,\n"
397 " twice: no status messages)\n"
398 " -r reboot after successful command\n"
399 " -f force write without trx checks\n"
400 " -e <device> erase <device> before executing the command\n"
401 " -d <name> directory for jffs2write, defaults to \"tmp\"\n"
402 " -j <name> integrate <file> into jffs2 data when writing an image\n"
404 "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
405 " mtd -r write linux.trx linux\n\n");
409 static void do_reboot(void)
411 fprintf(stderr, "Rebooting ...\n");
414 /* try regular reboot method first */
415 system("/sbin/reboot");
418 /* if we're still alive at this point, force the kernel to reboot */
419 syscall(SYS_reboot,LINUX_REBOOT_MAGIC1,LINUX_REBOOT_MAGIC2,LINUX_REBOOT_CMD_RESTART,NULL);
422 int main (int argc, char **argv)
424 int ch, i, boot, unlock, imagefd, force, unlocked;
425 char *erase[MAX_ARGS], *device;
440 while ((ch = getopt(argc, argv, "frqe:d:j:")) != -1)
456 while ((erase[i] != NULL) && ((i + 1) < MAX_ARGS))
475 if ((strcmp(argv[0], "unlock") == 0) && (argc == 2)) {
478 } else if ((strcmp(argv[0], "refresh") == 0) && (argc == 2)) {
481 } else if ((strcmp(argv[0], "erase") == 0) && (argc == 2)) {
484 } else if ((strcmp(argv[0], "write") == 0) && (argc == 3)) {
488 if (strcmp(argv[1], "-") == 0) {
489 imagefile = "<stdin>";
493 if ((imagefd = open(argv[1], O_RDONLY)) < 0) {
494 fprintf(stderr, "Couldn't open image file: %s!\n", imagefile);
499 if (!mtd_check(device)) {
500 fprintf(stderr, "Can't open device for writing!\n");
503 /* check trx file before erasing or writing anything */
504 if (!image_check(imagefd, device) && !force) {
505 fprintf(stderr, "Image check failed.\n");
508 } else if ((strcmp(argv[0], "jffs2write") == 0) && (argc == 3)) {
509 cmd = CMD_JFFS2WRITE;
513 if (!mtd_check(device)) {
514 fprintf(stderr, "Can't open device for writing!\n");
525 while (erase[i] != NULL) {
526 mtd_unlock(erase[i]);
528 if (strcmp(erase[i], device) == 0)
547 mtd_write(imagefd, device);
552 mtd_write_jffs2(device, imagefile, jffs2dir);