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.
35 #include <sys/ioctl.h>
36 #include <sys/types.h>
37 #include <sys/param.h>
38 #include <sys/mount.h>
40 #include <sys/reboot.h>
45 #define TRX_MAGIC 0x30524448 /* "HDR0" */
46 #define BUFSIZE (16 * 1024)
51 #define SYSTYPE_UNKNOWN 0
52 #define SYSTYPE_BROADCOM 1
56 uint32_t magic; /* "HDR0" */
57 uint32_t len; /* Length of file including header */
58 uint32_t crc32; /* 32-bit CRC from flag_version to end of file */
59 uint32_t flag_version; /* 0:15 flags, 16:31 version */
60 uint32_t offsets[3]; /* Offsets of partitions from start of header */
69 image_check_brcm(int imagefd, const char *mtd)
71 struct trx_header *trx = (struct trx_header *) buf;
72 struct mtd_info_user mtdInfo;
75 if (strcmp(mtd, "linux") != 0)
78 buflen = read(imagefd, buf, 32);
80 fprintf(stdout, "Could not get image header, file too small (%ld bytes)\n", buflen);
85 case 0x47343557: /* W54G */
86 case 0x53343557: /* W54S */
87 case 0x73343557: /* W54s */
88 case 0x46343557: /* W54F */
89 case 0x55343557: /* W54U */
90 /* ignore the first 32 bytes */
91 buflen = read(imagefd, buf, sizeof(struct trx_header));
95 if (trx->magic != TRX_MAGIC || trx->len < sizeof(struct trx_header)) {
97 fprintf(stderr, "Bad trx header\n");
98 fprintf(stderr, "If this is a firmware in bin format, like some of the\n"
99 "original firmware files are, you need to convert it to trx.\n");
104 /* check if image fits to mtd device */
105 fd = mtd_open(mtd, O_RDWR | O_SYNC);
107 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
111 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
112 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
116 if(mtdInfo.size < trx->len) {
117 fprintf(stderr, "Image too big for partition: %s\n", mtd);
125 #endif /* target_brcm */
128 image_check(int imagefd, const char *mtd)
136 return image_check_brcm(imagefd, mtd);
140 int mtd_check(char *mtd)
142 struct mtd_info_user mtdInfo;
145 fd = mtd_open(mtd, O_RDWR | O_SYNC);
147 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
151 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
152 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
162 mtd_unlock(const char *mtd)
165 struct mtd_info_user mtdInfo;
166 struct erase_info_user mtdLockInfo;
168 fd = mtd_open(mtd, O_RDWR | O_SYNC);
170 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
174 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
175 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
180 mtdLockInfo.start = 0;
181 mtdLockInfo.length = mtdInfo.size;
182 if(ioctl(fd, MEMUNLOCK, &mtdLockInfo)) {
192 mtd_open(const char *mtd, int flags)
198 if ((fp = fopen("/proc/mtd", "r"))) {
199 while (fgets(dev, sizeof(dev), fp)) {
200 if (sscanf(dev, "mtd%d:", &i) && strstr(dev, mtd)) {
201 snprintf(dev, sizeof(dev), "/dev/mtd/%d", i);
203 return open(dev, flags);
209 return open(mtd, flags);
213 mtd_erase(const char *mtd)
216 struct mtd_info_user mtdInfo;
217 struct erase_info_user mtdEraseInfo;
219 fd = mtd_open(mtd, O_RDWR | O_SYNC);
221 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
225 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
226 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
231 mtdEraseInfo.length = mtdInfo.erasesize;
233 for (mtdEraseInfo.start = 0;
234 mtdEraseInfo.start < mtdInfo.size;
235 mtdEraseInfo.start += mtdInfo.erasesize) {
237 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
238 if(ioctl(fd, MEMERASE, &mtdEraseInfo))
239 fprintf(stderr, "Failed to erase block on %s at 0x%x\n", mtd, mtdEraseInfo.start);
248 mtd_write(int imagefd, const char *mtd)
252 struct mtd_info_user mtdInfo;
253 struct erase_info_user mtdEraseInfo;
256 fd = mtd_open(mtd, O_RDWR | O_SYNC);
258 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
262 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
263 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
270 fprintf(stderr, " [ ]");
273 /* buffer may contain data already (from trx check) */
275 r += read(imagefd, buf + buflen, BUFSIZE - buflen);
281 /* need to erase the next block before writing data to it */
283 mtdEraseInfo.start = e;
284 mtdEraseInfo.length = mtdInfo.erasesize;
287 fprintf(stderr, "\b\b\b[e]");
288 /* erase the chunk */
289 if (ioctl (fd,MEMERASE,&mtdEraseInfo) < 0) {
290 fprintf(stderr, "Erasing mtd failed: %s\n", mtd);
293 e += mtdInfo.erasesize;
297 fprintf(stderr, "\b\b\b[w]");
299 if ((result = write(fd, buf, r)) < r) {
301 fprintf(stderr, "Error writing image.\n");
304 fprintf(stderr, "Insufficient space.\n");
312 fprintf(stderr, "\b\b\b\b");
320 fprintf(stderr, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>\n\n"
321 "The device is in the format of mtdX (eg: mtd4) or its label.\n"
322 "mtd recognizes these commands:\n"
323 " unlock unlock the device\n"
324 " erase erase all data on device\n"
325 " write <imagefile>|- write <imagefile> (use - for stdin) to device\n"
326 "Following options are available:\n"
327 " -q quiet mode (once: no [w] on writing,\n"
328 " twice: no status messages)\n"
329 " -r reboot after successful command\n"
330 " -f force write without trx checks\n"
331 " -e <device> erase <device> before executing the command\n\n"
332 "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
333 " mtd -r write linux.trx linux\n\n");
337 int main (int argc, char **argv)
339 int ch, i, boot, unlock, imagefd, force, unlocked;
340 char *erase[MAX_ARGS], *device, *imagefile;
353 while ((ch = getopt(argc, argv, "frqe:")) != -1)
366 while ((erase[i] != NULL) && ((i + 1) < MAX_ARGS))
383 if ((strcmp(argv[0], "unlock") == 0) && (argc == 2)) {
386 } else if ((strcmp(argv[0], "erase") == 0) && (argc == 2)) {
389 } else if ((strcmp(argv[0], "write") == 0) && (argc == 3)) {
393 if (strcmp(argv[1], "-") == 0) {
394 imagefile = "<stdin>";
398 if ((imagefd = open(argv[1], O_RDONLY)) < 0) {
399 fprintf(stderr, "Couldn't open image file: %s!\n", imagefile);
404 /* check trx file before erasing or writing anything */
405 if (!image_check(imagefd, device)) {
407 fprintf(stderr, "Image check failed.\n");
411 if (!mtd_check(device)) {
412 fprintf(stderr, "Can't open device for writing!\n");
424 while (erase[i] != NULL) {
426 fprintf(stderr, "Unlocking %s ...\n", erase[i]);
427 mtd_unlock(erase[i]);
429 fprintf(stderr, "Erasing %s ...\n", erase[i]);
431 if (strcmp(erase[i], device) == 0)
438 fprintf(stderr, "Unlocking %s ...\n", device);
447 fprintf(stderr, "Erasing %s ...\n", device);
452 fprintf(stderr, "Writing from %s to %s ... ", imagefile, device);
453 mtd_write(imagefd, device);
455 fprintf(stderr, "\n");
462 kill(1, 15); // send SIGTERM to init for reboot