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>
43 #include <linux/mtd/mtd.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 */
67 image_check_bcom(int imagefd, const char *mtd)
69 struct trx_header *trx = (struct trx_header *) buf;
70 struct mtd_info_user mtdInfo;
73 buflen = read(imagefd, buf, 32);
75 fprintf(stdout, "Could not get image header, file too small (%ld bytes)\n", buflen);
80 case 0x47343557: /* W54G */
81 case 0x53343557: /* W54S */
82 case 0x73343557: /* W54s */
83 case 0x46343557: /* W54F */
84 case 0x55343557: /* W54U */
85 /* ignore the first 32 bytes */
86 buflen = read(imagefd, buf, sizeof(struct trx_header));
90 if (trx->magic != TRX_MAGIC || trx->len < sizeof(struct trx_header)) {
91 fprintf(stderr, "Bad trx header\n");
92 fprintf(stderr, "If this is a firmware in bin format, like some of the\n"
93 "original firmware files are, use following command to convert to trx:\n"
94 "dd if=firmware.bin of=firmware.trx bs=32 skip=1\n");
98 /* check if image fits to mtd device */
99 fd = mtd_open(mtd, O_RDWR);
101 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
105 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
106 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
110 if(mtdInfo.size < trx->len) {
111 fprintf(stderr, "Image too big for partition: %s\n", mtd);
120 image_check(int imagefd, const char *mtd)
127 systype = SYSTYPE_UNKNOWN;
128 f = fopen("/proc/cpuinfo", "r");
129 while (!feof(f) && (fgets(buf, BUFSIZE - 1, f) != NULL)) {
130 if ((strncmp(buf, "system type", 11) == 0) && (c = strchr(buf, ':'))) {
132 if (strncmp(c, "Broadcom BCM947XX", 17) == 0)
133 systype = SYSTYPE_BROADCOM;
139 case SYSTYPE_BROADCOM:
140 return image_check_bcom(imagefd, mtd);
146 int mtd_check(char *mtd)
148 struct mtd_info_user mtdInfo;
151 fd = mtd_open(mtd, O_RDWR);
153 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
157 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
158 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
168 mtd_unlock(const char *mtd)
171 struct mtd_info_user mtdInfo;
172 struct erase_info_user mtdLockInfo;
174 fd = mtd_open(mtd, O_RDWR);
176 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
180 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
181 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
186 mtdLockInfo.start = 0;
187 mtdLockInfo.length = mtdInfo.size;
188 if(ioctl(fd, MEMUNLOCK, &mtdLockInfo)) {
198 mtd_open(const char *mtd, int flags)
204 if ((fp = fopen("/proc/mtd", "r"))) {
205 while (fgets(dev, sizeof(dev), fp)) {
206 if (sscanf(dev, "mtd%d:", &i) && strstr(dev, mtd)) {
207 snprintf(dev, sizeof(dev), "/dev/mtd/%d", i);
209 return open(dev, flags);
215 return open(mtd, flags);
219 mtd_erase(const char *mtd)
222 struct mtd_info_user mtdInfo;
223 struct erase_info_user mtdEraseInfo;
225 fd = mtd_open(mtd, O_RDWR);
227 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
231 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
232 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
237 mtdEraseInfo.length = mtdInfo.erasesize;
239 for (mtdEraseInfo.start = 0;
240 mtdEraseInfo.start < mtdInfo.size;
241 mtdEraseInfo.start += mtdInfo.erasesize) {
243 ioctl(fd, MEMUNLOCK, &mtdEraseInfo);
244 if(ioctl(fd, MEMERASE, &mtdEraseInfo)) {
245 fprintf(stderr, "Could not erase MTD device: %s\n", mtd);
257 mtd_write(int imagefd, const char *mtd, int quiet)
261 struct mtd_info_user mtdInfo;
262 struct erase_info_user mtdEraseInfo;
264 fd = mtd_open(mtd, O_RDWR);
266 fprintf(stderr, "Could not open mtd device: %s\n", mtd);
270 if(ioctl(fd, MEMGETINFO, &mtdInfo)) {
271 fprintf(stderr, "Could not get MTD device info from %s\n", mtd);
278 fprintf(stderr, " [ ]");
281 /* buffer may contain data already (from trx check) */
283 r += read(imagefd, buf + buflen, BUFSIZE - buflen);
289 /* need to erase the next block before writing data to it */
291 mtdEraseInfo.start = e;
292 mtdEraseInfo.length = mtdInfo.erasesize;
295 fprintf(stderr, "\b\b\b[e]");
296 /* erase the chunk */
297 if (ioctl (fd,MEMERASE,&mtdEraseInfo) < 0) {
298 fprintf(stderr, "Erasing mtd failed: %s\n", mtd);
301 e += mtdInfo.erasesize;
305 fprintf(stderr, "\b\b\b[w]");
307 if ((result = write(fd, buf, r)) < r) {
309 fprintf(stderr, "Error writing image.\n");
312 fprintf(stderr, "Insufficient space.\n");
320 fprintf(stderr, "\b\b\b\b");
327 fprintf(stderr, "Usage: mtd [<options> ...] <command> [<arguments> ...] <device>\n\n"
328 "The device is in the format of mtdX (eg: mtd4) or its label.\n"
329 "mtd recognizes these commands:\n"
330 " unlock unlock the device\n"
331 " erase erase all data on device\n"
332 " write <imagefile>|- write <imagefile> (use - for stdin) to device\n"
333 "Following options are available:\n"
334 " -q quiet mode (once: no [w] on writing,\n"
335 " twice: no status messages)\n"
336 " -r reboot after successful command\n"
337 " -f force write without trx checks\n"
338 " -e <device> erase <device> before executing the command\n\n"
339 "Example: To write linux.trx to mtd4 labeled as linux and reboot afterwards\n"
340 " mtd -r write linux.trx linux\n\n");
344 int main (int argc, char **argv)
346 int ch, i, boot, unlock, imagefd, force, quiet, unlocked;
347 char *erase[MAX_ARGS], *device, *imagefile;
360 while ((ch = getopt(argc, argv, "frqe:")) != -1)
373 while ((erase[i] != NULL) && ((i + 1) < MAX_ARGS))
390 if ((strcmp(argv[0], "unlock") == 0) && (argc == 2)) {
393 } else if ((strcmp(argv[0], "erase") == 0) && (argc == 2)) {
396 } else if ((strcmp(argv[0], "write") == 0) && (argc == 3)) {
400 if (strcmp(argv[1], "-") == 0) {
401 imagefile = "<stdin>";
405 if ((imagefd = open(argv[1], O_RDONLY)) < 0) {
406 fprintf(stderr, "Couldn't open image file: %s!\n", imagefile);
411 /* check trx file before erasing or writing anything */
412 if (!image_check(imagefd, device)) {
413 if ((quiet < 2) || !force)
414 fprintf(stderr, "TRX check failed!\n");
418 if (!mtd_check(device)) {
419 fprintf(stderr, "Can't open device for writing!\n");
431 while (erase[i] != NULL) {
433 fprintf(stderr, "Unlocking %s ...\n", erase[i]);
434 mtd_unlock(erase[i]);
436 fprintf(stderr, "Erasing %s ...\n", erase[i]);
438 if (strcmp(erase[i], device) == 0)
445 fprintf(stderr, "Unlocking %s ...\n", device);
454 fprintf(stderr, "Erasing %s ...\n", device);
459 fprintf(stderr, "Writing from %s to %s ... ", imagefile, device);
460 mtd_write(imagefd, device, quiet);
462 fprintf(stderr, "\n");
467 kill(1, 15); // send SIGTERM to init for reboot